การอ้างอิงถึงธุรกรรม
วัตถุ Transaction ที่ส่งผ่านไปยัง updateFunction ของธุรกรรมจัดเตรียมวิธีการอ่านและเขียนข้อมูลภายในบริบทของธุรกรรม ดู runTransaction() .
ลายเซ็น:
export declare class Transaction
วิธีการ
| วิธี | ตัวดัดแปลง | คำอธิบาย |
|---|---|---|
| ลบ(documentRef) | ลบเอกสารที่อ้างถึงโดย DocumentReference ที่ให้ไว้ . | |
| รับ (documentRef) | อ่านเอกสารที่อ้างอิงโดย DocumentReference ที่ให้มา . | |
| ชุด (documentRef, ข้อมูล) | เขียนไปยังเอกสารที่อ้างอิงโดย DocumentReference ที่ให้ไว้ . หากยังไม่มีเอกสารก็จะถูกสร้างขึ้น | |
| ชุด (documentRef, ข้อมูล, ตัวเลือก) | เขียนไปยังเอกสารที่อ้างอิงโดย DocumentReference ที่ให้ไว้ . หากยังไม่มีเอกสารก็จะถูกสร้างขึ้น หากคุณระบุ merge หรือ mergeFields ข้อมูลที่ระบุสามารถผสานเข้ากับเอกสารที่มีอยู่ได้ | |
| อัปเดต (documentRef, ข้อมูล) | อัปเดตฟิลด์ในเอกสารที่อ้างถึงโดย DocumentReference ที่ให้ไว้ . การอัปเดตจะล้มเหลวหากนำไปใช้กับเอกสารที่ไม่มีอยู่ | |
| อัปเดต (documentRef, ฟิลด์, ค่า, moreFieldsAndValues) | อัปเดตฟิลด์ในเอกสารที่อ้างถึงโดย DocumentReference ที่ให้ไว้ . การอัปเดตจะล้มเหลวหากนำไปใช้กับเอกสารที่ไม่มีอยู่ ฟิลด์ที่ซ้อนกันสามารถอัปเดตได้โดยการระบุสตริงพาธของฟิลด์ที่คั่นด้วยจุด หรือโดยการจัดเตรียมออบเจ็กต์ FieldPath |
ธุรกรรมลบ()
ลบเอกสารที่อ้างถึงโดย DocumentReference ที่ให้ไว้ .
ลายเซ็น:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| เอกสารอ้างอิง | เอกสารอ้างอิง <AppModelType, DbModelType> | การอ้างอิงถึงเอกสารที่จะลบ |
ผลตอบแทน:
นี้
อินสแตนซ์ Transaction นี้ ใช้สำหรับการเรียกวิธีการผูกมัด
ธุรกรรม.get()
อ่านเอกสารที่อ้างอิงโดย DocumentReference ที่ให้มา .
ลายเซ็น:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| เอกสารอ้างอิง | เอกสารอ้างอิง <AppModelType, DbModelType> | การอ้างอิงถึงเอกสารที่จะอ่าน |
ผลตอบแทน:
สัญญา< DocumentSnapshot <AppModelType, DbModelType>>
DocumentSnapshot พร้อมข้อมูลที่อ่าน
ธุรกรรม.set()
เขียนไปยังเอกสารที่อ้างอิงโดย DocumentReference ที่ให้ไว้ . หากยังไม่มีเอกสารก็จะถูกสร้างขึ้น
ลายเซ็น:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| เอกสารอ้างอิง | เอกสารอ้างอิง <AppModelType, DbModelType> | การอ้างอิงถึงเอกสารที่จะตั้งค่า |
| ข้อมูล | ด้วยค่าฟิลด์ <AppModelType> | วัตถุของเขตข้อมูลและค่าสำหรับเอกสาร |
ผลตอบแทน:
นี้
อินสแตนซ์ Transaction นี้ ใช้สำหรับการเรียกวิธีการผูกมัด
ข้อยกเว้น
ข้อผิดพลาด - หากอินพุตที่ระบุไม่ใช่เอกสาร Firestore ที่ถูกต้อง
ธุรกรรม.set()
เขียนไปยังเอกสารที่อ้างอิงโดย DocumentReference ที่ให้ไว้ . หากยังไม่มีเอกสารก็จะถูกสร้างขึ้น หากคุณระบุ merge หรือ mergeFields ข้อมูลที่ให้ไว้สามารถรวมเข้ากับเอกสารที่มีอยู่ได้
ลายเซ็น:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| เอกสารอ้างอิง | เอกสารอ้างอิง <AppModelType, DbModelType> | การอ้างอิงถึงเอกสารที่จะตั้งค่า |
| ข้อมูล | บางส่วนด้วยFieldValue <AppModelType> | วัตถุของเขตข้อมูลและค่าสำหรับเอกสาร |
| ตัวเลือก | ตั้งค่าตัวเลือก | วัตถุเพื่อกำหนดค่าพฤติกรรมการตั้งค่า |
ผลตอบแทน:
นี้
อินสแตนซ์ Transaction นี้ ใช้สำหรับการเรียกวิธีการผูกมัด
ข้อยกเว้น
ข้อผิดพลาด - หากอินพุตที่ระบุไม่ใช่เอกสาร Firestore ที่ถูกต้อง
ธุรกรรมอัพเดต ()
อัปเดตฟิลด์ในเอกสารที่อ้างถึงโดย DocumentReference ที่ให้ไว้ . การอัปเดตจะล้มเหลวหากนำไปใช้กับเอกสารที่ไม่มีอยู่
ลายเซ็น:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| เอกสารอ้างอิง | เอกสารอ้างอิง <AppModelType, DbModelType> | การอ้างอิงถึงเอกสารที่จะอัปเดต |
| ข้อมูล | อัปเดตข้อมูล <DbModelType> | ออบเจ็กต์ที่มีเขตข้อมูลและค่าที่ใช้อัปเดตเอกสาร ช่องต่างๆ สามารถมีจุดเพื่ออ้างอิงช่องที่ซ้อนกันภายในเอกสารได้ |
ผลตอบแทน:
นี้
อินสแตนซ์ Transaction นี้ ใช้สำหรับการเรียกวิธีการผูกมัด
ข้อยกเว้น
ข้อผิดพลาด - หากอินพุตที่ให้มาไม่ใช่ข้อมูล Firestore ที่ถูกต้อง
ธุรกรรมอัพเดต ()
อัปเดตฟิลด์ในเอกสารที่อ้างถึงโดย DocumentReference ที่ให้ไว้ . การอัปเดตจะล้มเหลวหากนำไปใช้กับเอกสารที่ไม่มีอยู่
ฟิลด์ที่ซ้อนกันสามารถอัปเดตได้โดยการระบุสตริงพาธของฟิลด์ที่คั่นด้วยจุด หรือโดยการจัดเตรียมออบเจ็กต์ FieldPath
ลายเซ็น:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
พารามิเตอร์
| พารามิเตอร์ | พิมพ์ | คำอธิบาย |
|---|---|---|
| เอกสารอ้างอิง | เอกสารอ้างอิง <AppModelType, DbModelType> | การอ้างอิงถึงเอกสารที่จะอัปเดต |
| สนาม | สตริง | FieldPath | ช่องแรกที่จะอัพเดต |
| ค่า | ไม่ทราบ | ค่าแรก |
| เพิ่มเติมFieldsAndValues | ไม่ทราบ[] | คู่คีย์/ค่าเพิ่มเติม |
ผลตอบแทน:
นี้
อินสแตนซ์ Transaction นี้ ใช้สำหรับการเรียกวิธีการผูกมัด
ข้อยกเว้น
ข้อผิดพลาด - หากอินพุตที่ให้มาไม่ใช่ข้อมูล Firestore ที่ถูกต้อง