Package google.firestore.v1

map<string, Value>

Hasil fungsi agregasi, misalnya: COUNT(*) AS total_docs.

Kuncinya adalah alias yang ditetapkan untuk fungsi agregasi pada input dan ukuran peta ini sama dengan jumlah fungsi agregasi dalam kueri.

Value

Nilai dalam array.

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{project_id}/databases/{database_id}.

string

Nama dokumen yang akan diambil. Dalam format: projects/{project_id}/databases/{database_id}/documents/{document_path}. Permintaan akan gagal jika salah satu dokumen bukan resource turunan dari database yang ditentukan. Nama duplikat akan dihilangkan.

DocumentMask

Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons.

bytes

Membaca dokumen dalam transaksi.

TransactionOptions

Memulai transaksi baru dan membaca dokumen. Setelan defaultnya adalah transaksi hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam streaming.

Timestamp

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.

bytes

Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya akan ditetapkan di respons pertama, dan hanya jika BatchGetDocumentsRequest.new_transaction ditetapkan dalam permintaan.

Timestamp

Waktu saat dokumen dibaca. Hal ini mungkin meningkat secara monotis, dalam hal ini dokumen sebelumnya dalam aliran hasil dijamin tidak berubah antara read_time dan yang ini.

Document

Dokumen yang diminta.

string

Nama dokumen yang diminta, tetapi tidak ada. Dalam format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{project_id}/databases/{database_id}.

Write

Penulisan yang akan diterapkan.

Metode tidak menerapkan penulisan secara atomik dan tidak menjamin pengurutan. Setiap penulisan berhasil atau gagal secara terpisah. Anda tidak dapat menulis ke dokumen yang sama lebih dari sekali per permintaan.

map<string, string>

Label yang terkait dengan penulisan batch ini.

WriteResult

Hasil penerapan penulisan.

Hasil penulisan ke-i ini sesuai dengan penulisan ke-i dalam permintaan.

Status

Status penerapan penulisan.

Status penulisan ke-i ini sesuai dengan penulisan ke-i dalam permintaan.

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{project_id}/databases/{database_id}.

TransactionOptions

Opsi untuk transaksi. Setelan defaultnya adalah transaksi baca-tulis.

bytes

Transaksi yang dimulai.

bytes

Byte yang mengenkode urutan bit. Mungkin memiliki panjang nol.

int32

Jumlah bit byte terakhir di bitmap yang akan diabaikan sebagai "padding". Jika panjang bitmap adalah nol, maka nilai ini harus 0. Jika tidak, nilai ini harus antara 0 dan 7, inklusif.

BitSequence

Data filter mekar.

int32

Jumlah {i>hash<i} yang digunakan oleh algoritma.

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{project_id}/databases/{database_id}.

Write

Penulisan yang akan diterapkan.

Selalu dijalankan secara atomik dan berurutan.

bytes

Jika ditetapkan, semua penulisan dalam transaksi ini akan diterapkan, lalu di-commit.

WriteResult

Hasil penerapan penulisan.

Hasil penulisan ke-i ini sesuai dengan penulisan ke-i dalam permintaan.

Timestamp

Waktu terjadinya commit. Setiap pembacaan dengan read_time yang sama atau lebih besar dijamin akan melihat efek commit.

string

Wajib diisi. Resource induk. Contoh: projects/{project_id}/databases/{database_id}/documents atau projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

Wajib diisi. ID koleksi, relatif terhadap parent, terhadap daftar. Contoh: chatrooms.

string

ID dokumen yang ditetapkan klien untuk digunakan dalam dokumen ini.

Opsional. Jika tidak ditentukan, ID akan ditetapkan oleh layanan.

Document

Wajib diisi. Dokumen yang akan dibuat. name tidak boleh ditetapkan.

DocumentMask

Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons.

Value

Nilai yang mewakili posisi, sesuai urutan kemunculannya dalam urutan klausa kueri.

Dapat berisi lebih sedikit nilai dari yang ditentukan dalam urutan berdasarkan klausa.

bool

Jika posisinya tepat sebelum atau tepat setelah nilai yang diberikan, sesuai dengan tata urutan yang ditentukan oleh kueri.

string

Wajib diisi. Nama resource Dokumen yang akan dihapus. Dalam format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

Precondition

Prakondisi opsional pada dokumen. Permintaan akan gagal jika disetel dan tidak dipenuhi oleh dokumen target.

string

Nama resource dokumen, misalnya projects/{project_id}/databases/{database_id}/documents/{document_path}.

map<string, Value>

Timestamp

Hanya output. Waktu dokumen dibuat.

Nilai ini meningkat secara monoton saat dokumen dihapus lalu dibuat ulang. Metrik ini juga dapat dibandingkan dengan nilai dari dokumen lain dan read_time kueri.

Timestamp

Hanya output. Waktu saat dokumen terakhir diubah.

Nilai ini awalnya ditetapkan ke create_time, lalu meningkat secara monoton dengan setiap perubahan pada dokumen. Metrik ini juga dapat dibandingkan dengan nilai dari dokumen lain dan read_time kueri.

