Referensi ke suatu transaksi.
Objek Transaction yang diteruskan ke updateFunction transaksi menyediakan metode untuk membaca dan menulis data dalam konteks transaksi. Lihat jalankanTransaksi() .
Tanda tangan:
export declare class Transaction
Metode
| metode | Pengubah | Keterangan |
|---|---|---|
| hapus(documentRef) | Menghapus dokumen yang dirujuk oleh DocumentReference yang disediakan . | |
| dapatkan (documentRef) | Membaca dokumen yang direferensikan oleh DocumentReference yang disediakan . | |
| set(Ref Dokumen, data) | Menulis ke dokumen yang dirujuk oleh DocumentReference yang disediakan . Jika dokumennya belum ada, maka akan dibuat. | |
| set(documentRef, data, opsi) | 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. | |
| perbarui(documentRef, data) | Bidang pembaruan dalam dokumen yang dirujuk oleh DocumentReference yang disediakan . Pembaruan akan gagal jika diterapkan pada dokumen yang tidak ada. | |
| perbarui(documentRef, bidang, nilai, moreFieldsAndValues) | Bidang pembaruan dalam dokumen yang dirujuk oleh DocumentReference yang disediakan . Pembaruan akan gagal jika diterapkan pada dokumen yang tidak ada. Bidang bertumpuk dapat diperbarui dengan menyediakan string jalur bidang yang dipisahkan titik atau dengan menyediakan objek FieldPath . |
Transaksi.hapus()
Menghapus dokumen yang dirujuk oleh DocumentReference yang disediakan .
Tanda tangan:
delete<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): this;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| dokumenRef | Referensi Dokumen <AppModelType, DbModelType> | Referensi ke dokumen yang akan dihapus. |
Pengembalian:
ini
Contoh Transaction ini. Digunakan untuk merangkai panggilan metode.
Transaksi.dapatkan()
Membaca dokumen yang direferensikan oleh DocumentReference yang disediakan .
Tanda tangan:
get<AppModelType, DbModelType extends DocumentData>(documentRef: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| dokumenRef | Referensi Dokumen <AppModelType, DbModelType> | Referensi ke dokumen yang akan dibaca. |
Pengembalian:
Janji< DocumentSnapshot <AppModelType, DbModelType>>
DocumentSnapshot dengan data yang dibaca.
Transaksi.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>): this;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| dokumenRef | Referensi Dokumen <AppModelType, DbModelType> | Referensi ke dokumen yang akan ditetapkan. |
| data | DenganFieldValue <JenisModel Aplikasi> | Objek bidang dan nilai dokumen. |
Pengembalian:
ini
Contoh Transaction ini. Digunakan untuk merangkai panggilan metode.
Pengecualian
Kesalahan - Jika masukan yang diberikan bukan dokumen Firestore yang valid.
Transaksi.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): this;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| dokumenRef | Referensi Dokumen <AppModelType, DbModelType> | Referensi ke dokumen yang akan ditetapkan. |
| data | PartialWithFieldValue <JenisModel Aplikasi> | Objek bidang dan nilai dokumen. |
| pilihan | Set Opsi | Sebuah objek untuk mengonfigurasi perilaku yang disetel. |
Pengembalian:
ini
Contoh Transaction ini. Digunakan untuk merangkai panggilan metode.
Pengecualian
Kesalahan - Jika masukan yang diberikan bukan dokumen Firestore yang valid.
Transaksi.update()
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>): this;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| dokumenRef | Referensi Dokumen <AppModelType, DbModelType> | Referensi ke dokumen yang akan diperbarui. |
| data | Perbaharui data <DbModelType> | Objek yang berisi bidang dan nilai yang dapat digunakan untuk memperbarui dokumen. Bidang dapat berisi titik-titik untuk mereferensikan bidang bertumpuk dalam dokumen. |
Pengembalian:
ini
Contoh Transaction ini. Digunakan untuk merangkai panggilan metode.
Pengecualian
Kesalahan - Jika masukan yang diberikan bukan data Firestore yang valid.
Transaksi.update()
Bidang pembaruan dalam dokumen yang dirujuk oleh DocumentReference yang disediakan . Pembaruan akan gagal jika diterapkan pada dokumen yang tidak ada.
Bidang bertumpuk 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[]): this;
Parameter
| Parameter | Jenis | Keterangan |
|---|---|---|
| dokumenRef | Referensi Dokumen <AppModelType, DbModelType> | Referensi ke dokumen yang akan diperbarui. |
| bidang | tali | Jalur Lapangan | Bidang pertama yang diperbarui. |
| nilai | tidak dikenal | Nilai pertama. |
| moreFieldsAndValues | tidak dikenal[] | Pasangan kunci/nilai tambahan. |
Pengembalian:
ini
Contoh Transaction ini. Digunakan untuk merangkai panggilan metode.
Pengecualian
Kesalahan - Jika masukan yang diberikan bukan data Firestore yang valid.