הפניה לעסקה.
אובייקט Transaction המועבר ל- updateFunction של עסקה מספק את השיטות לקריאה ולכתיבה של נתונים בהקשר העסקה. ראה runTransaction() .
חֲתִימָה:
export declare class Transaction
שיטות
| שיטה | משנה | תיאור |
|---|---|---|
| delete(documentRef) | מוחק את המסמך שאליו מתייחס DocumentReference שסופק . | |
| get(documentRef) | קורא את המסמך שאליו מתייחס DocumentReference שסופק . | |
| set(מסמךRef, נתונים) | כותב למסמך שאליו מתייחס DocumentReference שסופק . אם המסמך עדיין לא קיים, הוא ייווצר. | |
| הגדר (מסמךRef, נתונים, אפשרויות) | כותב למסמך שאליו מתייחס DocumentReference שסופק . אם המסמך עדיין לא קיים, הוא ייווצר. אם תספק merge או mergeFields , ניתן למזג את הנתונים שסופקו למסמך קיים. | |
| עדכון (מסמך Ref, נתונים) | מעדכן שדות במסמך שאליו מתייחס DocumentReference שסופק . העדכון ייכשל אם יוחל על מסמך שאינו קיים. | |
| update(documentRef, field, value, moreFieldsAndValues) | מעדכן שדות במסמך שאליו מתייחס DocumentReference שסופק . העדכון ייכשל אם יוחל על מסמך שאינו קיים. ניתן לעדכן שדות מקוננים על ידי מתן מחרוזות נתיב שדות מופרדות בנקודות או על ידי אספקת אובייקטי FieldPath . |
Transaction.delete()
מוחק את המסמך שאליו מתייחס DocumentReference שסופק .
חֲתִימָה:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש למחוק. |
החזרות:
זֶה
מופע Transaction זה. משמש לקריאת שיטות שרשור.
Transaction.get()
קורא את המסמך שאליו מתייחס DocumentReference שסופק .
חֲתִימָה:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש לקרוא. |
החזרות:
הבטחה< DocumentSnapshot <AppModelType, DbModelType>>
תצלום של DocumentSnapshot עם נתוני הקריאה.
Transaction.set()
כותב למסמך שאליו מתייחס DocumentReference שסופק . אם המסמך עדיין לא קיים, הוא ייווצר.
חֲתִימָה:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <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;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש להגדיר. |
| נתונים | PartialWithFieldValue <AppModelType> | אובייקט של השדות והערכים של המסמך. |
| אפשרויות | הגדר אפשרויות | אובייקט לקביעת התנהגות ההגדרה. |
החזרות:
זֶה
מופע Transaction זה. משמש לקריאת שיטות שרשור.
חריגים
שגיאה - אם הקלט שסופק אינו מסמך Firestore חוקי.
Transaction.update()
מעדכן שדות במסמך שאליו מתייחס DocumentReference שסופק . העדכון ייכשל אם יוחל על מסמך שאינו קיים.
חֲתִימָה:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <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;
פרמטרים
| פָּרָמֶטֶר | סוּג | תיאור |
|---|---|---|
| מסמךRef | הפניה למסמך <AppModelType, DbModelType> | הפניה למסמך שיש לעדכן. |
| שדה | מחרוזת | FieldPath | השדה הראשון לעדכון. |
| ערך | לא ידוע | הערך הראשון. |
| moreFieldsAndValues | לא ידוע[] | צמדי מפתח/ערך נוספים. |
החזרות:
זֶה
מופע Transaction זה. משמש לקריאת שיטות שרשור.
חריגים
שגיאה - אם הקלט שסופק אינו נתוני Firestore חוקיים.