Indeks
Firestore
(antar muka)AggregationResult
(pesan)ArrayValue
(pesan)BatchGetDocumentsRequest
(pesan)BatchGetDocumentsResponse
(pesan)BatchWriteRequest
(pesan)BatchWriteResponse
(pesan)BeginTransactionRequest
(pesan)BeginTransactionResponse
(pesan)BitSequence
(pesan)BloomFilter
(pesan)CommitRequest
(pesan)CommitResponse
(pesan)CreateDocumentRequest
(pesan)Cursor
(pesan)DeleteDocumentRequest
(pesan)Document
(pesan)DocumentChange
(pesan)DocumentDelete
(pesan)DocumentMask
(pesan)DocumentRemove
(pesan)DocumentTransform
(pesan)DocumentTransform.FieldTransform
(pesan)DocumentTransform.FieldTransform.ServerValue
(enum)ExecutionStats
(pesan)ExistenceFilter
(pesan)ExplainMetrics
(pesan)ExplainOptions
(pesan)GetDocumentRequest
(pesan)ListCollectionIdsRequest
(pesan)ListCollectionIdsResponse
(pesan)ListDocumentsRequest
(pesan)ListDocumentsResponse
(pesan)ListenRequest
(pesan)ListenResponse
(pesan)MapValue
(pesan)PartitionQueryRequest
(pesan)PartitionQueryResponse
(pesan)PlanSummary
(pesan)Precondition
(pesan)RollbackRequest
(pesan)RunAggregationQueryRequest
(pesan)RunAggregationQueryResponse
(pesan)RunQueryRequest
(pesan)RunQueryResponse
(pesan)StructuredAggregationQuery
(pesan)StructuredAggregationQuery.Aggregation
(pesan)StructuredAggregationQuery.Aggregation.Avg
(pesan)StructuredAggregationQuery.Aggregation.Count
(pesan)StructuredAggregationQuery.Aggregation.Sum
(pesan)StructuredQuery
(pesan)StructuredQuery.CollectionSelector
(pesan)StructuredQuery.CompositeFilter
(pesan)StructuredQuery.CompositeFilter.Operator
(enum)StructuredQuery.Direction
(enum)StructuredQuery.FieldFilter
(pesan)StructuredQuery.FieldFilter.Operator
(enum)StructuredQuery.FieldReference
(pesan)StructuredQuery.Filter
(pesan)StructuredQuery.FindNearest
(pesan)StructuredQuery.FindNearest.DistanceMeasure
(enum)StructuredQuery.Order
(pesan)StructuredQuery.Projection
(pesan)StructuredQuery.UnaryFilter
(pesan)StructuredQuery.UnaryFilter.Operator
(enum)Target
(pesan)Target.DocumentsTarget
(pesan)Target.QueryTarget
(pesan)TargetChange
(pesan)TargetChange.TargetChangeType
(enum)TransactionOptions
(pesan)TransactionOptions.ReadOnly
(pesan)TransactionOptions.ReadWrite
(pesan)UpdateDocumentRequest
(pesan)Value
(pesan)Write
(pesan)WriteRequest
(pesan)WriteResponse
(pesan)WriteResult
(pesan)
Firestore
Layanan Cloud Firestore.
Cloud Firestore adalah database dokumen NoSQL yang cepat, terkelola sepenuhnya, tanpa server, dan berbasis cloud, yang menyederhanakan proses penyimpanan, sinkronisasi, dan pembuatan kueri data untuk aplikasi seluler, web, dan IoT dalam skala global. Library kliennya menyediakan sinkronisasi live dan dukungan offline, sementara fitur keamanan dan integrasinya dengan Firebase dan Google Cloud Platform mempercepat pembuatan aplikasi yang benar-benar serverless.
BatchGetDocuments |
---|
Mendapatkan beberapa dokumen. Dokumen yang ditampilkan dengan metode ini tidak dijamin akan dikembalikan dalam urutan yang sama seperti yang diminta.
|
BatchWrite |
---|
Menerapkan sekumpulan operasi tulis. Metode BatchWrite tidak menerapkan operasi tulis secara atomik dan dapat menerapkannya secara tidak berurutan. Metode tidak mengizinkan lebih dari satu penulisan per dokumen. Setiap penulisan berhasil atau gagal secara independen. Lihat Jika Anda memerlukan kumpulan operasi tulis yang diterapkan secara atomik, gunakan
|
BeginTransaction |
---|
Memulai transaksi baru.
|
Commit |
---|
Melakukan transaksi, sekaligus memperbarui dokumen secara opsional.
|
CreateDocument |
---|
Membuat dokumen baru.
|
DeleteDocument |
---|
Menghapus dokumen.
|
GetDocument |
---|
Mendapatkan satu dokumen.
|
ListCollectionIds |
---|
Mencantumkan semua ID koleksi di bawah dokumen.
|
ListDocuments |
---|
Mencantumkan dokumen.
|
Dengarkan |
---|
Memproses perubahan. Metode ini hanya tersedia melalui gRPC atau WebChannel (bukan REST).
|
PartitionQuery |
---|
Mempartisi kueri dengan menampilkan kursor partisi yang dapat digunakan untuk menjalankan kueri secara paralel. Kursor partisi yang ditampilkan adalah titik terpisah yang dapat digunakan oleh RunQuery sebagai titik awal/akhir untuk hasil kueri.
|
Rollback |
---|
Me-roll back transaksi.
|
RunAggregationQuery |
---|
Menjalankan kueri agregasi. Daripada memberikan hasil Contoh Tingkat Tinggi:
|
RunQuery |
---|
Menjalankan kueri.
|
UpdateDocument |
---|
Memperbarui atau menyisipkan dokumen.
|
Tulis |
---|
Streaming batch pembaruan dan penghapusan dokumen, secara berurutan. Metode ini hanya tersedia melalui gRPC atau WebChannel (bukan REST).
|
AggregationResult
Hasil satu bucket dari kueri agregasi Firestore.
Kunci aggregate_fields
sama untuk semua hasil dalam kueri agregasi, tidak seperti kueri dokumen yang dapat memiliki kolom berbeda untuk setiap hasil.
Kolom | |
---|---|
aggregate_fields |
Hasil fungsi agregasi, misalnya: Kuncinya adalah |
ArrayValue
Nilai array.
Kolom | |
---|---|
values[] |
Nilai dalam array. |
BatchGetDocumentsRequest
Permintaan untuk Firestore.BatchGetDocuments
.
Kolom | |
---|---|
database |
Wajib. Nama database. Dalam format: |
documents[] |
Nama dokumen yang akan diambil. Dalam format: |
mask |
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. |
Kolom union consistency_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
transaction |
Membaca dokumen dalam transaksi. |
new_transaction |
Memulai transaksi baru dan membaca dokumen. Setelan defaultnya adalah transaksi hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam aliran data. |
read_time |
Membaca dokumen sebagaimana adanya pada waktu yang ditentukan. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
BatchGetDocumentsResponse
Respons yang di-streaming untuk Firestore.BatchGetDocuments
.
Kolom | |
---|---|
transaction |
Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya akan ditetapkan dalam respons pertama, dan hanya jika |
read_time |
Waktu saat dokumen dibaca. Jumlah ini mungkin meningkat secara monoton, dalam hal ini dokumen sebelumnya dalam aliran hasil dijamin tidak berubah antara waktu baca dan yang ini. |
Kolom union result . Hasil tunggal. Kolom ini boleh kosong jika server baru saja menampilkan transaksi. result hanya ada berupa salah satu diantara berikut: |
|
found |
Dokumen yang diminta. |
missing |
Nama dokumen yang diminta tetapi tidak ada. Dalam format: |
BatchWriteRequest
Permintaan untuk Firestore.BatchWrite
.
Kolom | |
---|---|
database |
Wajib. Nama database. Dalam format: |
writes[] |
Penulisan yang akan diterapkan. Metode tidak menerapkan penulisan secara atomik dan tidak menjamin pengurutan. Setiap penulisan berhasil atau gagal secara independen. Anda tidak dapat menulis ke dokumen yang sama lebih dari sekali per permintaan. |
labels |
Label yang terkait dengan batch operasi ini. |
BatchWriteResponse
Respons dari Firestore.BatchWrite
.
Kolom | |
---|---|
write_results[] |
Hasil penerapan penulisan. Hasil penulisan i-th ini sesuai dengan penulisan i-th dalam permintaan. |
status[] |
Status penerapan operasi tulis. Status penulisan i-th ini sesuai dengan penulisan ke-i dalam permintaan. |
BeginTransactionRequest
Permintaan untuk Firestore.BeginTransaction
.
Kolom | |
---|---|
database |
Wajib. Nama database. Dalam format: |
options |
Opsi untuk transaksi. Setelan defaultnya adalah transaksi baca-tulis. |
BeginTransactionResponse
Respons untuk Firestore.BeginTransaction
.
Kolom | |
---|---|
transaction |
Transaksi yang dimulai. |
BitSequence
Urutan bit yang dienkode dalam array byte.
Setiap byte dalam array byte bitmap
menyimpan 8 bit urutan. Satu-satunya pengecualian adalah byte terakhir, yang dapat menyimpan 8 atau kurang bit. padding
menentukan jumlah bit byte terakhir yang akan diabaikan sebagai "padding". Nilai bit "padding" ini tidak ditentukan dan harus diabaikan.
Untuk mengambil bit pertama, bit 0, hitung: (bitmap[0] & 0x01) != 0
. Untuk mengambil bit kedua, bit 1, hitung: (bitmap[0] & 0x02) != 0
. Untuk mengambil bit ketiga, bit 2, hitung: (bitmap[0] & 0x04) != 0
. Untuk mengambil bit keempat, bit 3, hitung: (bitmap[0] & 0x08) != 0
. Untuk mengambil bit n, hitung: (bitmap[n / 8] & (0x01 << (n % 8))) != 0
.
"Ukuran" BitSequence
(jumlah bit yang ada di dalamnya) dihitung dengan formula ini: (bitmap.length * 8) - padding
.
Kolom | |
---|---|
bitmap |
Byte yang mengenkode urutan bit. Panjangnya mungkin nol. |
padding |
Jumlah bit byte terakhir dalam |
BloomFilter
Filter mekar (https://en.wikipedia.org/wiki/Bloom_filter).
Mekar filter hash entri dengan MD5 dan memperlakukan hash 128-bit yang dihasilkan sebagai 2 nilai hash 64-bit yang berbeda, ditafsirkan sebagai bilangan bulat yang tidak bertanda tangan menggunakan komplemen 2's encoding.
Kedua nilai hash ini, yang bernama h1
dan h2
, kemudian digunakan untuk menghitung nilai hash hash_count
menggunakan formula, mulai dari i=0
:
h(i) = h1 + (i * h2)
Nilai yang dihasilkan ini kemudian diambil modulo jumlah bit dalam filter mekar untuk mendapatkan bagian dari filter mekar untuk diuji pada entri yang ditentukan.
Kolom | |
---|---|
bits |
Data filter bunga. |
hash_count |
Jumlah hash yang digunakan oleh algoritma. |
CommitRequest
Permintaan untuk Firestore.Commit
.
Kolom | |
---|---|
database |
Wajib. Nama database. Dalam format: |
writes[] |
Penulisan yang akan diterapkan. Selalu dieksekusi secara atomik dan berurutan. |
transaction |
Jika ditetapkan, menerapkan semua penulisan dalam transaksi ini dan melakukan commit. |
CommitResponse
Respons untuk Firestore.Commit
.
Kolom | |
---|---|
write_results[] |
Hasil penerapan penulisan. Hasil penulisan i-th ini sesuai dengan penulisan i-th dalam permintaan. |
commit_time |
Waktu saat commit terjadi. Setiap operasi baca dengan |
CreateDocumentRequest
Permintaan untuk Firestore.CreateDocument
.
Kolom | |
---|---|
parent |
Wajib. Resource induk. Misalnya: |
collection_id |
Wajib. ID koleksi, yang terkait dengan |
document_id |
ID dokumen yang ditetapkan klien untuk digunakan untuk dokumen ini. Opsional. Jika tidak ditentukan, ID akan ditetapkan oleh layanan. |
document |
Wajib. Dokumen yang akan dibuat. |
mask |
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. |
Kursor
Posisi dalam kumpulan hasil kueri.
Kolom | |
---|---|
values[] |
Nilai-nilai yang mewakili posisi, dalam urutan kemunculannya dalam urutan menurut klausa di kueri. Dapat berisi lebih sedikit nilai dari yang ditentukan dalam urutan berdasarkan klausa. |
before |
Jika posisinya tepat sebelum atau setelah nilai yang diberikan, relatif terhadap tata urutan yang ditentukan oleh kueri. |
DeleteDocumentRequest
Permintaan untuk Firestore.DeleteDocument
.
Kolom | |
---|---|
name |
Wajib. Nama resource Dokumen yang akan dihapus. Dalam format: |
current_document |
Prasyarat opsional pada dokumen. Permintaan akan gagal jika hal ini ditetapkan dan tidak dipenuhi oleh dokumen target. |
Dokumen
Dokumen Firestore.
Tidak boleh melebihi 1 MiB - 4 byte.
Kolom | |
---|---|
name |
Nama resource dokumen, misalnya |
fields |
|
create_time |
Hanya output. Waktu saat dokumen dibuat. Nilai ini meningkat secara monoton saat dokumen dihapus lalu dibuat ulang. Nilai ini juga dapat dibandingkan dengan nilai dari dokumen lain dan |
update_time |
Hanya output. Waktu saat dokumen terakhir diubah. Nilai ini awalnya ditetapkan ke |
DocumentChange
Document
telah berubah.
Mungkin merupakan hasil dari beberapa writes
, termasuk penghapusan, yang pada akhirnya menghasilkan nilai baru untuk Document
.
Beberapa pesan DocumentChange
dapat ditampilkan untuk perubahan logis yang sama, jika beberapa target terpengaruh.
Kolom | |
---|---|
document |
Status baru Jika |
target_ids[] |
Kumpulan ID target target yang cocok dengan dokumen ini. |
removed_target_ids[] |
Kumpulan ID target untuk target yang tidak lagi cocok dengan dokumen ini. |
DocumentDelete
Document
telah dihapus.
Mungkin disebabkan oleh beberapa writes
, termasuk pembaruan, yang terakhir di antaranya menghapus Document
.
Beberapa pesan DocumentDelete
dapat ditampilkan untuk penghapusan logis yang sama, jika beberapa target terpengaruh.
Kolom | |
---|---|
document |
Nama resource |
removed_target_ids[] |
Kumpulan ID target untuk target yang sebelumnya cocok dengan entitas ini. |
read_time |
Stempel waktu operasi baca saat penghapusan diamati. Lebih besar atau sama dengan |
DocumentMask
Kumpulan jalur kolom pada dokumen. Digunakan untuk membatasi operasi dapatkan atau update pada dokumen ke sebagian kolomnya. Hal ini berbeda dengan mask kolom standar, karena selalu tercakup ke Document
, dan mempertimbangkan sifat dinamis Value
.
Kolom | |
---|---|
field_paths[] |
Daftar jalur kolom pada mask. Lihat |
DocumentRemove
Document
telah dihapus dari tampilan target.
Dikirim jika dokumen tidak lagi relevan dengan target dan tidak terlihat. Dapat dikirim sebagai pengganti DocumentDelete atau DocumentChange jika server tidak dapat mengirim nilai baru dokumen.
Jika beberapa target terpengaruh, beberapa pesan DocumentRemove
dapat ditampilkan untuk penulisan atau penghapusan logis yang sama.
Kolom | |
---|---|
document |
Nama resource |
removed_target_ids[] |
Kumpulan ID target untuk target yang sebelumnya cocok dengan dokumen ini. |
read_time |
Stempel waktu operasi baca saat penghapusan diamati. Lebih besar atau sama dengan |
DocumentTransform
Transformasi dokumen.
Kolom | |
---|---|
document |
Nama dokumen yang akan diubah. |
field_transforms[] |
Daftar transformasi yang akan diterapkan ke kolom dokumen secara berurutan. Wajib diisi. |
FieldTransform
Transformasi kolom dokumen.
Kolom | |
---|---|
field_path |
Jalur kolom. Lihat |
Kolom union transform_type . Transformasi yang akan diterapkan pada kolom. transform_type hanya ada berupa salah satu diantara berikut: |
|
set_to_server_value |
Menetapkan kolom ke nilai server yang ditentukan. |
increment |
Menambahkan nilai yang diberikan ke nilai kolom saat ini. Nilai ini harus berupa 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 akan ditafsirkan sebagai ganda. Aritmatika ganda dan representasi nilai ganda mengikuti semantik IEEE 754. Jika ada luapan bilangan bulat positif/negatif, bidang akan diselesaikan ke bilangan bulat positif/negatif terbesar. |
maximum |
Menetapkan kolom ke nilai maksimum saat ini dan nilai yang diberikan. Nilai ini harus berupa 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 dengan kolom dan nilai input berjenis campuran (yaitu - satu adalah integer dan satu lagi adalah ganda), kolom akan menggunakan jenis operand yang lebih besar. Jika operand setara (mis. 3 dan 3.0), kolom tidak akan berubah. 0, 0,0, dan -0,0 semuanya bernilai nol. Nilai maksimum dari nilai tersimpan dan nilai input nol selalu merupakan nilai yang disimpan. Nilai numerik maksimum x dan NaN adalah NaN. |
minimum |
Menetapkan kolom ke nilai minimum saat ini dan nilai yang diberikan. Nilai ini harus berupa bilangan bulat atau nilai ganda. Jika kolom bukan bilangan bulat atau ganda, atau jika kolom belum ada, transformasi akan menetapkan kolom ke nilai input. Jika operasi minimum diterapkan dengan kolom dan nilai input berjenis campuran (yaitu - satu adalah integer dan satu lagi adalah ganda), kolom akan menggunakan jenis operand yang lebih kecil. Jika operand setara (mis. 3 dan 3.0), kolom tidak akan berubah. 0, 0,0, dan -0,0 semuanya bernilai nol. Nilai minimum dari nilai tersimpan dan nilai input nol selalu merupakan nilai yang disimpan. Nilai minimum dari nilai numerik x dan NaN adalah NaN. |
append_missing_elements |
Menambahkan elemen yang ditentukan secara berurutan jika belum ada di nilai kolom saat ini. Jika kolom tersebut bukan array, atau jika kolom belum ada, kolom tersebut akan ditetapkan ke array kosong terlebih dahulu. Angka yang setara dari jenis yang berbeda (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 menjadi nilai null. |
remove_all_from_array |
Menghapus semua elemen yang diberikan dari array dalam kolom. Jika kolom tersebut bukan array, atau jika kolom belum ada, kolom ini akan disetel ke array kosong. Jumlah yang setara dari jenis yang berbeda (mis. 3L dan 3,0) dianggap sama ketika memutuskan apakah suatu elemen harus dihapus. 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 menjadi nilai null. |
ServerValue
Nilai yang dihitung oleh server.
Enum | |
---|---|
SERVER_VALUE_UNSPECIFIED |
Tidak ditentukan. Nilai ini tidak boleh digunakan. |
REQUEST_TIME |
Waktu saat server memproses permintaan, dengan presisi milidetik. Jika digunakan di beberapa kolom (dokumen yang sama atau berbeda) dalam sebuah transaksi, semua kolom akan mendapatkan stempel waktu server yang sama. |
ExecutionStats
Statistik eksekusi untuk kueri.
Kolom | |
---|---|
results_returned |
Total jumlah hasil yang ditampilkan, termasuk dokumen, proyeksi, hasil agregasi, dan kunci. |
execution_duration |
Total waktu untuk menjalankan kueri di backend. |
read_operations |
Total operasi baca yang dapat ditagih. |
debug_stats |
Statistik proses debug dari eksekusi kueri. Perlu diperhatikan bahwa statistik proses debug dapat berubah seiring perkembangan Firestore. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } } |
ExistenceFilter
Ringkasan semua dokumen yang sesuai dengan target yang diberikan.
Kolom | |
---|---|
target_id |
ID target tempat filter ini diterapkan. |
count |
Jumlah total dokumen yang cocok dengan Jika berbeda dari jumlah dokumen dalam klien yang cocok, klien harus secara manual menentukan dokumen mana yang tidak lagi sesuai dengan target. Klien dapat menggunakan filter bloom |
unchanged_names |
Filter bloom yang, apa pun namanya, berisi encoding byte UTF-8 dari nama resource SEMUA dokumen yang cocok dengan Filter bloom ini dapat dihilangkan atas diskresi server, seperti jika dianggap bahwa klien tidak akan memanfaatkannya atau jika terlalu mahal secara komputasi untuk dihitung atau dikirim. Klien harus dengan baik menangani kolom ini yang tidak ada dengan kembali ke logika yang digunakan sebelum kolom ini ada; yaitu, menambahkan kembali target tanpa token resume untuk mencari tahu dokumen mana dalam cache klien yang tidak sinkron. |
ExplainMetrics
Menjelaskan metrik untuk kueri.
Kolom | |
---|---|
plan_summary |
Informasi fase perencanaan untuk kueri. |
execution_stats |
Statistik gabungan dari eksekusi kueri. Hanya ada jika |
ExplainOptions
Menjelaskan opsi untuk kueri tersebut.
Kolom | |
---|---|
analyze |
Opsional. Apakah akan mengeksekusi kueri ini. Jika false (default), kueri akan direncanakan, yang hanya menampilkan metrik dari tahap perencanaan. Jika true (benar), kueri akan direncanakan dan dieksekusi, yang menampilkan hasil kueri lengkap beserta metrik tahap perencanaan dan eksekusi. |
GetDocumentRequest
Permintaan untuk Firestore.GetDocument
.
Kolom | |
---|---|
name |
Wajib. Nama resource Dokumen yang akan didapatkan. Dalam format: |
mask |
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. |
Kolom union consistency_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
transaction |
Membaca dokumen dalam transaksi. |
read_time |
Membaca versi dokumen pada waktu tertentu. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
ListCollectionIdsRequest
Permintaan untuk Firestore.ListCollectionIds
.
Kolom | |
---|---|
parent |
Wajib. Dokumen induk. Dalam format: |
page_size |
Jumlah hasil maksimum yang akan ditampilkan. |
page_token |
Token halaman. Harus berupa nilai dari |
Kolom union consistency_selector . Mode konsistensi untuk permintaan ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
read_time |
Membaca dokumen sebagaimana adanya pada waktu yang ditentukan. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
ListCollectionIdsResponse
Respons dari Firestore.ListCollectionIds
.
Kolom | |
---|---|
collection_ids[] |
ID koleksi. |
next_page_token |
Token halaman yang dapat digunakan untuk melanjutkan daftar. |
ListDocumentsRequest
Permintaan untuk Firestore.ListDocuments
.
Kolom | |
---|---|
parent |
Wajib. Nama resource induk. Dalam format: Misalnya: |
collection_id |
Opsional. ID koleksi, yang terkait dengan Misalnya: Hal ini bersifat opsional. Jika tidak disediakan, Firestore akan mencantumkan dokumen dari semua koleksi pada |
page_size |
Opsional. Jumlah maksimum dokumen yang akan ditampilkan dalam satu respons. Firestore mungkin menampilkan lebih sedikit dari nilai ini. |
page_token |
Opsional. Token halaman, diterima dari respons Berikan ini untuk mengambil halaman berikutnya. Saat melakukan penomoran halaman, semua parameter lainnya (kecuali |
order_by |
Opsional. Urutan opsional dokumen yang akan ditampilkan. Misalnya: Ini mencerminkan |
mask |
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. |
show_missing |
Apakah daftar akan menampilkan dokumen yang tidak ada. Dokumen hilang jika tidak ada, tetapi ada sub-dokumen yang disusun bertingkat di bawahnya. Jika benar (true), dokumen yang hilang tersebut akan ditampilkan dengan kunci, tetapi tidak akan memiliki kolom, Permintaan dengan |
Kolom union consistency_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
transaction |
Lakukan operasi baca sebagai bagian dari transaksi yang sudah aktif. |
read_time |
Melakukan pembacaan pada waktu yang disediakan. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
ListDocumentsResponse
Respons untuk Firestore.ListDocuments
.
Kolom | |
---|---|
documents[] |
Dokumen ditemukan. |
next_page_token |
Token untuk mengambil halaman dokumen berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya. |
ListenRequest
Permintaan untuk Firestore.Listen
Kolom | |
---|---|
database |
Wajib. Nama database. Dalam format: |
labels |
Label yang terkait dengan perubahan target ini. |
Kolom union target_change . Perubahan target yang didukung. target_change hanya ada berupa salah satu diantara berikut: |
|
add_target |
Target untuk ditambahkan ke streaming ini. |
remove_target |
ID target yang akan dihapus dari aliran data ini. |
ListenResponse
Respons untuk Firestore.Listen
.
Kolom | |
---|---|
Kolom union response_type . Respons yang didukung. response_type hanya ada berupa salah satu diantara berikut: |
|
target_change |
Target telah berubah. |
document_change |
|
document_delete |
|
document_remove |
|
filter |
Filter yang akan diterapkan ke kumpulan dokumen yang sebelumnya ditampilkan untuk target tertentu. Ditampilkan saat dokumen mungkin telah dihapus dari target yang diberikan, tetapi dokumen persisnya tidak diketahui. |
MapValue
Nilai peta.
Kolom | |
---|---|
fields |
Kolom peta. Kunci peta mewakili nama kolom. Nama kolom yang cocok dengan ekspresi reguler |
PartitionQueryRequest
Permintaan untuk Firestore.PartitionQuery
.
Kolom | |
---|---|
parent |
Wajib. Nama resource induk. Dalam format: |
partition_count |
Jumlah titik partisi maksimum yang diinginkan. Partisi dapat ditampilkan di beberapa halaman hasil. Angkanya harus positif. Jumlah partisi sebenarnya yang ditampilkan mungkin lebih sedikit. Misalnya, nilai ini dapat disetel menjadi kurang dari jumlah kueri paralel yang akan dijalankan, atau dalam menjalankan tugas pipeline data, jumlahnya lebih sedikit dari jumlah pekerja atau instance komputasi yang tersedia. |
page_token |
Nilai Misalnya, dua panggilan berikutnya yang menggunakan page_token dapat menampilkan:
Untuk memperoleh kumpulan hasil lengkap yang diurutkan sehubungan dengan hasil kueri yang diberikan ke PartitionQuery, kumpulan hasil tersebut harus digabungkan: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W |
page_size |
Jumlah partisi maksimum untuk ditampilkan dalam panggilan ini, tunduk pada Misalnya, jika |
Kolom union query_type . Kueri untuk mempartisi. query_type hanya ada berupa salah satu diantara berikut: |
|
structured_query |
Kueri terstruktur. Kueri harus menentukan koleksi dengan semua turunan dan diurutkan berdasarkan nama menaik. Filter, urutan menurut, batas, offset, dan kursor awal/akhir lainnya tidak didukung. |
Kolom union consistency_selector . Mode konsistensi untuk permintaan ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
read_time |
Membaca dokumen sebagaimana adanya pada waktu yang ditentukan. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
PartitionQueryResponse
Respons untuk Firestore.PartitionQuery
.
Kolom | |
---|---|
partitions[] |
Hasil partisi. Setiap partisi adalah titik pemisahan 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 dengan hasil kueri yang diberikan ke PartitionQuery. Misalnya, jika permintaan PartitionQuery menampilkan kursor partisi A dan B, menjalankan tiga kueri berikut akan menampilkan seluruh kumpulan hasil kueri asli:
Hasil kosong dapat menunjukkan bahwa kueri memiliki hasil yang terlalu sedikit untuk dipartisi, atau kueri belum didukung untuk partisi. |
next_page_token |
Token halaman yang dapat digunakan untuk meminta serangkaian hasil tambahan, hingga jumlah yang ditentukan oleh |
PlanSummary
Informasi fase perencanaan untuk kueri.
Kolom | |
---|---|
indexes_used[] |
Indeks yang dipilih untuk kueri. For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] |
Precondition
Prasyarat pada dokumen, digunakan untuk operasi bersyarat.
Kolom | |
---|---|
Kolom union condition_type . Jenis prasyarat. condition_type hanya ada berupa salah satu diantara berikut: |
|
exists |
Jika ditetapkan ke |
update_time |
Jika ditetapkan, dokumen target harus ada dan terakhir diperbarui pada saat itu. Stempel waktu harus selaras dalam mikrodetik. |
RollbackRequest
Permintaan untuk Firestore.Rollback
.
Kolom | |
---|---|
database |
Wajib. Nama database. Dalam format: |
transaction |
Wajib. Transaksi yang akan di-roll back. |
RunAggregationQueryRequest
Permintaan untuk Firestore.RunAggregationQuery
.
Kolom | |
---|---|
parent |
Wajib. Nama resource induk. Dalam format: |
explain_options |
Opsional. Menjelaskan opsi untuk kueri tersebut. 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: |
|
structured_aggregation_query |
Kueri agregasi. |
Kolom union consistency_selector . Mode konsistensi untuk kueri secara default disetel ke konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
transaction |
Jalankan agregasi dalam transaksi yang sudah aktif. Nilai di sini adalah ID transaksi buram untuk mengeksekusi kueri. |
new_transaction |
Memulai transaksi baru sebagai bagian dari kueri, yang setelan defaultnya adalah hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam aliran data. |
read_time |
Mengeksekusi kueri pada stempel waktu yang ditentukan. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
RunAggregationQueryResponse
Respons untuk Firestore.RunAggregationQuery
.
Kolom | |
---|---|
result |
Hasil agregasi tunggal. Tidak ada saat melaporkan progres sebagian. |
transaction |
Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya ada di respons pertama saat permintaan meminta untuk memulai transaksi baru. |
read_time |
Waktu saat hasil agregat dihitung. Hal ini selalu meningkat secara monoton; dalam hal ini, AggregationResult sebelumnya di aliran hasil dijamin tidak berubah antara Jika kueri tidak menampilkan hasil, respons dengan |
explain_metrics |
Mengkueri metrik. Hal ini hanya ada jika |
RunQueryRequest
Permintaan untuk Firestore.RunQuery
.
Kolom | |
---|---|
parent |
Wajib. Nama resource induk. Dalam format: |
explain_options |
Opsional. Menjelaskan opsi untuk kueri tersebut. 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: |
|
structured_query |
Kueri terstruktur. |
Kolom union consistency_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, setelan default-nya 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. |
new_transaction |
Memulai transaksi baru dan membaca dokumen. Setelan defaultnya adalah transaksi hanya baca. ID transaksi baru akan ditampilkan sebagai respons pertama dalam aliran data. |
read_time |
Membaca dokumen sebagaimana adanya pada waktu yang ditentukan. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
RunQueryResponse
Respons untuk Firestore.RunQuery
.
Kolom | |
---|---|
transaction |
Transaksi yang dimulai sebagai bagian dari permintaan ini. Hanya dapat ditetapkan dalam respons pertama, dan hanya jika |
document |
Hasil kueri, tidak disetel saat melaporkan progres sebagian. |
read_time |
Waktu saat dokumen dibaca. Jumlah ini mungkin meningkat secara monoton; dalam kasus ini, dokumen sebelumnya dalam aliran hasil dijamin tidak berubah antara Jika kueri tidak menampilkan hasil, respons dengan |
skipped_results |
Jumlah hasil yang dilewati karena adanya offset antara respons terakhir dan respons saat ini. |
explain_metrics |
Mengkueri metrik. Hal ini hanya ada jika |
Kolom union continuation_selector . Mode kelanjutan untuk kueri. Jika ada, ini menunjukkan bahwa streaming respons kueri saat ini telah selesai. Kolom ini dapat ditetapkan dengan atau tanpa adanya document , tetapi jika ditetapkan, tidak ada hasil lagi yang ditampilkan. continuation_selector hanya dapat berupa salah satu dari yang berikut: |
|
done |
Jika ada, berarti Firestore telah menyelesaikan permintaan sepenuhnya dan tidak ada lagi dokumen yang akan ditampilkan. |
StructuredAggregationQuery
Kueri Firestore untuk menjalankan agregasi pada StructuredQuery
.
Kolom | |
---|---|
aggregations[] |
Opsional. Serangkaian agregasi yang akan diterapkan pada hasil Memerlukan:
|
Kolom union query_type . Kueri dasar yang akan digabungkan. query_type hanya ada berupa salah satu diantara berikut: |
|
structured_query |
Kueri terstruktur bertingkat. |
Agregasi
Menentukan agregasi yang menghasilkan satu hasil.
Kolom | |
---|---|
alias |
Opsional. Nama opsional kolom untuk menyimpan hasil agregasi. Jika tidak diberikan, Firestore akan memilih nama default dengan mengikuti format
menjadi:
Memerlukan:
|
Kolom union operator . Jenis agregasi yang akan dilakukan, diperlukan. operator hanya ada berupa salah satu diantara berikut: |
|
count |
Agregator jumlah. |
sum |
Agregator jumlah. |
avg |
Agregator rata-rata. |
Avg
Rata-rata nilai kolom yang diminta.
Hanya nilai numerik yang akan diagregasi. Semua nilai non-numerik termasuk
NULL
akan dilewati.Jika nilai gabungan berisi
NaN
, tampilkanNaN
. Matematika tak terbatas mengikuti standar IEEE-754.Jika kumpulan nilai gabungan kosong, tampilkan
NULL
.Selalu tampilkan hasilnya sebagai ganda.
Kolom | |
---|---|
field |
Kolom yang akan digabungkan. |
Jumlah
Jumlah dokumen yang cocok dengan kueri.
Fungsi agregasi COUNT(*)
beroperasi di seluruh dokumen sehingga tidak memerlukan referensi kolom.
Kolom | |
---|---|
up_to |
Opsional. Batasan opsional pada jumlah maksimum dokumen yang akan dihitung. Cara ini menyediakan cara untuk menetapkan batas atas jumlah dokumen yang akan dipindai, membatasi latensi, dan biaya. Tidak ditentukan ditafsirkan sebagai tanpa ikatan. Contoh Tingkat Tinggi:
Memerlukan:
|
Total
Jumlah nilai kolom yang diminta.
Hanya nilai numerik yang akan diagregasi. Semua nilai non-numerik termasuk
NULL
akan dilewati.Jika nilai gabungan berisi
NaN
, tampilkanNaN
. Matematika tak terbatas mengikuti standar IEEE-754.Jika kumpulan nilai gabungan kosong, nilai yang ditampilkan adalah 0.
Menampilkan bilangan bulat 64-bit jika semua angka gabungan adalah bilangan bulat dan hasil jumlah tidak meluap. Jika tidak, hasilnya ditampilkan sebagai ganda. Perhatikan bahwa meskipun semua nilai gabungan adalah bilangan bulat, hasilnya akan ditampilkan sebagai ganda jika tidak bisa muat dalam bilangan bulat 64-bit yang telah ditandai. Jika hal ini terjadi, nilai yang ditampilkan akan kehilangan presisi.
Jika terjadi underflow, agregasi floating point bersifat non-deterministik. Ini berarti, menjalankan kueri yang sama berulang kali tanpa perubahan apa pun pada nilai yang mendasarinya dapat memberikan hasil yang sedikit berbeda setiap waktu. Dalam kasus tersebut, nilai harus disimpan sebagai bilangan bulat di atas angka floating point.
Kolom | |
---|---|
field |
Kolom yang akan digabungkan. |
StructuredQuery
Kueri Firestore.
Tahapan kueri dijalankan dengan urutan sebagai berikut: 1. dari 2. di mana 3. pilih 4. order_by + start_at + end_at 5. offset 6. limit
Kolom | |
---|---|
select |
Subkumpulan kolom opsional yang akan ditampilkan. Hal ini bertindak sebagai |
from[] |
Koleksi yang akan dikueri. |
where |
Filter yang akan diterapkan. |
order_by[] |
Urutan yang akan diterapkan ke hasil kueri. Firestore memungkinkan pemanggil untuk menyediakan pemesanan lengkap, pemesanan parsial, atau tidak ada pemesanan sama sekali. Dalam semua kasus, Firestore menjamin pengurutan yang stabil melalui aturan berikut:
Kolom ditambahkan dengan arah pengurutan yang sama seperti urutan terakhir yang ditentukan, atau 'ASCENDING' jika tidak ada urutan yang ditentukan. Contoh:
|
start_at |
Awalan potensial dari posisi dalam kumpulan hasil untuk memulai kueri. Urutan kumpulan hasil didasarkan pada klausa
Hasil kueri ini diurutkan berdasarkan Kursor dapat merujuk ke urutan lengkap atau awalan lokasi, meskipun tidak dapat merujuk lebih banyak kolom daripada yang ada di Melanjutkan contoh di atas, melampirkan kursor awal berikut akan memiliki dampak yang berbeda:
Tidak seperti Memerlukan:
|
end_at |
Awalan potensial dari posisi dalam hasil yang ditetapkan untuk mengakhiri kueri. Ini mirip dengan Memerlukan:
|
offset |
Jumlah dokumen yang harus dilewati sebelum menampilkan hasil pertama. Ini berlaku setelah batasan yang ditentukan oleh Memerlukan:
|
limit |
Jumlah hasil maksimum yang akan ditampilkan. Berlaku setelah semua batasan lainnya. Memerlukan:
|
find_nearest |
Opsional. Penelusuran calon tetangga terdekat. Berlaku setelah semua filter dan pengurutan lainnya. Menemukan embedding vektor terdekat ke vektor kueri yang ditentukan. |
CollectionSelector
Pilihan koleksi, seperti messages as m1
.
Kolom | |
---|---|
collection_id |
ID koleksi. Jika ditetapkan, hanya akan memilih koleksi dengan ID ini. |
all_descendants |
Jika salah, hanya memilih koleksi yang merupakan turunan langsung dari |
CompositeFilter
Filter yang menggabungkan beberapa filter lain menggunakan operator yang diberikan.
Kolom | |
---|---|
op |
Operator untuk menggabungkan beberapa filter. |
filters[] |
Daftar filter untuk digabungkan. Memerlukan:
|
Operator
Operator filter gabungan.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Tidak ditentukan. Nilai ini tidak boleh digunakan. |
AND |
Dokumen diperlukan untuk memenuhi semua filter gabungan. |
OR |
Dokumen diperlukan untuk memenuhi setidaknya salah satu filter gabungan. |
Arah
Arah pengurutan.
Enum | |
---|---|
DIRECTION_UNSPECIFIED |
Tidak ditentukan. |
ASCENDING |
Menaik. |
DESCENDING |
Menurun. |
FieldFilter
Filter pada kolom tertentu.
Kolom | |
---|---|
field |
Kolom yang akan digunakan untuk memfilter. |
op |
Operator yang akan digunakan untuk memfilter. |
value |
Nilai yang akan dibandingkan. |
Operator
Operator filter kolom.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Tidak ditentukan. Nilai ini tidak boleh digunakan. |
LESS_THAN |
Memerlukan:
|
LESS_THAN_OR_EQUAL |
Memerlukan:
|
GREATER_THAN |
Memerlukan:
|
GREATER_THAN_OR_EQUAL |
Memerlukan:
|
EQUAL |
field yang diberikan sama dengan value yang ditentukan. |
NOT_EQUAL |
Memerlukan:
|
ARRAY_CONTAINS |
field yang diberikan adalah array yang berisi value yang diberikan. |
IN |
Memerlukan:
|
ARRAY_CONTAINS_ANY |
Memerlukan:
|
NOT_IN |
Nilai Memerlukan:
|
FieldReference
Referensi ke kolom dalam dokumen, misalnya: stats.operations
.
Kolom | |
---|---|
field_path |
Referensi ke kolom dalam dokumen. Memerlukan:
|
Filter
Sebuah filter.
Kolom | |
---|---|
Kolom union filter_type . Jenis filter. filter_type hanya ada berupa salah satu diantara berikut: |
|
composite_filter |
Filter gabungan. |
field_filter |
Filter di kolom dokumen. |
unary_filter |
Filter yang mengambil tepat satu argumen. |
FindNearest
Konfigurasi penelusuran Nearest Neighbors.
Kolom | |
---|---|
vector_field |
Wajib. Kolom vektor terindeks untuk ditelusuri. Hanya dokumen yang berisi vektor yang dimensinya cocok dengan query_vector yang dapat ditampilkan. |
query_vector |
Wajib. Vektor kueri yang kita telusuri. Harus berupa vektor tidak lebih dari 2048 dimensi. |
distance_measure |
Wajib. Ukuran jarak yang akan digunakan, diperlukan. |
limit |
Wajib. Jumlah tetangga terdekat yang akan kembali. Harus berupa bilangan bulat positif yang tidak lebih dari 1000. |
DistanceMeasure
Ukuran jarak yang akan digunakan ketika membandingkan vektor.
Enum | |
---|---|
DISTANCE_MEASURE_UNSPECIFIED |
Tidak boleh ditetapkan. |
EUCLIDEAN |
Mengukur jarak EUCLIDEAN antarvektor. Lihat Euclidean untuk mempelajari lebih lanjut |
COSINE |
Membandingkan berbagai vektor berdasarkan sudut antarvektor, yang memungkinkan Anda mengukur kesamaan yang tidak didasarkan pada besarnya vektor. Kami menyarankan untuk menggunakan DOT_PRODUCT dengan vektor unit yang dinormalisasi alih-alih jarak COSINE, yang secara matematis setara dengan kinerja yang lebih baik. Lihat Cosine Similarity (Kemiripan Kosinus) untuk mempelajari lebih lanjut. |
DOT_PRODUCT |
Mirip dengan kosinus tetapi dipengaruhi oleh besarnya vektor. Lihat Produk Dot untuk mempelajari lebih lanjut. |
Pesan
Pesanan di kolom.
Kolom | |
---|---|
field |
Kolom untuk mengurutkan. |
direction |
Arah pengurutan. Default-nya adalah |
Proyeksi
Proyeksi kolom dokumen yang akan ditampilkan.
Kolom | |
---|---|
fields[] |
Kolom yang akan ditampilkan. Jika kosong, semua kolom akan ditampilkan. Untuk menampilkan nama dokumen saja, gunakan |
UnaryFilter
Filter dengan satu operand.
Kolom | |
---|---|
op |
Operator unary yang akan diterapkan. |
Kolom union operand_type . Argumen untuk filter. operand_type hanya ada berupa salah satu diantara berikut: |
|
field |
Kolom tempat operator akan diterapkan. |
Operator
Operator unary.
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
Tidak ditentukan. Nilai ini tidak boleh digunakan. |
IS_NAN |
field yang ditentukan sama dengan NaN . |
IS_NULL |
field yang ditentukan sama dengan NULL . |
IS_NOT_NAN |
Memerlukan:
|
IS_NOT_NULL |
Memerlukan:
|
Target
Spesifikasi dari kumpulan dokumen yang akan diproses.
Kolom | |
---|---|
target_id |
ID target yang mengidentifikasi target pada streaming. Harus berupa angka positif dan bukan nol. Jika Perhatikan bahwa jika klien mengirim beberapa permintaan Jika |
once |
Apakah target harus dihapus setelah statusnya masih berlaku dan konsisten. |
expected_count |
Jumlah dokumen yang terakhir cocok dengan kueri pada token resume atau waktu baca. Nilai ini hanya relevan jika |
Kolom union target_type . Jenis target yang akan diproses. target_type hanya ada berupa salah satu diantara berikut: |
|
query |
Target yang ditentukan oleh kueri. |
documents |
Target yang ditentukan oleh kumpulan nama dokumen. |
Kolom union Jika ditentukan, hanya Dokumen yang cocok yang telah diperbarui SETELAH |
|
resume_token |
Token melanjutkan dari Menggunakan token resume dengan target yang berbeda tidak didukung dan bisa gagal. |
read_time |
Mulai mendengarkan setelah Klien harus mengetahui status dokumen yang cocok pada saat ini. |
DocumentsTarget
Target yang ditentukan oleh sekumpulan nama dokumen.
Kolom | |
---|---|
documents[] |
Nama dokumen yang akan diambil. Dalam format: |
QueryTarget
Target yang ditentukan oleh kueri.
Kolom | |
---|---|
parent |
Nama resource induk. Dalam format: |
Kolom union query_type . Kueri yang akan dijalankan. query_type hanya ada berupa salah satu diantara berikut: |
|
structured_query |
Kueri terstruktur. |
TargetChange
Target yang ditonton telah berubah.
Kolom | |
---|---|
target_change_type |
Jenis perubahan yang terjadi. |
target_ids[] |
ID target target yang telah berubah. Jika kosong, perubahan akan diterapkan ke semua target. Urutan ID target tidak ditentukan. |
cause |
Error yang mengakibatkan perubahan ini, jika berlaku. |
resume_token |
Token yang dapat digunakan untuk melanjutkan streaming untuk Tidak ditetapkan pada setiap perubahan target. |
read_time |
Aliran data dijamin akan mengirim Untuk aliran tertentu, |
TargetChangeType
Jenis perubahan.
Enum | |
---|---|
NO_CHANGE |
Tidak ada perubahan yang terjadi. Digunakan hanya untuk mengirim resume_token yang diperbarui. |
ADD |
Target telah ditambahkan. |
REMOVE |
Target telah dihapus. |
CURRENT |
Target mencerminkan semua perubahan yang dilakukan sebelum target ditambahkan ke aliran data. Ini akan dikirim setelah atau dengan Pemroses dapat menunggu perubahan ini jika semantik baca setelah tulis diinginkan. |
RESET |
Target telah direset, dan status awal baru untuk target akan ditampilkan dalam perubahan berikutnya. Setelah status awal selesai, |
TransactionOptions
Opsi untuk membuat transaksi baru.
Kolom | |
---|---|
Kolom union mode . Mode transaksi. mode hanya ada berupa salah satu diantara berikut: |
|
read_only |
Transaksi hanya dapat digunakan untuk operasi baca. |
read_write |
Transaksi ini dapat digunakan untuk operasi baca dan tulis. |
ReadOnly
Opsi untuk transaksi yang hanya dapat digunakan untuk membaca dokumen.
Kolom | |
---|---|
Kolom union consistency_selector . Mode konsistensi untuk transaksi ini. Jika tidak disetel, setelan default-nya adalah konsistensi kuat. consistency_selector hanya ada berupa salah satu diantara berikut: |
|
read_time |
Membaca dokumen pada waktu tertentu. Ini harus berupa stempel waktu presisi mikrodetik dalam satu jam terakhir, atau jika Pemulihan Point-in-Time diaktifkan, dapat juga berupa stempel waktu menit penuh dalam 7 hari terakhir. |
ReadWrite
Opsi untuk transaksi yang dapat digunakan untuk membaca dan menulis dokumen.
Firestore tidak mengizinkan permintaan autentikasi pihak ketiga untuk membuat transaksi baca-tulis.
Kolom | |
---|---|
retry_transaction |
Transaksi opsional untuk dicoba lagi. |
UpdateDocumentRequest
Permintaan untuk Firestore.UpdateDocument
.
Kolom | |
---|---|
document |
Wajib. Dokumen yang diperbarui. Membuat dokumen jika belum ada. |
update_mask |
Kolom yang akan diperbarui. Tidak ada jalur kolom dalam mask yang boleh berisi nama yang dicadangkan. Jika dokumen ada di server dan memiliki kolom yang tidak dirujuk di mask, kolom tersebut tidak akan berubah. Kolom yang dirujuk dalam mask, tetapi tidak ada di dokumen input, akan dihapus dari dokumen di server. |
mask |
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. |
current_document |
Prasyarat opsional pada dokumen. Permintaan akan gagal jika hal ini ditetapkan dan tidak dipenuhi oleh dokumen target. |
Nilai
Pesan yang dapat menyimpan salah satu jenis nilai yang didukung.
Kolom | |
---|---|
Kolom union value_type . Harus memiliki kumpulan nilai. value_type hanya ada berupa salah satu diantara berikut: |
|
null_value |
Nilai null. |
boolean_value |
Nilai boolean. |
integer_value |
Nilai bilangan bulat. |
double_value |
Nilai ganda. |
timestamp_value |
Nilai stempel waktu. Presisi hanya hingga mikrodetik. Jika disimpan, presisi tambahan akan dibulatkan ke bawah. |
string_value |
Nilai string. String, yang dinyatakan sebagai UTF-8, tidak boleh melebihi 1 MiB - 89 byte. Hanya 1.500 byte pertama dari representasi UTF-8 yang dipertimbangkan oleh kueri. |
bytes_value |
Nilai byte. Tidak boleh melebihi 1 MiB - 89 byte. Hanya 1.500 byte pertama yang dipertimbangkan oleh kueri. |
reference_value |
Referensi ke dokumen. Misalnya: |
geo_point_value |
Nilai titik geografis yang mewakili titik di permukaan Bumi. |
array_value |
Nilai array. Tidak dapat langsung berisi nilai array lain, meskipun dapat berisi peta yang berisi array lain. |
map_value |
Nilai peta. |
Tulis
Penulisan pada dokumen.
Kolom | |
---|---|
update_mask |
Kolom yang akan diperbarui dalam penulisan ini. Kolom ini hanya dapat ditetapkan jika operasinya adalah |
update_transforms[] |
Transformasi yang akan dilakukan setelah update. Kolom ini hanya dapat ditetapkan jika operasinya adalah |
current_document |
Prasyarat opsional pada dokumen. Penulisan akan gagal jika hal ini ditetapkan dan tidak dipenuhi oleh dokumen target. |
Kolom union operation . Operasi yang akan dieksekusi. operation hanya ada berupa salah satu diantara berikut: |
|
update |
Dokumen yang akan ditulis. |
delete |
Nama dokumen yang akan dihapus. Dalam format: |
transform |
Menerapkan transformasi pada dokumen. |
WriteRequest
Permintaan untuk Firestore.Write
.
Permintaan pertama membuat streaming, atau melanjutkan permintaan yang sudah ada dari token.
Saat membuat streaming baru, server akan membalas dengan respons yang hanya berisi ID dan token, untuk digunakan dalam permintaan berikutnya.
Saat melanjutkan streaming, server terlebih dahulu melakukan streaming respons apa pun yang lebih lambat dari token yang diberikan, lalu respons yang hanya berisi token terbaru, untuk digunakan dalam permintaan berikutnya.
Kolom | |
---|---|
database |
Wajib. Nama database. Dalam format: |
stream_id |
ID aliran data tulis yang akan dilanjutkan. Ini hanya dapat ditetapkan di pesan pertama. Jika dibiarkan kosong, aliran data tulis baru akan dibuat. |
writes[] |
Penulisan yang akan diterapkan. Selalu dieksekusi secara atomik dan berurutan. Kolom ini harus kosong pada permintaan pertama. Kolom ini mungkin kosong pada permintaan terakhir. Kolom ini tidak boleh kosong di semua permintaan lainnya. |
stream_token |
Token aliran data yang sebelumnya dikirim oleh server. Klien harus menetapkan kolom ini ke token dari Server dapat menutup streaming jika ada terlalu banyak respons yang tidak dikonfirmasi. Biarkan kolom ini tidak disetel saat membuat streaming baru. Untuk melanjutkan streaming pada titik tertentu, tetapkan kolom ini dan kolom Biarkan kolom ini tidak disetel saat membuat streaming baru. |
labels |
Label yang terkait dengan permintaan tulis ini. |
WriteResponse
Respons untuk Firestore.Write
.
Kolom | |
---|---|
stream_id |
ID aliran data. Hanya disetel pada pesan pertama, saat streaming baru dibuat. |
stream_token |
Token yang mewakili posisi respons ini dalam aliran data. Langkah ini dapat digunakan oleh klien untuk melanjutkan streaming pada tahap ini. Kolom ini selalu ditetapkan. |
write_results[] |
Hasil penerapan penulisan. Hasil penulisan i-th ini sesuai dengan penulisan i-th dalam permintaan. |
commit_time |
Waktu saat commit terjadi. Setiap operasi baca dengan |
WriteResult
Hasil penerapan operasi tulis.
Kolom | |
---|---|
update_time |
Waktu pembaruan terakhir dokumen setelah menerapkan penulisan. Tidak ditetapkan setelah Jika penulisan tidak benar-benar mengubah dokumen, ini akan menjadi update_time sebelumnya. |
transform_results[] |
Hasil penerapan setiap |