提供意見
Method: projects.databases.documents.batchGet
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
取得多份文件。
此方法傳回的文件不一定會按照要求的順序傳回。
HTTP 要求
POST https://firestore.googleapis.com/v1/{database=projects/*/databases/*}/documents:batchGet
這個網址使用 gRPC 轉碼 語法。
路徑參數
參數
database
string
執行個體類型,資料庫名稱。請採用下列格式:projects/{projectId}/databases/{databaseId}
。
要求主體
要求主體包含下列結構的資料:
JSON 表示法
{
"documents" : [
string
] ,
"mask" : {
object (DocumentMask
)
} ,
// Union field consistency_selector
can be only one of the following:
"transaction" : string ,
"newTransaction" : {
object (TransactionOptions
)
} ,
"readTime" : string
// End of list of possible types for union field consistency_selector
.
}
欄位
documents[]
string
要擷取的文件名稱。請採用下列格式:projects/{projectId}/databases/{databaseId}/documents/{document_path}
。如果文件有任何文件不是指定 database
的子項資源,要求就會失敗。系統會省略重複的名稱。
mask
object (DocumentMask
)
要傳回的欄位。如未設定,則會傳回所有欄位。
如果文件含有不在這個遮罩中的欄位,回應中就不會傳回該欄位。
聯集欄位 consistency_selector
。這筆交易的一致性模式。如果未設定,則會預設為同步一致性。consistency_selector
只能採用下列其中一種設定:
transaction
string (bytes format)
這個外掛程式能在交易中讀取文件。
Base64 編碼字串。
newTransaction
object (TransactionOptions
)
開始新的交易並讀取文件。預設為唯讀交易。系統會傳回新的交易 ID,做為串流中的第一個回應。
readTime
string (Timestamp
format)
讀取特定時間的文件。
這個時間戳記須為過去 1 小時內的微秒精確度,或者如果已啟用時間點復原,也可以是過去 7 天內的整分鐘時間戳記。
RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z"
和 "2014-10-02T15:01:23.045123456Z"
。
回應主體
針對 Firestore.BatchGetDocuments
的串流回應。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法
{
"transaction" : string ,
"readTime" : string ,
// Union field result
can be only one of the following:
"found" : {
object (Document
)
} ,
"missing" : string
// End of list of possible types for union field result
.
}
欄位
transaction
string (bytes format)
依此要求啟動的交易。只會在第一個回應中設定,且必須在要求中設定 BatchGetDocumentsRequest.new_transaction
。
Base64 編碼字串。
readTime
string (Timestamp
format)
讀取文件的時間。這可能是單純增加的,在這種情況下,結果串流中的舊有文件絕對不會在 readTime 和此檔案之間變更。
RFC3339 世界標準時間「Zulu」的時間戳記格式,解析度為奈秒,且最多 9 個小數位數。範例:"2014-10-02T15:01:23Z"
和 "2014-10-02T15:01:23.045123456Z"
。
聯集欄位 result
。單一結果。如果伺服器只會傳回交易,這個值可以留空。result
只能採用下列其中一種設定:
found
object (Document
)
要求的文件。
missing
string
要求但不存在的文件名稱。請採用下列格式:projects/{projectId}/databases/{databaseId}/documents/{document_path}
。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
詳情請參閱驗證總覽 一文。
提供意見
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權 ,程式碼範例則為阿帕契 2.0 授權 。詳情請參閱《Google Developers 網站政策 》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2024-08-23 (世界標準時間)。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"缺少我需要的資訊"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"過於複雜/步驟過多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"過時"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻譯問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/程式碼問題"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"容易理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"確實解決了我的問題"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
想進一步說明嗎?
{"lastModified": "\u4e0a\u6b21\u66f4\u65b0\u6642\u9593\uff1a2024-08-23 (\u4e16\u754c\u6a19\u6e96\u6642\u9593)\u3002"}
[[["容易理解","easyToUnderstand","thumb-up"],["確實解決了我的問題","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["缺少我需要的資訊","missingTheInformationINeed","thumb-down"],["過於複雜/步驟過多","tooComplicatedTooManySteps","thumb-down"],["過時","outOfDate","thumb-down"],["翻譯問題","translationIssue","thumb-down"],["示例/程式碼問題","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["上次更新時間:2024-08-23 (世界標準時間)。"]]