Menjalankan kueri.
Permintaan HTTP
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:runQuery
URL menggunakan sintaks gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
parent |
Wajib diisi. Nama resource induk. Dalam format: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "explainOptions": { object ( |
Kolom | |
---|---|
explainOptions |
Opsional. Menjelaskan opsi untuk kueri. Jika ditetapkan, statistik kueri tambahan akan ditampilkan. Jika tidak, hanya hasil kueri yang akan ditampilkan. |
Kolom union query_type . Kueri yang akan dijalankan. query_type hanya ada berupa salah satu diantara berikut: |
|
structuredQuery |
Kueri terstruktur. |
Kolom union consistency_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, defaultnya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
transaction |
Jalankan kueri dalam transaksi yang sudah aktif. Nilai di sini adalah ID transaksi buram untuk mengeksekusi kueri. String berenkode base64. |
newTransaction |
Memulai transaksi baru dan membaca dokumen. Setelan defaultnya adalah transaksi hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam streaming. |
readTime |
Membaca dokumen sebagaimana adanya pada waktu tertentu. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, juga dapat berupa stempel waktu menit penuh dalam 7 hari terakhir. Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
Isi respons
Respons untuk Firestore.RunQuery
.
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "transaction": string, "document": { object ( |
Kolom | |
---|---|
transaction |
Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya dapat ditetapkan di respons pertama, dan hanya jika String berenkode base64. |
document |
Hasil kueri, tidak ditetapkan saat melaporkan progres parsial. |
readTime |
Waktu saat dokumen dibaca. Jumlah ini mungkin meningkat secara monoton; dalam hal ini, dokumen sebelumnya dalam aliran hasil dipastikan tidak akan berubah antara Jika kueri tidak menampilkan hasil, respons dengan Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
skippedResults |
Jumlah hasil yang telah dilewati karena ada offset antara respons terakhir dan respons saat ini. |
explainMetrics |
Metrik penjelasan kueri. Ini hanya ada saat |
Kolom union continuation_selector . Mode kelanjutan untuk kueri. Jika ada, ini menunjukkan aliran respons kueri saat ini telah selesai. Fungsi ini dapat disetel dengan atau tanpa adanya document , tetapi jika ditetapkan, tidak akan ada hasil lagi yang ditampilkan. continuation_selector hanya dapat berupa salah satu dari yang berikut: |
|
done |
Jika ada, Firestore telah menyelesaikan permintaan dan tidak ada lagi dokumen yang akan ditampilkan. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.