トランザクションへの参照。
トランザクションのupdateFunctionに渡されるTransactionオブジェクトは、トランザクション コンテキスト内でデータを読み書きするメソッドを提供します。 runTransaction()を参照してください。 。
サイン：
export declare class Transaction
メソッド
| 方法 | 修飾子 | 説明 |
|---|---|---|
| 削除(ドキュメント参照) | 提供されたDocumentReferenceによって参照されるドキュメントを削除します。 | |
| get(ドキュメント参照) | 提供されたDocumentReferenceによって参照されるドキュメントを読み取ります。 | |
| set(documentRef, データ) | 提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。 | |
| set(documentRef、データ、オプション) | 提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。 mergeまたはmergeFieldsを指定すると、指定されたデータを既存のドキュメントにマージできます。 | |
| update(documentRef, データ) | 提供されたDocumentReferenceによって参照されるドキュメント内のフィールドを更新します。 。存在しないドキュメントに適用すると、更新は失敗します。 | |
| update(documentRef、フィールド、値、moreFieldsAndValues) | 提供されたDocumentReferenceによって参照されるドキュメント内のフィールドを更新します。 。存在しないドキュメントに適用すると、更新は失敗します。ネストされたフィールドは、ドット区切りのフィールド パス文字列を指定するか、 FieldPathオブジェクトを指定することによって更新できます。 |
Transaction.delete()
提供されたDocumentReferenceによって参照されるドキュメントを削除します。
サイン：
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ドキュメント参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 削除するドキュメントへの参照。 |
戻り値：
これ
このTransactionインスタンス。メソッド呼び出しを連鎖させるために使用されます。
Transaction.get()
提供されたDocumentReferenceによって参照されるドキュメントを読み取ります。
サイン：
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ドキュメント参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 読むドキュメントへの参照。 |
戻り値：
Promise< DocumentSnapshot <AppModelType、DbModelType>>
読み取られたデータを含むDocumentSnapshot 。
Transaction.set()
提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。
サイン：
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ドキュメント参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 設定するドキュメントへの参照。 |
| データ | フィールド値あり<AppModelType> | ドキュメントのフィールドと値のオブジェクト。 |
戻り値：
これ
このTransactionインスタンス。メソッド呼び出しを連鎖させるために使用されます。
例外
エラー - 指定された入力が有効な Firestore ドキュメントではない場合。
Transaction.set()
提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。 mergeまたはmergeFields提供する場合、提供されたデータを既存のドキュメントにマージできます。
サイン：
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ドキュメント参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 設定するドキュメントへの参照。 |
| データ | 部分的フィールド値あり<AppModelType> | ドキュメントのフィールドと値のオブジェクト。 |
| オプション | オプションの設定 | 設定された動作を構成するオブジェクト。 |
戻り値：
これ
このTransactionインスタンス。メソッド呼び出しを連鎖させるために使用されます。
例外
エラー - 指定された入力が有効な Firestore ドキュメントではない場合。
Transaction.update()
提供されたDocumentReferenceによって参照されるドキュメント内のフィールドを更新します。 。存在しないドキュメントに適用すると、更新は失敗します。
サイン：
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ドキュメント参照 | ドキュメントリファレンス<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;
パラメーター
| パラメータ | タイプ | 説明 |
|---|---|---|
| ドキュメント参照 | ドキュメントリファレンス<AppModelType、DbModelType> | 更新されるドキュメントへの参照。 |
| 分野 | 文字列 |フィールドパス | 更新する最初のフィールド。 |
| 価値 | 未知 | 最初の値。 |
| 詳細フィールドと値 | 未知[] | 追加のキーと値のペア。 |
戻り値：
これ
このTransactionインスタンス。メソッド呼び出しを連鎖させるために使用されます。
例外
エラー - 指定された入力が有効な Firestore データではない場合。