WriteBatch class

書き込みバッチ。複数の書き込みを 1 つのアトミック単位として実行するために使用されます。

WriteBatchオブジェクトは、 writeBatch()を呼び出すことで取得できます。 。書き込みバッチに書き込みを追加するメソッドを提供します。 WriteBatch.commit() が呼び出されるまで、書き込みはコミットされません (またはローカルで表示されません)。

サイン：

export declare class WriteBatch

メソッド

方法修飾子説明
専念（）この書き込みバッチ内のすべての書き込みを単一のアトミック単位としてコミットします。これらの書き込みの結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。
削除(ドキュメント参照)提供されたDocumentReferenceによって参照されるドキュメントを削除します。
set(documentRef, データ)提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。
set(documentRef、データ、オプション)提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。 mergeまたはmergeFieldsを指定すると、指定されたデータを既存のドキュメントにマージできます。
update(documentRef, データ)提供されたDocumentReferenceによって参照されるドキュメント内のフィールドを更新します。 。存在しないドキュメントに適用すると、更新は失敗します。
update(documentRef、フィールド、値、moreFieldsAndValues)このDocumentReferenceによって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。ネストされたフィールドは、ドット区切りのフィールド パス文字列を指定するか、 FieldPathオブジェクトを指定することによって更新できます。

WriteBatch.commit()

この書き込みバッチ内のすべての書き込みを単一のアトミック単位としてコミットします。

これらの書き込みの結果は、返された Promise が解決された後に発生するドキュメント読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルの変更またはバッファ書き込みを確認したい場合は、完全な Firestore SDK を使用してください。

サイン：

commit(): Promise<void>;

戻り値：

約束<無効>

Promise 、バッチ内のすべての書き込みがアトミック単位としてバックエンドに正常に書き込まれると解決されます (オフライン中は解決されないことに注意してください)。

WriteBatch.delete()

提供されたDocumentReferenceによって参照されるドキュメントを削除します。

サイン：

delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;

パラメーター

パラメータタイプ説明
ドキュメント参照ドキュメントリファレンス<AppModelType、DbModelType>削除するドキュメントへの参照。

戻り値：

ライトバッチ

このWriteBatchインスタンス。メソッド呼び出しを連鎖させるために使用されます。

WriteBatch.set()

提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。

サイン：

set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;

パラメーター

パラメータタイプ説明
ドキュメント参照ドキュメントリファレンス<AppModelType、DbModelType>設定するドキュメントへの参照。
データフィールド値あり<AppModelType>ドキュメントのフィールドと値のオブジェクト。

戻り値：

ライトバッチ

このWriteBatchインスタンス。メソッド呼び出しを連鎖させるために使用されます。

WriteBatch.set()

提供されたDocumentReferenceによって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。 mergeまたはmergeFields提供する場合、提供されたデータを既存のドキュメントにマージできます。

サイン：

set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): WriteBatch;

パラメーター

パラメータタイプ説明
ドキュメント参照ドキュメントリファレンス<AppModelType、DbModelType>設定するドキュメントへの参照。
データ部分的フィールド値あり<AppModelType>ドキュメントのフィールドと値のオブジェクト。
オプションオプションの設定設定された動作を構成するオブジェクト。

戻り値：

ライトバッチ

このWriteBatchインスタンス。メソッド呼び出しを連鎖させるために使用されます。

例外

エラー - 指定された入力が有効な Firestore ドキュメントではない場合。

WriteBatch.update()

提供されたDocumentReferenceによって参照されるドキュメント内のフィールドを更新します。 。存在しないドキュメントに適用すると、更新は失敗します。

サイン：

update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;

パラメーター

パラメータタイプ説明
ドキュメント参照ドキュメントリファレンス<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;

パラメーター

パラメータタイプ説明
ドキュメント参照ドキュメントリファレンス<AppModelType、DbModelType>更新されるドキュメントへの参照。
分野文字列 |フィールドパス更新する最初のフィールド。
価値未知最初の値。
詳細フィールドと値未知[]追加のキーと値のペア。

戻り値：

ライトバッチ

このWriteBatchインスタンス。メソッド呼び出しを連鎖させるために使用されます。

例外

エラー - 指定された入力が有効な Firestore データではない場合。