Realtime Database トリガー

Cloud Functions を使用すると、クライアント コードを更新することなく、Firebase Realtime Database 内のイベントを処理できます。Cloud Functions では、完全な管理者権限を使用してデータベース オペレーションを実行することができます。また、データベースに対する個々の変更がそれぞれ別個に処理されます。Firebase Realtime Database の変更は、DeltaSnapshot または Admin SDK を使用して実行できます。

一般的なライフサイクルの場合、Firebase Realtime Database の関数は以下のように機能します。

  1. 特定のデータベースに変更が加えられるのを待ちます。
  2. イベントが発生するとトリガーされ、そのタスクを実行します(ユースケースについては、Cloud Functions で可能な処理 をご覧ください)。
  3. 指定されたパスに保存されているデータの 2 つのスナップショット(変更前の元のデータのスナップショットと新しいデータのスナップショット)が格納された、イベントデータ オブジェクトを受け取ります。

データベース関数をトリガーする

functions.database を使用して、Realtime Database イベント用の新しい関数を作成します。関数がトリガーされるタイミングを制御するには、イベント ハンドラの 1 つを指定し、イベントをリッスンするデータベース パスを指定します。

イベント ハンドラを設定する

関数を使用して、2 つのレベルの特性でデータベース イベントを処理できます。作成イベント、更新イベント、または削除イベントのみリッスンすることも、パスに対するあらゆる種類の変更をリッスンすることもできます。Cloud Functions は、Realtime Database の以下のイベント ハンドラをサポートしています。

  • onWrite()。Realtime Database でデータが作成、更新または削除されるとトリガーされます。
  • onCreate()。Realtime Database で新しいデータが作成されるとトリガーされます。
  • onUpdate()。Realtime Database でデータが更新されるとトリガーされます。
  • onDelete()。Realtime Database でデータが削除されるとトリガーされます。

データベース インスタンスとパスを指定する

関数がトリガーされるタイミングと場所を制御するには、ref(path) を呼び出してパスを指定します。また、オプションで instance('INSTANCE_NAME') を使用してデータベース インスタンスを指定します。インスタンスを指定しないと、関数は Firebase プロジェクトのデフォルトのデータベース インスタンスにデプロイされます。次に例を示します。

  • デフォルトのデータベース インスタンス: functions.database.ref('/foo/bar')
  • 「my-app-db-2」という名前のインスタンス: functions.database.instance('my-app-db-2').ref('/foo/bar')

このメソッドは、データベース インスタンス内の特定のパスで書き込みを処理するよう関数に指示します。パスを指定すると、そのパスに関係するすべての書き込みが対象となり、これにはそのパス下のあらゆる場所で発生する書き込みが含まれます。関数のパスを /foo/bar として設定すると、次の場所のイベントはいずれもマッチ対象となります。

 /foo/bar
 /foo/bar/baz/really/deep/path

どちらの場合も、Firebase ではイベントが /foo/bar で発生したと解釈され、イベントデータには /foo/bar の古いデータと新しいデータが含まれます。イベントデータが大きい場合は、データベースのルート付近で単一の関数を使用する代わりに、より深いパスで複数の関数を使用することを検討してください。最高のパフォーマンスを得るには、できるだけ深いレベルのデータのみを要求するようにします。

パス コンポーネントは、中かっこで囲むことでワイルドカードとして指定できます。ref('foo/{bar}')/foo のすべての子と一致します。このワイルドカード パス コンポーネントの値は、関数の event.params オブジェクト内で使用できます。この例では、値は event.params.bar として使用可能になります。

ワイルドカードを含むパスは、1 つの書き込みの複数のイベントに一致する場合があります。次の挿入を見てみます。

{
  "foo": {
    "hello": "world",
    "firebase": "functions"
  }
}

これはパス "/foo/{bar}" と 2 回一致します。1 回目は "hello": "world" で、2 回目は "firebase": "functions" です。

イベントデータを処理する

Realtime Database イベントを処理する場合、event.dataDeltaSnapshot です。この例では、関数は指定されたパスの event.data を取得し、その場所の文字列を大文字に変換し、変更された文字列を場所 /messages/{pushId}/uppercased に書き込みます。

// Listens for new messages added to /messages/:pushId/original and creates an
// uppercase version of the message to /messages/:pushId/uppercase
exports.makeUppercase = functions.database.ref('/messages/{pushId}/original').onWrite((event) => {
  // Grab the current value of what was written to the Realtime Database.
  const original = event.data.val();
  console.log('Uppercasing', event.params.pushId, original);
  const uppercase = original.toUpperCase();
  // You must return a Promise when performing asynchronous tasks inside a Functions such as
  // writing to the Firebase Realtime Database.
  // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
  return event.data.ref.parent.child('uppercase').set(uppercase);
});

前の値を読み取る

DeltaSnapshot には、イベントの発生前にデータベースに何が保存されていたのかを調べることができる previous プロパティが用意されています。previous プロパティを使用すると別の DeltaSnapshot が返され、すべてのメソッド(val()exists() など)で前の値が参照されるようになります。新しい値を再度読み込むには、元の DeltaSnapshot を使用するか、任意の DeltaSnapshotcurrent プロパティを読み込んで、イベント発生後の値をそのまま読み取ります。

たとえば、previous プロパティを使用すると、makeUppercase() 関数を大文字のみの新しい値にすることができます。

exports.makeUppercase = functions.database.ref('/messages/{pushId}/original').onWrite((event) => {
      // Only edit data when it is first created.
      if (event.data.previous.exists()) {
        return null;
      }
      // Exit when the data is deleted.
      if (!event.data.exists()) {
        return null;
      }
  // Grab the current value of what was written to the Realtime Database.
  const original = event.data.val();
  console.log('Uppercasing', event.params.pushId, original);
  const uppercase = original.toUpperCase();
  // You must return a Promise when performing asynchronous tasks inside a Functions such as
  // writing to the Firebase Realtime Database.
  // Setting an "uppercase" sibling in the Realtime Database returns a Promise.
  return event.data.ref.parent.child('uppercase').set(uppercase);
    });

変更された値をモニタリングする

場合によっては、古い値は必要なく、データが変更されたかどうかだけがわかればよいこともあります。DeltaSnapshotchanged() 関数を使用すると、パスのデータが変更されたかどうかを確認できます。次の関数は、ユーザー プロフィールの変更によって profilePicture の値も変更された場合にのみ、createThumbnail() を呼び出します。

exports.thumbnailProfile = functions.database.ref('/profiles/{userID}')
  .onWrite(event => {
    var eventSnapshot = event.data;
    var profilePictureSnapshot = eventSnapshot.child('profilePicture');
    if (profilePictureSnapshot.changed()) {
      return createThumbnail(profilePictureSnapshot.val())
        .then(url => {
          return eventSnapshot.ref.update({ profileThumbnail: url });
        });
    }
  });

フィードバックを送信...

ご不明な点がありましたら、Google のサポートページをご覧ください。