Firebase 資料庫 REST API

access_token

所有要求類型都支援這項功能。驗證這項要求即可 存取由 Firebase Realtime Database Security Rules 保護的資料。 詳情請參閱 REST 驗證說明文件。

curl 'https://[PROJECT_ID].firebaseio/users/jack/name.json?access_token=CREDENTIAL'

淺層

這項進階功能主要是為了協助您 不必下載所有資料設為 true：限制傳回資料的深度 物件如果位置的資料是 JSON 基元 (字串、數字或布林值)，系統只會傳回其值。如果 位置的資料快照是 JSON 物件 每個鍵的值都會截斷為 true。

curl 'https://[PROJECT_ID].firebaseio/.json?shallow=true'

請注意，shallow 無法與任何其他查詢搭配使用 參數。

列印

將伺服器的回應中傳回的資料格式化。

curl 'https://[PROJECT_ID].firebaseio.com/users/jack/name.json?print=pretty'

curl -X PUT -d '{ "first": "Jack", "last": "Sparrow" }' \
  'https://[PROJECT_ID].firebaseio.com/users/jack/name.json?print=silent'

回呼

僅支援 GET。透過網路瀏覽器執行 REST 呼叫 可以使用 JSONP，將回應包裝在 JavaScript 中 回呼函式。新增 callback= 以納入 REST API 包裝 您在指定的回呼函式中傳回的資料。

<script>
  function gotData(data) {
    console.log(data);
  }
</script>
<script src="https://[PROJECT_ID].firebaseio.com/.json?callback=gotData"></script>

格式

如果設為 export，伺服器就會在 回應。

curl 'https://[PROJECT_ID].firebaseio.com/.json?format=export'

下載

僅支援 GET。如何觸發檔案 從網路瀏覽器下載您的資料，請新增 download=。 這會導致 REST 服務新增適當的標頭，以便 就會知道要將資料儲存到檔案。

curl 'https://[PROJECT_ID].firebaseio/.json?download=myfilename.txt'

逾時

用於限制伺服器端讀取作業的時間。如果讀取 要求未在分配的時間內完成，就會以 HTTP 回應 400 錯誤。當您需要進行小規模的資料傳輸時，這個方式就特別實用 因此最好不要花太久的時間 才能擷取潛在的龐大子樹實際 讀取時間可能會因資料大小和快取而異。

請使用下列格式指定 timeouts：3ms、 3s 或 3min，包含數字和單位。如果不是 已指定15min，最多只能有timeout 已套用。如果 timeout 不是正數或超過數量上限， 要求都會遭到拒絕，並顯示 HTTP 400 錯誤。

WriteSizeLimit

指定 unlimited 時，會造成異常大量寫入 (酬載最多 256 MB) 系統可能會在資料庫處理 目前作業寫入伺服器後即無法取消寫入。

curl -X DELETE 'https://docs-examples.firebaseio.com/rest/delete-data.json?writeSizeLimit=medium'

如果寫入過大，系統會顯示以下錯誤訊息：

Error: WRITE_TOO_BIG: Data to write exceeds the maximum size that can be modified with a single request.

此外，您可以為整個資料庫設定 defaultWriteSizeLimit 管理執行個體這項限制適用於所有要求，包括來自 SDK 的要求。 建立defaultWriteSizeLimit設為 large 的新資料庫。 您無法使用 Firebase CLI 將 defaultWriteSizeLimit 設為 tiny，

firebase database:settings:set defaultWriteSizeLimit large

orderBy

請參閱指南中這一節， 排序資料 瞭解詳情

limitToFirst、LimitToLast、startAt、endAt、equalTo

請參閱指南中這一節， 篩選資料 瞭解詳情

put

JSON 編碼資料是具有兩個鍵的物件：path 和資料。path 索引鍵會指向 相對於要求網址的相對位置用戶端應該將 在快取中保留該位置的資料與「data」。

patch

JSON 編碼資料是具有兩個鍵的物件：path 和資料。path 索引鍵會指向 相對於要求網址的相對位置針對每個 data，用戶端應將 快取中對應的金鑰，以及訊息中該鍵的資料。

保持運作

這個事件的資料為 null。您無須採取任何行動，

取消

有些非預期的錯誤可能會傳送 `cancel` 事件並終止連線， 原因請參閱系統為這個事件提供的資料。以下列舉幾個可能原因 如下： 1.Firebase Realtime Database Security Rules 不再允許在要求的位置讀取資料。 這個問題的「資料」說明為「權限遭拒」。 2. 寫入作業觸發的事件串流程式傳送了超過我們的限制的大型 JSON 樹狀結構。 512 MB。這項原因的 `data` 為「指定的酬載過大，請 資料較少的位置」

驗證已撤銷

此事件的資料是字串，指出憑證 已過期。系統會在提供的 auth 時傳送這個事件 參數已失效。