Document

Status baru Document.

Jika mask disetel, hanya berisi kolom yang diperbarui atau ditambahkan.

int32

Kumpulan ID target target yang cocok dengan dokumen ini.

int32

Kumpulan ID target untuk target yang tidak lagi cocok dengan dokumen ini.

string

Nama resource Document yang telah dihapus.

int32

Kumpulan ID target untuk target yang sebelumnya cocok dengan entity ini.

Timestamp

Stempel waktu pembacaan saat penghapusan diamati.

Lebih besar atau sama dengan commit_time dari penghapusan.

string

Daftar jalur kolom dalam mask. Lihat Document.fields untuk melihat referensi sintaksis jalur kolom.

string

Nama resource Document yang tidak terlihat.

int32

Kumpulan ID target untuk target yang sebelumnya cocok dengan dokumen ini.

Timestamp

Stempel waktu pembacaan saat penghapusan diamati.

Lebih besar atau sama dengan commit_time dari perubahan/hapus/penghapusan.

string

Nama dokumen yang akan diubah.

FieldTransform

Daftar transformasi yang akan diterapkan ke kolom dokumen, secara berurutan. Kolom ini wajib diisi.

string

Jalur kolom. Lihat Document.fields untuk referensi sintaksis jalur kolom.

ServerValue

Menetapkan kolom ke nilai server yang diberikan.

Value

Menambahkan nilai yang diberikan ke nilai kolom saat ini.

Nilainya harus bilangan bulat atau nilai ganda. Jika kolom bukan bilangan bulat atau ganda, atau jika kolom belum ada, transformasi akan menetapkan kolom ke nilai yang diberikan. Jika salah satu nilai yang diberikan atau nilai kolom saat ini bernilai ganda, kedua nilai tersebut akan ditafsirkan sebagai nilai ganda. Aritmatika ganda dan representasi nilai ganda mengikuti semantik IEEE 754. Jika ada overflow bilangan bulat positif/negatif, kolom diselesaikan ke bilangan bulat positif/negatif terbesar.

Value

Menetapkan kolom ke maksimum nilai saat ini dan nilai yang diberikan.

Nilainya harus bilangan bulat atau nilai ganda. Jika kolom bukan bilangan bulat atau ganda, atau jika kolom belum ada, transformasi akan menetapkan kolom ke nilai yang diberikan. Jika operasi maksimum diterapkan saat kolom dan nilai inputnya memiliki jenis campuran (yaitu - satu adalah bilangan bulat dan satu adalah double), kolom akan mengambil jenis operand yang lebih besar. Jika operand setara (misalnya 3 dan 3.0), bidang tidak berubah. 0, 0.0, dan -0.0 semuanya nol. Maksimum nilai nol yang disimpan dan nilai input nol selalu merupakan nilai yang disimpan. Maksimum dari nilai numerik apa pun x dan NaN adalah NaN.

Value

Menetapkan kolom ke minimum nilai saat ini dan nilai yang diberikan.

Nilainya harus bilangan bulat atau nilai ganda. Jika kolom bukan bilangan bulat atau ganda, atau jika kolom belum ada, transformasi akan menetapkan kolom tersebut ke nilai input. Jika operasi minimum diterapkan dengan kolom dan nilai inputnya berupa jenis campuran (yaitu - satu adalah bilangan bulat dan satu adalah double) kolom akan mengambil jenis operand yang lebih kecil. Jika operand setara (misalnya 3 dan 3.0), bidang tidak berubah. 0, 0.0, dan -0.0 semuanya nol. Minimum dari nilai nol yang disimpan dan nilai input nol selalu merupakan nilai yang disimpan. Minimum dari nilai numerik apa pun x dan NaN adalah NaN.

ArrayValue

Menambahkan elemen yang diberikan secara berurutan jika belum ada di nilai kolom saat ini. Jika kolom bukan berupa array, atau jika belum ada, kolom akan disetel ke array kosong terlebih dahulu.

Jumlah yang setara dari berbagai jenis (misalnya, 3L dan 3.0) dianggap sama saat memeriksa apakah ada nilai yang hilang. NaN sama dengan NaN, dan {i>Null<i} sama dengan {i>Null<i}. Jika input berisi beberapa nilai setara, hanya nilai pertama yang akan dipertimbangkan.

transform_result yang sesuai akan berupa nilai null.

ArrayValue

Hapus semua elemen yang diberikan dari array dalam kolom. Jika kolom bukan berupa array, atau jika belum ada, kolom akan ditetapkan ke array kosong.

Jumlah yang setara dari jenis yang berbeda (misalnya 3L dan 3.0) dianggap sama saat memutuskan apakah suatu elemen harus dihapus atau tidak. NaN sama dengan NaN, dan {i>Null<i} sama dengan {i>Null<i}. Tindakan ini akan menghapus semua nilai yang setara jika ada duplikat.

transform_result yang sesuai akan berupa nilai null.

int64

Jumlah total hasil yang ditampilkan, termasuk dokumen, proyeksi, hasil agregasi, dan kunci.

