firebase-admin.database package

Реэкспорт внешнего API

Следующие внешне определенные API для удобства реэкспортируются из этой точки входа модуля.

Символ Описание
Снимок данных Тип DataSnapshot из пакета @firebase/database-compat .
тип события Тип EventType из пакета @firebase/database-compat .
При отключении Тип OnDisconnect из пакета @firebase/database-compat .
Запрос Тип Query из пакета @firebase/database-compat .
Ссылка Reference тип из пакета @firebase/database-compat .
Тогдааблессылка Тип ThenableReference из пакета @firebase/database-compat .

База данных Firebase реального времени.

Функции

Функция Описание
getDatabase (приложение) Получает службу базы данных для приложения по умолчанию или данного приложения. getDatabase() можно вызвать без аргументов для доступа к службе Database приложения по умолчанию или как getDatabase(app) для доступа к службе Database , связанной с конкретным приложением.
getDatabaseWithUrl (url, приложение) Получает службу базы данных для приложения по умолчанию или данного приложения. getDatabaseWithUrl() можно вызвать без аргументов для доступа к службе базы данных приложения по умолчанию или как getDatabaseWithUrl(app) для доступа к службе базы данных , связанной с конкретным приложением.

Классы

Сорт Описание
FirebaseDatabaseError Структура кода ошибки базы данных Firebase. Это расширяет FirebaseError.

Интерфейсы

Интерфейс Описание
База данных Интерфейс службы базы данных Firebase. Расширяет интерфейс базы данных , предоставляемый пакетом @firebase/database-compat .

Переменные

Переменная Описание
включить ведение журнала EnableLogging из пакета @firebase/database-compat .
Сервервалуе Константа ServerValue из пакета @firebase/database-compat .

getDatabase (приложение)

Получает службу базы данных для приложения по умолчанию или данного приложения.

getDatabase() можно вызвать без аргументов для доступа к службе Database приложения по умолчанию или как getDatabase(app) для доступа к службе Database , связанной с конкретным приложением.

Подпись:

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

Параметры

Параметр Тип Описание
приложение Приложение

Возврат:

База данных

Служба Database по умолчанию, если приложение не предоставлено, или служба Database , связанная с предоставленным приложением.

Пример 1

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

Пример 2

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

getDatabaseWithUrl (url, приложение)

Получает службу базы данных для приложения по умолчанию или данного приложения.

getDatabaseWithUrl() можно вызвать без аргументов для доступа к службе базы данных приложения по умолчанию или как getDatabaseWithUrl(app) для доступа к службе базы данных , связанной с конкретным приложением.

Подпись:

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

Параметры

Параметр Тип Описание
URL нить
приложение Приложение

Возврат:

База данных

Служба Database по умолчанию, если приложение не предоставлено, или служба Database , связанная с предоставленным приложением.

Пример 1

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

Пример 2

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

включить ведение журнала

EnableLogging из пакета @firebase/database-compat .

Подпись:

enableLogging: typeof rtdb.enableLogging

значение сервера

Константа ServerValue из пакета @firebase/database-compat .

Подпись:

ServerValue: rtdb.ServerValue