firebase-admin.firestore package

Reexportações externas de API

As seguintes APIs definidas externamente são reexportadas deste ponto de entrada do módulo por conveniência.

Símbolo Descrição
Gravador em massa Tipo BulkWriter do pacote @google-cloud/firestore .
CampoAgregado Tipo AggregateField do pacote @google-cloud/firestore .
Opções de BulkWriter Tipo BulkWriterOptions do pacote @google-cloud/firestore .
Construtor de pacotes Tipo BundleBuilder do pacote @google-cloud/firestore .
Grupo de coleta Tipo CollectionGroup do pacote @google-cloud/firestore .
Referência de coleção Tipo CollectionReference do pacote @google-cloud/firestore .
Alteração de Documento Tipo DocumentChange do pacote @google-cloud/firestore .
DocumentData Tipo DocumentData do pacote @google-cloud/firestore .
Referência de Documento Tipo DocumentReference do pacote @google-cloud/firestore .
Instantâneo do documento Tipo DocumentSnapshot do pacote @google-cloud/firestore .
CampoCaminho Tipo FieldPath do pacote @google-cloud/firestore .
CampoValor Tipo FieldValue do pacote @google-cloud/firestore .
Filtro Tipo Filter do pacote @google-cloud/firestore .
Armazém de Fogo Tipo Firestore do pacote @google-cloud/firestore .
FirestoreDataConverter Tipo FirestoreDataConverter do pacote @google-cloud/firestore .
GeoPonto Tipo GeoPoint do pacote @google-cloud/firestore .
StatusGrpc Tipo GrpcStatus do pacote @google-cloud/firestore .
Condição prévia Tipo de Precondition do pacote @google-cloud/firestore .
Consulta Tipo Query do pacote @google-cloud/firestore .
QueryDocumentSnapshot Tipo QueryDocumentSnapshot do pacote @google-cloud/firestore .
Consultar Partição Tipo QueryPartition do pacote @google-cloud/firestore .
Consulta Instantâneo Tipo QuerySnapshot do pacote @google-cloud/firestore .
Opções de leitura Tipo ReadOptions do pacote @google-cloud/firestore .
Definir opções Tipo SetOptions do pacote @google-cloud/firestore .
Carimbo de data e hora Tipo de Timestamp do pacote @google-cloud/firestore .
Transação Tipo Transaction do pacote @google-cloud/firestore .
WriteBatch Tipo WriteBatch do pacote @google-cloud/firestore .
GravarResultado Tipo WriteResult do pacote @google-cloud/firestore .
setLogFunction Função setLogFunction do pacote @google-cloud/firestore .

Nuvem Firestore.

Funções

Função Descrição
getFirestore() Obtém o serviço padrão do Firestore para o aplicativo padrão.
obterFirestore(aplicativo) Obtém o serviço padrão do Firestore para o aplicativo específico.
getFirestore(databaseId) (BETA) Obtém o serviço Firestore nomeado para o aplicativo padrão.
getFirestore(aplicativo,databaseId) (BETA) Obtém o serviço Firestore nomeado para o aplicativo específico.
inicializarFirestore(aplicativo, configurações) Obtém o serviço padrão do Firestore para o aplicativo específico, passando parâmetros extras para seu construtor.
inicializeFirestore(aplicativo, configurações, ID do banco de dados) (BETA) Obtém o serviço Firestore nomeado para o aplicativo específico, passando parâmetros extras para seu construtor.

Interfaces

Interface Descrição
Configurações do Firestore Configurações a serem passadas para o construtor do Firestore.

getFirestore()

Obtém o serviço padrão do Firestore para o aplicativo padrão.

Assinatura:

export declare function getFirestore(): Firestore;

Retorna:

Armazém de Fogo

O serviço padrão do Firestore para o aplicativo padrão.

Exemplo

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

getFirestore()

Obtém o serviço padrão do Firestore para o aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.

Retorna:

Armazém de Fogo

O serviço padrão do Firestore associado ao aplicativo fornecido.

Exemplo

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

getFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço nomeado do Firestore para o aplicativo padrão.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço Firestore nomeado para o aplicativo padrão.

Exemplo

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

getFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço nomeado do Firestore para o aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço nomeado do Firestore associado ao aplicativo fornecido.

Exemplo

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

inicializarFirestore()

Obtém o serviço padrão do Firestore para o aplicativo específico, passando parâmetros extras para seu construtor.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
configurações Configurações do Firestore Objeto de configurações a ser passado ao construtor.

Retorna:

Armazém de Fogo

O serviço padrão Firestore associado ao aplicativo e às configurações fornecidos.

Exemplo

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

inicializarFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço Firestore nomeado para o aplicativo específico, passando parâmetros extras para seu construtor.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
configurações Configurações do Firestore Objeto de configurações a ser passado ao construtor.
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço nomeado Firestore associado ao aplicativo e às configurações fornecidos.

Exemplo

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

Reexportações externas de API

As seguintes APIs definidas externamente são reexportadas deste ponto de entrada do módulo por conveniência.

