Sorgu çalıştırır.
HTTP isteği
POST https://firestore.googleapis.com/v1/{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ı. Biçimi: |
İstek içeriği
İsteğin gövdesi, aşağıdaki yapıya sahip veriler 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 sorgudur. |
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 |
Sorguyu etkin bir işlem içinde ç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 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.RunQuery
için yanıt.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{ "transaction": string, "document": { object ( |
Alanlar | |
---|---|
transaction |
Bu isteğin bir parçası olarak başlatılan işlem. Yalnızca ilk yanıtta ve yalnızca istekte Base64 kodlu bir dize. |
document |
Kısmi ilerleme bildirilirken ayarlanmayan bir sorgu sonucu. |
readTime |
Belgenin okunduğu saat. Bu artış tekdüze olabilir. Bu durumda, sonuç akışındaki önceki dokümanların Sorgu hiçbir sonuç döndürmezse Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: |
skippedResults |
Son yanıt ile geçerli yanıt arasındaki ofset nedeniyle atlanan sonuç sayısı. |
explainMetrics |
Sorgu açıklama metrikleri. Bu yalnızca |
Birleştirme alanı continuation_selector . Sorgu için devam modu. Varsa geçerli sorgu yanıtı akışının bittiğini belirtir. Bu, document mevcut olduğunda veya olmadığında ayarlanabilir. Ancak, ayarlandığında başka sonuç döndürülmez. continuation_selector şunlardan yalnızca biri olabilir: |
|
done |
Mevcutsa, Firestore isteği tamamen tamamlamıştır ve başka doküman 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ış sayfasına göz atın.