firebase-admin.firestore package

Riesportazioni API esterne

Le seguenti API definite esternamente vengono riesportate da questo punto di ingresso del modulo per comodità.

Simbolo Descrizione
BulkWriter Tipo BulkWriter dal pacchetto @google-cloud/firestore .
Campo aggregato Tipo AggregateField dal pacchetto @google-cloud/firestore .
Opzioni BulkWriter Digitare BulkWriterOptions dal pacchetto @google-cloud/firestore .
BundleBuilder Tipo BundleBuilder dal pacchetto @google-cloud/firestore .
Gruppo di raccolta Tipo CollectionGroup dal pacchetto @google-cloud/firestore .
CollezioneRiferimento Tipo CollectionReference dal pacchetto @google-cloud/firestore .
Modifica documento DocumentChange tipo dal pacchetto @google-cloud/firestore .
DocumentData Tipo DocumentData dal pacchetto @google-cloud/firestore .
Riferimento documento Tipo DocumentReference dal pacchetto @google-cloud/firestore .
Istantanea del documento Tipo DocumentSnapshot dal pacchetto @google-cloud/firestore .
CampoPercorso Tipo FieldPath dal pacchetto @google-cloud/firestore .
CampoValore Tipo FieldValue dal pacchetto @google-cloud/firestore .
Filtro Tipo Filter dal pacchetto @google-cloud/firestore .
Firestore Tipo Firestore dal pacchetto @google-cloud/firestore .
FirestoreDataConverter Tipo FirestoreDataConverter dal pacchetto @google-cloud/firestore .
GeoPoint Tipo GeoPoint dal pacchetto @google-cloud/firestore .
GrpcStatus Tipo GrpcStatus dal pacchetto @google-cloud/firestore .
Precondizione Tipo di Precondition dal pacchetto @google-cloud/firestore .
Domanda Tipo Query dal pacchetto @google-cloud/firestore .
QueryDocumentSnapshot Tipo QueryDocumentSnapshot dal pacchetto @google-cloud/firestore .
QueryPartition Tipo QueryPartition dal pacchetto @google-cloud/firestore .
QuerySnapshot Tipo QuerySnapshot dal pacchetto @google-cloud/firestore .
LeggiOpzioni Digitare ReadOptions dal pacchetto @google-cloud/firestore .
Imposta opzioni Tipo SetOptions dal pacchetto @google-cloud/firestore .
Timestamp Tipo Timestamp dal pacchetto @google-cloud/firestore .
Transazione Tipo Transaction dal pacchetto @google-cloud/firestore .
WriteBatch Tipo WriteBatch dal pacchetto @google-cloud/firestore .
WriteResult Tipo WriteResult dal pacchetto @google-cloud/firestore .
setLogFunction funzione setLogFunction dal pacchetto @google-cloud/firestore .

Cloud Fire Store.

Funzioni

Funzione Descrizione
getFirestore() Ottiene il servizio Firestore predefinito per l'app predefinita.
getFirestore(app) Ottiene il servizio Firestore predefinito per l'app specificata.
getFirestore(IDdatabase) (BETA) Ottiene il servizio Firestore denominato per l'app predefinita.
getFirestore(app, ID database) (BETA) Ottiene il servizio Firestore denominato per l'app specificata.
inizializzaFirestore(app, impostazioni) Ottiene il servizio Firestore predefinito per l'app specificata, passando parametri aggiuntivi al relativo costruttore.
inizializzaFirestore(app, impostazioni, databaseId) (BETA) Ottiene il servizio Firestore denominato per l'app specificata, passando parametri aggiuntivi al relativo costruttore.

Interfacce

Interfaccia Descrizione
Impostazioni Firestore Impostazioni da passare al costruttore Firestore.

getFirestore()

Ottiene il servizio Firestore predefinito per l'app predefinita.

Firma:

export declare function getFirestore(): Firestore;

Ritorna:

Firestore

Il servizio Firestore predefinito per l'app predefinita.

Esempio

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

getFirestore()

Ottiene il servizio Firestore predefinito per l'app specificata.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.

Ritorna:

Firestore

Il servizio Firestore predefinito associato all'app fornita.

Esempio

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

getFirestore()

Questa API viene fornita come anteprima per gli sviluppatori e potrebbe cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Ottiene il servizio Firestore denominato per l'app predefinita.

Firma:

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

Parametri

Parametro Tipo Descrizione
ID database corda nome del database da restituire.

Ritorna:

Firestore

Il servizio Firestore denominato per l'app predefinita.

Esempio

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

getFirestore()

Questa API viene fornita come anteprima per gli sviluppatori e potrebbe cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Ottiene il servizio Firestore denominato per l'app specificata.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.
ID database corda nome del database da restituire.

Ritorna:

Firestore

Il servizio Firestore denominato associato all'app fornita.

Esempio

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

inizializzaFirestore()

Ottiene il servizio Firestore predefinito per l'app specificata, passando parametri aggiuntivi al relativo costruttore.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.
impostazioni Impostazioni Firestore Oggetto Impostazioni da passare al costruttore.

Ritorna:

Firestore

Il servizio Firestore predefinito associato all'app e alle impostazioni fornite.

Esempio

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

inizializzaFirestore()

Questa API viene fornita come anteprima per gli sviluppatori e potrebbe cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Ottiene il servizio Firestore denominato per l'app specificata, passando parametri aggiuntivi al relativo costruttore.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.
impostazioni Impostazioni Firestore Oggetto Impostazioni da passare al costruttore.
ID database corda nome del database da restituire.

Ritorna:

Firestore

Il servizio Firestore denominato associato all'app e alle impostazioni fornite.

Esempio

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

Riesportazioni API esterne

