Transaction class

Tham chiếu đến một giao dịch.

Đối tượng Transaction được truyền đến updateFunction của một giao dịch cung cấp các phương thức để đọc và ghi dữ liệu trong ngữ cảnh giao dịch. Hãy xem runTransaction().

Chữ ký:

export declare class Transaction 

Phương thức

Phương thức	Công cụ sửa đổi	Mô tả
delete(documentRef)		Xoá tài liệu do DocumentReference cung cấp,
get(documentRef)		Đọc tài liệu được tham chiếu theo DocumentReference được cung cấp.
set(documentRef; data)		Ghi vào tài liệu do DocumentReference cung cấp, Nếu chưa có, tài liệu sẽ được tạo.
set(documentRef; dữ liệu; tuỳ chọn)		Ghi vào tài liệu do DocumentReference cung cấp, Nếu chưa có, tài liệu sẽ được tạo. Nếu cung cấp merge hoặc mergeFields, bạn có thể hợp nhất dữ liệu mà bạn cung cấp vào một tài liệu hiện có.
update(documentRef; data)		Cập nhật các trường trong tài liệu tham chiếu bởi DocumentReference được cung cấp. Nội dung cập nhật sẽ không thành công nếu áp dụng cho một tài liệu không tồn tại.
update(documentRef; trường; giá trị; moreFieldsAndValues)		Cập nhật các trường trong tài liệu tham chiếu bởi DocumentReference được cung cấp. Quá trình cập nhật sẽ không thành công nếu được áp dụng cho một tài liệu không tồn tại.Bạn có thể cập nhật các trường lồng nhau bằng cách cung cấp chuỗi đường dẫn trường được phân tách bằng dấu chấm hoặc cung cấp các đối tượng FieldPath.

Giao dịch.delete()

Xoá tài liệu do DocumentReference cung cấp,

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần xoá.

Trường hợp trả lại hàng:

này

Thực thể Transaction này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Giao dịch.get()

Đọc tài liệu được tham chiếu theo DocumentReference được cung cấp.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần đọc.

Trường hợp trả lại hàng:

Cam kết<DocumentSnapshot<AppModelType, DbModelType>>

DocumentSnapshot có dữ liệu đọc.

Giao dịch.set()

Ghi vào tài liệu do DocumentReference cung cấp, Nếu chưa có, tài liệu sẽ được tạo.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần đặt.
dữ liệu	WithFieldValue<AppModelType>	Đối tượng của các trường và giá trị cho tài liệu.

Trường hợp trả lại hàng:

này

Thực thể Transaction này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Trường hợp ngoại lệ

Lỗi – Nếu thông tin đầu vào mà bạn cung cấp không phải là tài liệu hợp lệ trên Firestore.

Giao dịch.set()

Ghi vào tài liệu do DocumentReference cung cấp, Nếu chưa có, tài liệu sẽ được tạo. Nếu cung cấp merge hoặc mergeFields, bạn có thể hợp nhất dữ liệu được cung cấp vào một tài liệu hiện có.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần đặt.
dữ liệu	Một phầnWithFieldValue<AppModelType>	Đối tượng của các trường và giá trị cho tài liệu.
tuỳ chọn	SetOptions	Đối tượng để định cấu hình hành vi đã đặt.

Trường hợp trả lại hàng:

này

Thực thể Transaction này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Trường hợp ngoại lệ

Lỗi – Nếu thông tin đầu vào mà bạn cung cấp không phải là tài liệu hợp lệ trên Firestore.

Giao dịch.update()

Cập nhật các trường trong tài liệu tham chiếu bởi DocumentReference được cung cấp. Nội dung cập nhật sẽ không thành công nếu áp dụng cho một tài liệu không tồn tại.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần được cập nhật.
dữ liệu	UpdateData<DbModelType>	Một đối tượng chứa các trường và giá trị cần cập nhật tài liệu. Các trường có thể chứa dấu chấm để tham chiếu đến các trường lồng nhau trong tài liệu.

Trường hợp trả lại hàng:

này

Thực thể Transaction này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Trường hợp ngoại lệ

Lỗi – Nếu dữ liệu đầu vào được cung cấp không phải là dữ liệu Firestore hợp lệ.

Giao dịch.update()

Cập nhật các trường trong tài liệu tham chiếu bởi DocumentReference được cung cấp. Nội dung cập nhật sẽ không thành công nếu áp dụng cho một tài liệu không tồn tại.

Bạn có thể cập nhật các trường lồng nhau bằng cách cung cấp các chuỗi đường dẫn trường được phân tách bằng dấu chấm hoặc bằng cách cung cấp các đối tượng FieldPath.

Chữ ký:

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

Thông số

Thông số	Loại	Mô tả
tham khảo tài liệu	DocumentReference<AppModelType, DbModelType>	Tham chiếu đến tài liệu cần được cập nhật.
trường	chuỗi | FieldPath (Đường dẫn trường)	Trường đầu tiên để cập nhật.
value	không xác định	Giá trị đầu tiên.
moreFieldsAndValues	không xác định[]	Cặp khoá/giá trị bổ sung.

Trường hợp trả lại hàng:

này

Thực thể Transaction này. Dùng để tạo chuỗi cho các lệnh gọi phương thức.

Trường hợp ngoại lệ

Lỗi – Nếu dữ liệu đầu vào được cung cấp không phải là dữ liệu Firestore hợp lệ.