firebase-admin.firestore package

Ekspor Ulang API Eksternal

API yang ditentukan secara eksternal berikut diekspor ulang dari titik entri modul ini untuk memudahkan.

Simbol Deskripsi
Penulis Massal Jenis BulkWriter dari paket @google-cloud/firestore.
AggregateField Jenis AggregateField dari paket @google-cloud/firestore.
BulkWriterOptions Jenis BulkWriterOptions dari paket @google-cloud/firestore.
BundleBuilder Jenis BundleBuilder dari paket @google-cloud/firestore.
Grup Koleksi Jenis CollectionGroup dari paket @google-cloud/firestore.
CollectionReference Jenis CollectionReference dari paket @google-cloud/firestore.
Perubahan Dokumen Jenis DocumentChange dari paket @google-cloud/firestore.
DocumentData Jenis DocumentData dari paket @google-cloud/firestore.
DocumentReference Jenis DocumentReference dari paket @google-cloud/firestore.
Snapshot Dokumen Jenis DocumentSnapshot dari paket @google-cloud/firestore.
FieldPath Jenis FieldPath dari paket @google-cloud/firestore.
NilaiField Jenis FieldValue dari paket @google-cloud/firestore.
Filter Jenis Filter dari paket @google-cloud/firestore.
Firestore Jenis Firestore dari paket @google-cloud/firestore.
FirestoreDataConverter Jenis FirestoreDataConverter dari paket @google-cloud/firestore.
GeoPoint Jenis GeoPoint dari paket @google-cloud/firestore.
GrpcStatus Jenis GrpcStatus dari paket @google-cloud/firestore.
Prasyarat Jenis Precondition dari paket @google-cloud/firestore.
Kueri Jenis Query dari paket @google-cloud/firestore.
QueryDocumentSnapshot Jenis QueryDocumentSnapshot dari paket @google-cloud/firestore.
QueryPartition Jenis QueryPartition dari paket @google-cloud/firestore.
QuerySnapshot Jenis QuerySnapshot dari paket @google-cloud/firestore.
ReadOptions Jenis ReadOptions dari paket @google-cloud/firestore.
SetOptions Jenis SetOptions dari paket @google-cloud/firestore.
Stempel waktu Jenis Timestamp dari paket @google-cloud/firestore.
Transaksi Jenis Transaction dari paket @google-cloud/firestore.
WriteBatch Jenis WriteBatch dari paket @google-cloud/firestore.
WriteResult Jenis WriteResult dari paket @google-cloud/firestore.
setLogFunction Fungsi setLogFunction dari paket @google-cloud/firestore.

Cloud Firestore.

Functions

Fungsi Deskripsi
getFirestore() Mendapatkan layanan Firestore default untuk aplikasi default.
getFirestore(aplikasi) Mendapatkan layanan Firestore default untuk aplikasi yang ditentukan.
getFirestore(databaseId) (BETA) Mendapatkan layanan Firestore bernama untuk aplikasi default.
getFirestore(app, databaseId) (BETA) Mendapatkan layanan Firestore bernama untuk aplikasi tertentu.
InitializeFirestore(aplikasi, setelan) Mendapatkan layanan Firestore default untuk aplikasi tertentu, meneruskan parameter tambahan ke konstruktornya.
InitializeFirestore(app, settings, databaseId) (BETA) Mendapatkan layanan Firestore bernama untuk aplikasi tertentu, yang meneruskan parameter tambahan ke konstruktornya.

Antarmuka

Antarmuka Deskripsi
Setelan Firestore Setelan untuk diteruskan ke konstruktor Firestore.

getFirestore()

Mendapatkan layanan Firestore default untuk aplikasi default.

Tanda Tangan:

export declare function getFirestore(): Firestore;

Hasil:

Firestore

Layanan Firestore default untuk aplikasi default.

Contoh

// Get the default Firestore service for the default app
const defaultFirestore = getFirestore();

getFirestore(aplikasi)

Mendapatkan layanan Firestore default untuk aplikasi yang ditentukan.

Tanda Tangan:

export declare function getFirestore(app: App): Firestore;

Parameter

Parameter Jenis Deskripsi
aplikasi Aplikasi layanan Firestore mana yang akan dikembalikan.

Hasil:

Firestore

Layanan Firestore default yang terkait dengan aplikasi yang disediakan.

Contoh

// Get the default Firestore service for a specific app
const otherFirestore = getFirestore(app);

getFirestore(databaseId)

API ini disediakan sebagai pratinjau bagi developer dan dapat berubah berdasarkan masukan yang kami terima. Jangan gunakan API ini di lingkungan produksi.

Mendapatkan layanan Firestore bernama untuk aplikasi default.

Tanda Tangan:

export declare function getFirestore(databaseId: string): Firestore;

Parameter

Parameter Jenis Deskripsi
IDdatabase string nama {i>database<i} yang akan ditampilkan.

Hasil:

Firestore

Layanan Firestore bernama untuk aplikasi default.

Contoh

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

getFirestore(app, databaseId)

API ini disediakan sebagai pratinjau bagi developer dan dapat berubah berdasarkan masukan yang kami terima. Jangan gunakan API ini di lingkungan produksi.

Mendapatkan layanan Firestore bernama untuk aplikasi tertentu.

Tanda Tangan:

export declare function getFirestore(app: App, databaseId: string): Firestore;

Parameter

Parameter Jenis Deskripsi
aplikasi Aplikasi layanan Firestore mana yang akan dikembalikan.
IDdatabase string nama {i>database<i} yang akan ditampilkan.

Hasil:

Firestore

Layanan Firestore bernama yang terkait dengan aplikasi yang disediakan.

Contoh

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

inisialisasiFirestore(aplikasi, setelan)

Mendapatkan layanan Firestore default untuk aplikasi tertentu, meneruskan parameter tambahan ke konstruktornya.

Tanda Tangan:

export declare function initializeFirestore(app: App, settings?: FirestoreSettings): Firestore;

Parameter

Parameter Jenis Deskripsi
aplikasi Aplikasi layanan Firestore mana yang akan dikembalikan.
setelan Setelan Firestore Setelan yang akan diteruskan ke konstruktor.

Hasil:

Firestore

Layanan Firestore default yang dikaitkan dengan aplikasi dan setelan yang disediakan.

Contoh

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true});

inisialisasiFirestore(aplikasi, setelan, databaseId)

API ini disediakan sebagai pratinjau bagi developer dan dapat berubah berdasarkan masukan yang kami terima. Jangan gunakan API ini di lingkungan produksi.

Mendapatkan layanan Firestore bernama untuk aplikasi tertentu, meneruskan parameter tambahan ke konstruktornya.

Tanda Tangan:

export declare function initializeFirestore(app: App, settings: FirestoreSettings, databaseId: string): Firestore;

Parameter

Parameter Jenis Deskripsi
aplikasi Aplikasi layanan Firestore mana yang akan dikembalikan.
setelan Setelan Firestore Setelan yang akan diteruskan ke konstruktor.
IDdatabase string nama {i>database<i} yang akan ditampilkan.

Hasil:

Firestore

Layanan Firestore bernama yang dikaitkan dengan aplikasi dan setelan yang disediakan.

Contoh

// Get the Firestore service for a specific app, require HTTP/1.1 REST transport
const otherFirestore = initializeFirestore(app, {preferRest: true}, 'otherDb');