אצווה כתיבה, המשמשת לביצוע כתיבה מרובת כיחידה אטומית אחת.
ניתן לרכוש אובייקט WriteBatch על ידי קריאה ל-writerBatch() . הוא מספק שיטות להוספת כתבים לקבוצת הכתיבה. אף אחת מהכתובות לא תתבצע מחויבת (או תהיה גלויה מקומית) עד לקריאת WriteBatch.commit() .
חֲתִימָה:
export declare class WriteBatch
שיטות
| שיטה | משנה | תיאור |
|---|---|---|
| לְבַצֵעַ() | מבצע את כל הכתיבה באצווה כתיבה זו כיחידה אטומית אחת. התוצאה של כתיבה אלו תבוא לידי ביטוי רק בקריאות מסמכים המתרחשות לאחר שההבטחה שהוחזרה תיפתר. אם הלקוח לא מקוון, הכתיבה נכשלת. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore. | |
| delete(documentRef) | מוחק את המסמך שאליו מתייחס DocumentReference שסופק . | |
| set(מסמךRef, נתונים) | כותב למסמך שאליו מתייחס DocumentReference שסופק . אם המסמך עדיין לא קיים, הוא ייווצר. | |
| הגדר (מסמךRef, נתונים, אפשרויות) | כותב למסמך שאליו מתייחס DocumentReference שסופק . אם המסמך עדיין לא קיים, הוא ייווצר. אם תספק merge או mergeFields , ניתן למזג את הנתונים שסופקו למסמך קיים. | |
| עדכון (מסמך Ref, נתונים) | מעדכן שדות במסמך שאליו מתייחס DocumentReference שסופק . העדכון ייכשל אם יוחל על מסמך שאינו קיים. | |
| update(documentRef, field, value, moreFieldsAndValues) | מעדכן שדות במסמך שאליו מתייחס DocumentReference זה . העדכון ייכשל אם יוחל על מסמך שאינו קיים. ניתן לעדכן שדות מקוננים על ידי מתן מחרוזות נתיב שדות מופרדות בנקודות או על ידי אספקת אובייקטי FieldPath . |
WriteBatch.commit()
מבצע את כל הכתיבה באצווה כתיבה זו כיחידה אטומית אחת.
התוצאה של כתיבה אלו תבוא לידי ביטוי רק בקריאות מסמכים המתרחשות לאחר שההבטחה שהוחזרה תיפתר. אם הלקוח לא מקוון, הכתיבה נכשלת. אם תרצה לראות שינויים מקומיים או כתיבת חוצץ עד שהלקוח יהיה מקוון, השתמש ב-SDK המלא של Firestore.
חֲתִימָה:
commit(): Promise<void>;
החזרות:
הבטחה<void>
Promise נפתרה לאחר שכל הכתובות באצווה נכתבו בהצלחה ל-backend כיחידה אטומית (שים לב שהיא לא תיפתר בזמן שאתה במצב לא מקוון).
WriteBatch.delete()
מוחק את המסמך שאליו מתייחס DocumentReference שסופק .
חֲתִימָה:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש למחוק. |
החזרות:
מופע זה WriteBatch . משמש לקריאת שיטות שרשור.
WriteBatch.set()
כותב למסמך שאליו מתייחס DocumentReference שסופק . אם המסמך עדיין לא קיים, הוא ייווצר.
חֲתִימָה:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש להגדיר. |
| נתונים | WithFieldValue <AppModelType> | אובייקט של השדות והערכים של המסמך. |
החזרות:
מופע זה WriteBatch . משמש לקריאת שיטות שרשור.
WriteBatch.set()
כותב למסמך שאליו מתייחס DocumentReference שסופק . אם המסמך עדיין לא קיים, הוא ייווצר. אם אתה מספק merge או mergeFields , ניתן למזג את הנתונים שסופקו למסמך קיים.
חֲתִימָה:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): WriteBatch;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש להגדיר. |
| נתונים | PartialWithFieldValue <AppModelType> | אובייקט של השדות והערכים של המסמך. |
| אפשרויות | הגדר אפשרויות | אובייקט לקביעת התנהגות ההגדרה. |
החזרות:
מופע זה WriteBatch . משמש לקריאת שיטות שרשור.
חריגים
שגיאה - אם הקלט שסופק אינו מסמך Firestore חוקי.
WriteBatch.update()
מעדכן שדות במסמך שאליו מתייחס DocumentReference שסופק . העדכון ייכשל אם יוחל על מסמך שאינו קיים.
חֲתִימָה:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש לעדכן. |
| נתונים | עדכן מידע <DbModelType> | אובייקט המכיל את השדות והערכים שאיתם יש לעדכן את המסמך. שדות יכולים להכיל נקודות כדי להתייחס לשדות מקוננים בתוך המסמך. |
החזרות:
מופע זה WriteBatch . משמש לקריאת שיטות שרשור.
חריגים
שגיאה - אם הקלט שסופק אינו נתוני Firestore חוקיים.
WriteBatch.update()
מעדכן שדות במסמך שאליו מתייחס DocumentReference זה . העדכון ייכשל אם יוחל על מסמך שאינו קיים.
ניתן לעדכן שדות מקוננים על ידי מתן מחרוזות נתיב שדות מופרדות בנקודות או על ידי אספקת אובייקטי FieldPath .
חֲתִימָה:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש לעדכן. |
| שדה | מחרוזת | FieldPath | השדה הראשון לעדכון. |
| ערך | לא ידוע | הערך הראשון. |
| moreFieldsAndValues | לא ידוע[] | צמדי ערכי מפתח נוספים. |
החזרות:
מופע זה WriteBatch . משמש לקריאת שיטות שרשור.
חריגים
שגיאה - אם הקלט שסופק אינו נתוני Firestore חוקיים.