Referensi ke transaksi.
Objek Transaction yang diteruskan ke updateFunction transaksi menyediakan metode untuk membaca dan menulis data dalam konteks transaksi. Lihat runTransaction().
Tanda Tangan:
export declare class Transaction
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| delete(documentRef) | Menghapus dokumen yang dirujuk oleh DocumentReference yang diberikan. | |
| get(documentRef) | Membaca dokumen yang dirujuk oleh DocumentReference yang diberikan. | |
| set(documentRef, data) | Menulis ke dokumen yang dirujuk oleh DocumentReference yang diberikan. Jika belum ada, dokumen akan dibuat. | |
| set(documentRef, data, opsi) | Menulis ke dokumen yang dirujuk oleh DocumentReference yang diberikan. Jika belum ada, dokumen akan dibuat. Jika Anda memberikan merge atau mergeFields, data yang diberikan dapat digabungkan ke dalam dokumen yang sudah ada. |
|
| update(documentRef, data) | Memperbarui kolom dalam dokumen yang dirujuk oleh DocumentReference yang diberikan. Pembaruan akan gagal jika diterapkan ke dokumen yang tidak ada. | |
| update(documentRef, kolom, nilai, moreFieldsAndValues) | Memperbarui kolom dalam dokumen yang dirujuk oleh DocumentReference yang diberikan. Pembaruan akan gagal jika diterapkan ke dokumen yang tidak ada.Kolom bertingkat dapat diperbarui dengan memberikan string jalur kolom yang dipisahkan titik atau dengan memberikan objek FieldPath. |
Transaction.delete()
Menghapus dokumen yang dirujuk oleh DocumentReference yang diberikan.
Tanda Tangan:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| dokumenReferensi | DocumentReference<AppModelType, DbModelType> | Referensi ke dokumen yang akan dihapus. |
Hasil:
ini yang ini ini loh nih noh
Instance Transaction ini. Digunakan untuk panggilan metode perantaian.
Transaction.get()
Membaca dokumen yang dirujuk oleh DocumentReference yang diberikan.
Tanda Tangan:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| dokumenReferensi | DocumentReference<AppModelType, DbModelType> | Referensi ke dokumen yang akan dibaca. |
Hasil:
Promise<DocumentSnapshot<AppModelType, DbModelType>>
DocumentSnapshot dengan data baca.
Transaction.set()
Menulis ke dokumen yang dirujuk oleh DocumentReference yang diberikan. Jika belum ada, dokumen akan dibuat.
Tanda Tangan:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): this;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| dokumenReferensi | DocumentReference<AppModelType, DbModelType> | Referensi ke dokumen yang akan ditetapkan. |
| data | WithFieldValue<AppModelType> | Objek kolom dan nilai untuk dokumen. |
Hasil:
ini yang ini ini loh nih noh
Instance Transaction ini. Digunakan untuk panggilan metode perantaian.
Pengecualian
Error - Jika input yang diberikan bukan dokumen Firestore yang valid.
Transaction.set()
Menulis ke dokumen yang dirujuk oleh DocumentReference yang diberikan. Jika belum ada, dokumen akan dibuat. Jika Anda memberikan merge atau mergeFields, data yang diberikan dapat digabungkan ke dalam dokumen yang sudah ada.
Tanda Tangan:
set<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): this;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| dokumenReferensi | DocumentReference<AppModelType, DbModelType> | Referensi ke dokumen yang akan ditetapkan. |
| data | PartialWithFieldValue<AppModelType> | Objek kolom dan nilai untuk dokumen. |
| opsi | SetOptions | Objek untuk mengonfigurasi perilaku yang ditetapkan. |
Hasil:
ini yang ini ini loh nih noh
Instance Transaction ini. Digunakan untuk panggilan metode perantaian.
Pengecualian
Error - Jika input yang diberikan bukan dokumen Firestore yang valid.
Transaction.update()
Memperbarui kolom dalam dokumen yang dirujuk oleh DocumentReference yang diberikan. Pembaruan akan gagal jika diterapkan ke dokumen yang tidak ada.
Tanda Tangan:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): this;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| dokumenReferensi | DocumentReference<AppModelType, DbModelType> | Referensi ke dokumen yang akan diperbarui. |
| data | UpdateData<DbModelType> | Objek yang berisi kolom dan nilai yang akan digunakan untuk memperbarui dokumen. Kolom dapat berisi titik untuk mereferensikan kolom bertingkat dalam dokumen. |
Hasil:
ini yang ini ini loh nih noh
Instance Transaction ini. Digunakan untuk panggilan metode perantaian.
Pengecualian
Error - Jika input yang diberikan tidak valid untuk data Firestore.
Transaction.update()
Memperbarui kolom dalam dokumen yang dirujuk oleh DocumentReference yang diberikan. Pembaruan akan gagal jika diterapkan ke dokumen yang tidak ada.
Kolom bertingkat dapat diperbarui dengan memberikan string jalur kolom yang dipisahkan titik atau dengan memberikan objek FieldPath.
Tanda Tangan:
update<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): this;
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| dokumenReferensi | DocumentReference<AppModelType, DbModelType> | Referensi ke dokumen yang akan diperbarui. |
| medan | rangkaian | FieldPath | Kolom pertama yang akan diperbarui. |
| value | tidak diketahui | Nilai pertama. |
| moreFieldsAndValues | tidak diketahui[] | Key-value pair tambahan. |
Hasil:
ini yang ini ini loh nih noh
Instance Transaction ini. Digunakan untuk panggilan metode perantaian.
Pengecualian
Error - Jika input yang diberikan tidak valid untuk data Firestore.