書き込みバッチ。複数の書き込みを単一のアトミック単位として実行するために使用されます。
WriteBatch オブジェクトは、writeBatch() を呼び出すことで取得できます。書き込みバッチに書き込みを追加するためのメソッドが用意されています。WriteBatch.commit() が呼び出されるまで、書き込みは commit（またはローカルで表示）されません。
署名:
export declare class WriteBatch
メソッド
| メソッド | 修飾キー | 説明 |
|---|---|---|
| commit() | この書き込みバッチのすべての書き込みを単一のアトミック単位として commit します。これらの書き込みの結果は、返された Promise の解決後に行われるドキュメントの読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルで変更を確認したり、書き込みをバッファしたりする場合は、完全な Firestore SDK を使用してください。 | |
| delete(documentRef) | 指定された DocumentReference によって参照されるドキュメントを削除します。 | |
| set(documentRef, data) | 指定された DocumentReference によって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。 | |
| set(documentRef, data, options) | 指定された DocumentReference によって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。merge または mergeFields を指定すると、提供されたデータを既存のドキュメントに統合できます。 |
|
| update(documentRef, data) | 指定された DocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。 | |
| update(documentRef, field, value, moreFieldsAndValues) | この DocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。ネストされたフィールドを更新するには、ドット区切りのフィールドパス文字列を指定するか、FieldPath オブジェクトを指定します。 |
WriteBatch.commit()
この書き込みバッチのすべての書き込みを単一のアトミック単位として commit します。
これらの書き込みの結果は、返された Promise が解決された後に発生するドキュメントの読み取りにのみ反映されます。クライアントがオフラインの場合、書き込みは失敗します。クライアントがオンラインになるまでローカルで変更を確認したり、書き込みをバッファしたりする場合は、完全な Firestore SDK を使用してください。
署名:
commit(): Promise<void>;
戻り値:
約束 <void>
バッチ内のすべての書き込みがアトミック単位としてバックエンドに正常に書き込まれると、Promise が解決されます（オフライン中は解決されません）。
WriteBatch.delete()
指定された DocumentReference によって参照されるドキュメントを削除します。
署名:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): WriteBatch;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| documentRef | DocumentReference<AppModelType、DbModelType> | 削除するドキュメントへの参照。 |
戻り値:
この WriteBatch インスタンス。メソッド呼び出しのチェーンに使用されます。
WriteBatch.set()
指定された DocumentReference によって参照されるドキュメントに書き込みます。ドキュメントがまだ存在しない場合は作成されます。
署名:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): WriteBatch;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| documentRef | DocumentReference<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;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| documentRef | DocumentReference<AppModelType、DbModelType> | 設定するドキュメントへの参照。 |
| データ | PartialWithFieldValue<AppModelType> | ドキュメントのフィールドと値のオブジェクト。 |
| オプション | SetOptions | 設定動作を構成するオブジェクト。 |
戻り値:
この WriteBatch インスタンス。メソッド呼び出しのチェーンに使用されます。
例外
エラー - 指定された入力が有効な Firestore ドキュメントでない場合。
WriteBatch.update()
指定された DocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。
署名:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): WriteBatch;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| documentRef | DocumentReference<AppModelType、DbModelType> | 更新するドキュメントへの参照。 |
| データ | UpdateData<DbModelType> | ドキュメントの更新に使用するフィールドと値を含むオブジェクト。フィールドには、ドキュメント内のネストされたフィールドを参照するドットを含めることができます。 |
戻り値:
この WriteBatch インスタンス。メソッド呼び出しのチェーンに使用されます。
例外
エラー - 指定された入力が有効な Firestore データでない場合。
WriteBatch.update()
この DocumentReference によって参照されるドキュメント内のフィールドを更新します。存在しないドキュメントに適用すると、更新は失敗します。
ネストされたフィールドを更新するには、ドット区切りのフィールドパス文字列を指定するか、FieldPath オブジェクトを指定します。
署名:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| documentRef | DocumentReference<AppModelType、DbModelType> | 更新するドキュメントへの参照。 |
| フィールド | 文字列 |FieldPath | 更新する最初のフィールドです。 |
| 値 | 不明 | 1 つ目の値です。 |
| moreFieldsAndValues | 不明 [] | 追加の Key-Value ペア。 |
戻り値:
この WriteBatch インスタンス。メソッド呼び出しのチェーンに使用されます。
例外
エラー - 指定された入力が有効な Firestore データでない場合。