firebase-admin.database package

外部 API 再导出

为方便起见，系统会从此模块入口点重新导出以下外部定义的 API。

符号 说明
DataSnapshot @firebase/database-compat 软件包中的 DataSnapshot 类型。
EventType @firebase/database-compat 软件包中的 EventType 类型。
OnDisconnect @firebase/database-compat 软件包中的 OnDisconnect 类型。
查询 @firebase/database-compat 软件包中的 Query 类型。
参考文档 @firebase/database-compat 软件包中的 Reference 类型。
ThenableReference @firebase/database-compat 软件包中的 ThenableReference 类型。

Firebase Realtime Database。

函数

函数 说明
getDatabase(app) 获取默认应用或指定应用的 Database 服务。无需参数即可调用 getDatabase() 以访问默认应用的 Database 服务，或者以 getDatabase(app) 的形式调用与特定应用关联的 Database 服务。
getDatabaseWithUrl(url, app) 获取默认应用或指定应用的 Database 服务。无需参数即可调用 getDatabaseWithUrl() 以访问默认应用的 Database 服务，或者以 getDatabaseWithUrl(app) 的形式调用与特定应用关联的 Database 服务。

类

类 说明
FirebaseDatabaseError Firebase 数据库错误代码结构。这会扩展 FirebaseError。

接口

接口 说明
数据库 Firebase 数据库服务接口。扩展 @firebase/database-compat 软件包提供的 Database 接口。

变量

变量 说明
启用日志记录 @firebase/database-compat 软件包中的 enableLogging 函数。
ServerValue @firebase/database-compat 软件包中的 ServerValue 常量。

getDatabase(应用)

获取默认应用或给定应用的 Database 服务。

可以在不使用任何参数的情况下调用 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, app)

获取默认应用或给定应用的 Database 服务。

可以不使用任何参数调用 getDatabaseWithUrl() 来访问默认应用的 Database 服务，也可以通过 getDatabaseWithUrl(app) 的形式调用与特定应用关联的 Database 服务。

签名：

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

参数

参数 类型 说明
网址 字符串
应用 应用

返回：

数据库

如果未提供任何应用或与所提供的应用关联的 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);

启用日志记录

@firebase/database-compat 软件包中的 enableLogging 函数。

签名：

enableLogging: typeof rtdb.enableLogging

ServerValue

@firebase/database-compat 软件包中的 ServerValue 常量。

签名：

ServerValue: rtdb.ServerValue