交易的參照。
傳遞至交易 updateFunction 的 Transaction 物件提供了在交易環境內讀取及寫入資料的方法。請參閱 runTransaction()。
簽名：
export declare class Transaction
方法
| 方法 | 修飾符 | 說明 |
|---|---|---|
| delete(documentRef) | 刪除所提供 DocumentReference 提及的文件。 | |
| get(documentRef) | 讀取所提供 DocumentReference 參照的文件。 | |
| set(documentRef, 資料) | 寫入所提供 DocumentReference 提及的文件。如果文件不存在，系統會建立文件。 | |
| set(documentRef, data, options) | 寫入所提供 DocumentReference 提及的文件。如果文件不存在，系統會建立文件。如果您提供 merge 或 mergeFields，則提供的資料可以合併至現有文件。 |
|
| update(documentRef, 資料) | 更新由提供的 DocumentReference 所參照的文件中的欄位。如果套用至不存在的文件，更新就會失敗。 | |
| update(documentRef, field, value, moreFieldsAndValues) | 更新由提供的 DocumentReference 所參照的文件中的欄位。如果套用至不存在的文件，更新就會失敗。如要更新巢狀欄位，請提供以點分隔的欄位路徑字串或提供 FieldPath 物件。 |
交易.delete()
刪除所提供 DocumentReference 提及的文件。
簽名：
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType、DundModelType> | 要刪除的文件參照。 |
傳回：
這個
這個「Transaction」執行個體。用於鏈結方法呼叫。
交易.get()
讀取所提供 DocumentReference 參照的文件。
簽名：
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType、DundModelType> | 要讀取的文件參照。 |
傳回：
Promise<DocumentSnapshot<AppModelType, DBMModelType>>
包含讀取資料的 DocumentSnapshot。
交易.set()
寫入所提供 DocumentReference 提及的文件。如果文件不存在，系統會建立文件。
簽名：
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType、DundModelType> | 要設定文件的參照。 |
| 資料 | WithFieldValue<AppModelType> | 文件的欄位和值。 |
傳回：
這個
這個「Transaction」執行個體。用於鏈結方法呼叫。
例外狀況
錯誤 - 如果提供的輸入內容不是有效的 Firestore 文件，
交易.set()
寫入所提供 DocumentReference 提及的文件。如果文件不存在，系統會建立文件。如果您提供 merge 或 mergeFields，所提供的資料可以合併為現有文件。
簽名：
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType、DundModelType> | 要設定文件的參照。 |
| 資料 | PartialWithFieldValue<AppModelType> | 文件的欄位和值。 |
| 選項 | 設定選項 | 用來設定設定行為的物件。 |
傳回：
這個
這個「Transaction」執行個體。用於鏈結方法呼叫。
例外狀況
錯誤 - 如果提供的輸入內容不是有效的 Firestore 文件，
交易.update()
更新由提供的 DocumentReference 所參照的文件中的欄位。如果套用至不存在的文件，更新就會失敗。
簽名：
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType、DundModelType> | 要更新文件的參照。 |
| 資料 | UpdateData<DbModelType> | 物件，內容包含要更新文件的欄位和值。欄位可以包含半形句號，以參照文件中的巢狀欄位。 |
傳回：
這個
這個「Transaction」執行個體。用於鏈結方法呼叫。
例外狀況
錯誤 - 如果提供的輸入內容不是有效的 Firestore 資料，
交易.update()
更新由提供的 DocumentReference 所參照的文件中的欄位。如果套用至不存在的文件，更新就會失敗。
透過提供以點分隔的欄位路徑字串或 FieldPath 物件，即可更新巢狀欄位。
簽名：
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
參數
| 參數 | 類型 | 說明 |
|---|---|---|
| DocumentRef | DocumentReference<AppModelType、DundModelType> | 要更新文件的參照。 |
| 欄位 | 字串 |FieldPath | 要更新的第一個欄位。 |
| 值 | 不明 | 第一個值。 |
| moreFieldsAndValues | 不明 [] | 其他鍵/值組合。 |
傳回：
這個
這個「Transaction」執行個體。用於鏈結方法呼叫。
例外狀況
錯誤 - 如果提供的輸入內容不是有效的 Firestore 資料，