firebase-admin.database package

外部 API 重新匯出

為方便起見，以下外部定義的 API 會從這個模組進入點重新匯出。

符號 說明
資料快照 來自 @firebase/database-compat 套件的 DataSnapshot 類型。
EventType 來自 @firebase/database-compat 套件的 EventType 類型。
中斷連線 來自 @firebase/database-compat 套件的 OnDisconnect 類型。
查詢 來自 @firebase/database-compat 套件的 Query 類型。
參考資料 來自 @firebase/database-compat 套件的 Reference 類型。
AndableReference 來自 @firebase/database-compat 套件的 ThenableReference 類型。

Firebase 即時資料庫。

函式

函式 說明
getDatabase(應用程式) 取得預設應用程式或特定應用程式的資料庫服務。在不需引數的情況下呼叫 getDatabase()，即可存取預設應用程式的 Database 服務，也可使用 getDatabase(app) 搭配 getDatabase(app)，存取與特定應用程式相關聯的 Database 服務。
getDatabaseWithUrl(網址, 應用程式) 取得預設應用程式或特定應用程式的資料庫服務。在不使用引數的情況下呼叫 getDatabaseWithUrl()，即可存取預設應用程式的資料庫服務，也可使用 getDatabaseWithUrl(app) 存取與特定應用程式相關聯的資料庫服務。

類別

類別 說明
FirebaseDatabaseError Firebase 資料庫錯誤代碼結構。這會擴充 FirebaseError。

介面

介面 說明
資料庫 Firebase 資料庫服務介面。擴充 @firebase/database-compat 套件提供的 Database 介面。

變數

變數 說明
enableLogging 從 @firebase/database-compat 套件 enableLogging 函式。
伺服器值 @firebase/database-compat 套件中的 ServerValue 常數。

getDatabase(應用程式)

取得預設應用程式或特定應用程式的資料庫服務。

呼叫 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, 應用程式)

取得預設應用程式或特定應用程式的資料庫服務。

呼叫 getDatabaseWithUrl() 時無需引數，即可存取預設應用程式的資料庫服務，也可使用 getDatabaseWithUrl(app) 形式呼叫，存取與特定應用程式相關聯的資料庫服務。

簽名：

export declare function getDatabaseWithUrl(url: string, app?: App): Database;

參數

參數 類型 說明
網址 字串
應用程式 應用程式

傳回：

資料庫

如未提供應用程式，或是與提供應用程式相關聯的 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

伺服器值

@firebase/database-compat 套件中的 ServerValue 常數。

簽名：

ServerValue: rtdb.ServerValue