Firebase Realtime Database
関数
| 関数 | 説明 |
|---|---|
| function(app, ...) | |
| getDatabase(app, url) | 指定された FirebaseApp に関連付けられている Realtime Database SDK のインスタンスを返します。インスタンスが存在しない場合、または既存のインスタンスがカスタム データベース URL を使用している場合、デフォルト設定で新しいインスタンスを初期化します。 |
| function(db, ...) | |
| connectDatabaseEmulator(db, host, port, options) | 提供されたインスタンスを変更して、Realtime Database エミュレータと通信します。 注: このメソッドは、他の処理を実行する前に呼び出す必要があります。 |
| goOffline（db） | サーバーからの切断（すべてのデータベース オペレーションはオフラインで完了します）。クライアントはデータベース サーバーへの永続的な接続を自動的に維持します。この接続は無期限にアクティブな状態を保ち、切断されると再接続します。ただし、永続的な接続が望ましくない場合は、goOffline() メソッドと goOnline() メソッドを使用してクライアント接続を制御できます。オフラインの間、クライアントはデータベースからデータ更新を受信しなくなります。ただし、ローカルで実行されるすべてのデータベース オペレーションは引き続きすぐにイベントを発生させるため、アプリケーションは通常どおりに動作します。また、ローカルで実行された各オペレーションは自動的にキューに格納され、データベース サーバーに再接続すると再試行されます。データベースに再接続してリモート イベントの受信を開始するには、goOnline() をご覧ください。 |
| goOnline（db） | サーバーに再接続し、オフラインのデータベースの状態をサーバーの状態と同期します。このメソッドは、goOffline() でアクティブな接続を無効にした後に使用する必要があります。再接続されると、クライアントは適切なデータを送信し、適切なイベントを発生させ、クライアントが「キャッチアップ」します。自動的に適用されます。 |
| ref(db, パス) | 指定されたパスに対応するデータベース内の場所を表す Reference を返します。パスが指定されていない場合、Reference はデータベースのルートを指します。 |
| refFromURL(db, url) | 指定された Firebase URL に対応するデータベース内の場所を表す Reference を返します。URL が有効な Firebase データベースの URL でない場合、または現在の Database インスタンスとは異なるドメインがある場合は、例外がスローされます。クエリ パラメータ（orderBy、limitToLast など）はすべて無視され、返される Reference には適用されません。 |
| function（） | |
| forceLongPolling() | WebSocket の代わりに longPolling の使用を強制します。databaseURL で WebSocket プロトコルが使用されている場合は無視されます。 |
| forceWebSockets() | longPolling ではなく WebSocket の使用を強制。 |
| orderByKey() | キーで並べ替える新しい QueryConstraint を作成します。クエリの結果をキー値（昇順）で並べ替えます。orderByKey() の詳細については、データを並べ替えるをご覧ください。 |
| orderByPriority() | 優先度順に並べる新しい QueryConstraint を作成します。アプリケーションは優先度を使用する必要はありませんが、通常のプロパティによってコレクションを並べ替えることができます（優先度に代わる選択肢については、データの並べ替えをご覧ください）。 |
| orderByValue() | 値で並べ替える新しい QueryConstraint を作成します。クエリの子がすべてスカラー値（文字列、数値、ブール値）の場合は、結果（昇順）で並べ替えることができます。orderByValue() の詳細については、データの並べ替えをご覧ください。 |
| serverTimestamp() | Firebase サーバーによって決定された現在のタイムスタンプ（Unix エポックからの経過時間、ミリ秒単位）を自動入力するためのプレースホルダ値を返します。 |
| 関数(delta, ...) | |
| インクリメント（デルタ） | 現在のデータベース値を指定された差分だけアトミックに増分するために使用できるプレースホルダ値を返します。 |
| function(enabled, ...) | |
| enableLogging(enabled, persistent) | デバッグ情報をコンソールに記録します。 |
| function(limit, ...) を参照してください。 | |
| limitToFirst(limit) | 最初の特定の子数に制限される場合、新しい QueryConstraint を作成します。limitToFirst() メソッドは、特定のコールバックに対して同期する子の最大数を設定するために使用します。上限を 100 に設定した場合、最初は最大 100 個の child_added イベントしか受信されません。データベースに保存されているメッセージが 100 個未満の場合、メッセージごとに child_added イベントが発生します。ただし、100 件を超えるメッセージがある場合、並べ替えられた最初の 100 件のメッセージについてのみ child_added イベントを受け取ります。アイテムが変更されると、アクティブ リストから外れるアイテムごとに child_removed イベントを受け取り、合計数は 100 に保たれます。limitToFirst() について詳しくは、データのフィルタリングをご覧ください。 |
| limitToLast(limit) | 最後に指定された数の子のみを返すように制限された新しい QueryConstraint を作成します。limitToLast() メソッドは、特定のコールバックに対して同期する子の最大数を設定するために使用されます。上限を 100 に設定した場合、最初は最大 100 個の child_added イベントしか受信されません。データベースに保存されているメッセージが 100 個未満の場合、メッセージごとに child_added イベントが発生します。ただし、100 件を超えるメッセージがある場合、並べ替えられた直近の 100 件のメッセージについてのみ child_added イベントを受け取ります。アイテムが変更されると、アクティブ リストから外れるアイテムごとに child_removed イベントを受け取り、合計数は 100 に保たれます。limitToLast() について詳しくは、データのフィルタリングをご覧ください。 |
| function(logger, ...) を参照してください。 | |
| enableLogging(logger) | デバッグ情報をコンソールに記録します。 |
| 関数(親, ...) | |
| 子(親, パス) | 指定された相対パスにある場所の Reference を取得します。相対パスには、単純な子名（「ada」など）か、より深いスラッシュで区切られたパス（「ada/name/first」など）を使用できます。 |
| push(parent, value) | 一意のキーを使用して新しい子の場所を生成し、その Reference を返します。これはアイテムのコレクションにデータを追加する最も一般的なパターンです。push() に値を指定すると、生成された場所に値が書き込まれます。値を渡さなかった場合、データベースには何も書き込まれず、子は空のままになります（ただし、Reference は他の場所で使用できます）。push() によって生成された一意のキーは現在の時刻で並べ替えられるため、結果のアイテムリストは時系列で並べ替えられます。また、鍵は推測不可に設計されています（72 個のランダムなエントロピーが含まれます）。データのリストに追加するをご覧ください。一意の ID を確保する 2^120 の方法をご覧ください。 |
| function(path, ...) を参照してください。 | |
| orderByChild(path) | 指定された子キーで並べ替える新しい QueryConstraint を作成します。クエリは一度に 1 つのキーでのみ並べ替えることができます。同じクエリで orderByChild() を複数回呼び出すとエラーになります。Firebase クエリを使用すると、任意の子キーでその場でデータを並べ替えることができます。ただし、インデックスの内容が事前にわかっている場合は、セキュリティ ルールの .indexOn ルールを使用してインデックスを定義し、パフォーマンスを向上させることができます。詳しくは、https://firebase.google.com/docs/database/security/indexing-data ルールをご覧ください。orderByChild() について詳しくは、データの並べ替えをご覧ください。 |
| function(query, ...) | |
| get(query) | このクエリの最新の結果を取得します。 |
| off(query, eventType, callback) | 対応する on() （onValue, onChildAdded）リスナーに以前にアタッチされていたコールバックをデタッチします。注: リスナーを削除する方法としては、おすすめしません。代わりに、それぞれの on コールバックから返されたコールバック関数を使用してください。以前に on*() でアタッチされたコールバックをデタッチします。親リスナーで off() を呼び出しても、子ノードに登録されているリスナーが自動的に削除されるわけではありません。コールバックを削除するには、子リスナーでも off() も呼び出す必要があります。コールバックが指定されていない場合、指定した eventType のすべてのコールバックが削除されます。同様に、eventType が指定されていない場合、Reference のコールバックはすべて削除されます。個々のリスナーは、登録解除のコールバックを呼び出すことで削除することもできます。 |
| onChildAdded(query, callback, cancelCallback) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildAdded イベントは、この場所にある最初の子ごとに 1 回トリガーされます。また、新しい子が追加されるたびに、再びトリガーされます。コールバックに渡される DataSnapshot には、関連する子のデータが反映されます。並べ替えのために、2 番目の引数が渡されます。これは、前の兄弟子のキーが並べ替え順で格納された文字列です。最初の子である場合は null になります。 |
| onChildAdded(クエリ, コールバック, オプション) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildAdded イベントは、この場所にある最初の子ごとに 1 回トリガーされます。また、新しい子が追加されるたびに、再びトリガーされます。コールバックに渡される DataSnapshot には、関連する子のデータが反映されます。並べ替えのために、2 番目の引数が渡されます。これは、前の兄弟子のキーが並べ替え順で格納された文字列です。最初の子である場合は null になります。 |
| onChildAdded(query, callback, cancelCallback, options) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildAdded イベントは、この場所にある最初の子ごとに 1 回トリガーされます。また、新しい子が追加されるたびに、再びトリガーされます。コールバックに渡される DataSnapshot には、関連する子のデータが反映されます。並べ替えのために、2 番目の引数が渡されます。これは、前の兄弟子のキーが並べ替え順で格納された文字列です。最初の子である場合は null になります。 |
| onChildChanged(query, callback, cancelCallback) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上のデータを取得するをご覧ください。onChildChanged イベントは、子（またはその子孫）に保存されているデータが変更されるとトリガーされます。1 つの child_changed イベントで、子に対する複数の変更を表すことができます。コールバックに渡される DataSnapshot には、新しい子コンテンツが含まれます。並べ替えのため、コールバックには 2 番目の引数も渡されます。これは、前の兄弟子のキーを含む文字列を並べ替え順序順に並べたものです。最初の子である場合は null になります。 |
| onChildChanged(クエリ, コールバック, オプション) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上のデータを取得するをご覧ください。onChildChanged イベントは、子（またはその子孫）に保存されているデータが変更されるとトリガーされます。1 つの child_changed イベントで、子に対する複数の変更を表すことができます。コールバックに渡される DataSnapshot には、新しい子コンテンツが含まれます。並べ替えのため、コールバックには 2 番目の引数も渡されます。これは、前の兄弟子のキーを含む文字列を並べ替え順序順に並べたものです。最初の子である場合は null になります。 |
| onChildChanged(query, call, cancelCallback, options) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上のデータを取得するをご覧ください。onChildChanged イベントは、子（またはその子孫）に保存されているデータが変更されるとトリガーされます。1 つの child_changed イベントで、子に対する複数の変更を表すことができます。コールバックに渡される DataSnapshot には、新しい子コンテンツが含まれます。並べ替えのため、コールバックには 2 番目の引数も渡されます。これは、前の兄弟子のキーを含む文字列を並べ替え順序順に並べたものです。最初の子である場合は null になります。 |
| onChildMoved(query, callback, cancelCallback) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildMoved イベントは、子の並べ替え順序が、兄弟要素に対する相対的な位置が変わるとトリガーされます。コールバックに渡される DataSnapshot は、移動した子のデータ用です。また、2 番目の引数にも渡されます。これは、前の兄弟の子のキーを並べ替え順で含む文字列です。子が最初の子である場合は null です。 |
| onChildMoved(クエリ, コールバック, オプション) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildMoved イベントは、子の並べ替え順序が、兄弟要素に対する相対的な位置が変わるとトリガーされます。コールバックに渡される DataSnapshot は、移動した子のデータ用です。また、2 番目の引数にも渡されます。これは、前の兄弟の子のキーを並べ替え順で含む文字列です。子が最初の子である場合は null です。 |
| onChildMoved(query, callback, cancelCallback, options) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildMoved イベントは、子の並べ替え順序が、兄弟要素に対する相対的な位置が変わるとトリガーされます。コールバックに渡される DataSnapshot は、移動した子のデータ用です。また、2 番目の引数にも渡されます。これは、前の兄弟の子のキーを並べ替え順で含む文字列です。子が最初の子である場合は null です。 |
| onChildRemoved(query, callback, cancelCallback) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildRemoved イベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡される DataSnapshot は、削除された子の古いデータになります。次のいずれかが発生すると、子が削除されます。- クライアントがその子またはその祖先の 1 つに対して明示的に remove() を呼び出した場合。クライアントがその子またはその祖先の 1 つで set(null) を呼び出した場合、子がすべて子が削除された場合、実際に子が除外されます（並べ替え順序が変更されたか、上限に達したため）。 |
| onChildRemoved(クエリ, コールバック, オプション) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildRemoved イベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡される DataSnapshot は、削除された子の古いデータになります。次のいずれかが発生すると、子が削除されます。- クライアントがその子またはその祖先の 1 つに対して明示的に remove() を呼び出した場合。クライアントがその子またはその祖先の 1 つで set(null) を呼び出した場合、子がすべて子が削除された場合、実際に子が除外されます（並べ替え順序が変更されたか、上限に達したため）。 |
| onChildRemoved(クエリ, コールバック, cancelCallback, オプション) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onChildRemoved イベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡される DataSnapshot は、削除された子の古いデータになります。次のいずれかが発生すると、子が削除されます。- クライアントがその子またはその祖先の 1 つに対して明示的に remove() を呼び出した場合。クライアントがその子またはその祖先の 1 つで set(null) を呼び出した場合、子がすべて子が削除された場合、実際に子が除外されます（並べ替え順序が変更されたか、上限に達したため）。 |
| onValue(query, callback, cancelCallback) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onValue イベントは、この場所に保存された初期データで 1 回トリガーされます。その後、データが変更されるたびに再びトリガーされます。コールバックに渡される DataSnapshot は、on() が呼び出された場所に対するものになります。コンテンツ全体が同期されるまでトリガーされません。ビジネスにデータがない場合は、空の DataSnapshot でトリガーされます（val() は null を返します）。 |
| onValue(クエリ, コールバック, オプション) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onValue イベントは、この場所に保存された初期データで 1 回トリガーされます。その後、データが変更されるたびに再びトリガーされます。コールバックに渡される DataSnapshot は、on() が呼び出された場所に対するものになります。コンテンツ全体が同期されるまでトリガーされません。ビジネスにデータがない場合は、空の DataSnapshot でトリガーされます（val() は null を返します）。 |
| onValue(query, call, cancelCallback, options) | 特定の場所でデータの変更をリッスンします。これは、データベースからデータを読み取る基本的な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。onValue イベントは、この場所に保存された初期データで 1 回トリガーされます。その後、データが変更されるたびに再びトリガーされます。コールバックに渡される DataSnapshot は、on() が呼び出された場所に対するものになります。コンテンツ全体が同期されるまでトリガーされません。ビジネスにデータがない場合は、空の DataSnapshot でトリガーされます（val() は null を返します）。 |
| query(query, queryConstraints) | 追加のクエリ制約も含まれるように拡張された Query の新しい不変インスタンスを作成します。 |
| function(ref, ...) | |
| onDisconnect(ref) | OnDisconnect オブジェクトを返します。使用方法については、JavaScript でのオフライン機能の有効化をご覧ください。 |
| remove(ref) | このデータベースの場所のデータを削除します。子の場所のデータもすべて削除されます。削除の結果はすぐに表示され、対応するイベントの「value」が表示されます。トリガーされます削除と Firebase サーバーの同期も開始され、完了すると、返された Promise が解決されます。指定すると、同期の完了後に onComplete コールバックが非同期的に呼び出されます。 |
| runTransaction(ref, transactionUpdate, options) | この場所にあるデータをアトミックに変更します。この場所にあるデータをアトミックに変更します。以前の値に関係なくデータを上書きする通常の set() とは異なり、runTransaction() を使用して既存の値を新しい値に変更し、同時に同じ場所に書き込む他のクライアントとの競合が発生しないようにします。これを実現するには、現在の値を新しい値に変換するために使用される update 関数を runTransaction() に渡します。新しい値が正常に書き込まれる前に別のクライアントがそのロケーションに書き込むと、更新関数が新しい現在の値で再度呼び出され、書き込みが再試行されます。これは、競合なしで書き込みが成功するか、更新関数から値を返さずにトランザクションを中止するまで繰り返されます。注: set() を使用してデータを変更すると、その場所で保留中のトランザクションがキャンセルされるため、set() と runTransaction() を組み合わせて同じデータを更新する場合は、細心の注意を払ってください。注: セキュリティ ルールと Firebase ルールが有効なトランザクションを使用する場合、トランザクションを実行するには、トランザクションを実行するために .write アクセスに加えて .read アクセスが必要です。これは、トランザクションのクライアントサイドの性質上、トランザクションによってデータを更新するために、クライアントがデータを読み取る必要があるためです。 |
| set(ref, value) | このデータベースの場所にデータを書き込みます。これにより、この場所にあるすべてのデータが上書きされます。書き込みの結果がすぐに表示され、対応するイベント（"value"、"child_added" など）がトリガーされます。Firebase サーバーへのデータの同期も開始され、完了すると、返された Promise が解決されます。指定すると、同期の完了後に onComplete コールバックが非同期で呼び出されます。新しい値に null を渡すと、remove() を呼び出すのと同じ結果になります。つまり、この場所のデータとすべての子の場所のデータが削除されます。set() はこの場所にあるすべての優先度を削除するため、優先度を保持する場合は、代わりに setWithPriority() を使用する必要があります。set() を使用してデータを変更すると、その場所で保留中のトランザクションがすべてキャンセルされるため、set() と transaction() を組み合わせて同じデータを変更する場合は、細心の注意を払ってください。単一の set() で 1 つの「値」が生成される場合は、細心の注意を払ってください。set() が実行された場所で開催します。 |
| setPriority(ref, 優先値) | このデータベースのロケーションにあるデータの優先度を設定します。アプリケーションで優先度を使用する必要はありませんが、通常のプロパティによってコレクションを並べ替えることができます（データの並べ替えとフィルタを参照）。 |
| setWithPriority(ref, value, 優先) | データベースのロケーションにデータを書き込みます。set() に似ていますが、データの優先度も指定します。アプリケーションでは優先度を指定する必要はありませんが、通常のプロパティでコレクションの順序を指定できます（データの並べ替えとフィルタをご覧ください）。 |
| update(ref, values) | 複数の値をデータベースに一度に書き込みます。values 引数には、データベースに一緒に書き込まれる複数のプロパティと値のペアが含まれます。子プロパティは、シンプルなプロパティ（「name」など）か、現在の場所から更新するデータまでの相対パス（「name/first」など）のいずれかです。update() を使用すると、（現在の場所にあるすべての子プロパティを置き換えるのではなく）set() メソッドとは異なり、参照されているプロパティのみを選択的に更新できます。書き込みの効果はすぐに確認でき、対応するイベント（'_value）が追加されます。',Firebase サーバーへのデータの同期も開始され、完了すると、返された Promise が解決されます。指定すると、同期の完了後に onComplete コールバックが非同期で呼び出されます。1 つの update() で 1 つの「値」が生成されます。イベントは、update() が実行された場所で、変更した子の数にかかわらず発生します。update() を使用してデータを変更すると、その場所で保留中のトランザクションがすべてキャンセルされるため、update() と transaction() を混在させて同じデータを変更する場合は、細心の注意を払ってください。update() に null を渡すと、この場所のデータが削除されます。複数の場所での更新などの導入をご覧ください。 |
| function(value, ...) | |
| endAt(値, キー) | 指定された終点を持つ QueryConstraint を作成します。startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリの任意の始点と終点を選択できます。終点は包括的であるため、指定した値だけを持つ子がクエリに含まれます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。指定する場合、正確に指定された値を持つ子は、指定されたキー以下のキー名も持つ必要があります。endAt() の詳細については、データのフィルタリングをご覧ください。 |
| endBefore(値, キー) | 指定された終点（含まない）を持つ QueryConstraint を作成します。startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリの任意の始点と終点を選択できます。終点は排他的です。値のみを指定した場合、指定した値より小さい値を持つ子がクエリに含まれます。キーを指定する場合、子は指定された値以下の値と、指定されたキーより小さいキー名を持つ必要があります。 |
| equalTo(value, key) | 指定された値に一致する子を含む QueryConstraint を作成します。startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリの任意の始点と終点を選択できます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。指定した場合、正確に指定された値を持つ子は、指定されたキーもキー名として持つ必要があります。これは、同じ値で多数の一致がある結果セットをフィルタするために使用できます。equalTo() の詳細については、データのフィルタリングをご覧ください。 |
| startAfter(value, key) | 指定された始点（この点を含まない）で QueryConstraint を作成します。startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリの任意の始点と終点を選択できます。始点は排他的です。値のみを指定すると、指定した値より大きい値を持つ子がクエリに含まれます。キーを指定する場合、子は指定された値以上の値と、指定されたキーより大きいキー名を持つ必要があります。 |
| startAt(value, キー) | 指定された始点で QueryConstraint を作成します。startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリの任意の始点と終点を選択できます。始点は包括的であるため、正確に指定された値を持つ子がクエリに含まれます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。指定する場合、正確に指定された値を持つ子は、指定されたキー以上のキー名を持つ必要もあります。startAt() の詳細については、データのフィルタリングをご覧ください。 |
クラス
| クラス | 説明 |
|---|---|
| データベース | Firebase Realtime Database を表すクラス。 |
| DataSnapshot | DataSnapshot にはデータベースのロケーションのデータが含まれています。データベースからデータを読み取るたびに、データは DataSnapshot として受け取ります。DataSnapshot は、on() または once() でアタッチしたイベント コールバックに渡されます。スナップショットの内容を JavaScript オブジェクトとして抽出するには、val() メソッドを呼び出します。または、child() を呼び出して子スナップショットを返すことで、スナップショットをトラバースすることもできます（その後、val() を呼び出すことができます）。DataSnapshot は、データベースのロケーションにあるデータの、効率的に生成され、不変のコピーです。変更できず、変更されることはありません（データを変更する場合は、必ず Reference の set() メソッドを直接呼び出します）。 |
| OnDisconnect | onDisconnect クラスを使用すると、クライアントがデータベース サーバーから接続を解除したときに、データの書き込みやクリアを行うことができます。これらの更新は、クライアントが正常に切断されたかどうかにかかわらず行われるため、接続の切断やクライアントがクラッシュした場合でも、この機能を利用してデータをクリーンアップできます。onDisconnect クラスは、接続されているクライアントの数や他のクライアントがいつ切断されたかを検出するのに役立つアプリケーションでのプレゼンスを管理するためによく使用されます。詳しくは、JavaScript でのオフライン機能の有効化をご覧ください。リクエストをデータベース サーバーに転送する前に接続が切断された場合の問題を回避するには、データを書き込む前にこれらの関数を呼び出す必要があります。onDisconnect オペレーションは 1 回だけトリガーされます。切断が発生するたびにオペレーションが発生するようにするには、再接続するたびに onDisconnect オペレーションを再確立する必要があります。 |
| QueryConstraint | QueryConstraint は、データベース クエリによって返されるドキュメントのセットを絞り込むために使用します。QueryConstraintQueryConstraint |
| TransactionResult | runTransaction() の解決値の型。 |
インターフェース
| インターフェース | 説明 |
|---|---|
| DatabaseReference | DatabaseReference はデータベース内の特定の場所を表し、そのデータベースの場所に対するデータの読み書きに使用できます。ref() または ref("child/path") を呼び出すと、データベース内のルートまたは子の場所を参照できます。書き込みは set() メソッドで、読み取りは on*() メソッドで実行します。https://firebase.google.com/docs/database/web/read-and-write をご覧ください。 |
| IteratedDataSnapshot | 反復処理されている Reference の子スナップショットを表します。キーが未定義になることはありません。 |
| ListenOptions | リスナーのカスタマイズに使用できるオプション オブジェクト。 |
| クエリ | Query は、Database の場所にあるデータの並べ替えとフィルタを行い、子データのサブセットのみが含まれるようにします。これを使用して、データのコレクションをなんらかの属性（恐竜の身長など）で並べ替えたり、多数のアイテム（チャット メッセージなど）をクライアントと同期するのに適切な数に制限したりできます。クエリは、ここで定義した 1 つ以上のフィルタ メソッドを連結して作成されます。DatabaseReference と同様に、on*() メソッドを使用して Query からデータを受け取ることができます。クエリに一致するデータのサブセットに関するイベントと DataSnapshot のみを受信します。詳しくは、https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data をご覧ください。 |
| thenableReference | push() によって返されたときに DatabaseReference としても機能する Promise。参照はすぐに利用可能になり、バックエンドへの書き込みが完了すると Promise が解決されます。 |
| TransactionOptions | トランザクションを構成するオプション オブジェクト。 |
型エイリアス
| 型エイリアス | 説明 |
|---|---|
| イベントタイプ | 文字列「value」、「child_added」、「child_changed」、「child_removed」、「child_moved」のいずれか。 |
| QueryConstraintType | この SDK で使用できるさまざまなクエリ制約について説明します。 |
| 配信停止 | リスナーを削除するために呼び出すことができるコールバック。 |
関数（アプリ、...）
getDatabase(アプリ, URL)
指定された FirebaseApp に関連付けられている Realtime Database SDK のインスタンスを返します。インスタンスが存在しない場合、または既存のインスタンスがカスタム データベース URL を使用している場合、デフォルト設定で新しいインスタンスを初期化します。
署名:
export declare function getDatabase(app?: FirebaseApp, url?: string): Database;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| アプリ | FirebaseApp | 返された Realtime Database インスタンスが関連付けられている FirebaseApp インスタンス。 |
| URL | 文字列 | 接続先の Realtime Database インスタンスの URL。指定しない場合、SDK は Firebase アプリのデフォルト インスタンスに接続します。 |
戻り値:
指定されたアプリの Database インスタンス。
function(db, ...)
connectDatabaseEmulator（db、host、port、オプション）
提供されたインスタンスを変更して、Realtime Database エミュレータと通信します。
注: このメソッドは、他の処理を実行する前に呼び出す必要があります。
署名:
export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
mockUserToken?: EmulatorMockTokenOptions | string;
}): void;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| db | データベース | 変更するインスタンス。 |
| ホスト | 文字列 | エミュレータ ホスト（例: localhost） |
| ポート | 数値 | エミュレータのポート（例: 8080） |
| オプション | { mockUserToken?:EmulatorMockTokenOptions |string;} |
戻り値:
void
goOffline（db）
サーバーからの切断（すべてのデータベース オペレーションがオフラインで完了します）。
クライアントはデータベース サーバーへの永続的な接続を自動的に維持します。この接続は無期限にアクティブな状態を保ち、接続が切断されたときに再接続します。ただし、永続的な接続が望ましくない場合は、goOffline() メソッドと goOnline() メソッドを使用してクライアント接続を制御できます。
オフライン時、クライアントはデータベースからデータ更新を受信しなくなります。ただし、ローカルで実行されるすべてのデータベース オペレーションは引き続きすぐにイベントを発生させるため、アプリケーションは通常どおりに動作します。また、ローカルで実行された各オペレーションは自動的にキューに格納され、データベース サーバーに再接続すると再試行されます。
データベースに再接続してリモート イベントの受信を開始するには、goOnline() をご覧ください。
署名:
export declare function goOffline(db: Database): void;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| db | データベース | 切断するインスタンス。 |
戻り値:
void
goOnline（db）
サーバーに再接続し、オフラインのデータベースの状態をサーバーの状態と同期します。
このメソッドは、goOffline() でアクティブな接続を無効にした後に使用してください。再接続されると、クライアントは適切なデータを送信し、適切なイベントを発生させ、クライアントが「キャッチアップ」します。自動的に適用されます。
署名:
export declare function goOnline(db: Database): void;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| db | データベース | 再接続するインスタンス。 |
戻り値:
void
ref(db, パス)
指定されたパスに対応するデータベース内の場所を表す Reference を返します。パスが指定されていない場合、Reference はデータベースのルートを指します。
署名:
export declare function ref(db: Database, path?: string): DatabaseReference;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| db | データベース | 参照を取得するデータベース インスタンス。 |
| パス | 文字列 | 返された Reference がポイントする場所を表すパス（省略可）。指定しない場合、返される Reference はデータベースのルートを指します。 |
戻り値:
パスが指定されている場合は、指定されたパスを指す Reference。それ以外の場合は、データベースのルートを指す Reference。
refFromURL(db, url)
指定された Firebase URL に対応するデータベース内の場所を表す Reference を返します。
URL が有効な Firebase データベース URL でない場合、または URL のドメインが現在の Database インスタンスと異なる場合は、例外がスローされます。
すべてのクエリ パラメータ（orderBy、limitToLast など）は無視され、返される Reference には適用されません。
署名:
export declare function refFromURL(db: Database, url: string): DatabaseReference;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| db | データベース | 参照を取得するデータベース インスタンス。 |
| URL | 文字列 | 返された Reference が参照する Firebase URL。 |
戻り値:
指定された Firebase URL を指す Reference。
関数
forceLongPolling()
WebSocket の代わりに longPolling の使用を強制します。databaseURL で WebSocket プロトコルが使用されている場合は無視されます。
署名:
export declare function forceLongPolling(): void;
戻り値:
void
forceWebSockets()
longPolling ではなく WebSocket の使用を強制。
署名:
export declare function forceWebSockets(): void;
戻り値:
void
orderByKey()
キーで並べ替える新しい QueryConstraint を作成します。
クエリの結果をキー値（昇順）で並べ替えます。
orderByKey() について詳しくは、データを並べ替えるをご覧ください。
署名:
export declare function orderByKey(): QueryConstraint;
戻り値:
orderByPriority()
優先度順に並べる新しい QueryConstraint を作成します。
アプリで優先度を使用する必要はありませんが、通常のプロパティでコレクションを並べ替えることができます（優先度に代わるものについては、データの並べ替えをご覧ください）。
署名:
export declare function orderByPriority(): QueryConstraint;
戻り値:
orderByValue()
値で並べ替える新しい QueryConstraint を作成します。
クエリの子がすべてスカラー値（文字列、数値、ブール値）の場合、結果を（昇順）値で並べ替えることができます。
orderByValue() について詳しくは、データを並べ替えるをご覧ください。
署名:
export declare function orderByValue(): QueryConstraint;
戻り値:
serverTimestamp()
Firebase サーバーによって決定された現在のタイムスタンプ（Unix エポックからの経過時間、ミリ秒単位）を自動入力するためのプレースホルダ値を返します。
署名:
export declare function serverTimestamp(): object;
戻り値:
オブジェクト
関数（delta、...）
インクリメント（デルタ）
現在のデータベース値を指定された差分だけアトミックに増分するために使用できるプレースホルダ値を返します。
署名:
export declare function increment(delta: number): object;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| デルタ | 数値 | 現在の値をアトミックに変更する量。 |
戻り値:
オブジェクト
サーバーサイドでアトミックにデータを変更するためのプレースホルダ値。
function(enabled, ...)
enableLogging（有効, 持続）
デバッグ情報をコンソールに記録します。
署名:
export declare function enableLogging(enabled: boolean, persistent?: boolean): any;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 有効 | ブール値 | true の場合はロギングを有効にし、false の場合はロギングを無効にします。 |
| 永続的 | ブール値 | true の場合、ページ更新間のロギング状態を記憶します。 |
戻り値:
任意
function(limit, ...)
limitToFirst(limit)
最初の特定の子数に制限する場合は、新しい QueryConstraint を作成します。
limitToFirst() メソッドは、特定のコールバックに対して同期する子の最大数を設定するために使用します。上限を 100 に設定した場合、最初は最大 100 個の child_added イベントしか受信されません。データベースに保存されているメッセージが 100 個未満の場合、メッセージごとに child_added イベントが発生します。ただし、100 件を超えるメッセージがある場合、並べ替えられた最初の 100 件のメッセージについてのみ child_added イベントを受け取ります。アイテムが変更されると、アクティブ リストから外れるアイテムごとに child_removed イベントを受け取り、合計数が 100 に保たれます。
limitToFirst() の詳細については、データのフィルタリングをご覧ください。
署名:
export declare function limitToFirst(limit: number): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| limit | 数値 | このクエリに含めるノードの最大数。 |
戻り値:
limitToLast(limit)
最後に指定された数の子のみを返すように制限された新しい QueryConstraint を作成します。
limitToLast() メソッドは、特定のコールバックに対して同期する子の最大数を設定するために使用します。上限を 100 に設定した場合、最初は最大 100 個の child_added イベントしか受信されません。データベースに保存されているメッセージが 100 個未満の場合、メッセージごとに child_added イベントが発生します。ただし、100 件を超えるメッセージがある場合、並べ替えられた直近の 100 件のメッセージについてのみ child_added イベントを受け取ります。アイテムが変更されると、アクティブ リストから外れるアイテムごとに child_removed イベントを受け取り、合計数が 100 に保たれます。
limitToLast() の詳細については、データのフィルタリングをご覧ください。
署名:
export declare function limitToLast(limit: number): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| limit | 数値 | このクエリに含めるノードの最大数。 |
戻り値:
function(logger, ...)
enableLogging（ロガー）
デバッグ情報をコンソールに記録します。
署名:
export declare function enableLogging(logger: (message: string) => unknown): any;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| logger | （メッセージ: 文字列）=>不明 | ログの作成方法を制御するカスタム ロガー関数。 |
戻り値:
任意
関数（親、...）
子（親、パス）
指定された相対パスにあるロケーションの Reference を取得します。
相対パスには、単純な子名（「ada」など）か、より深いスラッシュで区切られたパス（「ada/name/first」など）を指定できます。
署名:
export declare function child(parent: DatabaseReference, path: string): DatabaseReference;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 親 | DatabaseReference | 親ビジネス。 |
| パス | 文字列 | このロケーションから目的の子ロケーションへの相対パス。 |
戻り値:
指定した子の場所。
push(parent, value)
一意の鍵を使用して新しい子の場所を生成し、その Reference を返します。
これは、アイテムの集合にデータを追加する最も一般的なパターンです。
push() に値を指定すると、生成された場所に値が書き込まれます。値を渡さないと、データベースには何も書き込まれず、子は空のままになります（ただし、Reference は別の場所で使用できます）。
push() によって生成された一意のキーは現在の時刻で並べ替えられるため、結果のアイテムリストは時系列で並べ替えられます。また、鍵は推測不可に設計されています（72 個のランダムなエントロピーを含みます）。
データのリストに追加するをご覧ください。一意の ID を確保する 2^120 の方法をご覧ください。
署名:
export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 親 | DatabaseReference | 親ビジネス。 |
| 値 | 不明 | 生成された場所に書き込まれるオプションの値。 |
戻り値:
Promise と Reference を組み合わせました書き込みが完了すると解決されますが、子の場所への Reference としてすぐに使用できます。
関数(パス, ...)
orderByChild(path)
指定された子キーで並べ替える新しい QueryConstraint を作成します。
クエリでは、一度に 1 つのキーのみで並べ替えることができます。同じクエリで orderByChild() を複数回呼び出すとエラーになります。
Firebase のクエリを使用すると、任意の子キーでデータをその場で並べ替えることができます。ただし、インデックスの内容が事前にわかっている場合は、セキュリティ ルールの .indexOn ルールを使用してインデックスを定義し、パフォーマンスを向上させることができます。詳しくは、https://firebase.google.com/docs/database/security/indexing-data ルールをご覧ください。
orderByChild() について詳しくは、データを並べ替えるをご覧ください。
署名:
export declare function orderByChild(path: string): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| パス | 文字列 | 並べ替えるパス。 |
戻り値:
function(query, ...)
get（クエリ）
このクエリの最新の結果を取得します。
署名:
export declare function get(query: Query): Promise<DataSnapshot>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
戻り値:
Promise <DataSnapshot>
Promise。値が使用可能な場合は結果の DataSnapshot に解決され、クライアントが値を返せない場合（サーバーにアクセスできず、キャッシュに保存されていない場合など）は拒否されます。
オフ（クエリ、イベント タイプ、コールバック）
以前に対応する on*()（onValue、onChildAdded）リスナーにアタッチされていたコールバックをデタッチします。注: リスナーを削除する方法としては、おすすめしません。代わりに、それぞれの on* コールバックから返されるコールバック関数を使用してください。
以前に on*() でアタッチされたコールバックをデタッチします。親リスナーで off() を呼び出しても、子ノードに登録されているリスナーが自動的に削除されるわけではありません。コールバックを削除するために、子リスナーで off() も呼び出す必要があります。
コールバックが指定されていない場合、指定した eventType のコールバックがすべて削除されます。同様に、eventType が指定されていない場合、Reference のコールバックはすべて削除されます。
個々のリスナーは、それぞれの登録解除コールバックを呼び出して削除することもできます。
署名:
export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | リスナーが登録されたクエリ。 |
| eventType | イベントタイプ | 文字列「value」、「child_added」、「child_changed」、「child_removed」、「child_moved」のいずれか。省略すると、Reference のコールバックがすべて削除されます。 |
| callback | （スナップショット: DataSnapshot, beforeChildName?: string | null）=>不明 | すべてのコールバックを削除するために、on() または undefined に渡されたコールバック関数。 |
戻り値:
void
onChildAdded（クエリ, コールバック, キャンセルコールバック）
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildAdded イベントは、この場所にある最初の子ごとに 1 回トリガーされます。また、新しい子が追加されるたびに、再びトリガーされます。コールバックに渡される DataSnapshot には、関連する子のデータが反映されます。並べ替えのために、2 番目の引数が渡されます。これは、前の兄弟子のキーが並べ替え順で格納された文字列です。最初の子である場合は null になります。
署名:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot, beforeChildName?: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildAdded(クエリ, コールバック, オプション)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildAdded イベントは、この場所にある最初の子ごとに 1 回トリガーされます。また、新しい子が追加されるたびに、再びトリガーされます。コールバックに渡される DataSnapshot には、関連する子のデータが反映されます。並べ替えのために、2 番目の引数が渡されます。これは、前の兄弟子のキーが並べ替え順で格納された文字列です。最初の子である場合は null になります。
署名:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildAdded（クエリ、コールバック、cancelCallback、オプション）
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildAdded イベントは、この場所にある最初の子ごとに 1 回トリガーされます。また、新しい子が追加されるたびに、再びトリガーされます。コールバックに渡される DataSnapshot には、関連する子のデータが反映されます。並べ替えのために、2 番目の引数が渡されます。これは、前の兄弟子のキーが並べ替え順で格納された文字列です。最初の子である場合は null になります。
署名:
export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildChanged（クエリ、コールバック、キャンセルコールバック）
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildChanged イベントは、子（またはその子孫）に格納されているデータが変更されるとトリガーされます。1 つの child_changed イベントで、子に対する複数の変更を表すことができます。コールバックに渡される DataSnapshot には、新しい子コンテンツが含まれます。並べ替えのため、コールバックには 2 番目の引数も渡されます。これは、前の兄弟子のキーを含む文字列を並べ替え順序順に並べたものです。最初の子である場合は null になります。
署名:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildChanged(クエリ, コールバック, オプション)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildChanged イベントは、子（またはその子孫）に格納されているデータが変更されるとトリガーされます。1 つの child_changed イベントで、子に対する複数の変更を表すことができます。コールバックに渡される DataSnapshot には、新しい子コンテンツが含まれます。並べ替えのため、コールバックには 2 番目の引数も渡されます。これは、前の兄弟子のキーを含む文字列を並べ替え順序順に並べたものです。最初の子である場合は null になります。
署名:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildChanged(query, call, cancelCallback, options)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildChanged イベントは、子（またはその子孫）に格納されているデータが変更されるとトリガーされます。1 つの child_changed イベントで、子に対する複数の変更を表すことができます。コールバックに渡される DataSnapshot には、新しい子コンテンツが含まれます。並べ替えのため、コールバックには 2 番目の引数も渡されます。これは、前の兄弟子のキーを含む文字列を並べ替え順序順に並べたものです。最初の子である場合は null になります。
署名:
export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildMoved（クエリ、コールバック、キャンセルコールバック）
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildMoved イベントは、子の並べ替え順が変更され、兄弟要素に対する相対的な位置が変更されるとトリガーされます。コールバックに渡される DataSnapshot は、移動した子のデータ用です。また、2 番目の引数にも渡されます。これは、前の兄弟の子のキーを並べ替え順で含む文字列です。子が最初の子である場合は null です。
署名:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildMoved(クエリ, コールバック, オプション)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildMoved イベントは、子の並べ替え順が変更され、兄弟要素に対する相対的な位置が変更されるとトリガーされます。コールバックに渡される DataSnapshot は、移動した子のデータ用です。また、2 番目の引数にも渡されます。これは、前の兄弟の子のキーを並べ替え順で含む文字列です。子が最初の子である場合は null です。
署名:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildMoved（クエリ、コールバック、cancelCallback、オプション）
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildMoved イベントは、子の並べ替え順が変更され、兄弟要素に対する相対的な位置が変更されるとトリガーされます。コールバックに渡される DataSnapshot は、移動した子のデータ用です。また、2 番目の引数にも渡されます。これは、前の兄弟の子のキーを並べ替え順で含む文字列です。子が最初の子である場合は null です。
署名:
export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot、previousChildName: string | null）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildRemoved（クエリ, コールバック, キャンセルコールバック）
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildRemoved イベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡される DataSnapshot は、削除された子の古いデータになります。次のいずれかに該当する場合、お子様は削除されます。
- クライアントがその子またはその祖先の 1 つに対して明示的に
remove()を呼び出した場合。クライアントがその子またはその祖先の 1 つでset(null)を呼び出し、その子ですべての子が削除された場合、子がフィルタで除外されます（並べ替え順序が変更されたか、上限に達したため）。
署名:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildRemoved(クエリ, コールバック, オプション)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildRemoved イベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡される DataSnapshot は、削除された子の古いデータになります。次のいずれかに該当する場合、お子様は削除されます。
- クライアントがその子またはその祖先の 1 つに対して明示的に
remove()を呼び出した場合。クライアントがその子またはその祖先の 1 つでset(null)を呼び出し、その子ですべての子が削除された場合、子がフィルタで除外されます（並べ替え順序が変更されたか、上限に達したため）。
署名:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onChildRemoved（クエリ、コールバック、cancelCallback、オプション）
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onChildRemoved イベントは、子が削除されるたびに 1 回トリガーされます。コールバックに渡される DataSnapshot は、削除された子の古いデータになります。次のいずれかに該当する場合、お子様は削除されます。
- クライアントがその子またはその祖先の 1 つに対して明示的に
remove()を呼び出した場合。クライアントがその子またはその祖先の 1 つでset(null)を呼び出し、その子ですべての子が削除された場合、子がフィルタで除外されます（並べ替え順序が変更されたか、上限に達したため）。
署名:
export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。このコールバックには、DataSnapshot と、前の子のキーを含む文字列が並べ替え順序順（最初の子の場合は null）に渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onValue(query, callback, cancelCallback)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onValue イベントは、この場所に保存された初期データで 1 回トリガーされます。その後、データが変更されるたびに再びトリガーされます。コールバックに渡される DataSnapshot は、on() が呼び出された場所に対するものになります。コンテンツ全体が同期されるまでトリガーされません。ビジネスにデータがない場合は、空の DataSnapshot でトリガーされます（val() は null を返します）。
署名:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。コールバックには DataSnapshot が渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onValue(クエリ, コールバック, オプション)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onValue イベントは、この場所に保存された初期データで 1 回トリガーされます。その後、データが変更されるたびに再びトリガーされます。コールバックに渡される DataSnapshot は、on() が呼び出された場所に対するものになります。コンテンツ全体が同期されるまでトリガーされません。ビジネスにデータがない場合は、空の DataSnapshot でトリガーされます（val() は null を返します）。
署名:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。コールバックには DataSnapshot が渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
onValue(クエリ, コールバック, キャンセルコールバック, オプション)
特定の場所でデータの変更をリッスンする。
これは、データベースからデータを読み取る主要な方法です。コールバックは初期データに対してトリガーされ、さらにデータが変更されるたびに再びトリガーされます。返された登録解除コールバックを呼び出して、更新情報の受信を停止します。詳しくは、ウェブ上でデータを取得するをご覧ください。
onValue イベントは、この場所に保存された初期データで 1 回トリガーされます。その後、データが変更されるたびに再びトリガーされます。コールバックに渡される DataSnapshot は、on() が呼び出された場所に対するものになります。コンテンツ全体が同期されるまでトリガーされません。ビジネスにデータがない場合は、空の DataSnapshot でトリガーされます（val() は null を返します）。
署名:
export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 実行するクエリ。 |
| callback | （スナップショット: DataSnapshot）=>不明 | 指定されたイベントが発生したときに配信されるコールバック。コールバックには DataSnapshot が渡されます。 |
| cancelCallback | （エラー: エラー）=>不明 | クライアントにこのデータの読み取り権限がない（またはクライアントがデータの読み取りを許可したが、データを失った）ためにイベントのサブスクリプションが解約された場合に通知されるコールバック（省略可）。このコールバックには、エラーが発生した理由を示す Error オブジェクトが渡されます。 |
| オプション | ListenOptions | onlyOnce の構成に使用できるオブジェクト。初回呼び出し後にリスナーを削除します。 |
戻り値:
リスナーを削除するために呼び出すことができる関数。
query（query, queryConstraints）
追加のクエリ制約も含まれるように拡張された Query の新しい不変インスタンスを作成します。
署名:
export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| クエリ | クエリ | 新しい制約のベースとして使用する Query インスタンス。 |
| queryConstraints | QueryConstraint[] | 適用する QueryConstraint のリスト。 |
戻り値:
例外
指定されたクエリ制約のいずれかを、既存の制約または新しい制約と組み合わせることができない場合。
関数（参照、...）
onDisconnect（ref）
OnDisconnect オブジェクトを返します。使用方法については、JavaScript でのオフライン機能の有効化をご覧ください。
署名:
export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| ref | DatabaseReference | OnDisconnect トリガーを追加するリファレンス。 |
戻り値:
削除（参照）
このデータベース ロケーションのデータを削除します。
子の場所のデータもすべて削除されます。
削除の効果はすぐに表示されます。また、対応するイベントの「value」もトリガーされます削除と Firebase サーバーの同期も開始され、完了すると、返された Promise が解決されます。指定すると、同期の完了後に onComplete コールバックが非同期的に呼び出されます。
署名:
export declare function remove(ref: DatabaseReference): Promise<void>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| ref | DatabaseReference | 削除するビジネス。 |
戻り値:
約束 <void>
サーバー上での削除が完了すると解決します。
runTransaction(ref, transactionUpdate, options)
この場所にあるデータをアトミックに変更します。
この場所にあるデータをアトミックに変更します。以前の値に関係なくデータを上書きする通常の set() とは異なり、runTransaction() を使用して既存の値を新しい値に変更します。これにより、同じ場所に同時に書き込みを行う他のクライアントとの競合がなくなります。
そのためには、現在の値を新しい値に変換するために使用される update 関数を runTransaction() に渡します。新しい値が正常に書き込まれる前に別のクライアントがそのロケーションに書き込むと、更新関数が新しい現在の値で再度呼び出され、書き込みが再試行されます。これは、書き込みが競合なしで成功するか、更新関数から値を返さずにトランザクションを中止するまで繰り返されます。
署名:
export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| ref | DatabaseReference | アトミックに変更する場所。 |
| transactionUpdate | (currentData: any) => 不明 | この場所にある現在のデータを（JavaScript オブジェクトとして）渡される、デベロッパー提供の関数。この関数は、書き込む新しい値を JavaScript オブジェクトとして返す必要があります。undefined が返された（つまり、引数なしで戻った）場合、トランザクションは中止され、この場所のデータは変更されません。 |
| オプション | TransactionOptions | トランザクションを構成するオプション オブジェクト。 |
戻り値:
Promise <TransactionResult>
成功と失敗を処理するために、onComplete コールバックの代わりにオプションで使用できる Promise。
set(ref, value)
このデータベースの場所にデータを書き込みます。
この操作を行うと、このロケーションとすべての子ロケーションのデータがすべて上書きされます。
書き込みの影響がすぐに表示され、対応するイベント（「value」、「child_added」など）がトリガーされます。Firebase サーバーへのデータの同期も開始され、完了すると、返された Promise が解決されます。指定すると、同期の完了後に onComplete コールバックが非同期で呼び出されます。
新しい値に null を渡すことは、remove() を呼び出すことと同じです。つまり、このロケーションとすべての子ロケーションにあるすべてのデータが削除されます。
set() は、この場所に保存されている優先度を削除するため、優先度を保持する場合は、代わりに setWithPriority() を使用する必要があります。
set() を使用してデータを変更すると、その場所での保留中のトランザクションがすべてキャンセルされるため、set() と transaction() を組み合わせて同じデータを変更する場合は細心の注意を払ってください。
1 つの set() で 1 つの「値」が生成されますset() が実行された場所で開催します。
署名:
export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| ref | DatabaseReference | 書き込み先の場所。 |
| 値 | 不明 | 書き込まれる値（文字列、数値、ブール値、オブジェクト、配列、null）。 |
戻り値:
約束 <void>
サーバーへの書き込みが完了したときに解決します。
setPriority(ref, 優先度)
このデータベース ロケーションにあるデータの優先度を設定します。
アプリケーションで優先度を使用する必要はありませんが、コレクションを通常のプロパティで並べ替えることができます（データの並べ替えとフィルタをご覧ください）。
署名:
export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| ref | DatabaseReference | 書き込み先の場所。 |
| priority | 文字列 |数値 |null | 書き込まれる優先度（文字列、数値、または null）。 |
戻り値:
約束 <void>
サーバーへの書き込みが完了したときに解決します。
setWithPriority(参照, 値, 優先度)
データベースのロケーションにデータを書き込みます。set() に似ていますが、そのデータの優先度も指定します。
アプリケーションで優先度を使用する必要はありませんが、コレクションを通常のプロパティで並べ替えることができます（データの並べ替えとフィルタをご覧ください）。
署名:
export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| ref | DatabaseReference | 書き込み先の場所。 |
| 値 | 不明 | 書き込まれる値（文字列、数値、ブール値、オブジェクト、配列、null）。 |
| priority | 文字列 |数値 |null | 書き込まれる優先度（文字列、数値、または null）。 |
戻り値:
約束 <void>
サーバーへの書き込みが完了したときに解決します。
update(ref, values)
一度に複数の値をデータベースに書き込みます。
values 引数には、データベースに一緒に書き込まれる複数のプロパティと値のペアが含まれます。子プロパティには、単純なプロパティ（「name」など）か、現在の場所から更新するデータへの相対パス（「name/first」など）を指定できます。
set() メソッドとは対照的に、update() を使用すると（現在の位置にあるすべての子プロパティを置き換えるのではなく）現在の位置にある参照されているプロパティのみを選択的に更新できます。
書き込みの影響がすぐに表示され、対応するイベント（「value」、「child_added」など）がトリガーされます。Firebase サーバーへのデータの同期も開始され、完了すると、返された Promise が解決されます。指定すると、同期の完了後に onComplete コールバックが非同期で呼び出されます。
1 つの update() で 1 つの「値」が生成されますイベントは、変更された子の数に関係なく、update() が実行された場所で発生します。
update() を使用してデータを変更すると、その場所での保留中のトランザクションがすべてキャンセルされるため、update() と transaction() を組み合わせて同じデータを変更する場合は細心の注意を払ってください。
null を update() に渡すと、この場所のデータが削除されます。
詳しくは、複数の場所での更新などのご紹介をご覧ください。
署名:
export declare function update(ref: DatabaseReference, values: object): Promise<void>;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| ref | DatabaseReference | 書き込み先の場所。 |
| values | オブジェクト | 複数の値を含むオブジェクト。 |
戻り値:
約束 <void>
サーバーの更新が完了したときに解決します。
関数(値, ...)
endAt(値, キー)
指定された終点で QueryConstraint を作成します。
startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリ用に任意の始点と終点を選択できます。
終点は包含的であるため、正確に指定された値を持つ子がクエリに含まれます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。指定する場合、正確に指定された値を持つ子も、指定されたキー以下のキー名を持つ必要があります。
endAt() の詳細については、データのフィルタリングをご覧ください。
署名:
export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 値 | 数値 |文字列 |ブール値 |null | 終了時点の値。引数の型は、このクエリで使用された orderBy() 関数によって異なります。orderBy() 型と一致する値を指定します。orderByKey() と組み合わせて使用する場合、値は文字列にする必要があります。 |
| key | 文字列 | 以前に指定した優先度を持つ子の中で、終了する子キー。この引数は、子、値、または優先度で並べ替える場合にのみ使用できます。 |
戻り値:
endBefore(値, キー)
指定された終点（その点は含まない）で QueryConstraint を作成します。
startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリ用に任意の始点と終点を選択できます。
終点は指定されません。値のみを指定した場合、指定した値より小さい値を持つ子がクエリに含まれます。キーを指定する場合、子は指定された値以下の値と、指定されたキーより小さいキー名を持つ必要があります。
署名:
export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 値 | 数値 |文字列 |ブール値 |null | 指定日の前に終了する値。引数の型は、このクエリで使用された orderBy() 関数によって異なります。orderBy() 型と一致する値を指定します。orderByKey() と組み合わせて使用する場合、値は文字列にする必要があります。 |
| key | 文字列 | 前に指定した優先度を持つ子の中で、前に終了する子キー。この引数は、子、値、または優先度で並べ替える場合にのみ使用できます。 |
戻り値:
sameTo(値, キー)
指定された値に一致する子を含む QueryConstraint を作成します。
startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリ用に任意の始点と終点を選択できます。
オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。指定した場合、正確に指定された値を持つ子は、指定されたキーもキー名として持つ必要があります。これは、同じ値に多数の一致がある結果セットをフィルタするために使用できます。
equalTo() の詳細については、データのフィルタリングをご覧ください。
署名:
export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 値 | 数値 |文字列 |ブール値 |null | 照合する値。引数の型は、このクエリで使用された orderBy() 関数によって異なります。orderBy() 型と一致する値を指定します。orderByKey() と組み合わせて使用する場合、値は文字列にする必要があります。 |
| key | 文字列 | 以前に指定した優先度を持つ子の中で、開始する子キー。この引数は、子、値、または優先度で並べ替える場合にのみ使用できます。 |
戻り値:
startAfter(value, key)
指定された開始点（その点は含まない）で QueryConstraint を作成します。
startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリ用に任意の始点と終点を選択できます。
開始点は排他的です。値のみを指定すると、指定した値より大きい値を持つ子がクエリに含まれます。キーを指定する場合、子は指定された値以上の値と、指定されたキーより大きいキー名を持つ必要があります。
署名:
export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 値 | 数値 |文字列 |ブール値 |null | 次の値より後に開始する値です。引数の型は、このクエリで使用された orderBy() 関数によって異なります。orderBy() 型と一致する値を指定します。orderByKey() と組み合わせて使用する場合、値は文字列にする必要があります。 |
| key | 文字列 | この後に開始する子キー。この引数は、子、値、または優先度で並べ替える場合にのみ使用できます。 |
戻り値:
startAt(値, キー)
指定された開始点で QueryConstraint を作成します。
startAt()、startAfter()、endBefore()、endAt()、equalTo() を使用すると、クエリ用に任意の始点と終点を選択できます。
始点は包含的であるため、正確に指定された値を持つ子がクエリに含まれます。オプションの key 引数を使用すると、クエリの範囲をさらに制限できます。指定した場合、正確に指定された値を持つ子は、指定されたキー以上のキー名を持つ必要もあります。
startAt() の詳細については、データのフィルタリングをご覧ください。
署名:
export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;
パラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
| 値 | 数値 |文字列 |ブール値 |null | 開始時の値です。引数の型は、このクエリで使用された orderBy() 関数によって異なります。orderBy() 型と一致する値を指定します。orderByKey() と組み合わせて使用する場合、値は文字列にする必要があります。 |
| key | 文字列 | 開始する子キー。この引数は、子、値、または優先度で並べ替える場合にのみ使用できます。 |
戻り値:
EventType
文字列「value」、「child_added」、「child_changed」、「child_removed」、「child_moved」のいずれか。
署名:
export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
QueryConstraintType
この SDK で使用できるさまざまなクエリ制約について説明します。
署名:
export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
登録解除
リスナーを削除するために呼び出すことができるコールバック。
署名:
export declare type Unsubscribe = () => void;