اشاره به یک معامله
شی Transaction که به updateFunction یک تراکنش ارسال می شود، روش هایی را برای خواندن و نوشتن داده ها در زمینه تراکنش فراهم می کند. به runTransaction() مراجعه کنید .
امضا:
export declare class Transaction
مواد و روش ها
| روش | اصلاح کننده ها | شرح |
|---|---|---|
| حذف (documentRef) | سند ارجاع شده توسط DocumentReference ارائه شده را حذف می کند . | |
| دریافت (documentRef) | سند ارجاع شده توسط DocumentReference ارائه شده را می خواند . | |
| مجموعه (documentRef، داده) | در سند ارجاع شده توسط DocumentReference ارائه شده می نویسد . اگر سند هنوز وجود نداشته باشد، ایجاد می شود. | |
| مجموعه (documentRef، داده ها، گزینه ها) | در سند ارجاع شده توسط DocumentReference ارائه شده می نویسد . اگر سند هنوز وجود نداشته باشد، ایجاد می شود. اگر فیلدهای merge یا mergeFields ارائه دهید، داده های ارائه شده را می توان در یک سند موجود ادغام کرد. | |
| به روز رسانی (documentRef، داده ها) | فیلدهای سندی را که توسط DocumentReference ارائه شده به آن ارجاع داده شده به روز می کند . اگر بر روی سندی که وجود ندارد اعمال شود، به‌روزرسانی ناموفق خواهد بود. | |
| به روز رسانی (documentRef، فیلد، مقدار، بیشترFieldsAndValues) | فیلدهای سندی را که توسط DocumentReference ارائه شده به آن ارجاع داده شده به روز می کند . اگر بر روی سندی که وجود ندارد اعمال شود، به‌روزرسانی ناموفق خواهد بود. فیلدهای تودرتو را می توان با ارائه رشته های مسیر میدان جدا شده با نقطه یا با ارائه اشیاء FieldPath به روز کرد. |
Transaction.delete()
سند ارجاع شده توسط DocumentReference ارائه شده را حذف می کند .
امضا:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| documentRef | مرجع سند <AppModelType، DbModelType> | ارجاع به سندی که باید حذف شود. |
برمی گرداند:
این
این مورد Transaction برای زنجیر کردن تماس های متد استفاده می شود.
Transaction.get()
سند ارجاع شده توسط DocumentReference ارائه شده را می خواند .
امضا:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| documentRef | مرجع سند <AppModelType، DbModelType> | ارجاع به سندی که باید خوانده شود. |
برمی گرداند:
Promise< DocumentSnapshot <AppModelType، DbModelType>>
یک DocumentSnapshot با داده های خوانده شده.
Transaction.set()
در سند ارجاع شده توسط DocumentReference ارائه شده می نویسد . اگر سند هنوز وجود نداشته باشد، ایجاد می شود.
امضا:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| documentRef | مرجع سند <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;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| documentRef | مرجع سند <AppModelType، DbModelType> | ارجاع به سندی که باید تنظیم شود. |
| داده ها | PartialWithFieldValue <AppModelType> | یک شی از فیلدها و مقادیر برای سند. |
| گزینه ها | SetOptions | یک شی برای پیکربندی رفتار مجموعه. |
برمی گرداند:
این
این مورد Transaction برای زنجیر کردن تماس های متد استفاده می شود.
استثناها
خطا - اگر ورودی ارائه شده یک سند Firestore معتبر نباشد.
Transaction.update()
فیلدهای سندی را که توسط DocumentReference ارائه شده به آن ارجاع داده شده به روز می کند . اگر بر روی سندی که وجود ندارد اعمال شود، به‌روزرسانی ناموفق خواهد بود.
امضا:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| documentRef | مرجع سند <AppModelType، DbModelType> | ارجاع به سندی که باید به روز شود. |
| داده ها | بروزرسانی اطلاعات <DbModelType> | یک شی حاوی فیلدها و مقادیری است که با آن سند به روز می شود. فیلدها می توانند حاوی نقطه هایی برای ارجاع به فیلدهای تودرتو در سند باشند. |
برمی گرداند:
این
این مورد Transaction برای زنجیر کردن تماس های متد استفاده می شود.
استثناها
خطا - اگر ورودی ارائه شده، داده Firestore معتبر نباشد.
Transaction.update()
فیلدهای سندی را که توسط DocumentReference ارائه شده به آن ارجاع داده شده به روز می کند . اگر بر روی سندی که وجود ندارد اعمال شود، به‌روزرسانی ناموفق خواهد بود.
فیلدهای تودرتو را می توان با ارائه رشته های مسیر میدان جدا شده با نقطه یا با ارائه اشیاء FieldPath به روز کرد.
امضا:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
مولفه های
| پارامتر | تایپ کنید | شرح |
|---|---|---|
| documentRef | مرجع سند <AppModelType، DbModelType> | ارجاع به سندی که باید به روز شود. |
| رشته | رشته | FieldPath | اولین فیلد برای به روز رسانی. |
| ارزش | ناشناخته | اولین مقدار. |
| MoreFieldsAndValues | ناشناخته[] | جفت کلید/مقدار اضافی |
برمی گرداند:
این
این مورد Transaction برای زنجیر کردن تماس های متد استفاده می شود.
استثناها
خطا - اگر ورودی ارائه شده، داده Firestore معتبر نباشد.