firebase-admin.firestore package

Réexportations d'API externes

Les API suivantes définies en externe sont réexportées à partir de ce point d'entrée de module pour plus de commodité.

Symbole	Description
Écrivain en bloc	Tapez BulkWriter du package @google-cloud/firestore .
Champ agrégé	Type AggregateField du package @google-cloud/firestore .
Options BulkWriter	Tapez BulkWriterOptions du package @google-cloud/firestore .
Générateur de bundles	Type BundleBuilder du package @google-cloud/firestore .
GroupeCollection	Type CollectionGroup du package @google-cloud/firestore .
CollectionRéférence	Type CollectionReference du package @google-cloud/firestore .
DocumentChange	Type DocumentChange du package @google-cloud/firestore .
DocumentDonnées	Type DocumentData du package @google-cloud/firestore .
Référence de document	Type DocumentReference du package @google-cloud/firestore .
Instantané du document	Type DocumentSnapshot du package @google-cloud/firestore .
Chemin de champ	Type FieldPath du package @google-cloud/firestore .
Valeur du champ	Type FieldValue du package @google-cloud/firestore .
Filtre	Type Filter du package @google-cloud/firestore .
Firestore	Type Firestore du package @google-cloud/firestore .
Convertisseur de données Firestore	Type FirestoreDataConverter du package @google-cloud/firestore .
GéoPoint	Type GeoPoint du package @google-cloud/firestore .
Statut Grpc	Saisissez GrpcStatus du package @google-cloud/firestore .
Condition préalable	Type Precondition du package @google-cloud/firestore .
Requête	Type Query du package @google-cloud/firestore .
RequêteDocumentSnapshot	Type QueryDocumentSnapshot du package @google-cloud/firestore .
RequêtePartition	Type QueryPartition du package @google-cloud/firestore .
RequêteSnapshot	Type QuerySnapshot du package @google-cloud/firestore .
Options de lecture	Tapez ReadOptions à partir du package @google-cloud/firestore .
Définir les options	Tapez SetOptions du package @google-cloud/firestore .
Horodatage	Type Timestamp du package @google-cloud/firestore .
Transaction	Type Transaction du package @google-cloud/firestore .
ÉcrireBatch	Type WriteBatch du package @google-cloud/firestore .
ÉcrireRésultat	Tapez WriteResult à partir du package @google-cloud/firestore .
setLogFunction	Fonction setLogFunction du package @google-cloud/firestore .

Cloud Firestore.

Les fonctions

Fonction	Description
getFirestore()	Obtient le service Firestore par défaut pour l'application par défaut.
getFirestore (application)	Obtient le service Firestore par défaut pour l'application donnée.
getFirestore (ID de base de données)	(BETA) Obtient le service Firestore nommé pour l'application par défaut.
getFirestore (application, ID de base de données)	(BETA) Obtient le service Firestore nommé pour l'application donnée.
initializeFirestore (application, paramètres)	Obtient le service Firestore par défaut pour l'application donnée, en transmettant des paramètres supplémentaires à son constructeur.
initializeFirestore (application, paramètres, identifiant de base de données)	(BETA) Obtient le service Firestore nommé pour l'application donnée, en transmettant des paramètres supplémentaires à son constructeur.

Interfaces

Interface	Description
Paramètres Firestore	Paramètres à transmettre au constructeur Firestore.

getFirestore()

Obtient le service Firestore par défaut pour l'application par défaut.

Signature:

export declare function getFirestore(): Firestore;

Retour:

Firestore

Le service Firestore par défaut pour l'application par défaut.

Exemple

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

getFirestore()

Obtient le service Firestore par défaut pour l'application donnée.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	quel service Firestore renvoyer.

Retour:

Firestore

Le service Firestore par défaut associé à l'application fournie.

Exemple

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

getFirestore()

Cette API est fournie en avant-première pour les développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Obtient le service Firestore nommé pour l'application par défaut.

Signature:

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

Paramètres

Paramètre	Taper	Description
ID de base de données	chaîne	nom de la base de données à retourner.

Retour:

Firestore

Le service Firestore nommé pour l'application par défaut.

Exemple

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

getFirestore()

Cette API est fournie en avant-première pour les développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Obtient le service Firestore nommé pour l'application donnée.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	quel service Firestore renvoyer.
ID de base de données	chaîne	nom de la base de données à retourner.

Retour:

Firestore

Le service Firestore nommé associé à l'application fournie.

Exemple

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

initializeFirestore()

Obtient le service Firestore par défaut pour l'application donnée, en transmettant des paramètres supplémentaires à son constructeur.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	quel service Firestore renvoyer.
paramètres	Paramètres Firestore	Objet de paramètres à transmettre au constructeur.

Retour:

Firestore

Le service Firestore par défaut associé à l'application et aux paramètres fournis.

Exemple

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

initializeFirestore()

Cette API est fournie en avant-première pour les développeurs et peut changer en fonction des commentaires que nous recevons. N'utilisez pas cette API dans un environnement de production.

Obtient le service Firestore nommé pour l'application donnée, en transmettant des paramètres supplémentaires à son constructeur.

Signature:

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

Paramètres

Paramètre	Taper	Description
application	Application	quel service Firestore renvoyer.
paramètres	Paramètres Firestore	Objet de paramètres à transmettre au constructeur.
ID de base de données	chaîne	nom de la base de données à retourner.

Retour:

Firestore

Le service Firestore nommé associé à l'application et aux paramètres fournis.

Exemple

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