Duration

Total waktu untuk menjalankan kueri di backend.

int64

Total operasi baca yang dapat ditagih.

Struct

Men-debug statistik dari eksekusi kueri. Perlu diperhatikan bahwa statistik proses debug dapat berubah sewaktu-waktu seiring perkembangan Firestore. Data ini dapat mencakup: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" }

int32

ID target tempat filter ini diterapkan.

int32

Jumlah total dokumen yang cocok dengan target_id.

Jika berbeda dari jumlah dokumen di klien yang cocok, klien harus menentukan secara manual dokumen mana yang tidak lagi sesuai dengan target.

Klien dapat menggunakan filter bloom unchanged_names untuk membantu penentuan ini dengan menguji SEMUA nama dokumen berdasarkan filter; jika nama dokumen TIDAK ada di filter, artinya dokumen tidak lagi cocok dengan target.

BloomFilter

Filter bloom yang, terlepas dari namanya, berisi encoding UTF-8 byte dari nama resource SEMUA dokumen yang cocok dengan target_id, dalam bentuk projects/{project_id}/databases/{database_id}/documents/{document_path}.

Filter bloom ini bisa diabaikan sesuai kebijaksanaan server, seperti jika dianggap bahwa klien tidak akan menggunakannya atau jika secara komputasi terlalu mahal untuk dihitung atau dikirim. Klien harus menangani kolom ini dengan baik jika kolom tersebut tidak ada dengan kembali ke logika yang digunakan sebelum kolom ini ada; yaitu, tambahkan kembali target tanpa token resume untuk mencari tahu dokumen mana dalam {i>cache<i} klien yang tidak sinkron.

PlanSummary

Informasi fase perencanaan untuk kueri.

ExecutionStats

Statistik gabungan dari eksekusi kueri. Hanya ada saat ExplainOptions.analyze ditetapkan ke benar (true).

bool

Opsional. Apakah akan mengeksekusi kueri ini.

Jika salah (default), kueri akan direncanakan, dengan hanya menampilkan metrik dari tahap perencanaan.

Jika benar, kueri akan direncanakan dan dieksekusi, sehingga menampilkan hasil kueri lengkap beserta metrik tahap perencanaan dan eksekusi.

string

Wajib diisi. Nama resource Dokumen yang akan didapatkan. Dalam format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentMask

Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons.

bytes

Membaca dokumen dalam transaksi.

Timestamp

Membaca versi dokumen 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.

string

Wajib diisi. Dokumen induk. Dalam format: projects/{project_id}/databases/{database_id}/documents/{document_path}. Contoh: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

Jumlah hasil maksimum yang akan ditampilkan.

string

Token halaman. Harus berupa nilai dari ListCollectionIdsResponse.

Timestamp

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.

string

ID koleksi.

string

Token halaman yang dapat digunakan untuk melanjutkan daftar.

string

Wajib diisi. Nama resource induk. Dalam format: projects/{project_id}/databases/{database_id}/documents atau projects/{project_id}/databases/{database_id}/documents/{document_path}.

Contoh: projects/my-project/databases/my-database/documents atau projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Opsional. ID koleksi, relatif terhadap parent, terhadap daftar.

Misalnya: chatrooms atau messages.

Hal ini bersifat opsional, dan jika tidak diberikan, Firestore akan mencantumkan dokumen dari semua koleksi pada parent yang disediakan.

int32

Opsional. Jumlah maksimum dokumen yang akan ditampilkan dalam satu respons.

Firestore dapat menampilkan lebih sedikit dari nilai ini.

string

Opsional. Token halaman, yang diterima dari respons ListDocuments sebelumnya.

Berikan atribut ini untuk mengambil halaman selanjutnya. Saat memberi nomor halaman, semua parameter lainnya (kecuali page_size) harus cocok dengan nilai yang ditetapkan dalam permintaan yang membuat token halaman.

string

Opsional. Urutan opsional dokumen yang akan ditampilkan.

Misalnya: priority desc, __name__ desc.

Metode ini mencerminkan ORDER BY yang digunakan dalam kueri Firestore, tetapi dalam representasi string. Jika tidak ada, dokumen akan diurutkan berdasarkan __name__ ASC.

DocumentMask

Opsional. Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons.

bool

Apakah daftar harus menampilkan dokumen yang hilang.

Dokumen tidak ada jika tidak ada, tetapi ada sub-dokumen yang disusun bertingkat di bawahnya. Jika benar, dokumen yang hilang tersebut akan ditampilkan dengan kunci, tetapi tidak akan memiliki kolom, create_time, atau update_time yang ditetapkan.

Permintaan dengan show_missing tidak boleh menentukan where atau order_by.

bytes

Melakukan pembacaan sebagai bagian dari transaksi yang sudah aktif.

Timestamp

Lakukan pembacaan pada waktu yang disediakan.

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.

Document

Dokumen ditemukan.

string

Token untuk mengambil halaman dokumen berikutnya.

Jika kolom ini dihilangkan, tidak ada halaman berikutnya.

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{project_id}/databases/{database_id}.

