WriteBatch class

Tek bir atomik birim olarak birden fazla yazma işlemi gerçekleştirmek için kullanılan bir yazma grubu.

WriteBatch nesnesi writeBatch() çağrılarak elde edilebilir. . Yazma grubuna yazma işlemleri eklemek için yöntemler sağlar. WriteBatch.commit() çağrılıncaya kadar yazmaların hiçbiri gerçekleştirilmeyecek (veya yerel olarak görülmeyecek).

İmza:

export declare class WriteBatch

Yöntemler

Yöntem Değiştiriciler Tanım
işlemek() Bu yazma toplu işlemindeki tüm yazma işlemlerini tek bir atomik birim olarak kaydeder. Bu yazma işlemlerinin sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın.
sil(belgeRef) Sağlanan DocumentReference tarafından atıfta bulunulan belgeyi siler .
set(belgeRef, veri) Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse oluşturulacaktır.
set(documentRef, veri, seçenekler) Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse oluşturulacaktır. merge veya mergeFields sağlarsanız sağlanan veriler mevcut bir belgeyle birleştirilebilir.
güncelleme(belgeRef, veri) Sağlanan DocumentReference tarafından atıfta bulunulan belgedeki alanları günceller . Mevcut olmayan bir belgeye uygulandığında güncelleme başarısız olur.
güncelleme(documentRef, alan, değer, moreFieldsAndValues) Bu DocumentReference tarafından atıfta bulunulan belgedeki alanları günceller . Mevcut olmayan bir belgeye uygulandığında güncelleme başarısız olur. İç içe geçmiş alanlar, noktalarla ayrılmış alan yolu dizeleri sağlanarak veya FieldPath nesneleri sağlanarak güncellenebilir.

WriteBatch.commit()

Bu yazma toplu işlemindeki tüm yazma işlemlerini tek bir atomik birim olarak kaydeder.

Bu yazma işlemlerinin sonucu yalnızca iade edilen söz çözüldükten sonra gerçekleşen belge okumalarına yansıtılacaktır. İstemci çevrimdışıysa yazma işlemi başarısız olur. İstemci çevrimiçi olana kadar yerel değişiklikleri veya arabellek yazma işlemlerini görmek istiyorsanız Firestore SDK'nın tamamını kullanın.

İmza:

commit(): Promise<void>;

İadeler:

Söz<void>

Toplu işteki tüm yazma işlemleri arka uca atomik bir birim olarak başarıyla yazıldığında bir Promise çözüldü (çevrimdışı olduğunuzda çözülmeyeceğini unutmayın).

WriteBatch.delete()

Sağlanan DocumentReference tarafından atıfta bulunulan belgeyi siler .

İmza:

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

Parametreler

Parametre Tip Tanım
belgeRef BelgeReferansı <AppModelType, DbModelType> Silinecek belgeye bir referans.

İadeler:

YazmaToplusu

Bu WriteBatch örneği. Yöntem çağrılarını zincirlemek için kullanılır.

WriteBatch.set()

Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse oluşturulacaktır.

İmza:

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

Parametreler

Parametre Tip Tanım
belgeRef BelgeReferansı <AppModelType, DbModelType> Ayarlanacak belgeye bir referans.
veri Alan Değeri ile <UygulamaModel Türü> Belgeye ilişkin alanların ve değerlerin nesnesi.

İadeler:

YazmaToplusu

Bu WriteBatch örneği. Yöntem çağrılarını zincirlemek için kullanılır.

WriteBatch.set()

Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar . Belge henüz mevcut değilse oluşturulacaktır. merge veya mergeFields sağlarsanız sağlanan veriler mevcut bir belgeyle birleştirilebilir.

İmza:

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

Parametreler

Parametre Tip Tanım
belgeRef BelgeReferansı <AppModelType, DbModelType> Ayarlanacak belgeye bir referans.
veri Kısmi WithFieldValue <UygulamaModel Türü> Belgeye ilişkin alanların ve değerlerin nesnesi.
seçenekler Seçenekleri Ayarla Ayarlanan davranışı yapılandırmak için bir nesne.

İadeler:

YazmaToplusu

Bu WriteBatch örneği. Yöntem çağrılarını zincirlemek için kullanılır.

İstisnalar

Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.

WriteBatch.update()

Sağlanan DocumentReference tarafından atıfta bulunulan belgedeki alanları günceller . Mevcut olmayan bir belgeye uygulandığında güncelleme başarısız olur.

İmza:

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

Parametreler

Parametre Tip Tanım
belgeRef BelgeReferansı <AppModelType, DbModelType> Güncellenecek belgeye bir referans.
veri Veriyi güncelle <DbModelType> Belgenin güncelleneceği alanları ve değerleri içeren bir nesne. Alanlar, belge içindeki iç içe geçmiş alanlara referans vermek için noktalar içerebilir.

İadeler:

YazmaToplusu

Bu WriteBatch örneği. Yöntem çağrılarını zincirlemek için kullanılır.

İstisnalar

Hata - Sağlanan giriş geçerli Firestore verileri değilse.

WriteBatch.update()

Bu DocumentReference tarafından atıfta bulunulan belgedeki alanları günceller . Mevcut olmayan bir belgeye uygulandığında güncelleme başarısız olur.

İç içe geçmiş alanlar, noktalarla ayrılmış alan yolu dizeleri sağlanarak veya FieldPath nesneleri sağlanarak güncellenebilir.

İmza:

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

Parametreler

Parametre Tip Tanım
belgeRef BelgeReferansı <AppModelType, DbModelType> Güncellenecek belgeye bir referans.
alan dize | AlanYolu Güncellenecek ilk alan.
değer Bilinmeyen İlk değer.
moreFieldsAndValues Bilinmeyen[] Ek anahtar değer çiftleri.

İadeler:

YazmaToplusu

Bu WriteBatch örneği. Yöntem çağrılarını zincirlemek için kullanılır.

İstisnalar

Hata - Sağlanan giriş geçerli Firestore verileri değilse.