WriteBatch class

Batch tulis, digunakan untuk melakukan beberapa penulisan sebagai satu unit atom.

Objek WriteBatch dapat diperoleh dengan memanggil writeBatch() . Ini menyediakan metode untuk menambahkan penulisan ke kumpulan penulisan. Tidak ada penulisan yang akan dilakukan (atau terlihat secara lokal) hingga WriteBatch.commit() dipanggil.

Tanda tangan:

export declare class WriteBatch 

Metode

WriteBatch.commit()

Mengkomit semua penulisan dalam kumpulan penulisan ini sebagai satu unit atom.

Hasil penulisan ini hanya akan tercermin dalam pembacaan dokumen yang terjadi setelah janji yang dikembalikan diselesaikan. Jika klien sedang offline, penulisan gagal. Jika Anda ingin melihat modifikasi lokal atau penulisan buffer hingga klien online, gunakan Firestore SDK lengkap.

Tanda tangan:

commit(): Promise<void>;

Pengembalian:

Janji<batal>

Promise diselesaikan setelah semua penulisan dalam batch berhasil ditulis ke backend sebagai unit atom (perhatikan bahwa janji tersebut tidak akan diselesaikan saat Anda offline).

WriteBatch.hapus()

Menghapus dokumen yang dirujuk oleh DocumentReference yang disediakan .

Tanda tangan:

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

Parameter

Pengembalian:

TulisBatch

Contoh WriteBatch ini. Digunakan untuk merangkai panggilan metode.

WriteBatch.set()

Menulis ke dokumen yang dirujuk oleh DocumentReference yang disediakan . Jika dokumennya belum ada, maka akan dibuat.

Tanda tangan:

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

Parameter

Pengembalian:

TulisBatch

Contoh WriteBatch ini. Digunakan untuk merangkai panggilan metode.

WriteBatch.set()

Menulis ke dokumen yang dirujuk oleh DocumentReference yang disediakan . Jika dokumennya belum ada, maka akan dibuat. Jika Anda menyediakan merge atau mergeFields , data yang disediakan dapat digabungkan ke dalam dokumen yang sudah ada.

Tanda tangan:

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

Parameter

Pengembalian:

TulisBatch

Contoh WriteBatch ini. Digunakan untuk merangkai panggilan metode.

Pengecualian

Kesalahan - Jika masukan yang diberikan bukan dokumen Firestore yang valid.

WriteBatch.perbarui()

Bidang pembaruan dalam dokumen yang dirujuk oleh DocumentReference yang disediakan . Pembaruan akan gagal jika diterapkan pada dokumen yang tidak ada.

Tanda tangan:

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

Parameter

Pengembalian:

TulisBatch

Contoh WriteBatch ini. Digunakan untuk merangkai panggilan metode.

Pengecualian

Kesalahan - Jika masukan yang diberikan bukan data Firestore yang valid.

WriteBatch.perbarui()

Bidang pembaruan dalam dokumen yang dirujuk oleh DocumentReference ini . Pembaruan akan gagal jika diterapkan pada dokumen yang tidak ada.

Bidang bersarang dapat diperbarui dengan menyediakan string jalur bidang yang dipisahkan titik atau dengan menyediakan objek FieldPath .

Tanda tangan:

update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): WriteBatch;

Parameter

Pengembalian:

TulisBatch

Contoh WriteBatch ini. Digunakan untuk merangkai panggilan metode.

Pengecualian

Kesalahan - Jika masukan yang diberikan bukan data Firestore yang valid.