Símbolo Descrição
Gravador em massa Tipo BulkWriter do pacote @google-cloud/firestore .
CampoAgregado Tipo AggregateField do pacote @google-cloud/firestore .
Opções de BulkWriter Tipo BulkWriterOptions do pacote @google-cloud/firestore .
Construtor de pacotes Tipo BundleBuilder do pacote @google-cloud/firestore .
Grupo de coleta Tipo CollectionGroup do pacote @google-cloud/firestore .
Referência de coleção Tipo CollectionReference do pacote @google-cloud/firestore .
Alteração de Documento Tipo DocumentChange do pacote @google-cloud/firestore .
DocumentData Tipo DocumentData do pacote @google-cloud/firestore .
Referência de Documento Tipo DocumentReference do pacote @google-cloud/firestore .
Instantâneo do documento Tipo DocumentSnapshot do pacote @google-cloud/firestore .
CampoCaminho Tipo FieldPath do pacote @google-cloud/firestore .
CampoValor Tipo FieldValue do pacote @google-cloud/firestore .
Filtro Tipo Filter do pacote @google-cloud/firestore .
Armazém de Fogo Tipo Firestore do pacote @google-cloud/firestore .
FirestoreDataConverter Tipo FirestoreDataConverter do pacote @google-cloud/firestore .
GeoPonto Tipo GeoPoint do pacote @google-cloud/firestore .
StatusGrpc Tipo GrpcStatus do pacote @google-cloud/firestore .
Condição prévia Tipo de Precondition do pacote @google-cloud/firestore .
Consulta Tipo Query do pacote @google-cloud/firestore .
QueryDocumentSnapshot Tipo QueryDocumentSnapshot do pacote @google-cloud/firestore .
Consultar Partição Tipo QueryPartition do pacote @google-cloud/firestore .
Consulta Instantâneo Tipo QuerySnapshot do pacote @google-cloud/firestore .
Opções de leitura Tipo ReadOptions do pacote @google-cloud/firestore .
Definir opções Tipo SetOptions do pacote @google-cloud/firestore .
Carimbo de data e hora Tipo de Timestamp do pacote @google-cloud/firestore .
Transação Tipo Transaction do pacote @google-cloud/firestore .
WriteBatch Tipo WriteBatch do pacote @google-cloud/firestore .
GravarResultado Tipo WriteResult do pacote @google-cloud/firestore .
setLogFunction Função setLogFunction do pacote @google-cloud/firestore .

Nuvem Firestore.

Funções

Função Descrição
getFirestore() Obtém o serviço padrão do Firestore para o aplicativo padrão.
obterFirestore(aplicativo) Obtém o serviço padrão do Firestore para o aplicativo específico.
getFirestore(databaseId) (BETA) Obtém o serviço Firestore nomeado para o aplicativo padrão.
getFirestore(aplicativo,databaseId) (BETA) Obtém o serviço Firestore nomeado para o aplicativo específico.
inicializarFirestore(aplicativo, configurações) Obtém o serviço padrão do Firestore para o aplicativo específico, passando parâmetros extras para seu construtor.
inicializeFirestore(aplicativo, configurações, ID do banco de dados) (BETA) Obtém o serviço Firestore nomeado para o aplicativo específico, passando parâmetros extras para seu construtor.

Interfaces

Interface Descrição
Configurações do Firestore Configurações a serem passadas para o construtor do Firestore.

getFirestore()

Obtém o serviço padrão do Firestore para o aplicativo padrão.

Assinatura:

export declare function getFirestore(): Firestore;

Retorna:

Armazém de Fogo

O serviço padrão do Firestore para o aplicativo padrão.

Exemplo

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

getFirestore()

Obtém o serviço padrão do Firestore para o aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.

Retorna:

Armazém de Fogo

O serviço padrão do Firestore associado ao aplicativo fornecido.

Exemplo

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

getFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço nomeado do Firestore para o aplicativo padrão.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço Firestore nomeado para o aplicativo padrão.

Exemplo

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

getFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço nomeado do Firestore para o aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço nomeado do Firestore associado ao aplicativo fornecido.

Exemplo

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

inicializarFirestore()

Obtém o serviço padrão do Firestore para o aplicativo específico, passando parâmetros extras para seu construtor.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
configurações Configurações do Firestore Objeto de configurações a ser passado ao construtor.

Retorna:

Armazém de Fogo

O serviço padrão Firestore associado ao aplicativo e às configurações fornecidos.

Exemplo

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

inicializarFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço Firestore nomeado para o aplicativo específico, passando parâmetros extras para seu construtor.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
configurações Configurações do Firestore Objeto de configurações a ser passado ao construtor.
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço nomeado Firestore associado ao aplicativo e às configurações fornecidos.

Exemplo

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

Reexportações externas de API

As seguintes APIs definidas externamente são reexportadas deste ponto de entrada do módulo por conveniência.