map<string, string>

Label yang terkait dengan perubahan target ini.

Target

Target untuk ditambahkan ke aliran data ini.

int32

ID target yang akan dihapus dari aliran data ini.

TargetChange

Target telah berubah.

DocumentChange

Document telah diubah.

DocumentDelete

Document telah dihapus.

DocumentRemove

Document telah dihapus dari target (karena tidak lagi relevan dengan target tersebut).

ExistenceFilter

Filter yang akan diterapkan pada kumpulan dokumen yang sebelumnya ditampilkan untuk target tertentu.

Ditampilkan saat dokumen mungkin telah dihapus dari target yang ditentukan, tetapi dokumen persisnya tidak diketahui.

map<string, Value>

Kolom peta.

Kunci peta mewakili nama kolom. Nama kolom yang cocok dengan ekspresi reguler __.*__ telah dicadangkan. Nama kolom yang dicadangkan dilarang, kecuali dalam konteks tertentu yang terdokumentasi. Kunci peta, yang direpresentasikan sebagai UTF-8, tidak boleh melebihi 1.500 byte dan tidak boleh kosong.

string

Wajib diisi. Nama resource induk. Dalam format: projects/{project_id}/databases/{database_id}/documents. Nama resource dokumen tidak didukung; hanya nama resource database yang dapat ditentukan.

int64

Jumlah maksimum titik partisi yang diinginkan. Partisi dapat ditampilkan di beberapa halaman hasil. Angkanya harus positif. Jumlah partisi sebenarnya yang ditampilkan mungkin lebih sedikit.

Misalnya, parameter ini dapat ditetapkan ke jumlah kueri paralel yang lebih sedikit dari jumlah kueri paralel yang akan dijalankan, atau satu untuk menjalankan tugas pipeline data, yaitu satu lebih sedikit dari jumlah worker atau instance komputasi yang tersedia.

string

Nilai next_page_token yang ditampilkan dari panggilan sebelumnya ke PartitionQuery yang dapat digunakan untuk mendapatkan kumpulan hasil tambahan. Tidak ada jaminan pengurutan di antara kumpulan hasil. Dengan demikian, penggunaan beberapa kumpulan hasil akan memerlukan penggabungan kumpulan hasil yang berbeda.

Misalnya, dua panggilan berikutnya yang menggunakan page_token mungkin akan menampilkan:

• kursor B, kursor M, kursor Q
• kursor A, kursor U, kursor W

Untuk mendapatkan kumpulan hasil lengkap yang diurutkan sehubungan dengan hasil kueri yang diberikan ke PartitionQuery, kumpulan hasil harus digabungkan: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W

int32

Jumlah maksimum partisi yang akan ditampilkan dalam panggilan ini, tunduk pada partition_count.

Misalnya, jika partition_count = 10 dan page_size = 8, panggilan pertama ke PartitionQuery akan menampilkan hingga 8 partisi dan next_page_token jika ada hasil lainnya. Panggilan kedua ke PartitionQuery akan menampilkan hingga 2 partisi, untuk menyelesaikan total 10 partisi yang ditentukan dalam partition_count.

StructuredQuery

Kueri terstruktur. Kueri harus menentukan koleksi dengan semua turunan dan diurutkan berdasarkan nama menaik. Filter, urutan menurut, batas, offset, dan kursor awal/akhir tidak didukung.

Timestamp

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.

Cursor

Hasil partisi. Setiap partisi merupakan titik bagi yang dapat digunakan oleh RunQuery sebagai titik awal atau akhir untuk hasil kueri. Permintaan RunQuery harus dibuat dengan kueri yang sama dengan yang diberikan pada permintaan PartitionQuery ini. Kursor partisi akan diurutkan sesuai dengan urutan yang sama seperti hasil kueri yang diberikan ke PartitionQuery.

Misalnya, jika permintaan PartitionQuery menampilkan kursor partisi A dan B, menjalankan tiga kueri berikut akan menampilkan seluruh set hasil kueri asli:

• kueri, akhir_pada A
• query, start_at A, end_at B
• kueri, start_at B

Hasil kosong dapat menunjukkan bahwa kueri memiliki terlalu sedikit hasil untuk dipartisi, atau bahwa kueri tersebut belum didukung untuk pembuatan partisi.

string

Token halaman yang dapat digunakan untuk meminta kumpulan hasil tambahan, hingga jumlah yang ditentukan oleh partition_count dalam permintaan PartitionQuery. Jika kosong, tidak ada hasil lagi.

Struct

Indeks yang dipilih untuk kueri. Misalnya: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

Jika ditetapkan ke true, dokumen target harus ada. Jika ditetapkan ke false, dokumen target tidak boleh ada.

Timestamp

Jika ditetapkan, dokumen target harus ada dan telah diperbarui terakhir kali pada saat itu. Stempel waktu harus diselaraskan dalam mikrodetik.

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{project_id}/databases/{database_id}.

bytes

Wajib diisi. Transaksi yang akan di-roll back.

string

