Sorgu çalıştırır.
HTTP isteği
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:runQuery
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
parent |
Zorunlu. Üst kaynak adı. Şu biçimde: |
İstek içeriği
İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:
JSON gösterimi |
---|
{ "explainOptions": { object ( |
Alanlar | |
---|---|
explainOptions |
İsteğe bağlı. Sorguyla ilgili seçenekleri açıklayın. Ayarlanırsa ek sorgu istatistikleri döndürülür. Aksi takdirde yalnızca sorgu sonuçları döndürülür. |
Birleştirme alanı query_type . Çalıştırılacak sorgu. query_type şunlardan yalnızca biri olabilir: |
|
structuredQuery |
Yapılandırılmış bir sorgu. |
Birleştirme alanı consistency_selector . Bu işlem için tutarlılık modu. Ayarlanmazsa varsayılan olarak güçlü tutarlılık kullanılır. consistency_selector şunlardan yalnızca biri olabilir: |
|
transaction |
Sorguyu zaten etkin olan bir işlemde çalıştırın. Buradaki değer, sorgunun yürütüleceği opak işlem kimliğidir. base64 kodlu bir dize. |
newTransaction |
Yeni bir işlem başlatır ve belgeleri okur. Varsayılan olarak salt okunur işlem kullanılır. Yeni işlem kimliği, akıştaki ilk yanıt olarak döndürülür. |
readTime |
Belgeleri belirtilen zamanda olduğu gibi okur. Bu, son bir saat içindeki mikrosaniyelik bir hassasiyet zaman damgası olmalıdır. Belirli bir noktadan önceyi kurtarma özelliği etkinse son 7 gün içindeki bir tam dakikalık zaman damgası da olabilir. RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: |
Yanıt gövdesi
Firestore.RunQuery
için yanıt.
Başarılı olursa yanıt gövdesi aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{ "transaction": string, "document": { object ( |
Alanlar | |
---|---|
transaction |
Bu istek kapsamında başlatılan işlem. Yalnızca ilk yanıtta ve yalnızca istekte base64 kodlu bir dize. |
document |
Kısmi ilerleme durumu raporlanırken ayarlanmayan bir sorgu sonucu. |
readTime |
Belgenin okunma zamanı. Bu sayı monoton olarak artıyor olabilir. Bu durumda, sonuç akışında yer alan önceki dokümanların Sorgu herhangi bir sonuç döndürmezse RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: |
skippedResults |
Son yanıt ile geçerli yanıt arasındaki fark nedeniyle atlanan sonuçların sayısı. |
explainMetrics |
Sorgu, metrikleri açıklar. Bu mesaj yalnızca |
Birleştirme alanı continuation_selector . Sorgu için devamlı mod. Varsa mevcut sorgu yanıt akışının tamamlandığını belirtir. Bu ayar, document varken veya olmadan ayarlanabilir ancak ayarlandığında başka sonuç döndürülmez. continuation_selector şunlardan yalnızca biri olabilir: |
|
done |
Bu kod varsa Firestore, isteği tamamen tamamlamıştır ve başka belge döndürülmeyecektir. |
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ış başlıklı makaleye bakın.