firebase-admin.database package

外部 API の再エクスポート

便宜上、外部で定義された次の API は、このモジュールのエントリ ポイントから再エクスポートされます。

記号 説明
DataSnapshot @firebase/database-compat パッケージの DataSnapshot 型。
イベントタイプ @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 サービスを取得します。デフォルト アプリの Database サービスにアクセスする場合は、引数なしで getDatabase() を呼び出します。特定のアプリに関連付けられた Database サービスにアクセスするには、getDatabase(app) として呼び出します。
getDatabaseWithUrl(url, app) デフォルト アプリまたは特定のアプリの Database サービスを取得します。デフォルト アプリの Database サービスにアクセスする場合は、引数なしで getDatabaseWithUrl() を呼び出します。特定のアプリに関連付けられた Database サービスにアクセスするには、getDatabaseWithUrl(app) として呼び出します。

クラス

クラス 説明
FirebaseDatabaseError Firebase Database のエラーコードの構造。これは FirebaseError を拡張します。

インターフェース

インターフェース 説明
データベース Firebase Database サービス インターフェース。@firebase/database-compat パッケージの Database インターフェースを拡張します。

変数

変数 説明
enableLogging @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;

パラメータ

パラメータ 型 説明
URL 文字列
アプリ アプリ

戻り値:

データベース

アプリが指定されていない場合はデフォルトの 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);

enableLogging

@firebase/database-compat パッケージの enableLogging 関数を使用します。

署名:

enableLogging: typeof rtdb.enableLogging

ServerValue

@firebase/database-compat パッケージの ServerValue 定数。

署名:

ServerValue: rtdb.ServerValue