firebase-admin.database package

Reexportações da API externa

Por conveniência, as APIs definidas externamente abaixo são reexportadas desse ponto de entrada do módulo.

Símbolo Descrição
DataSnapshot (em inglês) Tipo DataSnapshot do pacote @firebase/database-compat.
EventType Tipo EventType do pacote @firebase/database-compat.
OnDesconectar Tipo OnDisconnect do pacote @firebase/database-compat.
Consulta Tipo Query do pacote @firebase/database-compat.
Referência Tipo Reference do pacote @firebase/database-compat.
thenableReference (link em inglês) Tipo ThenableReference do pacote @firebase/database-compat.

Firebase Realtime Database.

Funções

Função Descrição
getDatabase(app) (em inglês) Recebe o serviço Database para o app padrão ou para um determinado app.getDatabase() pode ser chamado sem argumentos para acessar o serviço Database do app padrão ou como getDatabase(app) para acessar o serviço Database associado a um app específico.
getDatabaseWithUrl(url, app) Recebe o serviço Database para o app padrão ou um determinado app.getDatabaseWithUrl() pode ser chamado sem argumentos para acessar o serviço Database do app padrão ou como getDatabaseWithUrl(app) para acessar o serviço Database associado a um app específico.

Classes

Turma Descrição
FirebaseDatabaseError (em inglês) Estrutura do código de erro do Firebase Database. Isso estende FirebaseError.

Interfaces

Interface Descrição
banco de dados A interface do serviço do Firebase Database. Estende a interface do Database fornecida pelo pacote @firebase/database-compat.

Variáveis

Variável Descrição
enableLogging (em inglês) enableLogging do pacote @firebase/database-compat.
ServerValue (em inglês) ServerValue do pacote @firebase/database-compat.

getDatabase(app)

Recebe o serviço Database do app padrão ou de um determinado app.

O getDatabase() pode ser chamado sem argumentos para acessar o serviço Database do app padrão ou como getDatabase(app) para acessar o serviço Database associado a um app específico.

Assinatura:

export declare function getDatabase(app?: App): Database;

Parâmetros

Parâmetro Tipo Descrição
app App

Retorna:

banco de dados

O serviço Database padrão, se nenhum app for fornecido, ou o serviço Database associado ao app fornecido.

Exemplo 1

// Get the Database service for the default app
const defaultDatabase = getDatabase();

Exemplo 2

// Get the Database service for a specific app
const otherDatabase = getDatabase(app);

getDatabaseWithUrl(url; app)

Recebe o serviço Database do app padrão ou de um determinado app.

O getDatabaseWithUrl() pode ser chamado sem argumentos para acessar o serviço Database do app padrão ou como getDatabaseWithUrl(app) para acessar o serviço Database associado a um app específico.

Assinatura:

export declare function getDatabaseWithUrl(url: string, app?: App): Database;

Parâmetros

Parâmetro Tipo Descrição
url string
app App

Retorna:

banco de dados

O serviço Database padrão, se nenhum app for fornecido, ou o serviço Database associado ao app fornecido.

Exemplo 1

// Get the Database service for the default app
const defaultDatabase = getDatabaseWithUrl('https://example.firebaseio.com');

Exemplo 2

// Get the Database service for a specific app
const otherDatabase = getDatabaseWithUrl('https://example.firebaseio.com', app);

ativarGeração de registros

enableLogging do pacote @firebase/database-compat.

Assinatura:

enableLogging: typeof rtdb.enableLogging

ServerValue

ServerValue do pacote @firebase/database-compat.

Assinatura:

ServerValue: rtdb.ServerValue