Birden çok dokümanı alır.
Bu yöntemle döndürülen dokümanların istenen sırayla iade edileceği garanti edilmez.
HTTP isteği
POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
database |
Zorunlu. Veritabanı adı. Biçimi: |
İstek içeriği
İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:
JSON gösterimi |
---|
{ "documents": [ string ], "mask": { object ( |
Alanlar | |
---|---|
documents[] |
Alınacak dokümanların adları. Biçimi: |
mask |
Döndürülecek alanlar. Ayarlanmazsa tüm alanları döndürür. Bir dokümanın bu maskede bulunmayan bir alanı varsa o alan yanıtta döndürülmez. |
Birleştirme alanı consistency_selector . Bu işlem için tutarlılık modu. Politika ayarlanmazsa varsayılan olarak güçlü tutarlılık sağlanır. consistency_selector şunlardan yalnızca biri olabilir: |
|
transaction |
Bir işlemdeki belgeleri okur. Base64 kodlu bir dize. |
newTransaction |
Yeni bir işlem başlatır ve dokümanları okur. Varsayılan olarak işlem salt okunurdur. Yeni işlem kimliği, akışta ilk yanıt olarak döndürülür. |
readTime |
Dokümanları verilen zaman olduğu gibi okur. Bu, son 1 saat içindeki bir mikrosaniye hassasiyetli zaman damgası olmalıdır veya Belirli Bir Noktadan Kurtarma özelliği etkinleştirilmişse son 7 gün içindeki tam bir dakikalık zaman damgası da olabilir. Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
Yanıt gövdesi
Firestore.BatchGetDocuments
için akış yanıtı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{ "transaction": string, "readTime": string, // Union field |
Alanlar | |
---|---|
transaction |
Bu isteğin bir parçası olarak başlatılan işlem. Yalnızca ilk yanıtta ve istekte Base64 kodlu bir dize. |
readTime |
Belgenin okunduğu saat. Bu durum tek bir şekilde artıyor olabilir. Bu durumda, sonuç akışındaki önceki dokümanlarda, bunların ReadTime ve bu doküman arasında değişmemesi garanti edilir. Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
Birleştirme alanı result . Tek bir sonuç. Sunucu sadece bir işlem döndürüyorsa bu alan boş olabilir. result şunlardan yalnızca biri olabilir: |
|
found |
İstenen bir belge. |
missing |
İstenen ancak mevcut olmayan bir belge adı. Biçimi: |
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış sayfasına göz atın.