Wajib diisi. Nama resource induk. Dalam format: projects/{project_id}/databases/{database_id}/documents atau projects/{project_id}/databases/{database_id}/documents/{document_path}. Contoh: projects/my-project/databases/my-database/documents atau projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Opsional. Menjelaskan opsi untuk kueri. Jika ditetapkan, statistik kueri tambahan akan ditampilkan. Jika tidak, hanya hasil kueri yang akan ditampilkan.

StructuredAggregationQuery

Kueri agregasi.

bytes

Jalankan agregasi dalam transaksi yang sudah aktif.

Nilai di sini adalah ID transaksi buram untuk mengeksekusi kueri.

TransactionOptions

Memulai transaksi baru sebagai bagian dari kueri, dengan setelan default ke hanya baca.

ID transaksi baru akan ditampilkan sebagai respons pertama dalam streaming.

Timestamp

Mengeksekusi kueri pada stempel waktu yang diberikan.

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.

AggregationResult

Hasil agregasi tunggal.

Tidak ada saat melaporkan progres parsial.

bytes

Transaksi yang dimulai sebagai bagian dari permintaan ini.

Hanya ada di respons pertama saat permintaan meminta untuk memulai transaksi baru.

Timestamp

Waktu saat hasil gabungan dihitung. Hal ini selalu meningkat secara monoton; dalam hal ini, AggregationResult sebelumnya di aliran hasil dijamin tidak akan berubah antara read_time dan yang ini.

Jika kueri tidak menampilkan hasil, respons dengan read_time dan tidak ada result akan dikirim, dan ini menunjukkan waktu saat kueri dijalankan.

ExplainMetrics

Metrik penjelasan kueri. Ini hanya ada saat RunAggregationQueryRequest.explain_options disediakan, dan hanya dikirim sekali dengan respons terakhir dalam aliran data.

string

Wajib diisi. Nama resource induk. Dalam format: projects/{project_id}/databases/{database_id}/documents atau projects/{project_id}/databases/{database_id}/documents/{document_path}. Contoh: projects/my-project/databases/my-database/documents atau projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Opsional. Menjelaskan opsi untuk kueri. Jika ditetapkan, statistik kueri tambahan akan ditampilkan. Jika tidak, hanya hasil kueri yang akan ditampilkan.

StructuredQuery

Kueri terstruktur.

bytes

Jalankan kueri dalam transaksi yang sudah aktif.

Nilai di sini adalah ID transaksi buram untuk mengeksekusi kueri.

TransactionOptions

Memulai transaksi baru dan membaca dokumen. Setelan defaultnya adalah transaksi hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam streaming.

Timestamp

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.

bytes

Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya dapat ditetapkan di respons pertama, dan hanya jika RunQueryRequest.new_transaction ditetapkan dalam permintaan. Jika ditetapkan, tidak ada kolom lain yang akan ditetapkan dalam respons ini.

Document

Hasil kueri, tidak ditetapkan saat melaporkan progres parsial.

Timestamp

Waktu saat dokumen dibaca. Jumlah ini mungkin meningkat secara monoton; dalam hal ini, dokumen sebelumnya dalam aliran hasil dipastikan tidak akan berubah antara read_time dan dokumen ini.

Jika kueri tidak menampilkan hasil, respons dengan read_time dan tidak ada document akan dikirim, dan ini menunjukkan waktu saat kueri dijalankan.

int32

Jumlah hasil yang telah dilewati karena ada offset antara respons terakhir dan respons saat ini.

ExplainMetrics

Metrik penjelasan kueri. Ini hanya ada saat RunQueryRequest.explain_options disediakan, dan hanya dikirim sekali dengan respons terakhir dalam aliran data.

bool

Jika ada, Firestore telah menyelesaikan permintaan dan tidak ada lagi dokumen yang akan ditampilkan.

Aggregation

Opsional. Serangkaian agregasi yang akan diterapkan pada hasil structured_query.

Membutuhkan:

• Minimal satu dan maksimum lima agregasi per kueri.

StructuredQuery

Kueri terstruktur bertingkat.

string

Opsional. Nama opsional kolom untuk menyimpan hasil agregasi.

Jika tidak disediakan, Firestore akan memilih nama default dengan mengikuti format field_<incremental_id++>. Contoh:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

menjadi:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

Membutuhkan:

• Harus unik di semua alias agregasi.
• Mematuhi batasan document field name.

Count

Agregator penghitungan.

Sum

Agregator jumlah.

Avg

Rata-rata agregator.

FieldReference

Kolom tempat agregat.

Int64Value

Opsional. Batasan opsional pada jumlah maksimum dokumen yang akan dihitung.

Hal ini menyediakan cara untuk menetapkan batas atas jumlah dokumen yang akan dipindai, membatasi latensi, dan biaya.

{i>Unspecified<i} ditafsirkan sebagai tidak terikat.

Contoh Tingkat Tinggi:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Membutuhkan:

• Harus lebih besar dari nol jika ada.

FieldReference

Kolom tempat agregat.

Projection

Sub-kumpulan opsional kolom yang akan ditampilkan.

