Transaction class

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

Đối tượng Transaction được chuyển đến updateFunction của 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. Xem runTransaction() .

Chữ ký:

export declare class Transaction

phương pháp

Phương pháp sửa đổi Sự miêu tả
xóa(tài liệuRef) Xóa tài liệu được tham chiếu bởi DocumentReference được cung cấp .
nhận được (tài liệuRef) Đọc tài liệu được tham chiếu bởi DocumentReference được cung cấp .
set(documentRef, data) Ghi vào tài liệu được tham chiếu bởi DocumentReference được cung cấp . Nếu tài liệu chưa tồn tại, nó sẽ được tạo.
set(documentRef, data, options) Ghi vào tài liệu được tham chiếu bởi DocumentReference được cung cấp . Nếu tài liệu chưa tồn tại, nó sẽ được tạo. Nếu bạn cung cấp merge hoặc mergeFields , dữ liệu được cung cấp có thể được hợp nhất vào tài liệu hiện có.
cập nhật(tài liệuRef, dữ liệu) Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference được cung cấp . Bản cập nhật sẽ không thành công nếu áp dụng cho tài liệu không tồn tại.
cập nhật (documentRef, trường, giá trị, moreFieldsAndValues) Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference được cung cấp . Bản cập nhật sẽ không thành công nếu áp dụng cho tài liệu không tồn tại. Các trường lồng nhau có thể được cập nhật 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 .

Giao dịch.delete()

Xóa tài liệu được tham chiếu bởi DocumentReference được cung cấp .

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ bị xóa.

Trả về:

cái này

Phiên bản Transaction này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

Giao dịch.get ()

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

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được đọc.

Trả về:

Lời hứa< Ảnh chụp tài liệu <AppModelType, DbModelType>>

DocumentSnapshot với dữ liệu đã đọc.

Giao dịch.set()

Ghi vào tài liệu được tham chiếu bởi DocumentReference được cung cấp . Nếu tài liệu chưa tồn tại, nó sẽ được tạo.

Chữ ký:

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

Thông số

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được thiết lập.
dữ liệu Với giá trị trường <AppModelType> Đối tượng của các trường và giá trị cho tài liệu.

Trả về:

cái này

Phiên bản Transaction này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

Ngoại lệ

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

Giao dịch.set()

Ghi vào tài liệu được tham chiếu bởi DocumentReference được cung cấp . Nếu tài liệu chưa tồn tại, nó sẽ được tạo. Nếu bạn cung cấp merge hoặc mergeFields , dữ liệu được cung cấp có thể được hợp nhất 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ố

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được thiết lập.
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.
tùy chọn Đặt tùy chọn Một đối tượng để cấu hình hành vi đã thiết lập.

Trả về:

cái này

Phiên bản Transaction này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

Ngoại lệ

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

Giao dịch.update()

Cập nhật các trường trong tài liệu được tham chiếu bởi DocumentReference được cung cấp . Bản cập nhật sẽ không thành công nếu áp dụng cho 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ố

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được cập nhật.
dữ liệu Cập nhật dữ liệu <DbModelType> Một đối tượng chứa các trường và giá trị để cập nhật tài liệu. Các trường có thể chứa dấu chấm để tham chiếu các trường lồng nhau trong tài liệu.

Trả về:

cái này

Phiên bản Transaction này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

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 được tham chiếu bởi DocumentReference được cung cấp . Bản cập nhật sẽ không thành công nếu áp dụng cho tài liệu không tồn tại.

Các trường lồng nhau có thể được cập nhật 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ố

Tham số Kiểu Sự miêu tả
tài liệuTham khảo Tài liệu tham khảo <AppModelType, DbModelType> Một tham chiếu đến tài liệu sẽ được cập nhật.
cánh đồng chuỗi | Đường dẫn trường Trường đầu tiên được cập nhật.
giá trị không xác định Giá trị đầu tiên.
thêmFieldsAndValues không xác định[] Cặp khóa/giá trị bổ sung.

Trả về:

cái này

Phiên bản Transaction này. Được sử dụng để xâu chuỗi các cuộc gọi phương thức.

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