Xuất lại API bên ngoài
Các API được xác định bên ngoài sau đây được tái xuất từ điểm truy cập của mô-đun này để thuận tiện.
Biểu tượng | Mô tả |
---|---|
bulkWriter | Loại BulkWriter từ gói @google-cloud/firestore . |
AggregateField (Trường tổng hợp) | Loại AggregateField từ gói @google-cloud/firestore . |
bulkWriterOptions | Loại BulkWriterOptions từ gói @google-cloud/firestore . |
BundleBuilder | Loại BundleBuilder từ gói @google-cloud/firestore . |
Nhóm thu thập | Loại CollectionGroup từ gói @google-cloud/firestore . |
Bộ sưu tập tham chiếu | Loại CollectionReference từ gói @google-cloud/firestore . |
DocumentChange | Loại DocumentChange từ gói @google-cloud/firestore . |
DocumentData | Loại DocumentData từ gói @google-cloud/firestore . |
Tài liệu tham khảo | Loại DocumentReference từ gói @google-cloud/firestore . |
Ảnh chụp nhanh tài liệu | Loại DocumentSnapshot từ gói @google-cloud/firestore . |
FieldPath | Loại FieldPath từ gói @google-cloud/firestore . |
Giá trị trường | Loại FieldValue từ gói @google-cloud/firestore . |
Bộ lọc | Loại Filter từ gói @google-cloud/firestore . |
Khôi phục lại | Loại Firestore từ gói @google-cloud/firestore . |
FirestoreDataConverter | Loại FirestoreDataConverter từ gói @google-cloud/firestore . |
GeoPoint | Loại GeoPoint từ gói @google-cloud/firestore . |
GrpcStatus | Loại GrpcStatus từ gói @google-cloud/firestore . |
Điều kiện tiên quyết | Loại Precondition từ gói @google-cloud/firestore . |
Cụm từ tìm kiếm | Loại Query từ gói @google-cloud/firestore . |
QueryDocumentSnapshot | Loại QueryDocumentSnapshot từ gói @google-cloud/firestore . |
Phân vùng truy vấn | Loại QueryPartition từ gói @google-cloud/firestore . |
Ảnh chụp nhanh truy vấn | Loại QuerySnapshot từ gói @google-cloud/firestore . |
ReadOptions (Tuỳ chọn đọc) | Loại ReadOptions từ gói @google-cloud/firestore . |
SetOptions | Loại SetOptions từ gói @google-cloud/firestore . |
Dấu thời gian | Loại Timestamp từ gói @google-cloud/firestore . |
Giao dịch | Loại Transaction từ gói @google-cloud/firestore . |
WriteBatch | Loại WriteBatch từ gói @google-cloud/firestore . |
WriteResult | Loại WriteResult từ gói @google-cloud/firestore . |
setLogFunction | Hàm setLogFunction từ gói @google-cloud/firestore . |
Cloud Firestore.
Hàm
Chức năng | Mô tả |
---|---|
getFirestore() | Lấy dịch vụ Firestore mặc định cho ứng dụng mặc định. |
getFirestore(ứng dụng) | Lấy dịch vụ Firestore mặc định cho ứng dụng cụ thể. |
getFirestore(databaseId) | (BETA) Lấy dịch vụ Firestore được đặt tên cho ứng dụng mặc định. |
getFirestore(app, databaseId) | (BETA) Lấy dịch vụ Firestore được đặt tên cho ứng dụng cụ thể. |
initializeFirestore(ứng dụng, chế độ cài đặt) | Lấy dịch vụ Firestore mặc định cho ứng dụng đã cho, truyền tham số bổ sung tới hàm khởi tạo của ứng dụng đó. |
initializeFirestore(ứng dụng, chế độ cài đặt, databaseId) | (BETA) Lấy dịch vụ Firestore được đặt tên cho ứng dụng cụ thể, truyền tham số bổ sung tới hàm khởi tạo của ứng dụng đó. |
Hạng
Hạng | Mô tả |
---|---|
Lỗi FirebaseFirestore | Cấu trúc của mã lỗi Firebase Firestore. Việc này sẽ mở rộng FirebaseError. |
Giao diện
Giao diện | Mô tả |
---|---|
Cài đặt khôi phục | Các chế độ cài đặt để truyền đến hàm khởi tạo Firestore. |
getFirestore()
Lấy dịch vụ Firestore mặc định cho ứng dụng mặc định.
Chữ ký:
export declare function getFirestore(): Firestore;
Trường hợp trả lại hàng:
Firestore
Dịch vụ Firestore mặc định cho ứng dụng mặc định.
Ví dụ
// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();
getFirestore(ứng dụng)
Lấy dịch vụ Firestore mặc định cho ứng dụng cụ thể.
Chữ ký:
export declare function getFirestore(app: App): Firestore;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
ứng dụng | Ứng dụng | cần trả về dịch vụ Firestore nào. |
Trường hợp trả lại hàng:
Firestore
Dịch vụ Firestore mặc định liên kết với ứng dụng được cung cấp.
Ví dụ
// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);
getFirestore(databaseId)
API này được cung cấp dưới dạng bản dùng thử cho nhà phát triển và có thể thay đổi dựa trên ý kiến phản hồi mà chúng tôi nhận được. Không sử dụng API này trong môi trường phát hành chính thức.
Lấy dịch vụ Firestore được đặt tên cho ứng dụng mặc định.
Chữ ký:
export declare function getFirestore(databaseId: string): Firestore;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
mã cơ sở dữ liệu | chuỗi | tên của cơ sở dữ liệu cần trả về. |
Trường hợp trả lại hàng:
Firestore
Dịch vụ Firestore được đặt tên cho ứng dụng mặc định.
Ví dụ
// Get the Firestore service for a named database and default app
const otherFirestore = getFirestore('otherDb');
getFirestore(ứng dụng, DatabaseId)
API này được cung cấp dưới dạng bản dùng thử cho nhà phát triển và có thể thay đổi dựa trên ý kiến phản hồi mà chúng tôi nhận được. Không sử dụng API này trong môi trường phát hành chính thức.
Lấy dịch vụ Firestore được đặt tên cho ứng dụng cụ thể.
Chữ ký:
export declare function getFirestore(app: App, databaseId: string): Firestore;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
ứng dụng | Ứng dụng | cần trả về dịch vụ Firestore nào. |
mã cơ sở dữ liệu | chuỗi | tên của cơ sở dữ liệu cần trả về. |
Trường hợp trả lại hàng:
Firestore
Dịch vụ Firestore có tên là liên kết với ứng dụng được cung cấp.
Ví dụ
// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');
khởi tạo Firestore(ứng dụng, cài đặt)
Lấy dịch vụ Firestore mặc định cho ứng dụng đã cho, truyền tham số bổ sung tới hàm khởi tạo của ứng dụng đó.
Chữ ký:
export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
ứng dụng | Ứng dụng | cần trả về dịch vụ Firestore nào. |
cài đặt | Cài đặt khôi phục | Đối tượng cài đặt sẽ được truyền đến hàm khởi tạo. |
Trường hợp trả lại hàng:
Firestore
Dịch vụ Firestore
mặc định được liên kết với ứng dụng và chế độ cài đặt đã cung cấp.
Ví dụ
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});
khởi tạo Khôi phục(ứng dụng, cài đặt, cơ sở dữ liệuId)
API này được cung cấp dưới dạng bản dùng thử cho nhà phát triển và có thể thay đổi dựa trên ý kiến phản hồi mà chúng tôi nhận được. Không sử dụng API này trong môi trường phát hành chính thức.
Lấy dịch vụ Firestore có tên cho ứng dụng đã cung cấp, truyền tham số bổ sung tới hàm khởi tạo của ứng dụng đó.
Chữ ký:
export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;
Thông số
Thông số | Loại | Mô tả |
---|---|---|
ứng dụng | Ứng dụng | cần trả về dịch vụ Firestore nào. |
cài đặt | Cài đặt khôi phục | Đối tượng cài đặt sẽ được truyền đến hàm khởi tạo. |
mã cơ sở dữ liệu | chuỗi | tên của cơ sở dữ liệu cần trả về. |
Trường hợp trả lại hàng:
Firestore
Dịch vụ Firestore
đã đặt tên được liên kết với ứng dụng và chế độ cài đặt đã cung cấp.
Ví dụ
// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');