Ini bertindak sebagai DocumentMask pada dokumen yang ditampilkan dari kueri. Jika tidak ditetapkan, mengasumsikan bahwa pemanggil ingin semua kolom ditampilkan.

CollectionSelector

Koleksi yang akan dikueri.

Filter

Filter yang akan diterapkan.

Order

Urutan yang akan diterapkan ke hasil kueri.

Firestore memungkinkan pemanggil untuk memberikan pengurutan lengkap, pengurutan parsial, atau tanpa pengurutan sama sekali. Dalam semua kasus, Firestore menjamin pengurutan yang stabil melalui aturan berikut:

• order_by diperlukan untuk mereferensikan semua kolom yang digunakan dengan filter ketidaksetaraan.
• Semua kolom yang harus ada di order_by, tetapi belum ada, ditambahkan dalam urutan leksikografis nama kolom.
• Jika pesanan di __name__ tidak ditentukan, pesanan tersebut akan ditambahkan secara default.

Kolom ditambahkan dengan arah pengurutan yang sama seperti urutan terakhir yang ditentukan, atau 'ASCENDING' jika tidak ada urutan yang ditentukan. Contoh:

• ORDER BY a menjadi ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC menjadi ORDER BY a DESC, __name__ DESC
• WHERE a > 1 menjadi WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 menjadi WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Cursor

Awalan potensial dari suatu posisi dalam kumpulan hasil untuk memulai kueri.

Urutan kumpulan hasil didasarkan pada klausa ORDER BY dari kueri asli.

SELECT * FROM k WHERE a = 1 AND b > 2 ORDER BY b ASC, __name__ ASC;

Hasil kueri ini diurutkan menurut (b ASC, __name__ ASC).

Kursor dapat merujuk ke pengurutan lengkap atau awalan lokasi, meskipun tidak dapat merujuk lebih banyak kolom daripada yang ada dalam ORDER BY yang diberikan.

Melanjutkan contoh di atas, melampirkan kursor awal berikut akan memiliki dampak yang berbeda-beda:

• START BEFORE (2, /k/123): mulai kueri tepat sebelum a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): memulai kueri tepat setelah a = 1 AND b > 10.

Tidak seperti OFFSET yang memerlukan pemindaian pada N hasil pertama untuk dilewati, kursor awal memungkinkan kueri untuk dimulai pada posisi logis. Posisi ini tidak diperlukan untuk mencocokkan hasil yang sebenarnya. Posisi ini akan memindai maju dari posisi ini untuk menemukan dokumen berikutnya.

Membutuhkan:

• Jumlah nilai tidak boleh lebih besar dari jumlah kolom yang ditentukan dalam klausa ORDER BY.

Cursor

Awalan potensial dari suatu posisi dalam kumpulan hasil untuk mengakhiri kueri.

Ini mirip dengan START_AT tetapi berfungsi mengontrol posisi akhir, bukan posisi awal.

Membutuhkan:

• Jumlah nilai tidak boleh lebih besar dari jumlah kolom yang ditentukan dalam klausa ORDER BY.

int32

Jumlah dokumen yang akan dilewati sebelum menampilkan hasil pertama.

Ini berlaku setelah batasan yang ditentukan oleh WHERE, START AT, & END AT tetapi sebelum klausa LIMIT.

Membutuhkan:

• Nilai harus lebih besar dari atau sama dengan nol jika ditentukan.

Int32Value

Jumlah hasil maksimum yang akan ditampilkan.

Berlaku setelah semua batasan lainnya.

Membutuhkan:

• Nilai harus lebih besar dari atau sama dengan nol jika ditentukan.

FindNearest

Opsional. Penelusuran tetangga terdekat yang potensial.

Berlaku setelah semua filter dan pengurutan lainnya.

Menemukan embedding vektor terdekat dengan vektor kueri yang diberikan.

string

ID koleksi. Jika ditetapkan, hanya memilih koleksi dengan ID ini.

bool

Jika salah (false), hanya koleksi yang merupakan turunan langsung dari parent yang ditentukan dalam RunQueryRequest penampung. Jika true (benar), akan memilih semua kumpulan turunan.

Operator

Operator untuk menggabungkan beberapa filter.

Filter

Daftar filter yang akan digabungkan.

Membutuhkan:

• Terdapat setidaknya satu filter.

FieldReference

Kolom yang akan difilter.

Operator

Operator untuk memfilter.

Value

Nilai untuk dibandingkan.

string

Referensi ke kolom dalam dokumen.

Membutuhkan:

• HARUS berupa string segmen yang dipisahkan titik (.), dengan setiap segmen sesuai dengan batasan document field name.

CompositeFilter

Filter gabungan.

FieldFilter

Filter di kolom dokumen.

UnaryFilter

Filter yang mengambil tepat satu argumen.

FieldReference

Wajib diisi. Kolom vektor yang diindeks untuk ditelusuri. Hanya dokumen yang berisi vektor yang dimensinya cocok dengan query_vector yang dapat ditampilkan.

Value

