firebase-admin.firestore package

Xuất lại API bên ngoài

Các API được xác định bên ngoài sau đây sẽ được xuất lại từ điểm truy cập mô-đun này để thuận tiện.

Biểu tượng Mô tả
Công cụ viết hàng loạt Loại BulkWriter trong gói @google-cloud/firestore.
AggregateField (Trường tổng hợp) Loại AggregateField trong gói @google-cloud/firestore.
BulkWriterOptions Loại BulkWriterOptions trong gói @google-cloud/firestore.
BundleBuilder Loại BundleBuilder trong gói @google-cloud/firestore.
CollectionGroup Loại CollectionGroup trong gói @google-cloud/firestore.
Tham khảo về bộ sưu tập Loại CollectionReference trong gói @google-cloud/firestore.
DocumentChange Loại DocumentChange trong gói @google-cloud/firestore.
DocumentData Loại DocumentData trong gói @google-cloud/firestore.
Tài liệu tham khảo Loại DocumentReference trong gói @google-cloud/firestore.
Ảnh chụp màn hình tài liệu Loại DocumentSnapshot trong gói @google-cloud/firestore.
FieldPath (Đường dẫn trường) Loại FieldPath trong gói @google-cloud/firestore.
Giá trị trường Loại FieldValue trong gói @google-cloud/firestore.
Bộ lọc Loại Filter trong gói @google-cloud/firestore.
Khôi phục Loại Firestore trong gói @google-cloud/firestore.
FirestoreDataConverter Loại FirestoreDataConverter trong gói @google-cloud/firestore.
GeoPoint Loại GeoPoint trong gói @google-cloud/firestore.
GrpcStatus Loại GrpcStatus trong gói @google-cloud/firestore.
Điều kiện tiên quyết Loại Precondition trong gói @google-cloud/firestore.
Cụm từ tìm kiếm Loại Query trong gói @google-cloud/firestore.
Truy vấn tài liệu ảnh chụp nhanh Loại QueryDocumentSnapshot trong gói @google-cloud/firestore.
QueryPartition Loại QueryPartition trong gói @google-cloud/firestore.
Truy vấn nhanh Loại QuerySnapshot trong gói @google-cloud/firestore.
ReadOptions (Tuỳ chọn đọc) Loại ReadOptions trong gói @google-cloud/firestore.
SetOptions Loại SetOptions trong gói @google-cloud/firestore.
Dấu thời gian Loại Timestamp trong gói @google-cloud/firestore.
Giao dịch Loại Transaction trong gói @google-cloud/firestore.
WriteBatch Loại WriteBatch trong gói @google-cloud/firestore.
WriteResult Loại WriteResult trong gói @google-cloud/firestore.
setLogFunction Hàm setLogFunction trong gói @google-cloud/firestore.

Cloud Firestore.

Hàm

Chức năng Mô tả
getFirestore() Tải dịch vụ Firestore mặc định cho ứng dụng mặc định.
getFirestore(ứng dụng) Tải dịch vụ Firestore mặc định cho ứng dụng cụ thể.
getFirestore(databaseId) (BETA) Lấy dịch vụ Firestore có tên cho ứng dụng mặc định.
getFirestore(ứng dụng, DatabaseId) (BETA) Lấy dịch vụ Firestore có tên cho ứng dụng cụ thể.
khởi tạoFirestore(ứng dụng, chế độ cài đặt) Lấy dịch vụ Firestore mặc định cho ứng dụng nhất định, truyền các tham số bổ sung đến hàm khởi tạo của ứng dụng đó.
khởi tạoFirestore(ứng dụng, chế độ cài đặt, mã cơ sở dữ liệu) (BETA) Lấy dịch vụ Firestore đã đặt tên cho ứng dụng cụ thể, truyền các tham số bổ sung đến hàm khởi tạo của ứng dụng đó.

Lớp học

Hạng Mô tả
FirebaseFirestoreError Cấu trúc mã lỗi Firebase Firestore. Điều này sẽ mở rộng FirebaseError.

Giao diện

Giao diện Mô tả
FirestoreSettings Các chế độ cài đặt để truyền đến hàm khởi tạo Firestore.

getFirestore()

Tải 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)

Tải 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 dịch vụ Firestore nào cần trả về.

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 đã 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 xem trước cho các nhà phát triển và có thể thay đổi dựa trê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.

Tải dịch vụ Firestore có 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ê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, Cơ sở dữ liệuId)

API này được cung cấp dưới dạng bản xem trước cho các nhà phát triển và có thể thay đổi dựa trê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.

Tải dịch vụ Firestore có 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 dịch vụ Firestore nào cần trả về.
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 được liên kết với ứng dụng đã cung cấp.

Ví dụ

// Get the Firestore service for a named database and specific app.
const otherFirestore = getFirestore('otherDb');

khởi độngFirestore(ứng dụng, chế độ cài đặt)

Lấy dịch vụ Firestore mặc định cho ứng dụng nhất định, truyền các tham số bổ sung đến 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 dịch vụ Firestore nào cần trả về.
cài đặt FirestoreSettings Đối tượng chế độ cài đặt cần 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});

derivedFirestore(ứng dụng, chế độ cài đặt, DatabaseId)

API này được cung cấp dưới dạng bản xem trước cho các nhà phát triển và có thể thay đổi dựa trê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 đã cho, truyền các tham số bổ sung đến 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 dịch vụ Firestore nào cần trả về.
cài đặt FirestoreSettings Đối tượng chế độ cài đặt cần 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 mà bạn 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');