Símbolo Descrição
Gravador em massa Tipo BulkWriter do pacote @google-cloud/firestore .
CampoAgregado Tipo AggregateField do pacote @google-cloud/firestore .
Opções de BulkWriter Tipo BulkWriterOptions do pacote @google-cloud/firestore .
Construtor de pacotes Tipo BundleBuilder do pacote @google-cloud/firestore .
Grupo de coleta Tipo CollectionGroup do pacote @google-cloud/firestore .
Referência de coleção Tipo CollectionReference do pacote @google-cloud/firestore .
Alteração de Documento Tipo DocumentChange do pacote @google-cloud/firestore .
DocumentData Tipo DocumentData do pacote @google-cloud/firestore .
Referência de Documento Tipo DocumentReference do pacote @google-cloud/firestore .
Instantâneo do documento Tipo DocumentSnapshot do pacote @google-cloud/firestore .
CampoCaminho Tipo FieldPath do pacote @google-cloud/firestore .
CampoValor Tipo FieldValue do pacote @google-cloud/firestore .
Filtro Tipo Filter do pacote @google-cloud/firestore .
Armazém de Fogo Tipo Firestore do pacote @google-cloud/firestore .
FirestoreDataConverter Tipo FirestoreDataConverter do pacote @google-cloud/firestore .
GeoPonto Tipo GeoPoint do pacote @google-cloud/firestore .
StatusGrpc Tipo GrpcStatus do pacote @google-cloud/firestore .
Condição prévia Tipo de Precondition do pacote @google-cloud/firestore .
Consulta Tipo Query do pacote @google-cloud/firestore .
QueryDocumentSnapshot Tipo QueryDocumentSnapshot do pacote @google-cloud/firestore .
Consultar Partição Tipo QueryPartition do pacote @google-cloud/firestore .
Consulta Instantâneo Tipo QuerySnapshot do pacote @google-cloud/firestore .
Opções de leitura Tipo ReadOptions do pacote @google-cloud/firestore .
Definir opções Tipo SetOptions do pacote @google-cloud/firestore .
Carimbo de data e hora Tipo de Timestamp do pacote @google-cloud/firestore .
Transação Tipo Transaction do pacote @google-cloud/firestore .
WriteBatch Tipo WriteBatch do pacote @google-cloud/firestore .
GravarResultado Tipo WriteResult do pacote @google-cloud/firestore .
setLogFunction Função setLogFunction do pacote @google-cloud/firestore .

Nuvem Firestore.

Funções

Função Descrição
getFirestore() Obtém o serviço padrão do Firestore para o aplicativo padrão.
obterFirestore(aplicativo) Obtém o serviço padrão do Firestore para o aplicativo específico.
getFirestore(databaseId) (BETA) Obtém o serviço Firestore nomeado para o aplicativo padrão.
getFirestore(aplicativo,databaseId) (BETA) Obtém o serviço Firestore nomeado para o aplicativo específico.
inicializarFirestore(aplicativo, configurações) Obtém o serviço padrão do Firestore para o aplicativo específico, passando parâmetros extras para seu construtor.
inicializeFirestore(aplicativo, configurações, ID do banco de dados) (BETA) Obtém o serviço Firestore nomeado para o aplicativo específico, passando parâmetros extras para seu construtor.

Interfaces

Interface Descrição
Configurações do Firestore Configurações a serem passadas para o construtor do Firestore.

getFirestore()

Obtém o serviço padrão do Firestore para o aplicativo padrão.

Assinatura:

export declare function getFirestore(): Firestore;

Retorna:

Armazém de Fogo

O serviço padrão do Firestore para o aplicativo padrão.

Exemplo

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

getFirestore()

Obtém o serviço padrão do Firestore para o aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.

Retorna:

Armazém de Fogo

O serviço padrão do Firestore associado ao aplicativo fornecido.

Exemplo

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

getFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço nomeado do Firestore para o aplicativo padrão.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço Firestore nomeado para o aplicativo padrão.

Exemplo

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

getFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço nomeado do Firestore para o aplicativo específico.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço nomeado do Firestore associado ao aplicativo fornecido.

Exemplo

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

inicializarFirestore()

Obtém o serviço padrão do Firestore para o aplicativo específico, passando parâmetros extras para seu construtor.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
configurações Configurações do Firestore Objeto de configurações a ser passado ao construtor.

Retorna:

Armazém de Fogo

O serviço padrão Firestore associado ao aplicativo e às configurações fornecidos.

Exemplo

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

inicializarFirestore()

Esta API é fornecida como uma prévia para desenvolvedores e pode mudar com base no feedback que recebermos. Não use esta API em um ambiente de produção.

Obtém o serviço Firestore nomeado para o aplicativo específico, passando parâmetros extras para seu construtor.

Assinatura:

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

Parâmetros

Parâmetro Tipo Descrição
aplicativo Aplicativo qual serviço Firestore retornar.
configurações Configurações do Firestore Objeto de configurações a ser passado ao construtor.
ID do banco de dados corda nome do banco de dados a ser retornado.

Retorna:

Armazém de Fogo

O serviço nomeado Firestore associado ao aplicativo e às configurações fornecidos.

Exemplo

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