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