إشارة إلى الصفقة.
يوفر كائن Transaction
الذي تم تمريره إلى updateFunction
الخاصة بالمعاملة طرقًا لقراءة البيانات وكتابتها في سياق المعاملة. راجع runTransaction() .
إمضاء:
export declare class Transaction
طُرق
طريقة | الصفات التعريفية | وصف |
---|---|---|
حذف (المستند) | يحذف المستند المشار إليه بواسطة DocumentReference المقدم . | |
الحصول على (المستندالمرجع) | يقرأ المستند المشار إليه بواسطة DocumentReference المقدم . | |
مجموعة (documentRef، البيانات) | يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه. | |
مجموعة (documentRef، البيانات، الخيارات) | يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه. إذا قمت بتوفير merge أو mergeFields ، فيمكن دمج البيانات المقدمة في مستند موجود. | |
التحديث (المستند، البيانات) | تحديث الحقول في المستند المشار إليه بواسطة 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
مع بيانات القراءة.
مجموعة المعاملات ()
يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه.
إمضاء:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
حدود
معامل | يكتب | وصف |
---|---|---|
وثيقةالمرجع | وثيقة مرجعية <AppModelType، DbModelType> | إشارة إلى الوثيقة التي سيتم تعيينها. |
بيانات | مع قيمة الحقل <AppModelType> | كائن من الحقول والقيم الخاصة بالمستند. |
عائدات:
هذا
مثيل Transaction
هذا. يستخدم لاستدعاءات أسلوب التسلسل.
الاستثناءات
خطأ - إذا كان الإدخال المقدم ليس مستند Firestore صالحًا.
مجموعة المعاملات ()
يكتب إلى المستند المشار إليه في DocumentReference المقدم . إذا لم يكن المستند موجودًا بعد، فسيتم إنشاؤه. إذا قمت بتوفير merge
أو mergeFields
، يمكن دمج البيانات المقدمة في مستند موجود.
إمضاء:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
حدود
معامل | يكتب | وصف |
---|---|---|
وثيقةالمرجع | وثيقة مرجعية <AppModelType، DbModelType> | إشارة إلى الوثيقة التي سيتم تعيينها. |
بيانات | PartialWithFieldValue <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> | إشارة إلى الوثيقة المراد تحديثها. |
مجال | سلسلة | مسار الحقل | الحقل الأول للتحديث. |
قيمة | مجهول | القيمة الأولى. |
المزيد من الحقول والقيم | مجهول[] | أزواج المفاتيح/القيمة الإضافية. |
عائدات:
هذا
مثيل Transaction
هذا. يستخدم لاستدعاءات أسلوب التسلسل.
الاستثناءات
خطأ - إذا كان الإدخال المقدم غير صالح لبيانات Firestore.