database namespace

函式

函式 說明
執行個體(執行個體) 註冊可在特定 Firebase 即時資料庫執行個體中觸發事件的函式。
ref(path) 註冊會在 Firebase 即時資料庫寫入事件時觸發的函式。

類別

類別 說明
資料快照 代表 Firebase 即時資料庫資料快照的介面。
執行個體建構工具 Firebase 即時資料庫執行個體建構工具介面。可透過 [database.instance()](providers_database_.html#instance) 存取。
RefBuilder Firebase 即時資料庫參考建構工具介面。透過 [functions.database.ref()](functions.database#.ref) 存取。

database.instance()

註冊可在特定 Firebase 即時資料庫執行個體中觸發事件的函式。

搭配 ref 使用此方法,即可指定要在哪個執行個體監控資料庫事件。例如:firebase.database.instance('my-app-db-2').ref('/foo/bar')

請注意,如果在不含 instance 的情況下使用 functions.database.ref,系統會觀看 *default* 事件。

簽名:

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

參數

參數 類型 說明
執行個體 字串 要監控寫入事件的資料庫執行個體名稱。

傳回:

執行個體建構工具

Firebase 即時資料庫執行個體建構工具介面。

database.ref()

註冊會在 Firebase 即時資料庫寫入事件時觸發的函式。

這個方法的行為與用戶端和 Admin Firebase SDK 中同名的方法非常類似。如果對資料庫有任何異動,且該變更會影響提供的 path 或下方的資料,就會在 Cloud Functions 中觸發事件。

在 Cloud Functions 監聽即時資料庫事件,以及在用戶端和 Admin SDK 中使用即時資料庫之間有三個重要差異:

  1. Cloud Functions 允許在 path 名稱中使用萬用字元。任何以大括號 ({}) 括住的 path 元件都是萬用字元,可以比對所有字串。與特定 Cloud 函式叫用相符的值會以 [EventContext.params](cloud_functions_eventcontext.html#params 物件) 形式傳回。舉例來說,ref("messages/{messageId}") 會比對 /messages/message1/messages/message2 的變更,因此 event.params.messageId 會分別設為 "message1""message2"

  2. Cloud Functions 不會針對部署 Cloud 函式前就已存在的資料觸發事件。

  3. Cloud 函式事件可以存取更多資訊,包括先前事件資料的快照,以及觸發 Cloud 函式的使用者相關資訊。

簽名:

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

參數

參數 類型 說明
路徑 參照 要監控寫入事件的資料庫中的路徑。

傳回:

RefBuilder<Ref>

Firebase 即時資料庫建構工具介面。