Bir işleme referans.
Bir işlemin updateFunction öğesine iletilen Transaction nesnesi, işlem bağlamında veri okuma ve yazma yöntemlerini sağlar. Bkz. runTransaction().
İmza:
export declare class Transaction
Yöntemler
| Yöntem | Değiştiriciler | Açıklama |
|---|---|---|
| delete(documentRef) | Sağlanan DocumentReference tarafından atıfta bulunulan dokümanı siler. | |
| get(documentRef) | Sağlanan DocumentReference'ta referans verilen dokümanı okur. | |
| set(documentRef, data) | Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur. | |
| set(documentRef, data, options) | Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur. merge veya mergeFields sağlarsanız, sağlanan veriler mevcut bir belgede birleştirilebilir. |
|
| update(documentRef, data) | Sağlanan DocumentReference tarafından atıfta bulunulan belgedeki alanları günceller. Mevcut olmayan bir dokümana uygulanırsa güncelleme başarısız olur. | |
| update(documentRef, domain, value, moreFieldsAndValues) | Sağlanan DocumentReference tarafından atıfta bulunulan belgedeki alanları günceller. Mevcut olmayan bir dokümana uygulanırsa güncelleme başarısız olur.İç içe yerleştirilmiş alanlar, noktayla ayrılmış alan yolu dizeleri sağlayarak veya FieldPath nesneleri sağlanarak güncellenebilir. |
Transaction.delete()
Sağlanan DocumentReference tarafından atıfta bulunulan dokümanı siler.
İmza:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| belgeRef. | DocumentReference<AppModelType, DbModelType> | Silinecek doküman için bir başvuru. |
Şunu döndürür:
bu
Bu Transaction örneği. Zincirleme yöntemi çağrıları için kullanılır.
Transaction.get()
Sağlanan DocumentReference'ta referans verilen dokümanı okur.
İmza:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| belgeRef. | DocumentReference<AppModelType, DbModelType> | Okunacak belge için bir referans. |
Şunu döndürür:
Promise<DocumentSnapshot<AppModelType, DbModelType>>
Okunan verileri içeren bir DocumentSnapshot
Transaction.set()
Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur.
İmza:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| belgeRef. | DocumentReference<AppModelType, DbModelType> | Ayarlanacak doküman için bir referans. |
| veri | WithFieldValue<AppModelType> | Dokümanla ilgili alanların ve değerlerin nesnesi. |
Şunu döndürür:
bu
Bu Transaction örneği. Zincirleme yöntemi çağrıları için kullanılır.
İstisnalar
Hata - Sağlanan giriş geçerli bir Firestore belgesi değilse.
Transaction.set()
Sağlanan DocumentReference tarafından atıfta bulunulan belgeye yazar. Doküman henüz yoksa oluşturulur. merge veya mergeFields sağlarsanız, sağlanan veriler mevcut bir belgede birleştirilebilir.
İmza:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| belgeRef. | DocumentReference<AppModelType, DbModelType> | Ayarlanacak doküman için bir referans. |
| veri | partWithFieldValue<AppModelType> | Dokümanla ilgili alanların ve değerlerin nesnesi. |
| seçenekler | SetOptions | Belirlenen davranışı yapılandıracak bir nesne. |
Şunu döndürür:
bu
Bu Transaction örneği. Zincirleme yöntemi çağrıları 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 dokümana uygulanırsa güncelleme başarısız olur.
İmza:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
Parametreler
| Parametre | Tür | Açıklama |
|---|---|---|
| belgeRef. | DocumentReference<AppModelType, DbModelType> | Güncellenecek doküman için bir referans. |
| veri | UpdateData<DbModelType> | Dokümanın güncelleneceği alanları ve değerleri içeren bir nesne. Alanlar, doküman içindeki iç içe yerleştirilmiş alanlara referans vermek için noktalar içerebilir. |
Şunu döndürür:
bu
Bu Transaction örneği. Zincirleme yöntemi çağrıları 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 dokümana uygulanırsa güncelleme başarısız olur.
İç içe geçmiş alanlar, noktayla ayrılmış alan yolu dizeleri 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 | Tür | Açıklama |
|---|---|---|
| belgeRef. | DocumentReference<AppModelType, DbModelType> | Güncellenecek doküman için bir referans. |
| alan | dize | FieldPath | Güncellenecek ilk alan. |
| value | bilinmiyor | İlk değer. |
| diğerAlanlarVeDeğerler | bilinmiyor[] | Ek anahtar/değer çiftleri. |
Şunu döndürür:
bu
Bu Transaction örneği. Zincirleme yöntemi çağrıları için kullanılır.
İstisnalar
Hata - Sağlanan giriş geçerli Firestore verileri değilse.