firebase-admin.firestore package

Reexportaciones de API externas

Las siguientes API definidas externamente se reexportan desde este punto de entrada del módulo para mayor comodidad.

Símbolo Descripción
escritor a granel Tipo BulkWriter del paquete @google-cloud/firestore .
Campo agregado Tipo AggregateField del paquete @google-cloud/firestore .
Opciones de BulkWriter Tipo BulkWriterOptions del paquete @google-cloud/firestore .
Constructor de paquetes Tipo BundleBuilder del paquete @google-cloud/firestore .
Grupo de colección Tipo CollectionGroup del paquete @google-cloud/firestore .
ColecciónReferencia Tipo CollectionReference del paquete @google-cloud/firestore .
Cambio de documento Tipo DocumentChange del paquete @google-cloud/firestore .
Datos del documento Tipo DocumentData del paquete @google-cloud/firestore .
Referencia de documento Tipo DocumentReference del paquete @google-cloud/firestore .
Instantánea del documento Tipo DocumentSnapshot del paquete @google-cloud/firestore .
Ruta de campo Tipo FieldPath del paquete @google-cloud/firestore .
Valor de campo Tipo FieldValue del paquete @google-cloud/firestore .
Filtrar Tipo Filter del paquete @google-cloud/firestore .
Tienda de fuego Tipo Firestore del paquete @google-cloud/firestore .
FirestoreDataConverter Tipo FirestoreDataConverter del paquete @google-cloud/firestore .
Geopunto Tipo GeoPoint del paquete @google-cloud/firestore .
EstadoGrpc Tipo GrpcStatus del paquete @google-cloud/firestore .
Condición previa Tipo Precondition del paquete @google-cloud/firestore .
Consulta Tipo Query del paquete @google-cloud/firestore .
ConsultaDocumentoInstantánea Tipo QueryDocumentSnapshot del paquete @google-cloud/firestore .
Partición de consulta Tipo QueryPartition del paquete @google-cloud/firestore .
ConsultaInstantánea Tipo QuerySnapshot del paquete @google-cloud/firestore .
Opciones de lectura Tipo ReadOptions del paquete @google-cloud/firestore .
Establecer opciones Tipo SetOptions del paquete @google-cloud/firestore .
Marca de tiempo Tipo de Timestamp del paquete @google-cloud/firestore .
Transacción Tipo Transaction del paquete @google-cloud/firestore .
escribir lote Tipo WriteBatch del paquete @google-cloud/firestore .
Escribir resultado Tipo WriteResult del paquete @google-cloud/firestore .
setLogFunción Función setLogFunction del paquete @google-cloud/firestore .

Tienda de fuego en la nube.

Funciones

Función Descripción
obtenerFirestore() Obtiene el servicio Firestore predeterminado para la aplicación predeterminada.
getFirestore (aplicación) Obtiene el servicio Firestore predeterminado para la aplicación determinada.
getFirestore(ID de base de datos) (BETA) Obtiene el servicio Firestore denominado para la aplicación predeterminada.
getFirestore(aplicación, ID de base de datos) (BETA) Obtiene el servicio Firestore denominado para la aplicación determinada.
inicializarFirestore(aplicación, configuración) Obtiene el servicio Firestore predeterminado para la aplicación determinada y pasa parámetros adicionales a su constructor.
inicializarFirestore(aplicación, configuración, ID de base de datos) (BETA) Obtiene el servicio Firestore denominado para la aplicación determinada y pasa parámetros adicionales a su constructor.

Interfaces

Interfaz Descripción
Configuración de Firestore Configuraciones para pasar al constructor de Firestore.

obtenerFirestore()

Obtiene el servicio Firestore predeterminado para la aplicación predeterminada.

Firma:

export declare function getFirestore(): Firestore;

Devoluciones:

Tienda de fuego

El servicio Firestore predeterminado para la aplicación predeterminada.

Ejemplo

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

obtenerFirestore()

Obtiene el servicio Firestore predeterminado para la aplicación determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore predeterminado asociado con la aplicación proporcionada.

Ejemplo

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

obtenerFirestore()

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el servicio Firestore denominado para la aplicación predeterminada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ID de base de datos cadena nombre de la base de datos a devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore denominado para la aplicación predeterminada.

Ejemplo

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

obtenerFirestore()

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el servicio Firestore denominado para la aplicación determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.
ID de base de datos cadena nombre de la base de datos a devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore denominado asociado con la aplicación proporcionada.

Ejemplo

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

inicializarFirestore()

Obtiene el servicio Firestore predeterminado para la aplicación determinada y pasa parámetros adicionales a su constructor.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.
ajustes Configuración de Firestore Objeto de configuración que se pasará al constructor.

Devoluciones:

Tienda de fuego

El servicio Firestore predeterminado asociado con la aplicación y la configuración proporcionadas.

Ejemplo

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

inicializarFirestore()

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el servicio Firestore denominado para la aplicación determinada y pasa parámetros adicionales a su constructor.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.
ajustes Configuración de Firestore Objeto de configuración que se pasará al constructor.
ID de base de datos cadena nombre de la base de datos a devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore denominado asociado con la aplicación y la configuración proporcionadas.

Ejemplo

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

Reexportaciones de API externas