Le seguenti API definite esternamente vengono riesportate da questo punto di ingresso del modulo per comodità.

Simbolo Descrizione
BulkWriter Tipo BulkWriter dal pacchetto @google-cloud/firestore .
Campo aggregato Tipo AggregateField dal pacchetto @google-cloud/firestore .
Opzioni BulkWriter Digitare BulkWriterOptions dal pacchetto @google-cloud/firestore .
BundleBuilder Tipo BundleBuilder dal pacchetto @google-cloud/firestore .
Gruppo di raccolta Tipo CollectionGroup dal pacchetto @google-cloud/firestore .
CollezioneRiferimento Tipo CollectionReference dal pacchetto @google-cloud/firestore .
Modifica documento DocumentChange tipo dal pacchetto @google-cloud/firestore .
DocumentData Tipo DocumentData dal pacchetto @google-cloud/firestore .
Riferimento documento Tipo DocumentReference dal pacchetto @google-cloud/firestore .
Istantanea del documento Tipo DocumentSnapshot dal pacchetto @google-cloud/firestore .
CampoPercorso Tipo FieldPath dal pacchetto @google-cloud/firestore .
CampoValore Tipo FieldValue dal pacchetto @google-cloud/firestore .
Filtro Tipo Filter dal pacchetto @google-cloud/firestore .
Firestore Tipo Firestore dal pacchetto @google-cloud/firestore .
FirestoreDataConverter Tipo FirestoreDataConverter dal pacchetto @google-cloud/firestore .
GeoPoint Tipo GeoPoint dal pacchetto @google-cloud/firestore .
GrpcStatus Tipo GrpcStatus dal pacchetto @google-cloud/firestore .
Precondizione Tipo di Precondition dal pacchetto @google-cloud/firestore .
Domanda Tipo Query dal pacchetto @google-cloud/firestore .
QueryDocumentSnapshot Tipo QueryDocumentSnapshot dal pacchetto @google-cloud/firestore .
QueryPartition Tipo QueryPartition dal pacchetto @google-cloud/firestore .
QuerySnapshot Tipo QuerySnapshot dal pacchetto @google-cloud/firestore .
LeggiOpzioni Digitare ReadOptions dal pacchetto @google-cloud/firestore .
Imposta opzioni Tipo SetOptions dal pacchetto @google-cloud/firestore .
Timestamp Tipo Timestamp dal pacchetto @google-cloud/firestore .
Transazione Tipo Transaction dal pacchetto @google-cloud/firestore .
WriteBatch Tipo WriteBatch dal pacchetto @google-cloud/firestore .
WriteResult Tipo WriteResult dal pacchetto @google-cloud/firestore .
setLogFunction funzione setLogFunction dal pacchetto @google-cloud/firestore .

Cloud Fire Store.

Funzioni

Funzione Descrizione
getFirestore() Ottiene il servizio Firestore predefinito per l'app predefinita.
getFirestore(app) Ottiene il servizio Firestore predefinito per l'app specificata.
getFirestore(IDdatabase) (BETA) Ottiene il servizio Firestore denominato per l'app predefinita.
getFirestore(app, ID database) (BETA) Ottiene il servizio Firestore denominato per l'app specificata.
inizializzaFirestore(app, impostazioni) Ottiene il servizio Firestore predefinito per l'app specificata, passando parametri aggiuntivi al relativo costruttore.
inizializzaFirestore(app, impostazioni, databaseId) (BETA) Ottiene il servizio Firestore denominato per l'app specificata, passando parametri aggiuntivi al relativo costruttore.

Interfacce

Interfaccia Descrizione
Impostazioni Firestore Impostazioni da passare al costruttore Firestore.

getFirestore()

Ottiene il servizio Firestore predefinito per l'app predefinita.

Firma:

export declare function getFirestore(): Firestore;

Ritorna:

Firestore

Il servizio Firestore predefinito per l'app predefinita.

Esempio

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

getFirestore()

Ottiene il servizio Firestore predefinito per l'app specificata.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.

Ritorna:

Firestore

Il servizio Firestore predefinito associato all'app fornita.

Esempio

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

getFirestore()

Questa API viene fornita come anteprima per gli sviluppatori e potrebbe cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Ottiene il servizio Firestore denominato per l'app predefinita.

Firma:

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

Parametri

Parametro Tipo Descrizione
ID database corda nome del database da restituire.

Ritorna:

Firestore

Il servizio Firestore denominato per l'app predefinita.

Esempio

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

getFirestore()

Questa API viene fornita come anteprima per gli sviluppatori e potrebbe cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Ottiene il servizio Firestore denominato per l'app specificata.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.
ID database corda nome del database da restituire.

Ritorna:

Firestore

Il servizio Firestore denominato associato all'app fornita.

Esempio

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

inizializzaFirestore()

Ottiene il servizio Firestore predefinito per l'app specificata, passando parametri aggiuntivi al relativo costruttore.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.
impostazioni Impostazioni Firestore Oggetto Impostazioni da passare al costruttore.

Ritorna:

Firestore

Il servizio Firestore predefinito associato all'app e alle impostazioni fornite.

Esempio

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

inizializzaFirestore()

Questa API viene fornita come anteprima per gli sviluppatori e potrebbe cambiare in base al feedback che riceviamo. Non utilizzare questa API in un ambiente di produzione.

Ottiene il servizio Firestore denominato per l'app specificata, passando parametri aggiuntivi al relativo costruttore.

Firma:

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

Parametri

Parametro Tipo Descrizione
app App quale servizio Firestore restituire.
impostazioni Impostazioni Firestore Oggetto Impostazioni da passare al costruttore.
ID database corda nome del database da restituire.

Ritorna:

Firestore

Il servizio Firestore denominato associato all'app e alle impostazioni fornite.

Esempio

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