database namespace

功能

功能描述
实例(实例)注册一个在特定 Firebase 实时数据库实例的事件上触发的函数。
参考(路径)注册一个在 Firebase 实时数据库写入事件上触发的函数。

课程

班级描述
数据快照表示 Firebase 实时数据库数据快照的接口。
实例生成器Firebase 实时数据库实例构建器界面。通过[ database.instance() ](providers_database_.html#instance)访问。
参考生成器Firebase 实时数据库参考构建器界面。通过[ functions.database.ref() ](functions.database#.ref)访问。

数据库.实例()

注册一个在特定 Firebase 实时数据库实例的事件上触发的函数。

将此方法与ref一起使用来指定要监视数据库事件的实例。例如: firebase.database.instance('my-app-db-2').ref('/foo/bar')

请注意,在没有instance下使用functions.database.ref会监视*default* 实例的事件。

签名:

export declare function instance(instance: string): InstanceBuilder;

参数

范围类型描述
实例细绳要监视写入事件的数据库实例的实例名称。

返回:

实例生成器

Firebase 实时数据库实例构建器界面。

数据库.ref()

注册一个在 Firebase 实时数据库写入事件上触发的函数。

此方法的行为与客户端和管理 Firebase SDK 中的同名方法非常相似。对数据库的任何更改会影响所提供path处或以下的数据,都将在 Cloud Functions 中触发事件。

在 Cloud Functions 中侦听实时数据库事件与在客户端和管理 SDK 中使用实时数据库之间存在三个重要区别:

  1. Cloud Functions 允许在path名称中使用通配符。大括号 ( {}中的任何path组件) 是匹配所有字符串的通配符。与 Cloud Function 的特定调用匹配的值作为 [ EventContext.params的一部分返回](cloud_functions_eventcontext.html#params 对象。例如, ref("messages/{messageId}")匹配/messages/message1/messages/message2处的更改,导致event.params.messageId设置为"message1""message2" , 分别。

  2. Cloud Functions 不会针对部署 Cloud Function 之前已存在的数据触发事件。

  3. 云函数事件可以访问更多信息,包括之前事件数据的快照以及触发云函数的用户信息。

签名:

export declare function ref<Ref extends string>(path: Ref): RefBuilder<Ref>;

参数

范围类型描述
小路参考号数据库中用于监视写入事件的路径。

返回:

参考生成器<参考>

Firebase 实时数据库构建器界面。