Las siguientes API definidas externamente se reexportan desde este punto de entrada del módulo para mayor comodidad.

Símbolo Descripción
escritor a granel Tipo BulkWriter del paquete @google-cloud/firestore .
Campo agregado Tipo AggregateField del paquete @google-cloud/firestore .
Opciones de BulkWriter Tipo BulkWriterOptions del paquete @google-cloud/firestore .
Constructor de paquetes Tipo BundleBuilder del paquete @google-cloud/firestore .
Grupo de colección Tipo CollectionGroup del paquete @google-cloud/firestore .
ColecciónReferencia Tipo CollectionReference del paquete @google-cloud/firestore .
Cambio de documento Tipo DocumentChange del paquete @google-cloud/firestore .
Datos del documento Tipo DocumentData del paquete @google-cloud/firestore .
Referencia de documento Tipo DocumentReference del paquete @google-cloud/firestore .
Instantánea del documento Tipo DocumentSnapshot del paquete @google-cloud/firestore .
Ruta de campo Tipo FieldPath del paquete @google-cloud/firestore .
Valor de campo Tipo FieldValue del paquete @google-cloud/firestore .
Filtrar Tipo Filter del paquete @google-cloud/firestore .
Tienda de fuego Tipo Firestore del paquete @google-cloud/firestore .
FirestoreDataConverter Tipo FirestoreDataConverter del paquete @google-cloud/firestore .
Geopunto Tipo GeoPoint del paquete @google-cloud/firestore .
EstadoGrpc Tipo GrpcStatus del paquete @google-cloud/firestore .
Condición previa Tipo Precondition del paquete @google-cloud/firestore .
Consulta Tipo Query del paquete @google-cloud/firestore .
ConsultaDocumentoInstantánea Tipo QueryDocumentSnapshot del paquete @google-cloud/firestore .
Partición de consulta Tipo QueryPartition del paquete @google-cloud/firestore .
ConsultaInstantánea Tipo QuerySnapshot del paquete @google-cloud/firestore .
Opciones de lectura Tipo ReadOptions del paquete @google-cloud/firestore .
Establecer opciones Tipo SetOptions del paquete @google-cloud/firestore .
Marca de tiempo Tipo de Timestamp del paquete @google-cloud/firestore .
Transacción Tipo Transaction del paquete @google-cloud/firestore .
escribir lote Tipo WriteBatch del paquete @google-cloud/firestore .
Escribir resultado Tipo WriteResult del paquete @google-cloud/firestore .
setLogFunción Función setLogFunction del paquete @google-cloud/firestore .

Tienda de fuego en la nube.

Funciones

Función Descripción
obtenerFirestore() Obtiene el servicio Firestore predeterminado para la aplicación predeterminada.
getFirestore (aplicación) Obtiene el servicio Firestore predeterminado para la aplicación determinada.
getFirestore(ID de base de datos) (BETA) Obtiene el servicio Firestore denominado para la aplicación predeterminada.
getFirestore(aplicación, ID de base de datos) (BETA) Obtiene el servicio Firestore denominado para la aplicación determinada.
inicializarFirestore(aplicación, configuración) Obtiene el servicio Firestore predeterminado para la aplicación determinada y pasa parámetros adicionales a su constructor.
inicializarFirestore(aplicación, configuración, ID de base de datos) (BETA) Obtiene el servicio Firestore denominado para la aplicación determinada y pasa parámetros adicionales a su constructor.

Interfaces

Interfaz Descripción
Configuración de Firestore Configuraciones para pasar al constructor de Firestore.

obtenerFirestore()

Obtiene el servicio Firestore predeterminado para la aplicación predeterminada.

Firma:

export declare function getFirestore(): Firestore;

Devoluciones:

Tienda de fuego

El servicio Firestore predeterminado para la aplicación predeterminada.

Ejemplo

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

obtenerFirestore()

Obtiene el servicio Firestore predeterminado para la aplicación determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore predeterminado asociado con la aplicación proporcionada.

Ejemplo

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

obtenerFirestore()

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el servicio Firestore denominado para la aplicación predeterminada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ID de base de datos cadena nombre de la base de datos a devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore denominado para la aplicación predeterminada.

Ejemplo

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

obtenerFirestore()

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el servicio Firestore denominado para la aplicación determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.
ID de base de datos cadena nombre de la base de datos a devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore denominado asociado con la aplicación proporcionada.

Ejemplo

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

inicializarFirestore()

Obtiene el servicio Firestore predeterminado para la aplicación determinada y pasa parámetros adicionales a su constructor.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.
ajustes Configuración de Firestore Objeto de configuración que se pasará al constructor.

Devoluciones:

Tienda de fuego

El servicio Firestore predeterminado asociado con la aplicación y la configuración proporcionadas.

Ejemplo

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

inicializarFirestore()

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtiene el servicio Firestore denominado para la aplicación determinada y pasa parámetros adicionales a su constructor.

Firma:

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

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación qué servicio Firestore devolver.
ajustes Configuración de Firestore Objeto de configuración que se pasará al constructor.
ID de base de datos cadena nombre de la base de datos a devolver.

Devoluciones:

Tienda de fuego

El servicio Firestore denominado asociado con la aplicación y la configuración proporcionadas.

Ejemplo

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