دفعة كتابة، تُستخدم لإجراء عمليات كتابة متعددة كوحدة ذرية واحدة.
يمكن الحصول على كائن WriteBatch عن طريق استدعاء writeBatch() . يوفر طرقًا لإضافة عمليات الكتابة إلى مجموعة الكتابة. لن يتم الالتزام بأي من عمليات الكتابة (أو تكون مرئية محليًا) حتى يتم استدعاء WriteBatch.commit() .
إمضاء:
export declare class WriteBatch
طُرق
| طريقة | الصفات التعريفية | وصف |
|---|---|---|
| يقترف() | ينفذ كافة عمليات الكتابة في مجموعة الكتابة هذه كوحدة ذرية واحدة. لن تنعكس نتيجة عمليات الكتابة هذه إلا في عمليات قراءة المستند التي تحدث بعد حل الوعد الذي تم إرجاعه. إذا كان العميل غير متصل، تفشل الكتابة. إذا كنت ترغب في رؤية التعديلات المحلية أو عمليات الكتابة المؤقتة حتى يصبح العميل متصلاً بالإنترنت، فاستخدم Firestore SDK الكامل. | |
| حذف (المستند) | يحذف المستند المشار إليه بواسطة DocumentReference المقدم . | |
| مجموعة (documentRef، البيانات) | يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه. | |
| مجموعة (documentRef، البيانات، الخيارات) | يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه. إذا قمت بتوفير merge أو mergeFields ، فيمكن دمج البيانات المقدمة في مستند موجود. | |
| التحديث (المستند، البيانات) | تحديث الحقول في المستند المشار إليه بواسطة DocumentReference المقدم . سوف يفشل التحديث إذا تم تطبيقه على مستند غير موجود. | |
| التحديث (documentRef، الحقل، القيمة، moreFieldsAndValues) | يقوم بتحديث الحقول في المستند المشار إليه بواسطة DocumentReference . سوف يفشل التحديث إذا تم تطبيقه على مستند غير موجود. يمكن تحديث الحقول المتداخلة من خلال توفير سلاسل مسار حقل مفصولة بنقاط أو من خلال توفير كائنات FieldPath . |
WriteBatch.commit()
ينفذ كافة عمليات الكتابة في مجموعة الكتابة هذه كوحدة ذرية واحدة.
لن تنعكس نتيجة عمليات الكتابة هذه إلا في عمليات قراءة المستند التي تحدث بعد حل الوعد الذي تم إرجاعه. إذا كان العميل غير متصل، تفشل الكتابة. إذا كنت ترغب في رؤية التعديلات المحلية أو عمليات الكتابة المؤقتة حتى يصبح العميل متصلاً بالإنترنت، فاستخدم Firestore SDK الكامل.
إمضاء:
commit(): Promise<void>;
عائدات:
وعد<باطل>
تم حل Promise بمجرد كتابة جميع عمليات الكتابة في الدفعة بنجاح إلى الواجهة الخلفية كوحدة ذرية (لاحظ أنه لن يتم حلها عندما تكون غير متصل بالإنترنت).
WriteBatch.delete()
يحذف المستند المشار إليه بواسطة DocumentReference المقدم .
إمضاء:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| وثيقةالمرجع | وثيقة مرجعية <AppModelType، DbModelType> | إشارة إلى الوثيقة المراد حذفها. |
عائدات:
هذا المثيل WriteBatch . يستخدم لاستدعاءات أسلوب التسلسل.
WriteBatch.set()
يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه.
إمضاء:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| وثيقةالمرجع | وثيقة مرجعية <AppModelType، DbModelType> | إشارة إلى الوثيقة التي سيتم تعيينها. |
| بيانات | مع قيمة الحقل <AppModelType> | كائن من الحقول والقيم الخاصة بالمستند. |
عائدات:
هذا المثيل WriteBatch . يستخدم لاستدعاءات أسلوب التسلسل.
WriteBatch.set()
يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه. إذا قمت بتوفير merge أو mergeFields ، يمكن دمج البيانات المقدمة في مستند موجود.
إمضاء:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): WriteBatch;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| وثيقةالمرجع | وثيقة مرجعية <AppModelType، DbModelType> | إشارة إلى الوثيقة التي سيتم تعيينها. |
| بيانات | PartialWithFieldValue <AppModelType> | كائن من الحقول والقيم الخاصة بالمستند. |
| خيارات | خيارات الضبط | كائن لتكوين السلوك المحدد. |
عائدات:
هذا المثيل WriteBatch . يستخدم لاستدعاءات أسلوب التسلسل.
الاستثناءات
خطأ - إذا كان الإدخال المقدم ليس مستند Firestore صالحًا.
تحديث WriteBatch()
تحديث الحقول في المستند المشار إليه بواسطة DocumentReference المقدم . سوف يفشل التحديث إذا تم تطبيقه على مستند غير موجود.
إمضاء:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| الوثيقةالمرجع | وثيقة مرجعية <AppModelType، DbModelType> | إشارة إلى الوثيقة المراد تحديثها. |
| بيانات | تحديث البيانات <DBModelType> | كائن يحتوي على الحقول والقيم التي سيتم تحديث المستند بها. يمكن أن تحتوي الحقول على نقاط للإشارة إلى الحقول المتداخلة داخل المستند. |
عائدات:
هذا المثيل WriteBatch . يستخدم لاستدعاءات أسلوب التسلسل.
الاستثناءات
خطأ - إذا كان الإدخال المقدم غير صالح لبيانات Firestore.
تحديث WriteBatch()
يقوم بتحديث الحقول في المستند المشار إليه بواسطة DocumentReference . سوف يفشل التحديث إذا تم تطبيقه على مستند غير موجود.
يمكن تحديث الحقول المتداخلة من خلال توفير سلاسل مسار حقل مفصولة بنقاط أو من خلال توفير كائنات FieldPath .
إمضاء:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
حدود
| معامل | يكتب | وصف |
|---|---|---|
| الوثيقةالمرجع | وثيقة مرجعية <AppModelType، DbModelType> | إشارة إلى الوثيقة المراد تحديثها. |
| مجال | سلسلة | مسار الحقل | الحقل الأول للتحديث. |
| قيمة | مجهول | القيمة الأولى. |
| المزيد من الحقول والقيم | مجهول[] | أزواج القيمة الرئيسية الإضافية. |
عائدات:
هذا المثيل WriteBatch . يستخدم لاستدعاءات أسلوب التسلسل.
الاستثناءات
خطأ - إذا كان الإدخال المقدم غير صالح لبيانات Firestore.