database namespace

関数

関数	説明
instance(instance)	特定の Firebase Realtime Database インスタンスからのイベントでトリガーする関数を登録します。
ref(パス)	Firebase Realtime Database の書き込みイベントでトリガーする関数を登録します。

クラス

クラス	説明
DataSnapshot	Firebase Realtime Database のデータ スナップショットを表すインターフェース。
InstanceBuilder	Firebase Realtime Database インスタンス ビルダーのインターフェース。[database.instance()]（providers_database_.html#instance）を介してアクセスします。
RefBuilder	Firebase Realtime Database リファレンス ビルダーのインターフェース。[functions.database.ref()]（functions.database#.ref）経由でアクセスします。

database.instance()

特定の Firebase Realtime Database インスタンスからのイベントでトリガーする関数を登録します。

このメソッドを ref とともに使用して、データベース イベントを監視するインスタンスを指定します。例: firebase.database.instance('my-app-db-2').ref('/foo/bar')

instance なしで使用した functions.database.ref は、*デフォルト* のインスタンスでイベントを監視します。

署名:

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

パラメータ

パラメータ	型	説明
インスタンス	文字列	書き込みイベントを監視するデータベース インスタンスのインスタンス名。

戻り値:

InstanceBuilder

Firebase Realtime Database インスタンス ビルダー インターフェース。

database.ref()

Firebase Realtime Database の書き込みイベントでトリガーする関数を登録します。

このメソッドは、クライアント SDK と Admin Firebase SDK の同じ名前のメソッドと非常によく似た動作をします。データベースに変更を加えると、指定した path 以下のデータに影響すると、Cloud Functions でイベントが発生します。

Cloud Functions で Realtime Database イベントをリッスンする場合と、クライアント SDK や Admin SDK で Realtime Database を使用する場合には、次の 3 つの重要な違いがあります。

1. Cloud Functions では、path 名にワイルドカードを使用できます。中かっこ（{}）で囲まれた path 要素は、すべての文字列に一致するワイルドカードです。Cloud Functions の特定の呼び出しに一致する値は、[EventContext.params](cloud_functions_eventcontext.html#params オブジェクト) の一部として返されます。たとえば、ref("messages/{messageId}") は /messages/message1 または /messages/message2 の変更と一致し、event.params.messageId はそれぞれ "message1" または "message2" に設定されます。

2. Cloud Functions は、その関数がデプロイされる前に存在していたデータに対してイベントを発生させません。

3. Cloud Functions のイベントは、以前のイベントデータのスナップショットや、Cloud Functions の関数をトリガーしたユーザーに関する情報など、より詳しい情報にアクセスできます。

署名:

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

パラメータ

パラメータ	型	説明
パス	Ref	書き込みイベントを監視するデータベース内のパス。

戻り値:

RefBuilder<Ref>

Firebase Realtime Database ビルダー インターフェース。