Wajib diisi. Vektor kueri yang kita telusuri. Harus berupa vektor yang tidak lebih dari 2.048 dimensi.

DistanceMeasure

Wajib diisi. Ukuran jarak yang akan digunakan, wajib diisi.

Int32Value

Wajib diisi. Jumlah tetangga terdekat yang akan ditampilkan. Harus berupa bilangan bulat positif yang tidak lebih dari 1.000.

FieldReference

Kolom untuk mengurutkan.

Direction

Arah pengurutan. Nilai defaultnya adalah ASCENDING.

FieldReference

Kolom yang akan ditampilkan.

Jika kosong, semua kolom akan ditampilkan. Untuk menampilkan nama dokumen saja, gunakan ['__name__'].

Operator

Operator unary yang akan diterapkan.

FieldReference

Kolom tempat Anda menerapkan operator.

int32

ID target yang mengidentifikasi target di streaming. Harus berupa bilangan positif dan bukan nol.

Jika target_id adalah 0 (atau tidak ditentukan), server akan menetapkan ID untuk target ini dan menampilkannya dalam peristiwa TargetChange::ADD. Setelah target dengan target_id=0 ditambahkan, semua target berikutnya juga harus memiliki target_id=0. Jika permintaan AddTarget dengan target_id != 0 dikirim ke server setelah target dengan target_id=0 ditambahkan, server akan segera mengirim respons dengan peristiwa TargetChange::Remove.

Perlu diperhatikan bahwa jika klien mengirim beberapa permintaan AddTarget tanpa ID, urutan ID yang ditampilkan dalam TargetChage.target_ids tidak ditentukan. Oleh karena itu, klien harus menyediakan ID target, bukan mengandalkan server untuk menetapkannya.

Jika target_id bukan nol, tidak boleh ada target aktif yang ada di aliran data ini dengan ID yang sama.

bool

Jika target harus dihapus setelah menjadi terbaru dan konsisten.

Int32Value

Jumlah dokumen yang terakhir cocok dengan kueri di token resume atau waktu baca.

Nilai ini hanya relevan jika resume_type disediakan. Nilai ini ada dan lebih besar dari nol menunjukkan bahwa klien ingin ExistenceFilter.unchanged_names disertakan dalam respons.

QueryTarget

Target yang ditentukan oleh kueri.

DocumentsTarget

Target yang ditentukan oleh sekumpulan nama dokumen.

bytes

Token resume dari TargetChange sebelumnya untuk target yang identik.

Menggunakan token resume dengan target yang berbeda tidak didukung dan mungkin akan gagal.

Timestamp

Mulai mendengarkan setelah read_time tertentu.

Klien harus mengetahui status dokumen yang cocok pada saat ini.

string

Nama dokumen yang akan diambil. Dalam format: projects/{project_id}/databases/{database_id}/documents/{document_path}. Permintaan akan gagal jika salah satu dokumen bukan resource turunan dari database yang ditentukan. Nama duplikat akan dihilangkan.

string

Nama resource induk. Dalam format: projects/{project_id}/databases/{database_id}/documents atau projects/{project_id}/databases/{database_id}/documents/{document_path}. Contoh: projects/my-project/databases/my-database/documents atau projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

Kueri terstruktur.

TargetChangeType

Jenis perubahan yang terjadi.

int32

ID target target yang telah berubah.

Jika kosong, perubahan akan berlaku untuk semua target.

Urutan ID target tidak ditentukan.

Status

Error yang mengakibatkan perubahan ini, jika berlaku.

bytes

Token yang dapat digunakan untuk melanjutkan streaming untuk target_ids yang ditentukan, atau semua target jika target_ids kosong.

Tidak ditetapkan pada setiap perubahan target.

Timestamp

read_time yang konsisten untuk target_ids yang ditentukan (dihilangkan jika target_id tidak memiliki snapshot yang konsisten).

Streaming dijamin akan mengirim read_time dengan target_ids kosong setiap kali seluruh streaming mencapai snapshot baru yang konsisten. Pesan ADD, CURRENT, dan RESET dijamin (pada akhirnya) akan menghasilkan snapshot baru yang konsisten (sedangkan pesan NO_CHANGE dan REMOVE tidak).

Untuk streaming tertentu, read_time dijamin meningkat secara monoton.

ReadOnly

Transaksi hanya dapat digunakan untuk operasi baca.

ReadWrite

Transaksi tersebut dapat digunakan untuk operasi baca dan tulis.

Timestamp

Membaca dokumen 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.

bytes

Transaksi opsional yang akan dicoba lagi.

Document

Wajib diisi. Dokumen yang diperbarui. Membuat dokumen jika belum ada.

DocumentMask

Kolom yang akan diperbarui. Tidak satu pun jalur kolom di mask yang boleh berisi nama yang dicadangkan.

Jika dokumen ada di server dan memiliki kolom yang tidak dirujuk dalam mask, kolom tersebut tidak akan berubah. Kolom yang dirujuk dalam mask, tetapi tidak ada dalam dokumen input, dihapus dari dokumen di server.

DocumentMask

