Transaction class

Bir işleme referans.

Bir işlemin updateFunction işlevine iletilen Transaction nesnesi, işlem bağlamı içindeki verileri okuma ve yazma yöntemlerini sağlar. runTransaction()' a bakın .

İmza:

export declare class Transaction

Yöntemler

Yöntem Değiştiriciler Tanım
sil(belgeRef) Sağlanan DocumentReference tarafından atıfta bulunulan belgeyi siler .
al(belgeRef) Sağlanan DocumentReference tarafından başvurulan belgeyi okur .
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) 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. İç içe geçmiş alanlar, noktalarla ayrılmış alan yolu dizeleri sağlanarak veya FieldPath nesneleri sağlanarak güncellenebilir.

Transaction.delete()

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

İmza:

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

Parametreler

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

İadeler:

Bu

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

Transaction.get()

Sağlanan DocumentReference tarafından başvurulan belgeyi okur .

İmza:

get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parametreler

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

İadeler:

Söz< Belge Anlık Görüntüsü <AppModelType, DbModelType>>

Okunan verileri içeren bir DocumentSnapshot .

İşlem.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>): this;

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:

Bu

Bu Transaction ö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.

İşlem.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): this;

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:

Bu

Bu Transaction ö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.

Transaction.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>): this;

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:

Bu

Bu Transaction ö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.

Transaction.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.

İç 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[]): this;

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:

Bu

Bu Transaction ö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.