ดัชนี
Firestore
(อินเทอร์เฟซ)AggregationResult
(ข้อความ)ArrayValue
(ข้อความ)BatchGetDocumentsRequest
(ข้อความ)BatchGetDocumentsResponse
(ข้อความ)BatchWriteRequest
(ข้อความ)BatchWriteResponse
(ข้อความ)BeginTransactionRequest
(ข้อความ)BeginTransactionResponse
(ข้อความ)BitSequence
(ข้อความ)BloomFilter
(ข้อความ)CommitRequest
(ข้อความ)CommitResponse
(ข้อความ)CreateDocumentRequest
(ข้อความ)Cursor
(ข้อความ)DeleteDocumentRequest
(ข้อความ)Document
(ข้อความ)DocumentChange
(ข้อความ)DocumentDelete
(ข้อความ)DocumentMask
(ข้อความ)DocumentRemove
(ข้อความ)DocumentTransform
(ข้อความ)DocumentTransform.FieldTransform
(ข้อความ)DocumentTransform.FieldTransform.ServerValue
(enum)ExecutionStats
(ข้อความ)ExistenceFilter
(ข้อความ)ExplainMetrics
(ข้อความ)ExplainOptions
(ข้อความ)GetDocumentRequest
(ข้อความ)ListCollectionIdsRequest
(ข้อความ)ListCollectionIdsResponse
(ข้อความ)ListDocumentsRequest
(ข้อความ)ListDocumentsResponse
(ข้อความ)ListenRequest
(ข้อความ)ListenResponse
(ข้อความ)MapValue
(ข้อความ)PartitionQueryRequest
(ข้อความ)PartitionQueryResponse
(ข้อความ)PlanSummary
(ข้อความ)Precondition
(ข้อความ)RollbackRequest
(ข้อความ)RunAggregationQueryRequest
(ข้อความ)RunAggregationQueryResponse
(ข้อความ)RunQueryRequest
(ข้อความ)RunQueryResponse
(ข้อความ)StructuredAggregationQuery
(ข้อความ)StructuredAggregationQuery.Aggregation
(ข้อความ)StructuredAggregationQuery.Aggregation.Avg
(ข้อความ)StructuredAggregationQuery.Aggregation.Count
(ข้อความ)StructuredAggregationQuery.Aggregation.Sum
(ข้อความ)StructuredQuery
(ข้อความ)StructuredQuery.CollectionSelector
(ข้อความ)StructuredQuery.CompositeFilter
(ข้อความ)StructuredQuery.CompositeFilter.Operator
(enum)StructuredQuery.Direction
(enum)StructuredQuery.FieldFilter
(ข้อความ)StructuredQuery.FieldFilter.Operator
(enum)StructuredQuery.FieldReference
(ข้อความ)StructuredQuery.Filter
(ข้อความ)StructuredQuery.FindNearest
(ข้อความ)StructuredQuery.FindNearest.DistanceMeasure
(enum)StructuredQuery.Order
(ข้อความ)StructuredQuery.Projection
(ข้อความ)StructuredQuery.UnaryFilter
(ข้อความ)StructuredQuery.UnaryFilter.Operator
(enum)Target
(ข้อความ)Target.DocumentsTarget
(ข้อความ)Target.QueryTarget
(ข้อความ)TargetChange
(ข้อความ)TargetChange.TargetChangeType
(enum)TransactionOptions
(ข้อความ)TransactionOptions.ReadOnly
(ข้อความ)TransactionOptions.ReadWrite
(ข้อความ)UpdateDocumentRequest
(ข้อความ)Value
(ข้อความ)Write
(ข้อความ)WriteRequest
(ข้อความ)WriteResponse
(ข้อความ)WriteResult
(ข้อความ)
Firestore
บริการ Cloud Firestore
Cloud Firestore เป็นฐานข้อมูลเอกสาร NoSQL ที่ดำเนินการบนระบบคลาวด์แบบ Serverless ที่รวดเร็ว มีการจัดการครบวงจร ซึ่งช่วยให้การจัดเก็บ การซิงค์ และการค้นหาข้อมูลสำหรับแอปบนอุปกรณ์เคลื่อนที่ เว็บและแอป IoT ในระดับโลกเป็นเรื่องง่ายขึ้น ไลบรารีของไคลเอ็นต์มีการซิงค์แบบเรียลไทม์และการสนับสนุนออฟไลน์ ส่วนฟีเจอร์ความปลอดภัยและการผสานรวมกับ Firebase และ Google Cloud Platform จะช่วยเร่งการสร้างแอปแบบ Serverless ได้จริง
BatchGetDocuments |
---|
รับเอกสารหลายรายการ เราไม่รับประกันว่าเอกสารที่แสดงผลโดยวิธีการนี้จะได้รับการส่งคืนในลำดับเดียวกับที่ขอ
|
BatchWrite |
---|
ใช้ชุดการดำเนินการเขียน เมธอด BatchWrite ไม่ได้ใช้การดำเนินการเขียนแบบอะตอมและไม่สามารถนำไปใช้อย่างไม่เรียงตามลำดับได้ เมธอดไม่อนุญาตให้มีการเขียนมากกว่า 1 รายการต่อเอกสาร การเขียนแต่ละรายการสำเร็จหรือล้มเหลวโดยแยกกัน ดูสถานะความสำเร็จของการเขียนแต่ละรายการได้ที่ หากต้องการใช้ชุดการเขียนแบบอะตอม ให้ใช้
|
BeginTransaction |
---|
เริ่มธุรกรรมใหม่
|
คอมมิต |
---|
ทำธุรกรรม ขณะเดียวกันก็เลือกที่จะอัปเดตเอกสารได้
|
CreateDocument |
---|
สร้างเอกสารใหม่
|
DeleteDocument |
---|
ลบเอกสาร
|
GetDocument |
---|
รับเอกสารเดียว
|
ListCollectionIds |
---|
แสดงรหัสคอลเล็กชันทั้งหมดภายใต้เอกสาร
|
ListDocuments |
---|
แสดงรายการเอกสาร
|
ฟัง |
---|
ฟังการเปลี่ยนแปลง วิธีนี้ใช้ได้เฉพาะใน gRPC หรือ WebChannel (ไม่ใช่ REST)
|
PartitionQuery |
---|
แบ่งพาร์ติชันการค้นหาโดยแสดงผลเคอร์เซอร์พาร์ติชันที่ใช้เรียกใช้การค้นหาพร้อมกันได้ เคอร์เซอร์พาร์ติชันที่แสดงผลคือจุดแยกที่ RunQuery จะใช้เป็นจุดเริ่มต้น/สิ้นสุดสำหรับผลการค้นหาได้
|
ย้อนกลับ |
---|
เปลี่ยนกลับธุรกรรม
|
RunAggregationQuery |
---|
เรียกใช้การค้นหาการรวม แทนที่จะสร้างผลลัพธ์ ตัวอย่างระดับสูง
|
RunQuery |
---|
เรียกใช้การค้นหา
|
UpdateDocument |
---|
อัปเดตหรือแทรกเอกสาร
|
เขียน |
---|
สตรีมการอัปเดตและลบเอกสารเป็นกลุ่มตามลำดับ วิธีนี้ใช้ได้เฉพาะใน gRPC หรือ WebChannel (ไม่ใช่ REST)
|
AggregationResult
ผลลัพธ์ของที่เก็บข้อมูลเดียวจากการค้นหาการรวม Firestore
คีย์ของ aggregate_fields
จะเหมือนกันสำหรับผลการค้นหาทั้งหมดในการค้นหาการรวม ซึ่งต่างจากการค้นหาเอกสารที่มีช่องที่ต่างกันสำหรับผลการค้นหาแต่ละรายการ
ช่อง | |
---|---|
aggregate_fields |
ผลลัพธ์ของฟังก์ชันการรวม เช่น คีย์คือ |
ArrayValue
ค่าอาร์เรย์
ช่อง | |
---|---|
values[] |
ค่าในอาร์เรย์ |
BatchGetDocumentsRequest
คำขอสำหรับ Firestore.BatchGetDocuments
ช่อง | |
---|---|
database |
ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: |
documents[] |
ชื่อเอกสารที่จะเรียกดู ในรูปแบบ: |
mask |
ช่องที่จะแสดงผล หากไม่ได้ตั้งค่า ระบบจะแสดงฟิลด์ทั้งหมด หากเอกสารมีช่องที่ไม่ได้อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในคำตอบ |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
transaction |
อ่านเอกสารในธุรกรรม |
new_transaction |
เริ่มธุรกรรมใหม่และอ่านเอกสาร ค่าเริ่มต้นคือธุรกรรมแบบอ่านอย่างเดียว ระบบจะแสดงรหัสธุรกรรมใหม่เป็นคำตอบแรกในสตรีม |
read_time |
อ่านเอกสารแบบเดียวกับ ณ เวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
BatchGetDocumentsResponse
การตอบกลับที่สตรีมสำหรับ Firestore.BatchGetDocuments
ช่อง | |
---|---|
transaction |
ธุรกรรมที่เริ่มต้นโดยเป็นส่วนหนึ่งของคำขอนี้ จะมีการตั้งค่าในการตอบกลับครั้งแรกเท่านั้น และจะตั้งค่า |
read_time |
เวลาที่อ่านเอกสาร กรณีนี้อาจเพิ่มขึ้นแบบโมฆะ ในกรณีนี้ เรารับประกันว่าเอกสารก่อนหน้าในสตรีมผลลัพธ์จะไม่มีการเปลี่ยนแปลงระหว่าง Read_time กับเอกสารนี้ |
ฟิลด์สหภาพ result ผลลัพธ์เดียว ค่านี้สามารถเว้นว่างไว้ได้ หากเซิร์ฟเวอร์เพียงแค่ส่งคืนธุรกรรม result ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
found |
เอกสารที่ขอไปแล้ว |
missing |
ชื่อเอกสารที่ขอไป แต่ไม่มีชื่ออยู่ ในรูปแบบ: |
BatchWriteRequest
คำขอสำหรับ Firestore.BatchWrite
ช่อง | |
---|---|
database |
ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: |
writes[] |
การเขียนที่จะใช้ วิธีการนี้ไม่ได้ใช้การเขียนแบบอะตอมและไม่รับประกันลำดับ การเขียนแต่ละรายการสำเร็จหรือล้มเหลวโดยแยกกัน คุณไม่สามารถเขียนลงในเอกสารเดียวกันเกิน 1 ครั้งต่อคำขอ |
labels |
ป้ายกำกับที่เกี่ยวข้องกับการเขียนกลุ่มนี้ |
BatchWriteResponse
คำตอบจาก Firestore.BatchWrite
ช่อง | |
---|---|
write_results[] |
ผลของการใช้การเขียน ผลการเขียน i นี้สอดคล้องกับการเขียน i-th ในคำขอ |
status[] |
สถานะของการใช้การเขียน สถานะการเขียน i นี้สอดคล้องกับการเขียน i-th ในคำขอ |
BeginTransactionRequest
คำขอสำหรับ Firestore.BeginTransaction
ช่อง | |
---|---|
database |
ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: |
options |
ตัวเลือกสำหรับธุรกรรม ค่าเริ่มต้นจะเป็นธุรกรรมแบบอ่าน-เขียน |
BeginTransactionResponse
การตอบกลับสำหรับ Firestore.BeginTransaction
ช่อง | |
---|---|
transaction |
ธุรกรรมที่เริ่มต้น |
BitSequence
ลำดับของบิตที่เข้ารหัสในอาร์เรย์ไบต์
แต่ละไบต์ในอาร์เรย์ bitmap
ไบต์จะจัดเก็บลำดับ 8 บิต ข้อยกเว้นเพียงอย่างเดียวคือไบต์สุดท้ายที่อาจจัดเก็บได้ 8 บิตหรือน้อยกว่า padding
กำหนดจำนวนบิตของไบต์สุดท้ายที่จะไม่สนใจเป็น "ระยะห่างจากขอบ" โดยจะไม่ได้ระบุค่าของบิต "ระยะห่างจากขอบ" เหล่านี้และระบบจะละเว้นค่าดังกล่าว
หากต้องการดึงบิตแรก ให้คำนวณบิตที่ 0 เป็น (bitmap[0] & 0x01) != 0
หากต้องการดึงบิตที่ 2 ให้คำนวณบิตที่ 1 เป็น (bitmap[0] & 0x02) != 0
หากต้องการดึงบิตที่ 3 บิตที่ 2 ให้คำนวณดังนี้ (bitmap[0] & 0x04) != 0
หากต้องการดึงบิตที่ 4 บิตที่ 3 ให้คำนวณดังนี้ (bitmap[0] & 0x08) != 0
หากต้องการดึงบิต n ให้คำนวณดังนี้ (bitmap[n / 8] & (0x01 << (n % 8))) != 0
"size" ของ BitSequence
(จำนวนบิตที่มี) คำนวณโดยใช้สูตรนี้ (bitmap.length * 8) - padding
ช่อง | |
---|---|
bitmap |
ไบต์ที่เข้ารหัสลำดับบิต อาจมีความยาวเป็น 0 |
padding |
จำนวนบิตของไบต์สุดท้ายใน |
BloomFilter
ฟิลเตอร์บลูม (https://en.wikipedia.org/wiki/Bloom_filter)
ตัวกรอง Bloom จะแฮชรายการที่มี MD5 และถือว่าแฮช 128 บิตที่ได้เป็นค่าแฮช 64 บิตที่แตกต่างกัน 2 ค่า โดยตีความเป็นจำนวนเต็มที่ไม่มีเครื่องหมายโดยใช้การเข้ารหัสเสริมของ 2
จากนั้นค่าแฮช 2 ค่านี้ ชื่อ h1
และ h2
จะใช้ในการคำนวณค่าแฮช hash_count
โดยใช้สูตร โดยเริ่มจาก i=0
h(i) = h1 + (i * h2)
จากนั้นค่าที่เป็นผลลัพธ์จะถูกนำไปปรับจำนวนบิตในตัวกรองบลูมเพื่อให้ได้บิตของฟิลเตอร์เบ่งบานเพื่อทดสอบรายการที่กำหนด
ช่อง | |
---|---|
bits |
ข้อมูลฟิลเตอร์บลูม |
hash_count |
จำนวนแฮชที่อัลกอริทึมใช้ |
CommitRequest
คำขอสำหรับ Firestore.Commit
ช่อง | |
---|---|
database |
ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: |
writes[] |
การเขียนที่จะใช้ ดำเนินการอย่างสมเหตุสมผลและเป็นไปตามลำดับเสมอ |
transaction |
หากตั้งค่าแล้ว ระบบจะใช้การเขียนทั้งหมดในธุรกรรมนี้และคอมมิต |
CommitResponse
การตอบกลับสำหรับ Firestore.Commit
ช่อง | |
---|---|
write_results[] |
ผลของการใช้การเขียน ผลการเขียน i นี้สอดคล้องกับการเขียน i-th ในคำขอ |
commit_time |
เวลาที่คอมมิตเกิดขึ้น การอ่านใดๆ ที่มี |
CreateDocumentRequest
คำขอสำหรับ Firestore.CreateDocument
ช่อง | |
---|---|
parent |
ต้องระบุ ทรัพยากรระดับบนสุด เช่น |
collection_id |
ต้องระบุ รหัสคอลเล็กชันที่สัมพันธ์กับ |
document_id |
รหัสเอกสารที่ลูกค้ากำหนดที่จะใช้กับเอกสารนี้ ไม่บังคับ หากไม่ได้ระบุ บริการจะกำหนดรหัสให้ |
document |
ต้องระบุ เอกสารที่จะสร้าง ต้องไม่ตั้งค่า |
mask |
ช่องที่จะแสดงผล หากไม่ได้ตั้งค่า ระบบจะแสดงฟิลด์ทั้งหมด หากเอกสารมีช่องที่ไม่ได้อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในคำตอบ |
เคอร์เซอร์
ตำแหน่งในชุดผลการค้นหา
ช่อง | |
---|---|
values[] |
ค่าที่แสดงถึงตำแหน่ง โดยเรียงลำดับตามข้อความของข้อความค้นหา อาจมีค่าน้อยกว่าที่ระบุไว้ในลำดับประโยค |
before |
หากตำแหน่งอยู่ก่อนหรือหลังค่าที่ระบุ ให้สัมพันธ์กับลำดับการจัดเรียงที่กำหนดโดยการค้นหา |
DeleteDocumentRequest
คำขอสำหรับ Firestore.DeleteDocument
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของเอกสารที่จะลบ ในรูปแบบ: |
current_document |
เงื่อนไขที่กำหนดไว้ล่วงหน้าในเอกสารซึ่งไม่บังคับ คำขอจะล้มเหลวหากมีการตั้งค่านี้ไว้และไม่เป็นไปตามเอกสารเป้าหมาย |
เอกสาร
เอกสาร Firestore
ต้องไม่เกิน 1 MiB - 4 ไบต์
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของเอกสาร เช่น |
fields |
|
create_time |
เอาต์พุตเท่านั้น เวลาที่สร้างเอกสาร ค่านี้จะเพิ่มขึ้นแบบจำเจเมื่อลบเอกสารแล้วสร้างใหม่ นอกจากนี้ยังสามารถเปรียบเทียบกับค่าจากเอกสารอื่นและ |
update_time |
เอาต์พุตเท่านั้น เวลาที่มีการเปลี่ยนแปลงเอกสารครั้งล่าสุด ตอนแรกค่านี้กำหนดไว้เป็น |
DocumentChange
Document
มีการเปลี่ยนแปลง
อาจเป็นผลมาจาก writes
หลายรายการรวมถึงการลบ ซึ่งท้ายที่สุดแล้วจะทำให้มีค่าใหม่สำหรับ Document
ระบบอาจแสดงข้อความ DocumentChange
หลายรายการสำหรับการเปลี่ยนแปลงเชิงตรรกะเดียวกัน หากเป้าหมายหลายรายการได้รับผลกระทบ
ช่อง | |
---|---|
document |
สถานะใหม่ของ หากตั้งค่า |
target_ids[] |
ชุดของรหัสเป้าหมายที่ตรงกับเอกสารนี้ |
removed_target_ids[] |
ชุดของรหัสเป้าหมายสำหรับเป้าหมายที่ไม่ตรงกับเอกสารนี้อีกต่อไป |
DocumentDelete
ลบ Document
แล้ว
อาจเป็นผลมาจาก writes
หลายรายการ รวมถึงการอัปเดต ซึ่งล่าสุดได้ลบ Document
แล้ว
ระบบอาจแสดงข้อความ DocumentDelete
หลายข้อความสําหรับการลบเชิงตรรกะเดียวกัน หากเป้าหมายหลายรายการได้รับผลกระทบ
ช่อง | |
---|---|
document |
ชื่อทรัพยากรของ |
removed_target_ids[] |
ชุดรหัสเป้าหมายสำหรับเป้าหมายที่ตรงกับเอนทิตีนี้ก่อนหน้านี้ |
read_time |
การประทับเวลาการอ่านที่พบการลบ มากกว่าหรือเท่ากับ |
DocumentMask
ชุดของเส้นทางภาคสนามในเอกสาร ใช้เพื่อจำกัดการดำเนินการรับหรืออัปเดตเอกสารสำหรับส่วนย่อยของช่องข้อมูล ซึ่งแตกต่างจากฟิลด์มาสก์มาตรฐาน เนื่องจากจะกำหนดขอบเขตเป็น Document
เสมอ และพิจารณาลักษณะแบบไดนามิกของ Value
ช่อง | |
---|---|
field_paths[] |
รายการเส้นทางช่องในมาสก์ ดูการอ้างอิงไวยากรณ์เส้นทางช่องได้ที่ |
DocumentRemove
นำ Document
ออกจากมุมมองของเป้าหมายแล้ว
ส่งหากเอกสารไม่เกี่ยวข้องกับเป้าหมายอีกต่อไปและมองไม่เห็น สามารถส่งแทน DocumentDelete หรือ DocumentChange ได้หากเซิร์ฟเวอร์ไม่สามารถส่งค่าใหม่ของเอกสารได้
ระบบอาจแสดงข้อความ DocumentRemove
หลายข้อความสำหรับการเขียนหรือลบด้วยตรรกะเดียวกัน หากเป้าหมายหลายรายการได้รับผลกระทบ
ช่อง | |
---|---|
document |
ชื่อทรัพยากรของ |
removed_target_ids[] |
ชุดของรหัสเป้าหมายสำหรับเป้าหมายที่ตรงกับเอกสารนี้ก่อนหน้านี้ |
read_time |
การประทับเวลาการอ่านที่พบการนำออก มากกว่าหรือเท่ากับ |
DocumentTransform
การเปลี่ยนรูปแบบเอกสาร
ช่อง | |
---|---|
document |
ชื่อเอกสารที่จะเปลี่ยนรูปแบบ |
field_transforms[] |
รายการการเปลี่ยนรูปแบบที่จะใช้กับช่องต่างๆ ของเอกสารตามลำดับ ต้องระบุ |
FieldTransform
การแปลงโฉมฟิลด์ของเอกสาร
ช่อง | |
---|---|
field_path |
เส้นทางของช่อง ดูการอ้างอิงไวยากรณ์เส้นทางช่องได้ที่ |
ฟิลด์สหภาพ transform_type การเปลี่ยนรูปแบบที่จะใช้กับภาคสนาม transform_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
set_to_server_value |
ตั้งค่าช่องนี้เป็นค่าของเซิร์ฟเวอร์ที่ระบุ |
increment |
เพิ่มค่าที่ระบุลงในค่าปัจจุบันของช่อง ค่านี้ต้องเป็นจำนวนเต็มหรือค่าทศนิยม หากช่องนี้ไม่ใช่จำนวนเต็มหรือคู่ หรือยังไม่มีช่องนี้ การเปลี่ยนรูปแบบจะตั้งค่าฟิลด์เป็นค่าที่ระบุ หากค่าใดค่าหนึ่งที่ระบุหรือค่าในช่องปัจจุบันเป็นเลขทศนิยม 2 ค่า ระบบจะแปลค่าทั้งสองเป็นเลขทศนิยม เลขคณิตคู่และการนำเสนอค่าทศนิยมเป็นไปตามความหมายของ IEEE 754 หากมีจำนวนเต็มบวก/ลบเพิ่มเติม ฟิลด์นี้จะถูกแก้ไขให้เป็นจำนวนเต็มบวก/ลบที่มีค่าที่สุด |
maximum |
ตั้งค่าช่องนี้ให้เป็นค่าสูงสุดของค่าปัจจุบันและค่าที่กำหนด ค่านี้ต้องเป็นจำนวนเต็มหรือค่าทศนิยม หากช่องนี้ไม่ใช่จำนวนเต็มหรือคู่ หรือยังไม่มีช่องนี้ การเปลี่ยนรูปแบบจะตั้งค่าฟิลด์เป็นค่าที่ระบุ หากใช้การดำเนินการสูงสุดโดยที่ฟิลด์และค่าอินพุตเป็นประเภทผสม (นั่นคือ 1 เป็นจำนวนเต็มและหนึ่งเป็นเลขคู่) ฟิลด์จะใช้ประเภทของตัวถูกดำเนินการที่มีขนาดใหญ่ หากตัวถูกดำเนินการเท่ากัน (เช่น 3 และ 3.0) ฟิลด์นี้จะไม่เปลี่ยนแปลง 0, 0.0 และ -0.0 เป็น 0 ทั้งหมด ค่าสูงสุดของค่าที่จัดเก็บไว้เป็น 0 และค่าที่ป้อนเป็นศูนย์จะเป็นค่าที่เก็บไว้เสมอ ค่าสูงสุดของค่าตัวเลข x และ NaN คือ NaN |
minimum |
ตั้งค่าช่องนี้เป็นค่าต่ำสุดของค่าปัจจุบันและค่าที่กำหนด ค่านี้ต้องเป็นจำนวนเต็มหรือค่าทศนิยม หากช่องนี้ไม่ใช่จำนวนเต็มหรือคู่ หรือยังไม่มีช่องนี้ การเปลี่ยนรูปแบบจะตั้งค่าช่องนี้เป็นค่าอินพุต หากใช้การดำเนินการขั้นต่ำเมื่อฟิลด์และค่าอินพุตเป็นประเภทผสม (นั่นคือ 1 เป็นจำนวนเต็มและหนึ่งเป็นเลขคู่) ฟิลด์จะใช้ประเภทของตัวถูกดำเนินการขนาดเล็ก หากตัวถูกดำเนินการเท่ากัน (เช่น 3 และ 3.0) ฟิลด์นี้จะไม่เปลี่ยนแปลง 0, 0.0 และ -0.0 เป็น 0 ทั้งหมด ค่าต่ำสุดของค่าที่จัดเก็บไว้เป็น 0 และค่าที่ป้อนเป็น 0 จะเป็นค่าที่เก็บไว้เสมอ ค่าตัวเลขต่ำสุดของ x และ NaN คือ NaN |
append_missing_elements |
เพิ่มองค์ประกอบที่ระบุตามลําดับหากยังไม่มีอยู่ในค่าของช่องปัจจุบัน หากช่องนี้ไม่ใช่อาร์เรย์ หรือยังไม่มีช่องนี้ ระบบจะตั้งค่าให้เป็นอาร์เรย์ว่างก่อน จำนวนที่เท่ากันของประเภทต่างๆ (เช่น 3L และ 3.0) จะถือว่าเท่ากันเมื่อตรวจสอบว่ามีค่าขาดหายไปหรือไม่ NaN เท่ากับ NaN และ Null เท่ากับ Null หากข้อมูลที่ป้อนมีค่าที่เทียบเท่าหลายค่า ระบบจะพิจารณาเฉพาะค่าแรก Transform_result ที่เกี่ยวข้องจะเป็นค่า Null |
remove_all_from_array |
นำองค์ประกอบที่ระบุทั้งหมดออกจากอาร์เรย์ในช่อง หากช่องนี้ไม่ใช่อาร์เรย์ หรือยังไม่มีช่องนี้ ระบบจะตั้งค่าเป็นอาร์เรย์ที่ว่างเปล่า จำนวนที่เท่ากันของประเภทต่างๆ (เช่น 3L และ 3.0) จะถือว่าเท่ากันเมื่อตัดสินใจว่าควรนำองค์ประกอบออกหรือไม่ NaN เท่ากับ NaN และ Null เท่ากับ Null การดำเนินการนี้จะนำค่าที่เทียบเท่าทั้งหมดออกหากมีรายการที่ซ้ำกัน Transform_result ที่เกี่ยวข้องจะเป็นค่า Null |
ServerValue
ค่าที่เซิร์ฟเวอร์จะคำนวณ
Enum | |
---|---|
SERVER_VALUE_UNSPECIFIED |
ไม่ระบุ ต้องไม่ใช้ค่านี้ |
REQUEST_TIME |
เวลาที่เซิร์ฟเวอร์ประมวลผลคำขอด้วยความแม่นยำในระดับมิลลิวินาที หากใช้ในหลายช่อง (เอกสารเดียวกันหรือต่างกัน) ในธุรกรรม ช่องทั้งหมดจะได้รับการประทับเวลาของเซิร์ฟเวอร์เหมือนกัน |
ExecutionStats
สถิติการดำเนินการสำหรับข้อความค้นหา
ช่อง | |
---|---|
results_returned |
จำนวนผลลัพธ์ทั้งหมดที่ส่งคืน รวมถึงเอกสาร การฉายภาพ ผลการรวม คีย์ |
execution_duration |
เวลาทั้งหมดที่ใช้ในการค้นหาในแบ็กเอนด์ |
read_operations |
การดำเนินการอ่านทั้งหมดที่เรียกเก็บเงินได้ |
debug_stats |
การแก้ไขข้อบกพร่องทางสถิติจากการดำเนินการค้นหา โปรดทราบว่าสถิติการแก้ไขข้อบกพร่องอาจมีการเปลี่ยนแปลงเมื่อ 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
สรุปของเอกสารทั้งหมดที่ตรงกับเป้าหมายที่ระบุ
ช่อง | |
---|---|
target_id |
รหัสเป้าหมายที่ใช้ตัวกรองนี้ |
count |
จำนวนเอกสารทั้งหมดที่ตรงกับ หากแตกต่างจากจำนวนเอกสารในไคลเอ็นต์ที่ตรงกัน ลูกค้าจะต้องพิจารณาด้วยตนเองว่าเอกสารใดไม่ตรงกับเป้าหมายอีกต่อไป ลูกค้าสามารถใช้ตัวกรอง Bloom ของ |
unchanged_names |
ตัวกรอง Bloom ที่แม้ว่าจะมีชื่อ แต่จะมีการเข้ารหัสแบบ UTF-8 ของชื่อทรัพยากรของเอกสารทั้งหมดที่ตรงกับ ตัวกรองเบ่งบานนี้อาจถูกละเว้นตามที่เซิร์ฟเวอร์เห็นสมควร เช่น ในกรณีที่เห็นว่าลูกค้าจะไม่ใช้ฟิลเตอร์นี้ หรือถ้าการประมวลผลมีราคาแพงเกินไปสำหรับการคำนวณหรือส่ง ไคลเอ็นต์จะต้องจัดการกับฟิลด์ที่ขาดไปนี้อย่างมีชั้นเชิง โดยการย้อนกลับไปใช้ตรรกะที่ใช้ก่อนที่จะมีช่องนี้ กล่าวคือ เพิ่มเป้าหมายอีกครั้งโดยไม่มีโทเค็นสำหรับกลับมาทำงานอีกครั้ง เพื่อดูว่าเอกสารใดในแคชของไคลเอ็นต์มีการซิงค์กันหรือไม่ |
ExplainMetrics
อธิบายเมตริกสำหรับการค้นหา
ช่อง | |
---|---|
plan_summary |
ข้อมูลระยะการวางแผนสำหรับการค้นหา |
execution_stats |
สถิติรวมจากการดำเนินการค้นหา แสดงเมื่อตั้งค่า |
ExplainOptions
อธิบายตัวเลือกสำหรับการสืบค้นข้อมูล
ช่อง | |
---|---|
analyze |
ไม่บังคับ จะดําเนินการค้นหานี้หรือไม่ เมื่อเป็นเท็จ (ค่าเริ่มต้น) ระบบจะวางแผนการค้นหาโดยแสดงเฉพาะเมตริกจากขั้นตอนการวางแผนเท่านั้น เมื่อเป็นจริง ระบบจะวางแผนและดำเนินการค้นหาโดยแสดงผลการค้นหาทั้งหมดพร้อมกับเมตริกขั้นตอนการวางแผนและการดำเนินการ |
GetDocumentRequest
คำขอสำหรับ Firestore.GetDocument
ช่อง | |
---|---|
name |
ต้องระบุ ชื่อทรัพยากรของเอกสารที่จะรับ ในรูปแบบ: |
mask |
ช่องที่จะแสดงผล หากไม่ได้ตั้งค่า ระบบจะแสดงฟิลด์ทั้งหมด หากเอกสารมีช่องที่ไม่ได้อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในคำตอบ |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
transaction |
อ่านเอกสารในธุรกรรม |
read_time |
อ่านเวอร์ชันของเอกสารในเวลาที่กำหนด โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
ListCollectionIdsRequest
คำขอสำหรับ Firestore.ListCollectionIds
ช่อง | |
---|---|
parent |
ต้องระบุ เอกสารหลัก ในรูปแบบ: |
page_size |
จำนวนผลลัพธ์สูงสุดที่จะแสดง |
page_token |
โทเค็นของหน้า ต้องเป็นค่าจาก |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับคำขอนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
read_time |
อ่านเอกสารแบบเดียวกับ ณ เวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
ListCollectionIdsResponse
คำตอบจาก Firestore.ListCollectionIds
ช่อง | |
---|---|
collection_ids[] |
รหัสคอลเล็กชัน |
next_page_token |
โทเค็นของหน้าที่อาจใช้เพื่อเป็นรายการต่อ |
ListDocumentsRequest
คำขอสำหรับ Firestore.ListDocuments
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: เช่น |
collection_id |
ไม่บังคับ รหัสคอลเล็กชันที่สัมพันธ์กับ เช่น ซึ่งจะไม่บังคับ และหากไม่มี Firestore จะแสดงเอกสารจากคอลเล็กชันทั้งหมดในส่วน |
page_size |
ไม่บังคับ จำนวนสูงสุดของเอกสารที่จะแสดงผลในการตอบ 1 ครั้ง Firestore อาจแสดงผลน้อยกว่าค่านี้ |
page_token |
ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการตอบกลับ ระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมด (ยกเว้น |
order_by |
ไม่บังคับ ลำดับของเอกสารที่จะส่งคืน (ไม่บังคับ) เช่น การดำเนินการนี้จะมิเรอร์ |
mask |
ไม่บังคับ ช่องที่จะแสดงผล หากไม่ได้ตั้งค่า ระบบจะแสดงฟิลด์ทั้งหมด หากเอกสารมีช่องที่ไม่ได้อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในคำตอบ |
show_missing |
หากในรายการควรแสดงเอกสารที่ขาดหายไป เอกสารจะหายไปหากไม่มีอยู่ แต่มีเอกสารย่อยซ้อนอยู่ เมื่อค่าเป็น "จริง" ระบบจะส่งเอกสารที่หายไปดังกล่าวกลับมาพร้อมกับคีย์ แต่จะไม่มีช่อง คำขอที่มี |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
transaction |
ดำเนินการอ่านที่เป็นส่วนหนึ่งของธุรกรรมที่ใช้งานอยู่แล้ว |
read_time |
อ่านเวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
ListDocumentsResponse
การตอบกลับสำหรับ Firestore.ListDocuments
ช่อง | |
---|---|
documents[] |
เอกสารที่พบ |
next_page_token |
โทเค็นสำหรับเรียกหน้าถัดไปของเอกสาร หากเว้นช่องนี้ไว้ ก็จะไม่เห็นหน้าต่อๆ ไป |
ListenRequest
คำขอสำหรับ Firestore.Listen
ช่อง | |
---|---|
database |
ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: |
labels |
ป้ายกำกับที่เกี่ยวข้องกับการเปลี่ยนแปลงเป้าหมายนี้ |
ฟิลด์สหภาพ target_change การเปลี่ยนแปลงเป้าหมายที่รองรับ target_change ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
add_target |
เป้าหมายที่จะเพิ่มลงในสตรีมนี้ |
remove_target |
รหัสของเป้าหมายที่จะนำออกจากสตรีมนี้ |
ListenResponse
การตอบกลับสำหรับ Firestore.Listen
ช่อง | |
---|---|
ฟิลด์สหภาพ response_type คำตอบที่รองรับ response_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
target_change |
เป้าหมายมีการเปลี่ยนแปลง |
document_change |
|
document_delete |
ลบ |
document_remove |
นำ |
filter |
ตัวกรองที่จะใช้กับชุดเอกสารที่ก่อนหน้านี้ส่งคืนสำหรับเป้าหมายที่ระบุ แสดงผลเมื่อเอกสารอาจถูกนําออกจากเป้าหมายที่ระบุแล้ว แต่ไม่ทราบเอกสารที่แน่นอน |
MapValue
ค่าแผนที่
ช่อง | |
---|---|
fields |
ช่องของแผนที่ คีย์แมปจะใช้ชื่อช่องต่างๆ ชื่อช่องที่ตรงกับนิพจน์ทั่วไป |
PartitionQueryRequest
คำขอสำหรับ Firestore.PartitionQuery
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: |
partition_count |
จำนวนจุดพาร์ติชันสูงสุดที่ต้องการ พาร์ติชันอาจแสดงในหน้าผลลัพธ์หลายหน้า ตัวเลขต้องเป็นค่าบวก จำนวนพาร์ติชันจริงที่แสดงผลอาจน้อยกว่านี้ เช่น อาจกำหนดให้น้อยกว่าจำนวนคำค้นหาพร้อมกันที่จะเรียกใช้ หรือในการเรียกใช้ไปป์ไลน์ข้อมูล 1 จำนวน โดยน้อยกว่าจำนวนผู้ปฏิบัติงานหรืออินสแตนซ์การประมวลผลที่ใช้ได้ |
page_token |
ค่า ตัวอย่างเช่น การเรียก 2 ครั้งต่อมาโดยใช้ page_token อาจส่งคืนดังนี้
หากต้องการได้ชุดผลลัพธ์ที่สมบูรณ์ซึ่งเรียงลำดับตามผลลัพธ์ของคำค้นหาที่ใช้กับ PartitionQuery ควรรวมชุดผลลัพธ์เข้าด้วยกัน ได้แก่ เคอร์เซอร์ A, เคอร์เซอร์ B, เคอร์เซอร์ M, เคอร์เซอร์ Q, เคอร์เซอร์ U, เคอร์เซอร์ W |
page_size |
จำนวนพาร์ติชันสูงสุดที่จะแสดงผลในการเรียกนี้ โดยขึ้นอยู่กับ ตัวอย่างเช่น หาก |
ฟิลด์สหภาพ query_type การค้นหาที่จะแบ่งพาร์ติชัน query_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
structured_query |
การค้นหาแบบมีโครงสร้าง ข้อความค้นหาต้องระบุคอลเล็กชันที่มีองค์ประกอบสืบทอดทั้งหมด และเรียงลำดับตามชื่อจากน้อยไปมาก ระบบไม่รองรับตัวกรองอื่นๆ ลำดับตาม ขีดจำกัด ออฟเซ็ต และเคอร์เซอร์เริ่มต้น/สิ้นสุด |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับคำขอนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
read_time |
อ่านเอกสารแบบเดียวกับ ณ เวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
PartitionQueryResponse
การตอบกลับสำหรับ Firestore.PartitionQuery
ช่อง | |
---|---|
partitions[] |
ผลลัพธ์การแบ่งพาร์ติชัน แต่ละพาร์ติชันคือจุดแยกที่ RunQuery จะใช้เป็นจุดเริ่มต้นหรือจุดสิ้นสุดสำหรับผลการค้นหาได้ คำขอ RunQuery ต้องดำเนินการด้วยการค้นหาเดียวกันกับที่ส่งไปยังคำขอ PartitionQuery นี้ เคอร์เซอร์พาร์ติชันจะมีการจัดเรียงตามลำดับเดียวกันกับผลลัพธ์ของการค้นหาที่ส่งไปยัง PartitionQuery ตัวอย่างเช่น หากคำขอ PartitionQuery แสดงผลเคอร์เซอร์พาร์ติชัน A และ B การเรียกใช้การค้นหา 3 รายการต่อไปนี้จะแสดงชุดผลลัพธ์ทั้งหมดของคำค้นหาเดิม
ผลลัพธ์ที่ว่างเปล่าอาจบ่งชี้ว่าการค้นหามีผลลัพธ์น้อยเกินไปสำหรับการแบ่งพาร์ติชัน หรือระบบยังไม่รองรับการค้นหาดังกล่าวสำหรับการแบ่งพาร์ติชัน |
next_page_token |
โทเค็นของหน้าเว็บที่อาจใช้เพื่อขอชุดผลลัพธ์เพิ่มเติมตามจำนวนที่ระบุโดย |
PlanSummary
ข้อมูลระยะการวางแผนสำหรับการค้นหา
ช่อง | |
---|---|
indexes_used[] |
ดัชนีที่เลือกสำหรับคำค้นหา For example: [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ] |
เงื่อนไขที่ต้องดำเนินการก่อน
เงื่อนไขที่กำหนดไว้ล่วงหน้าในเอกสารซึ่งใช้สำหรับการดำเนินการแบบมีเงื่อนไข
ช่อง | |
---|---|
ฟิลด์สหภาพ condition_type ประเภทของเงื่อนไขที่กำหนดไว้ล่วงหน้า condition_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
exists |
เมื่อตั้งค่าเป็น |
update_time |
เมื่อตั้งค่าแล้ว เอกสารเป้าหมายจะต้องมีอยู่และได้รับการอัปเดตล่าสุดในเวลานั้น การประทับเวลาต้องสอดคล้องกันแบบไมโครวินาที |
RollbackRequest
คำขอสำหรับ Firestore.Rollback
ช่อง | |
---|---|
database |
ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: |
transaction |
ต้องระบุ ธุรกรรมที่จะย้อนกลับ |
RunAggregationQueryRequest
คำขอสำหรับ Firestore.RunAggregationQuery
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: |
explain_options |
ไม่บังคับ อธิบายตัวเลือกสำหรับการสืบค้นข้อมูล หากตั้งค่าไว้ ระบบจะแสดงผลสถิติการค้นหาเพิ่มเติม ไม่เช่นนั้น ระบบจะแสดงเฉพาะผลการค้นหา |
ฟิลด์สหภาพ query_type การค้นหาที่เรียกใช้ query_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
structured_aggregation_query |
การค้นหาแบบรวม |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับการค้นหาจะมีค่าเริ่มต้นเป็นความสอดคล้องขั้นสูง consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
transaction |
เรียกใช้การรวมภายในธุรกรรมที่ใช้งานอยู่แล้ว ค่าในส่วนนี้คือรหัสธุรกรรมที่ไม่ชัดเจนสำหรับดำเนินการค้นหา |
new_transaction |
เริ่มธุรกรรมใหม่ในการค้นหา โดยมีค่าเริ่มต้นเป็นแบบอ่านอย่างเดียว ระบบจะแสดงรหัสธุรกรรมใหม่เป็นคำตอบแรกในสตรีม |
read_time |
ดำเนินการค้นหาตามการประทับเวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
RunAggregationQueryResponse
การตอบกลับสำหรับ Firestore.RunAggregationQuery
ช่อง | |
---|---|
result |
ผลลัพธ์การรวมรายการเดียว ไม่แสดงเมื่อรายงานความคืบหน้าบางส่วน |
transaction |
ธุรกรรมที่เริ่มต้นโดยเป็นส่วนหนึ่งของคำขอนี้ มีอยู่ในการตอบกลับครั้งแรกเมื่อคำขอขอให้เริ่มธุรกรรมใหม่เท่านั้น |
read_time |
เวลาที่มีการคํานวณผลลัพธ์รวม จะมีปริมาณเพิ่มขึ้นอยู่เสมอ ในกรณีนี้ Aggregation Results ก่อนหน้าในสตรีมผลลัพธ์นี้รับประกันว่าจะไม่มีการเปลี่ยนแปลงระหว่าง หากการค้นหาไม่แสดงผลลัพธ์ ระบบจะตอบกลับด้วย |
explain_metrics |
เมตริกอธิบายการค้นหา ซึ่งจะแสดงเมื่อมีการระบุ |
RunQueryRequest
คำขอสำหรับ Firestore.RunQuery
ช่อง | |
---|---|
parent |
ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: |
explain_options |
ไม่บังคับ อธิบายตัวเลือกสำหรับการสืบค้นข้อมูล หากตั้งค่าไว้ ระบบจะแสดงผลสถิติการค้นหาเพิ่มเติม ไม่เช่นนั้น ระบบจะแสดงเฉพาะผลการค้นหา |
ฟิลด์สหภาพ query_type การค้นหาที่เรียกใช้ query_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
structured_query |
การค้นหาแบบมีโครงสร้าง |
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
transaction |
เรียกใช้การค้นหาภายในธุรกรรมที่ใช้งานอยู่แล้ว ค่าในส่วนนี้คือรหัสธุรกรรมที่ไม่ชัดเจนสำหรับดำเนินการค้นหา |
new_transaction |
เริ่มธุรกรรมใหม่และอ่านเอกสาร ค่าเริ่มต้นคือธุรกรรมแบบอ่านอย่างเดียว ระบบจะแสดงรหัสธุรกรรมใหม่เป็นคำตอบแรกในสตรีม |
read_time |
อ่านเอกสารแบบเดียวกับ ณ เวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
RunQueryResponse
การตอบกลับสำหรับ Firestore.RunQuery
ช่อง | |
---|---|
transaction |
ธุรกรรมที่เริ่มต้นโดยเป็นส่วนหนึ่งของคำขอนี้ ตั้งค่าได้ในคำตอบแรกเท่านั้น และจะตั้งค่าได้เฉพาะเมื่อมีการตั้งค่า |
document |
ผลการค้นหาที่ไม่มีการตั้งค่าเมื่อรายงานความคืบหน้าเพียงบางส่วน |
read_time |
เวลาที่อ่านเอกสาร จำนวนนี้อาจเพิ่มขึ้นทีละน้อย ในกรณีนี้ เรารับประกันว่าเอกสารก่อนหน้าในสตรีมผลลัพธ์จะไม่มีการเปลี่ยนแปลงระหว่าง หากการค้นหาไม่แสดงผลลัพธ์ ระบบจะตอบกลับด้วย |
skipped_results |
จำนวนผลลัพธ์ที่ข้ามเนื่องจากออฟเซ็ตระหว่างคำตอบล่าสุดและคำตอบปัจจุบัน |
explain_metrics |
เมตริกอธิบายการค้นหา ซึ่งจะแสดงเมื่อมีการระบุ |
ฟิลด์สหภาพ continuation_selector โหมดความต่อเนื่องสำหรับการค้นหา หากมี แสดงว่าสตรีมคำตอบของการค้นหาปัจจุบันสิ้นสุดแล้ว ซึ่งอาจตั้งค่าโดยมีหรือไม่มี document แต่เมื่อตั้งค่าแล้วจะทำให้ระบบไม่แสดงผลลัพธ์อีก continuation_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
done |
หากมี Firestore ได้ดำเนินการตามคำขอเสร็จสมบูรณ์แล้ว และจะไม่มีการส่งคืนเอกสารอีก |
StructuredAggregationQuery
การค้นหา Firestore สำหรับเรียกใช้การรวมใน StructuredQuery
ช่อง | |
---|---|
aggregations[] |
ไม่บังคับ ชุดของการรวมที่จะใช้กับผลลัพธ์ของ ข้อกำหนด
|
ฟิลด์สหภาพ query_type ข้อความค้นหาพื้นฐานที่จะรวม query_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
structured_query |
คำค้นหาที่มีโครงสร้างที่ซ้อนกันอยู่ |
การรวม
กำหนดการรวมที่สร้างผลลัพธ์รายการเดียว
ช่อง | |
---|---|
alias |
ไม่บังคับ ชื่อช่องที่ไม่บังคับสำหรับจัดเก็บผลลัพธ์ของการรวม หากไม่ระบุ Firestore จะเลือกชื่อเริ่มต้นตามรูปแบบ
กลายเป็น:
ข้อกำหนด
|
ฟิลด์สหภาพ operator ประเภทของการรวมที่จะดำเนินการ (ต้องระบุ) operator ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
count |
ผู้รวบรวมข้อมูลจำนวน |
sum |
ผู้รวบรวมข้อมูลผลรวม |
avg |
ผู้รวบรวมข้อมูลเฉลี่ย |
เฉลี่ย
ค่าเฉลี่ยของช่องที่ขอ
ระบบจะรวมเฉพาะค่าที่เป็นตัวเลขเท่านั้น ระบบจะข้ามค่าที่ไม่ใช่ตัวเลขทั้งหมดรวมถึง
NULL
หากค่ารวมมี
NaN
ระบบจะแสดงผลNaN
Infinity math เป็นไปตามมาตรฐาน IEEE-754หากชุดค่ารวมว่างเปล่า ระบบจะแสดงผล
NULL
แสดงผลลัพธ์เป็นเลขคู่เสมอ
ช่อง | |
---|---|
field |
ฟิลด์ที่จะรวบรวมข้อมูล |
จำนวน
จำนวนเอกสารที่ตรงกับข้อความค้นหา
ฟังก์ชันการรวมข้อมูล COUNT(*)
จะทำงานกับทั้งเอกสาร ดังนั้นจึงไม่ต้องใช้การอ้างอิงช่อง
ช่อง | |
---|---|
up_to |
ไม่บังคับ ข้อจำกัดที่ไม่บังคับเกี่ยวกับจำนวนเอกสารสูงสุดที่จะนับ ซึ่งเป็นวิธีการตั้งค่าขอบเขตสูงสุดของจำนวนเอกสารที่จะสแกน ซึ่งช่วยจำกัดเวลาในการตอบสนอง และต้นทุน ไม่ระบุจะถูกตีความว่าไม่มีขอบเขต ตัวอย่างระดับสูง
ข้อกำหนด
|
ผลรวม
ผลรวมของมูลค่าของช่องที่ขอ
ระบบจะรวมเฉพาะค่าที่เป็นตัวเลขเท่านั้น ระบบจะข้ามค่าที่ไม่ใช่ตัวเลขทั้งหมดรวมถึง
NULL
หากค่ารวมมี
NaN
ระบบจะแสดงผลNaN
Infinity math เป็นไปตามมาตรฐาน IEEE-754หากชุดค่ารวมเป็นค่าว่าง ระบบจะแสดงผลเป็น 0
แสดงผลจำนวนเต็ม 64 บิต หากจำนวนที่สรุปรวมทั้งหมดเป็นจำนวนเต็มและผลลัพธ์รวมไม่เกิน มิฉะนั้น ผลลัพธ์จะแสดงเป็นเลขคู่ โปรดทราบว่าแม้ว่าค่ารวมทั้งหมดจะเป็นจำนวนเต็ม แต่ผลลัพธ์จะแสดงค่าเป็นเลขคู่หากไม่สามารถให้พอดีกับจำนวนเต็มแบบมีเครื่องหมาย 64 บิต เมื่อกรณีนี้เกิดขึ้น ค่าที่ส่งกลับจะสูญเสียความแม่นยํา
เมื่อเกิดภาวะน้ำล้นเกินกำหนด การรวมจุดลอยตัวจะไม่กำหนด ซึ่งหมายความว่าการเรียกใช้การค้นหาเดียวกันซ้ำๆ โดยไม่มีการเปลี่ยนแปลงค่าที่สำคัญอาจให้ผลลัพธ์ที่แตกต่างกันเล็กน้อยในแต่ละครั้ง ในกรณีดังกล่าว ควรเก็บค่าไว้เป็นจำนวนเต็มเหนือเลขทศนิยม
ช่อง | |
---|---|
field |
ฟิลด์ที่จะรวบรวมข้อมูล |
StructuredQuery
การค้นหา Firestore
ขั้นตอนการค้นหาจะทำงานตามลำดับต่อไปนี้ 1. จาก 2. โดยที่ 3. เลือก 4. order_by + start_at + end_at 5. ออฟเซ็ต 6.
ช่อง | |
---|---|
select |
ชุดย่อยของฟิลด์ที่จะแสดง (ไม่บังคับ) การดำเนินการนี้เป็น |
from[] |
คอลเล็กชันที่จะค้นหา |
where |
ตัวกรองที่จะใช้ |
order_by[] |
ลำดับที่จะใช้กับผลลัพธ์การค้นหา Firestore ช่วยให้ผู้โทรแจ้งลำดับที่สมบูรณ์ สั่งซื้อบางส่วน หรือไม่เรียงลำดับเลย ในทุกกรณี Firestore รับประกันลำดับที่เสถียรตามกฎต่อไปนี้
ระบบจะต่อท้ายช่องด้วยทิศทางการจัดเรียงเดียวกันกับลำดับสุดท้ายที่ระบุไว้ หรือ "ASCENDING" หากไม่ได้ระบุคำสั่งซื้อ เช่น
|
start_at |
คำนำหน้าที่เป็นไปได้ของตำแหน่งในชุดผลลัพธ์เพื่อเริ่มต้นการค้นหา ลำดับของชุดผลลัพธ์ขึ้นอยู่กับอนุประโยค
ผลการค้นหานี้เรียงลำดับตาม เคอร์เซอร์จะอ้างอิงลำดับแบบเต็มหรือคำนำหน้าของสถานที่ก็ได้ แต่จะอ้างอิงช่องมากกว่าช่องที่อยู่ใน ต่อจากตัวอย่างด้านบน การแนบเคอร์เซอร์เริ่มต้นต่อไปนี้จะมีผลต่างกัน
เคอร์เซอร์เริ่มต้นช่วยให้การค้นหาเริ่มต้นในตำแหน่งเชิงตรรกะ ซึ่งแตกต่างจาก ข้อกำหนด
|
end_at |
คำนำหน้าที่เป็นไปได้ของตำแหน่งในชุดผลลัพธ์เพื่อสิ้นสุดการค้นหา ซึ่งคล้ายกับ ข้อกำหนด
|
offset |
จำนวนเอกสารที่จะข้ามก่อนแสดงผลลัพธ์แรก ซึ่งจะมีผลหลังข้อจำกัดที่ระบุโดย ข้อกำหนด
|
limit |
จำนวนผลลัพธ์สูงสุดที่จะแสดง มีผลหลังจากข้อจำกัดอื่นๆ ทั้งหมด ข้อกำหนด
|
find_nearest |
ไม่บังคับ การค้นหาเพื่อนบ้านที่อาจอยู่ใกล้ที่สุด ใช้หลังจากตัวกรองและการจัดลำดับอื่นๆ ทั้งหมด ค้นหาเวกเตอร์ที่ฝังมากที่สุดกับเวกเตอร์การค้นหาที่ระบุ |
CollectionSelector
คอลเล็กชันที่เลือก เช่น messages as m1
ช่อง | |
---|---|
collection_id |
รหัสคอลเล็กชัน เมื่อตั้งค่าแล้ว ให้เลือกเฉพาะคอลเล็กชันที่มีรหัสนี้ |
all_descendants |
เมื่อเป็นเท็จ ให้เลือกเฉพาะคอลเล็กชันที่เป็นรายการย่อยของ |
CompositeFilter
ตัวกรองที่ผสานตัวกรองอื่นๆ หลายรายการโดยใช้โอเปอเรเตอร์ที่กำหนด
ช่อง | |
---|---|
op |
โอเปอเรเตอร์สำหรับการรวมตัวกรองหลายรายการ |
filters[] |
รายการตัวกรองที่จะรวม ข้อกำหนด
|
ผู้ประกอบธุรกิจ
โอเปอเรเตอร์ตัวกรองผสม
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
ไม่ระบุ ต้องไม่ใช้ค่านี้ |
AND |
ต้องใช้เอกสารตามตัวกรองที่รวมกันทั้งหมด |
OR |
ต้องใช้เอกสารเพื่อให้เป็นไปตามตัวกรองที่รวมกันอย่างน้อย 1 รายการ |
ทิศทาง
ทิศทางการจัดเรียง
Enum | |
---|---|
DIRECTION_UNSPECIFIED |
ไม่ระบุ |
ASCENDING |
น้อยไปมาก |
DESCENDING |
มากไปน้อย |
FieldFilter
ตัวกรองในช่องที่เฉพาะเจาะจง
ช่อง | |
---|---|
field |
ช่องที่ใช้กรอง |
op |
โอเปอเรเตอร์ที่จะกรอง |
value |
ค่าที่จะเปรียบเทียบ |
ผู้ประกอบธุรกิจ
โอเปอเรเตอร์ตัวกรองฟิลด์
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
ไม่ระบุ ต้องไม่ใช้ค่านี้ |
LESS_THAN |
ข้อกำหนด
|
LESS_THAN_OR_EQUAL |
ข้อกำหนด
|
GREATER_THAN |
ข้อกำหนด
|
GREATER_THAN_OR_EQUAL |
ข้อกำหนด
|
EQUAL |
field ที่ระบุเท่ากับ value ที่ระบุ |
NOT_EQUAL |
ข้อกำหนด
|
ARRAY_CONTAINS |
field ที่ระบุคืออาร์เรย์ที่มี value ที่ระบุ |
IN |
ข้อกำหนด
|
ARRAY_CONTAINS_ANY |
ข้อกำหนด
|
NOT_IN |
ค่าของ ข้อกำหนด
|
FieldReference
การอ้างอิงช่องในเอกสาร เช่น stats.operations
ช่อง | |
---|---|
field_path |
การอ้างอิงช่องในเอกสาร ข้อกำหนด
|
กรอง
ตัวกรอง
ช่อง | |
---|---|
ฟิลด์สหภาพ filter_type ประเภทตัวกรอง filter_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
composite_filter |
ตัวกรองแบบผสม |
field_filter |
ตัวกรองในช่องเอกสาร |
unary_filter |
ตัวกรองที่ใช้อาร์กิวเมนต์เพียงรายการเดียว |
FindNearest
การกำหนดค่าการค้นหาเพื่อนบ้านที่ใกล้ที่สุด
ช่อง | |
---|---|
vector_field |
ต้องระบุ ฟิลด์เวกเตอร์ที่มีการจัดทำดัชนีสำหรับค้นหา ส่งคืนได้เฉพาะเอกสารที่มีเวกเตอร์ที่มีมิติข้อมูลตรงกับ query_ector เท่านั้น |
query_vector |
ต้องระบุ เวกเตอร์การค้นหาที่เรากำลังค้นหา ต้องเป็นเวกเตอร์ขนาดไม่เกิน 2,048 มิติข้อมูล |
distance_measure |
ต้องระบุ ต้องระบุระยะทางที่จะใช้ |
limit |
ต้องระบุ จำนวนเพื่อนบ้านที่ใกล้ที่สุดที่จะส่งคืน ต้องเป็นจำนวนเต็มบวกที่ไม่เกิน 1000 |
DistanceMeasure
ระยะทางที่ใช้เมื่อเปรียบเทียบเวกเตอร์
Enum | |
---|---|
DISTANCE_MEASURE_UNSPECIFIED |
ไม่ควรตั้งค่า |
EUCLIDEAN |
วัดระยะห่าง EUCLIDEAN ระหว่างเวกเตอร์ ดู Euclidean เพื่อเรียนรู้เพิ่มเติม |
COSINE |
เปรียบเทียบเวกเตอร์ตามมุมระหว่างเวกเตอร์ ซึ่งช่วยให้คุณสามารถวัดความคล้ายคลึงที่ไม่ได้อิงตามขนาดของเวกเตอร์ได้ เราขอแนะนำให้ใช้ DOT_PRODUCT กับเวกเตอร์มาตรฐานหน่วยแทนระยะทาง COSINE ซึ่งเทียบเท่าทางคณิตศาสตร์ได้แต่มีประสิทธิภาพดีกว่า ดูข้อมูลเพิ่มเติมที่ความคล้ายคลึงกันของโคไซน์ |
DOT_PRODUCT |
คล้ายกับโคไซน์แต่ได้รับผลกระทบจากขนาดของเวกเตอร์ ดู Dot Product เพื่อเรียนรู้เพิ่มเติม |
สั่งซื้อ
คำสั่งซื้อในช่อง
ช่อง | |
---|---|
field |
ช่องที่จะเรียงลำดับ |
direction |
ทิศทางการสั่งซื้อ ค่าเริ่มต้นคือ |
การฉายภาพ
การฉายภาพของช่องของเอกสารที่จะแสดงผล
ช่อง | |
---|---|
fields[] |
ช่องที่จะแสดงผล หากเว้นว่างไว้ ระบบจะแสดงผลทุกช่อง หากต้องการแสดงผลเฉพาะชื่อเอกสาร ให้ใช้ |
UnaryFilter
ตัวกรองที่มีตัวถูกดำเนินการเดี่ยว
ช่อง | |
---|---|
op |
โอเปอเรเตอร์สากลที่จะใช้ |
ฟิลด์สหภาพ operand_type อาร์กิวเมนต์ของตัวกรอง operand_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
field |
ช่องที่จะใช้โอเปอเรเตอร์ |
ผู้ประกอบธุรกิจ
โอเปอเรเตอร์สากล
Enum | |
---|---|
OPERATOR_UNSPECIFIED |
ไม่ระบุ ต้องไม่ใช้ค่านี้ |
IS_NAN |
field ที่ระบุมีค่าเท่ากับ NaN |
IS_NULL |
field ที่ระบุมีค่าเท่ากับ NULL |
IS_NOT_NAN |
ข้อกำหนด
|
IS_NOT_NULL |
ข้อกำหนด
|
เป้าหมาย
ข้อมูลจำเพาะของชุดเอกสารที่จะฟัง
ช่อง | |
---|---|
target_id |
รหัสเป้าหมายที่ระบุเป้าหมายในสตรีม ต้องเป็นจำนวนบวกและไม่ใช่ 0 หาก โปรดทราบว่าหากไคลเอ็นต์ส่งคำขอ หาก |
once |
ควรนำเป้าหมายออกเมื่อเป็นปัจจุบันและสอดคล้องกันหรือไม่ |
expected_count |
จำนวนเอกสารที่ตรงกับการค้นหาครั้งล่าสุดในโทเค็นประวัติย่อหรือเวลาที่อ่าน ค่านี้จะเกี่ยวข้องเฉพาะในกรณีที่ระบุ |
ฟิลด์สหภาพ target_type ประเภทของเป้าหมายที่จะฟัง target_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
query |
เป้าหมายที่ระบุโดยคำค้นหา |
documents |
เป้าหมายที่ระบุโดยชุดชื่อเอกสาร |
ฟิลด์สหภาพ หากระบุไว้ ระบบจะส่งเฉพาะเอกสารที่ตรงกันซึ่งมีการอัปเดต "หลัง" |
|
resume_token |
โทเค็นการกลับมาทำงานอีกครั้งจาก ระบบไม่รองรับการใช้โทเค็นประวัติการทำงานกับเป้าหมายอื่นและอาจล้มเหลว |
read_time |
เริ่มฟังหลังผ่านไป ในขณะนี้ไคลเอ็นต์ต้องทราบสถานะของเอกสารที่ตรงกัน |
DocumentsTarget
เป้าหมายที่ระบุโดยชุดของชื่อเอกสาร
ช่อง | |
---|---|
documents[] |
ชื่อเอกสารที่จะเรียกดู ในรูปแบบ: |
QueryTarget
เป้าหมายที่ระบุโดยคำค้นหา
ช่อง | |
---|---|
parent |
ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: |
ฟิลด์สหภาพ query_type การค้นหาที่เรียกใช้ query_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
structured_query |
การค้นหาแบบมีโครงสร้าง |
TargetChange
เป้าหมายที่กำลังดูมีการเปลี่ยนแปลง
ช่อง | |
---|---|
target_change_type |
ประเภทของการเปลี่ยนแปลงที่เกิดขึ้น |
target_ids[] |
รหัสของเป้าหมายที่มีการเปลี่ยนแปลง หากเว้นว่างไว้ การเปลี่ยนแปลงจะมีผลกับเป้าหมายทั้งหมด ไม่ได้กำหนดลำดับของรหัสเป้าหมาย |
cause |
ข้อผิดพลาดที่ทำให้เกิดการเปลี่ยนแปลงนี้ (หากมี) |
resume_token |
โทเค็นที่สามารถใช้เพื่อสตรีมต่อสำหรับ ไม่ได้ตั้งค่าสำหรับการเปลี่ยนแปลงเป้าหมายทุกครั้ง |
read_time |
สตรีมจะส่ง ในสตรีมหนึ่งๆ ถือว่า |
TargetChangeType
ประเภทของการเปลี่ยนแปลง
Enum | |
---|---|
NO_CHANGE |
ไม่มีการเปลี่ยนแปลงใดๆ ใช้เพื่อส่ง resume_token ที่อัปเดตแล้วเท่านั้น |
ADD |
เพิ่มเป้าหมายแล้ว |
REMOVE |
นำเป้าหมายออกแล้ว |
CURRENT |
เป้าหมายแสดงถึงการเปลี่ยนแปลงทั้งหมดที่ทำก่อนที่จะเพิ่มเป้าหมายลงในสตรีม ระบบจะส่งข้อมูลนี้หลังจากหรือด้วย Listener จะรอการเปลี่ยนแปลงนี้ได้หากต้องการอรรถศาสตร์แบบอ่านหลังเขียน |
RESET |
ระบบรีเซ็ตเป้าหมายแล้ว และจะแสดงสถานะเริ่มต้นใหม่ของเป้าหมายในการเปลี่ยนแปลงครั้งต่อๆ ไป หลังจากสถานะเริ่มต้นเสร็จสมบูรณ์แล้ว ระบบจะแสดงผล |
TransactionOptions
ตัวเลือกสำหรับการสร้างธุรกรรมใหม่
ช่อง | |
---|---|
ฟิลด์สหภาพ mode รูปแบบธุรกรรม mode ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
read_only |
ธุรกรรมนี้ใช้สําหรับการดำเนินการอ่านได้เท่านั้น |
read_write |
ธุรกรรมนี้ใช้ได้สำหรับทั้งการดำเนินการอ่านและเขียน |
ReadOnly
ตัวเลือกสำหรับธุรกรรมที่ใช้อ่านเอกสารได้เท่านั้น
ช่อง | |
---|---|
ฟิลด์สหภาพ consistency_selector โหมดความสอดคล้องสำหรับธุรกรรมนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ความสอดคล้องขั้นสูงโดยค่าเริ่มต้น consistency_selector ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
read_time |
อ่านเอกสารในเวลาที่ระบุ โดยต้องเป็นการประทับเวลาที่แม่นยำในระดับไมโครวินาทีภายใน 1 ชั่วโมงที่ผ่านมา หรือหากเปิดใช้การกู้คืนช่วงเวลาอยู่ ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายในช่วง 7 วันที่ผ่านมาด้วย |
ReadWrite
ตัวเลือกสำหรับธุรกรรมที่ใช้เพื่ออ่านและเขียนเอกสารได้
Firestore ไม่อนุญาตให้คำขอการตรวจสอบสิทธิ์ของบุคคลที่สามสร้างธุรกรรมแบบอ่าน-เขียน
ช่อง | |
---|---|
retry_transaction |
ธุรกรรมที่ไม่บังคับเพื่อลองใหม่ |
UpdateDocumentRequest
คำขอสำหรับ Firestore.UpdateDocument
ช่อง | |
---|---|
document |
ต้องระบุ เอกสารที่อัปเดตแล้ว สร้างเอกสารหากยังไม่มี |
update_mask |
ช่องที่จะอัปเดต เส้นทางฟิลด์ในมาสก์อาจไม่มีชื่อที่สงวนไว้ หากเอกสารอยู่ในเซิร์ฟเวอร์และมีช่องที่ไม่ได้อ้างอิงในมาสก์ ช่องจะไม่มีการเปลี่ยนแปลง ระบบจะลบช่องที่อ้างอิงในมาสก์แต่ไม่มีอยู่ในเอกสารอินพุตออกจากเอกสารบนเซิร์ฟเวอร์ |
mask |
ช่องที่จะแสดงผล หากไม่ได้ตั้งค่า ระบบจะแสดงฟิลด์ทั้งหมด หากเอกสารมีช่องที่ไม่ได้อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในคำตอบ |
current_document |
เงื่อนไขที่กำหนดไว้ล่วงหน้าในเอกสารซึ่งไม่บังคับ คำขอจะล้มเหลวหากมีการตั้งค่านี้ไว้และไม่เป็นไปตามเอกสารเป้าหมาย |
ค่า
ข้อความที่เก็บประเภทค่าที่รองรับใดก็ได้
ช่อง | |
---|---|
ฟิลด์สหภาพ value_type ต้องมีชุดค่า value_type ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
null_value |
ค่า Null |
boolean_value |
ค่าบูลีน |
integer_value |
ค่าจำนวนเต็ม |
double_value |
ค่าทศนิยม |
timestamp_value |
ค่าการประทับเวลา แม่นยำระดับไมโครวินาทีเท่านั้น เมื่อจัดเก็บ ระบบจะปัดเศษความแม่นยำเพิ่มเติมลง |
string_value |
ค่าสตริง สตริงที่แสดงเป็น UTF-8 จะต้องมีขนาดไม่เกิน 1 MiB - 89 ไบต์ เฉพาะ 1,500 ไบต์แรกของการแสดง UTF-8 เท่านั้นที่จะพิจารณาตามคำค้นหา |
bytes_value |
ค่าไบต์ ต้องไม่เกิน 1 MiB - 89 ไบต์ เฉพาะ 1,500 ไบต์แรกเท่านั้นที่จะพิจารณาสำหรับคำค้นหา |
reference_value |
การอ้างอิงไปยังเอกสาร เช่น |
geo_point_value |
ค่าจุดทางภูมิศาสตร์ที่แสดงถึงจุดบนพื้นผิวโลก |
array_value |
ค่าอาร์เรย์ ไม่สามารถใส่ค่าอาร์เรย์อื่นโดยตรงได้ แต่สามารถใส่แผนที่ซึ่งมีอาร์เรย์อื่นได้ |
map_value |
ค่าแผนที่ |
เขียน
การเขียนในเอกสาร
ช่อง | |
---|---|
update_mask |
ช่องที่จะอัปเดตในการเขียนนี้ ช่องนี้จะตั้งค่าได้ก็ต่อเมื่อการดำเนินการคือ |
update_transforms[] |
การเปลี่ยนรูปแบบที่จะดำเนินการหลังการอัปเดต ช่องนี้จะตั้งค่าได้ก็ต่อเมื่อการดำเนินการคือ |
current_document |
เงื่อนไขที่กำหนดไว้ล่วงหน้าในเอกสารซึ่งไม่บังคับ การเขียนจะล้มเหลวหากมีการตั้งค่านี้ไว้และไม่ตรงตามเอกสารเป้าหมาย |
ฟิลด์สหภาพ operation การดำเนินการที่จะดำเนินการ operation ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
update |
เอกสารที่จะเขียน |
delete |
ชื่อเอกสารที่จะลบ ในรูปแบบ: |
transform |
ใช้การเปลี่ยนรูปแบบกับเอกสาร |
WriteRequest
คำขอสำหรับ Firestore.Write
คำขอแรกจะสร้างสตรีม หรือกำหนดให้สตรีมที่มีอยู่กลับมาทำงานอีกครั้งจากโทเค็น
เมื่อสร้างสตรีมใหม่ เซิร์ฟเวอร์จะตอบกลับด้วยการตอบกลับที่มีเฉพาะรหัสและโทเค็นเพื่อใช้ในคำขอถัดไป
เมื่อกลับมาสตรีมอีกครั้ง เซิร์ฟเวอร์จะสตรีมการตอบกลับภายหลังจากโทเค็นที่ระบุก่อน จากนั้นจึงส่งการตอบกลับที่มีเฉพาะโทเค็นล่าสุดเพื่อใช้ในคำขอถัดไป
ช่อง | |
---|---|
database |
ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: |
stream_id |
รหัสของสตรีมการเขียนที่จะดำเนินการต่อ ซึ่งอาจตั้งค่าในข้อความแรกเท่านั้น หากเว้นว่างไว้ ระบบจะสร้างสตรีมการเขียนใหม่ |
writes[] |
การเขียนที่จะใช้ ดำเนินการอย่างสมเหตุสมผลและเป็นไปตามลำดับเสมอ ค่านี้ต้องว่างเปล่าในคำขอแรก ซึ่งอาจว่างเปล่าในคำขอล่าสุด ค่านี้ต้องไม่ว่างเปล่าในคำขออื่นๆ ทั้งหมด |
stream_token |
โทเค็นสตรีมที่เซิร์ฟเวอร์ส่งไปก่อนหน้านี้ ไคลเอ็นต์ควรตั้งค่าช่องนี้เป็นโทเค็นจาก เซิร์ฟเวอร์อาจปิดสตรีมหากมีคำตอบที่ยังไม่ได้ตอบรับมากเกินไป ไม่ต้องเลือกช่องทำเครื่องหมายนี้เมื่อสร้างสตรีมใหม่ หากต้องการสตรีมต่อที่จุดที่เจาะจง ให้ตั้งค่าช่องนี้และช่อง ไม่ต้องเลือกช่องทำเครื่องหมายนี้เมื่อสร้างสตรีมใหม่ |
labels |
ป้ายกำกับที่เชื่อมโยงกับคำขอการเขียนนี้ |
WriteResponse
การตอบกลับสำหรับ Firestore.Write
ช่อง | |
---|---|
stream_id |
รหัสของสตรีม ตั้งค่าสำหรับข้อความแรกเท่านั้นเมื่อสร้างสตรีมใหม่ |
stream_token |
โทเค็นที่แสดงตำแหน่งของการตอบกลับนี้ในสตรีม ณ จุดนี้ ไคลเอ็นต์จะใช้เพื่อสตรีมต่อได้ ระบบจะตั้งค่าช่องนี้เสมอ |
write_results[] |
ผลของการใช้การเขียน ผลการเขียน i นี้สอดคล้องกับการเขียน i-th ในคำขอ |
commit_time |
เวลาที่คอมมิตเกิดขึ้น การอ่านที่มี |
WriteResult
ผลของการใช้การเขียน
ช่อง | |
---|---|
update_time |
เวลาอัปเดตเอกสารครั้งล่าสุดหลังจากใช้การเขียน ไม่ได้ตั้งค่าไว้หลัง หากการเขียนไม่ได้เปลี่ยนแปลงเอกสารจริงๆ นี่จะเป็นupdate_time ก่อนหน้า |
transform_results[] |
ผลการใช้ |