Kolom yang akan ditampilkan. Jika tidak ditetapkan, semua kolom akan ditampilkan.

Jika dokumen memiliki kolom yang tidak ada dalam mask ini, kolom tersebut tidak akan ditampilkan dalam respons.

Precondition

Prakondisi opsional pada dokumen. Permintaan akan gagal jika disetel dan tidak dipenuhi oleh dokumen target.

NullValue

Nilai null.

bool

Nilai boolean.

int64

Nilai bilangan bulat.

double

Nilai ganda.

Timestamp

Nilai stempel waktu.

Presisi hanya hingga mikrodetik. Saat disimpan, presisi tambahan apa pun akan dibulatkan ke bawah.

string

Nilai string.

String, yang direpresentasikan sebagai UTF-8, tidak boleh lebih dari 1 MiB - 89 byte. Hanya 1.500 byte pertama representasi UTF-8 yang dipertimbangkan oleh kueri.

bytes

Nilai byte.

Tidak boleh lebih dari 1 MiB - 89 byte. Hanya 1.500 byte pertama yang dipertimbangkan oleh kueri.

string

Referensi ke dokumen. Misalnya: projects/{project_id}/databases/{database_id}/documents/{document_path}.

LatLng

Nilai titik geografis yang mewakili titik di permukaan Bumi.

ArrayValue

Nilai array.

Tidak dapat berisi nilai array lain secara langsung, meskipun dapat berisi peta yang berisi array lain.

MapValue

Nilai peta.

DocumentMask

Kolom yang akan diperbarui dalam penulisan ini.

Kolom ini hanya dapat ditetapkan jika operasinya adalah update. Jika mask tidak ditetapkan untuk update dan dokumen ada, semua data yang ada akan ditimpa. Jika mask ditetapkan dan dokumen di server memiliki kolom yang tidak tercakup oleh mask, kolom tersebut tidak akan berubah. Kolom yang dirujuk dalam mask, tetapi tidak ada dalam dokumen input, dihapus dari dokumen di server. Jalur kolom di mask ini tidak boleh berisi nama kolom yang dicadangkan.

FieldTransform

Transformasi yang akan dilakukan setelah update.

Kolom ini hanya dapat ditetapkan jika operasinya adalah update. Jika ada, penulisan ini setara dengan melakukan update dan transform pada dokumen yang sama secara atomik dan berurutan.

Precondition

Prakondisi opsional pada dokumen.

Penulisan akan gagal jika hal ini disetel dan tidak dipenuhi oleh dokumen target.

Document

Dokumen yang akan ditulis.

string

Nama dokumen yang akan dihapus. Dalam format: projects/{project_id}/databases/{database_id}/documents/{document_path}.

DocumentTransform

Menerapkan transformasi ke dokumen.

string

Wajib diisi. Nama {i>database<i}. Dalam format: projects/{project_id}/databases/{database_id}. Ini hanya diperlukan di pesan pertama.

string

ID aliran data tulis yang akan dilanjutkan. Pesan ini hanya dapat ditetapkan di pesan pertama. Jika dibiarkan kosong, aliran data tulis baru akan dibuat.

Write

Penulisan yang akan diterapkan.

Selalu dijalankan secara atomik dan berurutan. Kolom ini harus kosong pada permintaan pertama. Kolom ini mungkin kosong pada permintaan terakhir. Kolom ini wajib diisi pada semua permintaan lainnya.

bytes

Token streaming yang sebelumnya dikirim oleh server.

Klien harus menetapkan kolom ini ke token dari WriteResponse terbaru yang diterimanya. Ini mengonfirmasi bahwa klien telah menerima respons hingga token ini. Setelah mengirimkan token ini, token sebelumnya tidak dapat digunakan lagi.

Server dapat menutup streaming jika ada terlalu banyak respons yang tidak dikonfirmasi.

Jangan tetapkan kolom ini saat membuat streaming baru. Untuk melanjutkan streaming pada titik tertentu, tetapkan kolom ini dan kolom stream_id.

Jangan tetapkan kolom ini saat membuat streaming baru.

map<string, string>

Label yang terkait dengan permintaan tulis ini.

string

ID streaming. Hanya ditetapkan pada pesan pertama, saat streaming baru dibuat.

bytes

Token yang merepresentasikan posisi respons ini dalam aliran data. Ini dapat digunakan oleh klien untuk melanjutkan streaming pada tahap ini.

Kolom ini selalu ditetapkan.

WriteResult

Hasil penerapan penulisan.

Hasil penulisan ke-i ini sesuai dengan penulisan ke-i dalam permintaan.

Timestamp

Waktu terjadinya commit. Setiap operasi baca dengan read_time yang sama atau lebih besar dijamin melihat efek penulisan.

Timestamp

Waktu pembaruan dokumen terakhir setelah menerapkan penulisan. Tidak ditetapkan setelah delete.

Jika penulisan tidak benar-benar mengubah dokumen, ini akan menjadi update_time sebelumnya.

Value

Hasil penerapan setiap DocumentTransform.FieldTransform, dalam urutan yang sama.