Package google.firestore.v1

map<string, Value>

ผลลัพธ์ของฟังก์ชันการรวมข้อมูล เช่น COUNT(*) AS total_docs

คีย์คือ alias ที่กำหนดให้กับฟังก์ชันการรวมข้อมูลในอินพุต และขนาดของแผนที่นี้เท่ากับจำนวนของฟังก์ชันการรวมข้อมูลในการค้นหา

Value

ค่าในอาร์เรย์

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{project_id}/databases/{database_id}

string

ชื่อเอกสารที่จะเรียกดู ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents/{document_path} คำขอจะล้มเหลวหากเอกสารใดไม่ใช่ทรัพยากรย่อยของ database ที่ระบุ โดยจะไม่มีการลบชื่อที่ซ้ำกัน

DocumentMask

ช่องที่จะแสดง หากไม่ได้ตั้งค่า ระบบจะแสดงช่องทั้งหมด

หากเอกสารมีฟิลด์ที่ไม่ได้แสดงอยู่ในมาสก์นี้ ฟิลด์ดังกล่าวจะไม่แสดงผลในคำตอบ

bytes

อ่านเอกสารในธุรกรรม

TransactionOptions

เริ่มธุรกรรมใหม่และอ่านเอกสาร ค่าเริ่มต้นจะเป็นธุรกรรมแบบอ่านอย่างเดียว รหัสธุรกรรมใหม่จะแสดงผลเป็นการตอบกลับแรกในสตรีม

Timestamp

อ่านเอกสารตามที่อยู่ในเวลาที่กำหนด

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

bytes

ธุรกรรมที่เริ่มต้นโดยเป็นส่วนหนึ่งของคำขอนี้ จะตั้งค่าในการตอบกลับครั้งแรก และในกรณีที่มีการตั้งค่า BatchGetDocumentsRequest.new_transaction ในคำขอเท่านั้น

Timestamp

เวลาที่อ่านเอกสาร ซึ่งอาจเพิ่มขึ้นทีละน้อย ในกรณีนี้ เรารับประกันว่าเอกสารก่อนหน้าในสตรีมผลลัพธ์จะไม่มีการเปลี่ยนแปลงระหว่าง read_time กับเอกสารนี้

Document

เอกสารที่ขอ

string

ชื่อเอกสารที่ขอแล้วแต่ไม่มีอยู่ ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents/{document_path}

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{project_id}/databases/{database_id}

Write

การเขียนที่จะใช้

เมธอดไม่ได้ใช้การเขียนแบบอะตอมและไม่รับประกันการเรียงลำดับ การเขียนแต่ละรายการประสบความสำเร็จหรือล้มเหลวโดยอิสระ คุณไม่สามารถเขียนไปยังเอกสารเดียวกันมากกว่า 1 ครั้งต่อคำขอ

map<string, string>

ป้ายกำกับที่เชื่อมโยงกับการเขียนแบบกลุ่มนี้

WriteResult

ผลลัพธ์ของการใช้การเขียน

ผลการเขียน i-th นี้สอดคล้องกับการเขียน i-th ในคำขอ

Status

สถานะของการใช้การเขียน

สถานะการเขียน i-th นี้สอดคล้องกับการเขียน i-th ในคำขอ

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{project_id}/databases/{database_id}

TransactionOptions

ตัวเลือกสำหรับธุรกรรม ค่าเริ่มต้นคือธุรกรรมแบบอ่าน-เขียน

bytes

ธุรกรรมที่เริ่มต้นแล้ว

bytes

ไบต์ที่เข้ารหัสลำดับบิต อาจมีความยาวเป็น 0

int32

จำนวนบิตของไบต์สุดท้ายใน bitmap ที่จะละเว้นเป็น "ระยะห่างจากขอบ" หากความยาวของ bitmap เป็น 0 ค่านี้ต้องเป็น 0 มิเช่นนั้น ค่านี้ต้องอยู่ระหว่าง 0 ถึง 7 เท่านั้น

BitSequence

ข้อมูลตัวกรองดอกไม้

int32

จำนวนแฮชที่อัลกอริทึมใช้

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{project_id}/databases/{database_id}

Write

การเขียนที่จะใช้

ดำเนินการโดยอัตโนมัติเสมอและเรียงตามลำดับ

bytes

หากมีการตั้งค่า จะใช้การเขียนทั้งหมดในธุรกรรมนี้และตกลง

WriteResult

ผลลัพธ์ของการใช้การเขียน

ผลการเขียน i-th นี้สอดคล้องกับการเขียน i-th ในคำขอ

Timestamp

เวลาที่การคอมมิตเกิดขึ้น การอ่านที่มี read_time เท่ากันหรือมากกว่าได้เห็นผลของคอมมิต

string

ต้องระบุ ทรัพยากรระดับบนสุด เช่น projects/{project_id}/databases/{database_id}/documents หรือ projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

ต้องระบุ รหัสคอลเล็กชันที่สัมพันธ์กับ parent ในรายการ เช่น chatrooms

string

รหัสเอกสารที่ลูกค้ากำหนดที่จะใช้กับเอกสารนี้

ไม่บังคับ หากไม่ระบุ บริการจะกำหนดรหัสให้

Document

ต้องระบุ เอกสารที่จะสร้าง ต้องตั้งค่า name

DocumentMask

ช่องที่จะแสดง หากไม่ได้ตั้งค่า ระบบจะแสดงช่องทั้งหมด

หากเอกสารมีช่องที่ไม่อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในการตอบกลับ

Value

ค่าที่แสดงถึงตำแหน่ง จะเรียงลำดับตามอนุประโยคของคำค้นหา

อาจมีค่าน้อยกว่าที่ระบุไว้ในลำดับตามอนุประโยค

bool

หากตำแหน่งอยู่ก่อนหรือหลังค่าที่ระบุ สัมพันธ์กับลำดับการจัดเรียงที่กำหนดโดยการค้นหา

string

ต้องระบุ ชื่อทรัพยากรของเอกสารที่จะลบ ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents/{document_path}

Precondition

เงื่อนไขที่ต้องดำเนินการก่อนในเอกสาร (ไม่บังคับ) คำขอจะล้มเหลวหากตั้งค่าไว้แต่ไม่บรรลุผลโดยเอกสารเป้าหมาย

string

ชื่อทรัพยากรของเอกสาร เช่น projects/{project_id}/databases/{database_id}/documents/{document_path}

map<string, Value>

Timestamp

เอาต์พุตเท่านั้น เวลาที่สร้างเอกสาร

ค่านี้จะเพิ่มขึ้นซ้ำๆ เมื่อมีการลบเอกสารแล้วสร้างใหม่ และยังเปรียบเทียบค่าจากเอกสารอื่นๆ และ read_time ของการค้นหาได้ด้วย

Timestamp

เอาต์พุตเท่านั้น เวลาที่เอกสารมีการเปลี่ยนแปลงล่าสุด

ค่านี้จะตั้งเป็น create_time ในตอนแรก จากนั้นจะเพิ่มขึ้นซ้ำๆ เมื่อมีการเปลี่ยนแปลงเอกสารแต่ละครั้ง และยังเปรียบเทียบค่าจากเอกสารอื่นๆ และ read_time ของการค้นหาได้ด้วย

Document

สถานะใหม่ของ Document

หากตั้งค่า mask ไว้ จะมีเฉพาะช่องที่ได้รับการอัปเดตหรือเพิ่มแล้ว

int32

ชุดรหัสเป้าหมายของเป้าหมายที่ตรงกับเอกสารนี้

int32

ชุดรหัสเป้าหมายสำหรับเป้าหมายที่ไม่ตรงกับเอกสารนี้อีกต่อไป

string

ชื่อทรัพยากรของ Document ที่ลบไปแล้ว

int32

ชุดรหัสเป้าหมายสำหรับเป้าหมายที่ตรงกับเอนทิตีนี้ก่อนหน้านี้

Timestamp

การประทับเวลาการอ่านที่พบการลบ

มากกว่าหรือเท่ากับ commit_time ของการลบ

string

รายการเส้นทางช่องในมาสก์ ดู Document.fields สำหรับการอ้างอิงไวยากรณ์เส้นทางช่อง

string

ชื่อทรัพยากรของ Document หายไปแล้ว

int32

ชุดรหัสเป้าหมายสำหรับเป้าหมายที่ตรงกับเอกสารนี้ก่อนหน้านี้

Timestamp

การประทับเวลาการอ่านที่พบการนำออก

มากกว่าหรือเท่ากับ commit_time ของการเปลี่ยนแปลง/ลบ/นำออก

string

ชื่อเอกสารที่จะแปลง

FieldTransform

รายการการเปลี่ยนรูปแบบที่จะนำไปใช้กับช่องของเอกสารตามลำดับ ต้องระบุข้อมูล

string

เส้นทางของช่อง ดู Document.fields สำหรับการอ้างอิงไวยากรณ์ของเส้นทางช่อง

ServerValue

ตั้งค่าช่องนี้เป็นค่าเซิร์ฟเวอร์ที่ระบุ

Value

เพิ่มค่าที่ระบุลงในค่าปัจจุบันของช่อง

ค่านี้ต้องเป็นจำนวนเต็มหรือค่าเลขทศนิยม หากช่องนี้ไม่ใช่จำนวนเต็มหรือเลขคู่ หรือยังไม่มีช่องนี้ การเปลี่ยนรูปแบบจะตั้งค่าช่องนี้เป็นค่าที่ระบุ หากค่าที่ระบุหรือค่าในช่องปัจจุบันเป็นเลขคู่ ระบบจะตีความทั้ง 2 ค่าเป็นเลขคู่ เลขคณิตคู่และการแทนค่าคู่จะเป็นไปตามความหมาย IEEE 754 ถ้ามีจำนวนเต็มบวก/ลบ ฟิลด์จะได้รับการแก้เป็นค่าจำนวนเต็มบวก/ลบที่มีค่ามากที่สุด

Value

ตั้งค่าช่องนี้เป็นค่าสูงสุดของค่าปัจจุบันและค่าที่ระบุ

ค่านี้ต้องเป็นจำนวนเต็มหรือค่าเลขทศนิยม หากช่องนี้ไม่ใช่จำนวนเต็มหรือเลขคู่ หรือยังไม่มีช่องนี้ การเปลี่ยนรูปแบบจะตั้งค่าช่องนี้เป็นค่าที่ระบุ หากใช้การดำเนินการสูงสุดในกรณีที่ช่องและค่าอินพุตเป็นประเภทผสม (กล่าวคือ 1 เป็นจำนวนเต็มและ 1 รายการเป็นเลขคู่) ช่องจะใช้ประเภทตัวถูกดำเนินการที่ใหญ่กว่า หากตัวถูกดำเนินการมีค่าเท่ากัน (เช่น 3 และ 3.0) ฟิลด์จะไม่เปลี่ยนแปลง 0, 0.0 และ -0.0 ถือเป็น 0 ทั้งหมด โดยค่าสูงสุดซึ่งเก็บค่าที่เท่ากับ 0 และค่าอินพุตเป็น 0 จะเป็นค่าที่จัดเก็บไว้เสมอ ค่าสูงสุดของค่าตัวเลข x และ NaN คือ NaN

Value

ตั้งค่าฟิลด์เป็นค่าต่ำสุดของค่าปัจจุบันและค่าที่ระบุ

ค่านี้ต้องเป็นจำนวนเต็มหรือค่าเลขทศนิยม หากช่องนี้ไม่ใช่จำนวนเต็มหรือเลขคู่ หรือยังไม่มีช่องนี้ การเปลี่ยนรูปแบบจะตั้งค่าช่องนี้เป็นค่าอินพุต หากใช้การดำเนินการขั้นต่ำในกรณีที่ช่องและค่าอินพุตเป็นประเภทผสม (กล่าวคือ 1 เป็นจำนวนเต็มและ 1 รายการเป็นเลขคู่) ช่องจะใช้ประเภทตัวถูกดำเนินการที่น้อยกว่า หากตัวถูกดำเนินการมีค่าเท่ากัน (เช่น 3 และ 3.0) ฟิลด์จะไม่เปลี่ยนแปลง 0, 0.0 และ -0.0 ถือเป็น 0 ทั้งหมด ค่าขั้นต่ำที่จัดเก็บเป็น 0 และค่าอินพุตเป็น 0 จะเป็นค่าที่จัดเก็บไว้เสมอ ค่าต่ำสุดของค่าตัวเลข x และ NaN คือ NaN

ArrayValue

เพิ่มองค์ประกอบที่กำหนดต่อท้ายองค์ประกอบที่กำหนดหากองค์ประกอบนั้นไม่อยู่ในค่าปัจจุบัน หากช่องนี้ไม่ใช่อาร์เรย์หรือยังไม่มีช่องนี้ ให้ตั้งเป็นอาร์เรย์ว่างเปล่าก่อน

จำนวนที่เทียบเท่าของประเภทต่างๆ (เช่น 3L และ 3.0) จะถือว่าเท่ากันเมื่อตรวจสอบว่าค่าขาดหายไปหรือไม่ NaN เท่ากับ NaN และ Null เท่ากับ Null หากอินพุตมีค่าที่เทียบเท่าหลายค่า ระบบจะพิจารณาเฉพาะค่าแรกเท่านั้น

transform_result ที่เกี่ยวข้องจะเป็นค่าว่าง

ArrayValue

นำองค์ประกอบที่ระบุทั้งหมดออกจากอาร์เรย์ในช่อง หากช่องนี้ไม่ใช่อาร์เรย์หรือยังไม่มีช่องนี้ ให้ตั้งเป็นอาร์เรย์ว่างเปล่า

จำนวนที่เทียบเท่ากันของประเภทต่างๆ (เช่น 3L และ 3.0) จะถือว่าเท่ากันเมื่อตัดสินว่าควรนำองค์ประกอบออกหรือไม่ NaN เท่ากับ NaN และ Null เท่ากับ Null การดำเนินการนี้จะนำค่าที่เทียบเท่ากันทั้งหมดออกหากมีค่าที่ซ้ำกัน

transform_result ที่เกี่ยวข้องจะเป็นค่าว่าง

int64

จำนวนของผลลัพธ์ทั้งหมดที่ส่งคืน รวมถึงเอกสาร การคาดการณ์ ผลลัพธ์การรวม คีย์

Duration

เวลาทั้งหมดในการดำเนินการค้นหาในแบ็กเอนด์

int64

การดำเนินการอ่านที่เรียกเก็บเงินได้ทั้งหมด

Struct

การแก้ไขข้อบกพร่องของสถิติจากการดำเนินการค้นหา โปรดทราบว่าสถิติการแก้ไขข้อบกพร่องอาจมีการเปลี่ยนแปลงเมื่อ Firestore พัฒนาขึ้น โดยอาจมี { "indexes_entries_sformatted": "1000", "documents_sสิ่งเหล่านี้": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" }

int32

รหัสเป้าหมายที่จะใช้กับตัวกรองนี้

int32

จำนวนเอกสารทั้งหมดที่ตรงกับ target_id

หากจำนวนเอกสารไม่ตรงกับจำนวนในเอกสารที่ตรงกัน ลูกค้าจะต้องระบุด้วยตนเองว่าเอกสารใดไม่ตรงกับเป้าหมายอีกต่อไป

ไคลเอ็นต์สามารถใช้ตัวกรองบลูม unchanged_names เพื่อช่วยในการพิจารณานี้โดยการทดสอบชื่อเอกสารทั้งหมดกับตัวกรอง หากชื่อเอกสารไม่ได้อยู่ในตัวกรอง แสดงว่าเอกสารนั้นไม่ตรงกับเป้าหมายอีกต่อไป

BloomFilter

ตัวกรองบลูมที่แม้จะมีชื่อ แต่ก็มีการเข้ารหัส UTF-8 ไบต์ของชื่อทรัพยากรของเอกสารทั้งหมดที่ตรงกับ target_id ในรูปแบบ projects/{project_id}/databases/{database_id}/documents/{document_path}

ตัวกรองบลูมนี้อาจถูกละเว้นโดยการพิจารณาตามที่เห็นสมควรของเซิร์ฟเวอร์ เช่น ถ้าพิจารณาแล้วว่าลูกค้าจะไม่ใช้ประโยชน์จากตัวกรองบลูมนี้ หรือมีค่าใช้จ่ายสําหรับการคำนวณหรือส่งข้อมูลที่แพงเกินไป ไคลเอ็นต์ต้องจัดการในกรณีที่ไม่มีข้อมูลช่องนี้ให้เรียบร้อย โดยกลับไปใช้ตรรกะที่ใช้ก่อนที่จะมีช่องนี้ กล่าวคือ ให้เพิ่มเป้าหมายอีกครั้งโดยไม่ต้องใช้โทเค็นสำหรับประวัติการทำงานเพื่อดูว่าเอกสารใดในแคชของไคลเอ็นต์ที่ไม่ซิงค์กัน

PlanSummary

ข้อมูลระยะการวางแผนสำหรับการค้นหา

ExecutionStats

สถิติรวมจากการดำเนินการค้นหา แสดงเมื่อตั้งค่า ExplainOptions.analyze เป็น "จริง" เท่านั้น

bool

ไม่บังคับ ต้องการเรียกใช้การค้นหานี้หรือไม่

เมื่อเป็นเท็จ (ค่าเริ่มต้น) ระบบจะวางแผนการค้นหาโดยแสดงผลเฉพาะเมตริกจากขั้นตอนการวางแผน

เมื่อเป็นจริง ระบบจะวางแผนและดำเนินการค้นหา โดยแสดงผลการค้นหาทั้งหมดพร้อมทั้งเมตริกขั้นตอนการวางแผนและการดำเนินการ

string

ต้องระบุ ชื่อทรัพยากรของเอกสารที่จะรับ ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents/{document_path}

DocumentMask

ช่องที่จะแสดง หากไม่ได้ตั้งค่า ระบบจะแสดงช่องทั้งหมด

หากเอกสารมีช่องที่ไม่อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในการตอบกลับ

bytes

อ่านเอกสารในธุรกรรม

Timestamp

อ่านเอกสารตามฉบับ ณ เวลาที่ระบุ

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

string

ต้องระบุ เอกสารหลัก ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents/{document_path} เช่น projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

จำนวนผลลัพธ์สูงสุดที่จะแสดง

string

โทเค็นของหน้า ต้องเป็นค่าจาก ListCollectionIdsResponse

Timestamp

อ่านเอกสารตามที่อยู่ในเวลาที่กำหนด

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

string

รหัสคอลเล็กชัน

string

โทเค็นหน้าเว็บที่อาจใช้เพื่อดำเนินรายการต่อ

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents หรือ projects/{project_id}/databases/{database_id}/documents/{document_path}

เช่น projects/my-project/databases/my-database/documents หรือ projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

ไม่บังคับ รหัสคอลเล็กชันที่สัมพันธ์กับ parent ในรายการ

เช่น chatrooms หรือ messages

โดยคุณจะดำเนินการนี้หรือไม่ก็ได้ และเมื่อไม่มีให้บริการ Firestore จะแสดงรายการเอกสารจากคอลเล็กชันทั้งหมดภายใต้ parent ที่มีให้

int32

ไม่บังคับ จำนวนเอกสารสูงสุดที่จะแสดงในคำตอบเดียว

Firestore อาจแสดงผลน้อยกว่าค่านี้

string

ไม่บังคับ โทเค็นของหน้าเว็บ ที่ได้รับจากการตอบกลับ ListDocuments ก่อนหน้า

ระบุพารามิเตอร์นี้เพื่อเรียกข้อมูลหน้าถัดไป เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมด (ยกเว้น page_size) ต้องตรงกับค่าที่ตั้งไว้ในคำขอที่สร้างโทเค็นของหน้าเว็บ

string

ไม่บังคับ ลำดับของเอกสารที่จะส่งคืนหรือไม่ก็ได้

เช่น priority desc, __name__ desc

ซึ่งสะท้อนให้เห็นถึง ORDER BY ที่ใช้ในการค้นหา Firestore แต่ในการแสดงสตริง หากไม่ระบุ ระบบจะเรียงลำดับเอกสารตาม__name__ ASC

DocumentMask

ไม่บังคับ ช่องที่จะแสดง หากไม่ได้ตั้งค่า ระบบจะแสดงช่องทั้งหมด

หากเอกสารมีฟิลด์ที่ไม่ได้แสดงอยู่ในมาสก์นี้ ฟิลด์ดังกล่าวจะไม่แสดงผลในคำตอบ

bool

กรณีที่รายการควรแสดงเอกสารที่ขาดหายไป

เอกสารหายไปถ้าไม่มีอยู่ แต่มีเอกสารย่อยฝังอยู่ใต้นั้น เมื่อเป็นจริง ระบบจะแสดงผลเอกสารที่ขาดหายไปดังกล่าวพร้อมคีย์ แต่จะไม่มีช่อง create_time หรือ update_time ที่ตั้งค่าไว้

คำขอที่มี show_missing ไม่สามารถระบุ where หรือ order_by

bytes

ดำเนินการอ่านโดยเป็นส่วนหนึ่งของธุรกรรมที่ใช้งานอยู่แล้ว

Timestamp

อ่านตามเวลาที่ระบุไว้

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

Document

เอกสารที่พบ

string

โทเค็นสำหรับเรียกหน้าถัดไปของเอกสาร

หากเว้นช่องนี้ไว้ จะไม่มีหน้าลำดับต่อมา

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{project_id}/databases/{database_id}

map<string, string>

ป้ายกำกับที่เชื่อมโยงกับการเปลี่ยนแปลงเป้าหมายนี้

Target

เป้าหมายที่จะเพิ่มลงในสตรีมนี้

int32

รหัสของเป้าหมายที่จะนำออกจากสตรีมนี้

TargetChange

เป้าหมายมีการเปลี่ยนแปลง

DocumentChange

Document มีการเปลี่ยนแปลง

DocumentDelete

ลบ Document แล้ว

DocumentRemove

นำ Document ออกจากเป้าหมายแล้ว (เนื่องจากไม่เกี่ยวข้องกับเป้าหมายนั้นแล้ว)

ExistenceFilter

ตัวกรองที่จะใช้กับชุดของเอกสารที่แสดงผลก่อนหน้านี้สำหรับเป้าหมายที่ระบุ

แสดงผลเมื่อเอกสารอาจถูกนำออกจากเป้าหมายที่กำหนด แต่ไม่ทราบเอกสารที่แน่นอน

map<string, Value>

ฟิลด์ของแผนที่

คีย์แผนที่จะแสดงชื่อช่อง ชื่อช่องที่ตรงกับนิพจน์ทั่วไป __.*__ เป็นชื่อที่สงวนไว้ ไม่อนุญาตให้ใช้ชื่อช่องที่สงวนไว้ ยกเว้นในบางบริบทที่มีการบันทึกไว้ คีย์แผนที่ซึ่งแสดงเป็น UTF-8 ต้องมีขนาดไม่เกิน 1,500 ไบต์และต้องไม่ว่างเปล่า

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents ระบบไม่รองรับชื่อทรัพยากรของเอกสาร ระบุได้เฉพาะชื่อทรัพยากรฐานข้อมูล

int64

จำนวนจุดพาร์ติชันสูงสุดที่ต้องการ พาร์ติชันอาจแสดงในผลลัพธ์หลายหน้า ตัวเลขต้องเป็นค่าบวก จำนวนพาร์ติชันจริงที่แสดงผลอาจน้อยกว่า

เช่น อาจตั้งค่านี้ให้น้อยกว่าจำนวนการค้นหาแบบขนานที่จะเรียกใช้ หรือในการเรียกใช้งานไปป์ไลน์ข้อมูล น้อยกว่าจำนวนผู้ปฏิบัติงานหรืออินสแตนซ์การประมวลผลที่พร้อมใช้งาน 1 รายการ

string

ค่า next_page_token ที่แสดงผลจากการเรียกไปยัง PartitionQuery ก่อนหน้านี้ ซึ่งอาจนำไปใช้เพื่อรับชุดผลลัพธ์เพิ่มเติม ไม่มีการรับประกันการสั่งซื้อระหว่างชุดผลลัพธ์ ดังนั้น การใช้ผลลัพธ์หลายชุดจะต้องมีการรวมชุดผลลัพธ์ที่แตกต่างกัน

ตัวอย่างเช่น การเรียก 2 ครั้งครั้งต่อๆ มาโดยใช้ page_token อาจส่งคืนผลลัพธ์ดังนี้

• เคอร์เซอร์ B, เคอร์เซอร์ M, เคอร์เซอร์ Q
• เคอร์เซอร์ A, เคอร์เซอร์ U, เคอร์เซอร์ W

หากต้องการได้ชุดผลลัพธ์ที่สมบูรณ์ซึ่งเรียงลำดับตามผลลัพธ์ของการค้นหาที่ระบุให้กับ PartitionQuery ชุดผลลัพธ์ควรรวมเข้าด้วยกัน: เคอร์เซอร์ A, เคอร์เซอร์ B, เคอร์เซอร์ M, เคอร์เซอร์ Q, เคอร์เซอร์ U, เคอร์เซอร์ W

int32

จำนวนพาร์ติชันสูงสุดที่จะแสดงในการเรียกนี้ ขึ้นอยู่กับ partition_count

ตัวอย่างเช่น ถ้า partition_count = 10 และ page_size = 8 การเรียก PartitionQuery ครั้งแรกจะแสดงพาร์ติชันสูงสุด 8 พาร์ติชัน และ next_page_token ถ้ามีผลลัพธ์มากกว่า การเรียก PartitionQuery ครั้งที่ 2 จะแสดงผลพาร์ติชันสูงสุด 2 พาร์ติชัน ซึ่งทำให้มีทั้งหมด 10 พาร์ติชันที่ระบุไว้ใน partition_count

StructuredQuery

การค้นหาแบบมีโครงสร้าง การค้นหาต้องระบุคอลเล็กชันที่มีองค์ประกอบสืบทอดทั้งหมด และเรียงลำดับตามชื่อจากน้อยไปหามาก ไม่รองรับตัวกรองอื่นๆ การเรียงลำดับตาม ขีดจำกัด ออฟเซ็ต และเคอร์เซอร์เริ่มต้น/สิ้นสุด

Timestamp

อ่านเอกสารตามที่อยู่ในเวลาที่กำหนด

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

Cursor

ผลลัพธ์การแบ่งพาร์ติชัน แต่ละพาร์ติชันคือจุดแยกที่สามารถใช้โดย RunQuery เป็นจุดเริ่มต้นหรือจุดสิ้นสุดสำหรับผลการค้นหา คำขอ RunQuery ต้องสร้างขึ้นด้วยคำค้นหาเดียวกันกับที่ระบุให้กับคำขอ PartitionQuery นี้ เคอร์เซอร์พาร์ติชันจะเรียงลำดับตามลำดับเดียวกับผลลัพธ์ของการค้นหาที่ระบุให้กับ PartitionQuery

ตัวอย่างเช่น หากคำขอ PartitionQuery แสดงผลเคอร์เซอร์พาร์ติชัน A และ B การเรียกใช้การค้นหาสามแบบต่อไปนี้จะแสดงชุดผลลัพธ์ทั้งหมดของคำค้นหาเดิม:

• คำค้นหา, สิ้นสุดที่ A
• คำค้นหา, เริ่มต้นที่ A, สิ้นสุดที่ B
• คำค้นหา, เริ่มต้นที่ B

ผลลัพธ์ที่ว่างเปล่าอาจบ่งชี้ว่าการค้นหามีผลลัพธ์น้อยเกินไปที่จะแบ่งพาร์ติชัน หรือการค้นหายังไม่รองรับการแบ่งพาร์ติชัน

string

โทเค็นหน้าเว็บที่อาจใช้เพื่อขอชุดผลลัพธ์เพิ่มเติม ตามจำนวนที่ระบุโดย partition_count ในคำขอ PartitionQuery หากเว้นว่างไว้ จะไม่มีผลลัพธ์เพิ่มเติม

Struct

ดัชนีที่เลือกสำหรับการค้นหา ตัวอย่างเช่น [ {"query_scope": "Collection", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)"} ]

bool

เมื่อตั้งค่าเป็น true เอกสารเป้าหมายต้องมีอยู่จริง เมื่อตั้งค่าเป็น false เอกสารเป้าหมายจะต้องไม่มีอยู่

Timestamp

เมื่อตั้งค่าแล้ว เอกสารเป้าหมายต้องมีอยู่และได้รับการอัปเดตล่าสุดในขณะนั้น การประทับเวลาต้องสอดคล้องกับไมโครวินาที

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{project_id}/databases/{database_id}

bytes

ต้องระบุ ธุรกรรมที่จะย้อนกลับ

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents หรือ projects/{project_id}/databases/{database_id}/documents/{document_path} เช่น projects/my-project/databases/my-database/documents หรือ projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

ไม่บังคับ อธิบายตัวเลือกต่างๆ สำหรับการค้นหา หากมีการตั้งค่า ระบบจะแสดงผลสถิติคำค้นหาเพิ่มเติม หากไม่ตรง ระบบจะแสดงเฉพาะผลการค้นหา

StructuredAggregationQuery

คำค้นหาการรวม

bytes

เรียกใช้การรวมภายในธุรกรรมที่ใช้งานอยู่แล้ว

ค่าในที่นี้คือรหัสธุรกรรมที่คลุมเครือซึ่งจะใช้ในการค้นหา

TransactionOptions

เริ่มธุรกรรมใหม่เป็นส่วนหนึ่งของการค้นหา โดยตั้งค่าเริ่มต้นเป็นอ่านอย่างเดียว

รหัสธุรกรรมใหม่จะแสดงผลเป็นการตอบกลับแรกในสตรีม

Timestamp

ดำเนินการค้นหาในการประทับเวลาที่ระบุ

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

AggregationResult

ผลลัพธ์ซึ่งเป็นการรวมข้อมูลเดียว

ไม่แสดงเมื่อรายงานความคืบหน้าบางส่วน

bytes

ธุรกรรมที่เริ่มต้นโดยเป็นส่วนหนึ่งของคำขอนี้

แสดงในคำตอบแรกเมื่อคำขอขอให้เริ่มธุรกรรมใหม่เท่านั้น

Timestamp

เวลาที่มีการคำนวณผลลัพธ์รวม ซึ่งเพิ่มขึ้นอย่างต่อเนื่อง ในกรณีนี้ AggregationResult ก่อนหน้าในสตรีมผลลัพธ์ในสตรีมผลลัพธ์จะไม่มีการเปลี่ยนแปลงระหว่าง read_time กับค่านี้

หากการค้นหาไม่แสดงผลลัพธ์ใดๆ ระบบจะส่งคำตอบที่มี read_time และไม่มี result และแสดงเวลาที่เรียกใช้การค้นหา

ExplainMetrics

ข้อความค้นหาอธิบายเมตริก ซึ่งจะปรากฏก็ต่อเมื่อระบุ RunAggregationQueryRequest.explain_options และจะส่งเพียงครั้งเดียวพร้อมกับคำตอบสุดท้ายในสตรีม

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents หรือ projects/{project_id}/databases/{database_id}/documents/{document_path} เช่น projects/my-project/databases/my-database/documents หรือ projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

ไม่บังคับ อธิบายตัวเลือกต่างๆ สำหรับการค้นหา หากมีการตั้งค่า ระบบจะแสดงผลสถิติคำค้นหาเพิ่มเติม หากไม่ตรง ระบบจะแสดงเฉพาะผลการค้นหา

StructuredQuery

การค้นหาแบบมีโครงสร้าง

bytes

เรียกใช้การค้นหาภายในธุรกรรมที่ใช้งานอยู่แล้ว

ค่าในที่นี้คือรหัสธุรกรรมที่คลุมเครือซึ่งจะใช้ในการค้นหา

TransactionOptions

เริ่มธุรกรรมใหม่และอ่านเอกสาร ค่าเริ่มต้นจะเป็นธุรกรรมแบบอ่านอย่างเดียว รหัสธุรกรรมใหม่จะแสดงผลเป็นการตอบกลับแรกในสตรีม

Timestamp

อ่านเอกสารตามที่อยู่ในเวลาที่กำหนด

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

bytes

ธุรกรรมที่เริ่มต้นโดยเป็นส่วนหนึ่งของคำขอนี้ ตั้งค่าได้ในการตอบกลับครั้งแรกเท่านั้น และจะตั้งค่าได้เฉพาะเมื่อตั้งค่า RunQueryRequest.new_transaction ในคำขอเท่านั้น หากตั้งค่าไว้ จะไม่มีการตั้งค่าช่องอื่นๆ ในการตอบกลับนี้

Document

ผลลัพธ์การค้นหา ไม่ได้ตั้งค่าไว้เมื่อรายงานความคืบหน้าบางส่วน

Timestamp

เวลาที่อ่านเอกสาร ซึ่งอาจเพิ่มขึ้นในทางเดียว ในกรณีนี้ เรารับประกันว่าเอกสารก่อนหน้าในสตรีมผลลัพธ์จะไม่มีการเปลี่ยนแปลงระหว่าง read_time กับเอกสารนี้

หากการค้นหาไม่แสดงผลลัพธ์ใดๆ ระบบจะส่งคำตอบที่มี read_time และไม่มี document และแสดงเวลาที่เรียกใช้การค้นหา

int32

จำนวนผลลัพธ์ที่ถูกข้ามเนื่องจากมีการชดเชยระหว่างคำตอบล่าสุดและคำตอบปัจจุบัน

ExplainMetrics

ข้อความค้นหาอธิบายเมตริก ซึ่งจะปรากฏก็ต่อเมื่อระบุ RunQueryRequest.explain_options และจะส่งเพียงครั้งเดียวพร้อมกับคำตอบสุดท้ายในสตรีม

bool

หากมีอยู่ Firestore ได้ดำเนินการตามคำขอเสร็จสมบูรณ์แล้วและจะไม่มีการส่งคืนเอกสารเพิ่มเติม

Aggregation

ไม่บังคับ ชุดของการรวมที่จะใช้กับผลลัพธ์ของ structured_query

ข้อกำหนด

• การรวมอย่างน้อย 1 รายการต่อการค้นหา 1 รายการ

StructuredQuery

การค้นหาแบบมีโครงสร้างที่ซ้อนกัน

string

ไม่บังคับ ชื่อของช่องที่ไม่บังคับสำหรับจัดเก็บผลลัพธ์ของการรวม

หากไม่มีการกำหนดไว้ Firestore จะเลือกชื่อเริ่มต้นตามรูปแบบ field_<incremental_id++> เช่น

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

กลายเป็น:

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

ข้อกำหนด

• ต้องไม่ซ้ำกันในชื่อแทนการรวมทั้งหมด
• สอดคล้องกับข้อจำกัดของ document field name

Count

ผู้รวบรวมข้อมูลการนับ

Sum

ผู้รวบรวมข้อมูลผลรวม

Avg

ผู้รวบรวมข้อมูลโดยเฉลี่ย

FieldReference

ฟิลด์ที่จะรวบรวมข้อมูล

Int64Value

ไม่บังคับ ข้อจำกัดที่ไม่บังคับสำหรับจำนวนเอกสารสูงสุดที่จะนับ

วิธีนี้ช่วยในการกำหนดขีดจำกัดสูงสุดของจำนวนเอกสารที่จะสแกน โดยการจำกัดเวลาในการตอบสนองและค่าใช้จ่าย

"ไม่ระบุ" จะตีความว่าไม่มีขอบเขต

ตัวอย่างระดับสูง:

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

ข้อกำหนด

• ต้องมากกว่า 0 เมื่ออยู่

FieldReference

ฟิลด์ที่จะรวบรวมข้อมูล

Projection

เซ็ตย่อยของช่องที่จะแสดงผล (ไม่บังคับ)

โดยจะทำหน้าที่เป็น DocumentMask ของเอกสารที่ส่งคืนจากการค้นหา เมื่อไม่ได้ตั้งค่า จะถือว่าผู้โทรต้องการแสดงผลลัพธ์ช่องทั้งหมด

CollectionSelector

คอลเล็กชันที่ต้องการค้นหา

Filter

ตัวกรองที่จะใช้

Order

ลำดับที่จะใช้กับผลการค้นหา

Firestore ช่วยให้ผู้โทรสั่งซื้อได้อย่างเต็มรูปแบบ สั่งซื้อบางส่วน หรือไม่สั่งซื้อเลย ในทุกกรณี Firestore รับประกันการสั่งซื้อที่เสถียรผ่านกฎต่อไปนี้

• ต้องระบุ order_by เพื่ออ้างอิงทุกช่องที่ใช้กับตัวกรองอสมการ
• ช่องทั้งหมดที่จำเป็นต้องอยู่ใน order_by แต่ยังไม่มีอยู่แล้วจะต่อท้ายด้วยการจัดลำดับพจนานุกรมของชื่อช่อง
• หากไม่ได้ระบุคำสั่งซื้อใน __name__ จะมีการต่อท้ายโดยค่าเริ่มต้น

ช่องจะต่อท้ายด้วยทิศทางการจัดเรียงเดียวกันกับลำดับสุดท้ายที่ระบุ หรือ "ASCENDING" หากไม่ได้ระบุคำสั่งซื้อไว้ เช่น

• ORDER BY a เปลี่ยนเป็น ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC เปลี่ยนเป็น ORDER BY a DESC, __name__ DESC
• WHERE a > 1 เปลี่ยนเป็น WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 เปลี่ยนเป็น WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

Cursor

คำนำหน้าที่เป็นไปได้ของตำแหน่งในชุดผลลัพธ์ที่จะเริ่มต้นการค้นหา

ลำดับของชุดผลลัพธ์จะเป็นไปตามเงื่อนไข ORDER BY ของการค้นหาเดิม

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

ผลการค้นหาเรียงลำดับตาม (b ASC, __name__ ASC)

เคอร์เซอร์อาจอ้างอิงการจัดลำดับแบบเต็มหรือคำนำหน้าตำแหน่งก็ได้ แต่จะอ้างอิงช่องมากกว่าที่มีอยู่ใน ORDER BY ที่ระบุไม่ได้

ต่อจากตัวอย่างด้านบน การแนบเคอร์เซอร์เริ่มต้นต่อไปนี้จะมีผลต่างกัน

• START BEFORE (2, /k/123): เริ่มการค้นหาก่อน a = 1 AND b > 2 AND __name__ > /k/123
• START AFTER (10): เริ่มการค้นหาต่อจาก a = 1 AND b > 10

เคอร์เซอร์เริ่มต้นจะทำให้การค้นหาเริ่มต้นในตำแหน่งที่เป็นตรรกะ ซึ่งต่างจาก OFFSET ที่ต้องสแกนผลการค้นหา N รายการแรกเพื่อข้าม ตำแหน่งนี้ไม่จำเป็นต้องตรงกับผลลัพธ์จริง แต่จะสแกนไปข้างหน้าจากตำแหน่งนี้เพื่อหาเอกสารถัดไป

ข้อกำหนด

• จำนวนค่าต้องไม่มากกว่าจำนวนช่องที่ระบุในวรรค ORDER BY

Cursor

คำนำหน้าที่เป็นไปได้ของตำแหน่งในชุดผลลัพธ์ซึ่งกำหนดให้สิ้นสุดคำค้นหา

ซึ่งคล้ายกับ START_AT แต่จะควบคุมตำแหน่งสิ้นสุดแทนตำแหน่งเริ่มต้น

ข้อกำหนด

• จำนวนค่าต้องไม่มากกว่าจำนวนช่องที่ระบุในวรรค ORDER BY

int32

จำนวนเอกสารที่จะข้ามก่อนที่จะแสดงผลลัพธ์แรก

ซึ่งจะมีผลหลังจากข้อจํากัดที่ระบุโดย WHERE, START AT และ END AT แต่อยู่ก่อนวรรค LIMIT

ข้อกำหนด

• ค่าต้องมากกว่าหรือเท่ากับ 0 หากระบุไว้

Int32Value

จำนวนผลลัพธ์สูงสุดที่จะแสดง

ใช้หลังจากข้อจำกัดอื่นๆ ทั้งหมด

ข้อกำหนด

• ค่าต้องมากกว่าหรือเท่ากับ 0 หากระบุไว้

FindNearest

ไม่บังคับ ค้นหาเพื่อนบ้านที่อาจจะอยู่ใกล้ที่สุด

ใช้หลังจากตัวกรองและลำดับอื่นๆ ทั้งหมด

ค้นหาเวกเตอร์ที่ใกล้เคียงที่สุดที่ฝังกับเวกเตอร์การค้นหาที่ระบุ

string

รหัสคอลเล็กชัน เมื่อตั้งค่าแล้ว ระบบจะเลือกเฉพาะคอลเล็กชันที่มีรหัสนี้

bool

เมื่อเป็นเท็จ เลือกเฉพาะคอลเล็กชันที่เป็นรายการย่อยของ parent ที่ระบุไว้ใน RunQueryRequest ที่มี เมื่อเป็น "จริง" เลือกคอลเล็กชันองค์ประกอบสืบทอดทั้งหมด

Operator

โอเปอเรเตอร์สำหรับการรวมตัวกรองหลายรายการ

Filter

รายการตัวกรองที่จะรวม

ข้อกำหนด

• ใช้ตัวกรองอยู่อย่างน้อย 1 รายการ

FieldReference

ช่องที่ใช้กรอง

Operator

โอเปอเรเตอร์ที่ใช้กรอง

Value

ค่าที่จะเปรียบเทียบ

string

การอ้างอิงช่องในเอกสาร

ข้อกำหนด

• ต้องเป็นสตริงที่คั่นด้วยจุด (.) ของกลุ่ม โดยที่แต่ละกลุ่มสอดคล้องกับข้อจำกัด document field name

CompositeFilter

ตัวกรองผสม

FieldFilter

ตัวกรองในช่องเอกสาร

UnaryFilter

ตัวกรองที่มีอาร์กิวเมนต์เพียง 1 รายการ

FieldReference

ต้องระบุ ฟิลด์เวกเตอร์ที่จัดทำดัชนีเพื่อใช้ค้นหา ส่งกลับเอกสารที่มีเวกเตอร์ที่มีมิติข้อมูลตรงกับ query_vector เท่านั้น

Value

ต้องระบุ เวกเตอร์ของคำค้นหาที่เรากำลังค้นหา ต้องเป็นเวกเตอร์ที่มีมิติข้อมูลไม่เกิน 2048 รายการ

DistanceMeasure

ต้องระบุ ต้องระบุมาตรวัดระยะทางที่จะใช้

Int32Value

ต้องระบุ จำนวนเพื่อนบ้านที่ใกล้ที่สุดที่จะส่งคืน ต้องเป็นจำนวนเต็มบวกที่ไม่เกิน 1000

FieldReference

ฟิลด์ที่จะเรียงลำดับ

Direction

ทิศทางในการเรียงลำดับ ค่าเริ่มต้นคือ ASCENDING

FieldReference

ช่องที่จะแสดง

หากเว้นว่างไว้ ระบบจะแสดงผลทุกช่อง หากต้องการแสดงเฉพาะชื่อเอกสาร ให้ใช้ ['__name__']

Operator

โอเปอเรเตอร์แบบเดี่ยวที่จะใช้

FieldReference

ฟิลด์ที่จะใช้โอเปอเรเตอร์

int32

รหัสเป้าหมายที่ระบุเป้าหมายในสตรีม ต้องเป็นจำนวนบวกและไม่ใช่ 0

หาก target_id เป็น 0 (หรือไม่ได้ระบุ) เซิร์ฟเวอร์จะกำหนดรหัสสำหรับเป้าหมายนี้และแสดงผลรหัสดังกล่าวในเหตุการณ์ TargetChange::ADD เมื่อเพิ่มเป้าหมายที่มี target_id=0 แล้ว เป้าหมายที่ตามมาทั้งหมดต้องมี target_id=0 ด้วย หากมีการส่งคำขอ AddTarget ที่มี target_id != 0 ไปยังเซิร์ฟเวอร์หลังจากเพิ่มเป้าหมายที่มี target_id=0 เซิร์ฟเวอร์จะส่งการตอบกลับพร้อมเหตุการณ์ TargetChange::Remove ทันที

โปรดทราบว่าหากไคลเอ็นต์ส่งคำขอ AddTarget หลายรายการโดยไม่มีรหัส ระบบจะไม่กำหนดลำดับของรหัสที่แสดงผลใน TargetChage.target_ids ดังนั้นไคลเอ็นต์ควรระบุรหัสเป้าหมายแทนการพึ่งพาเซิร์ฟเวอร์ในการกำหนดรหัส

หาก target_id ไม่ใช่ 0 ต้องไม่มีเป้าหมายที่ใช้งานอยู่ในสตรีมนี้ที่มีรหัสเดียวกัน

bool

ควรนำเป้าหมายออกเมื่อเป้าหมายเป็นปัจจุบันและสอดคล้องกันหรือไม่

Int32Value

จำนวนเอกสารที่ตรงกับคำค้นหาล่าสุดในโทเค็นประวัติงานหรือเวลาที่อ่าน

ค่านี้จะมีความเกี่ยวข้องเมื่อมีการระบุ resume_type เท่านั้น ค่านี้มีค่ามากกว่า 0 สัญญาณที่ไคลเอ็นต์ต้องการให้รวม ExistenceFilter.unchanged_names ไว้ในคำตอบ

QueryTarget

เป้าหมายที่ระบุโดยการค้นหา

DocumentsTarget

เป้าหมายที่ระบุโดยชุดชื่อเอกสาร

bytes

โทเค็นประวัติการทำงานจาก TargetChange ก่อนหน้าสำหรับเป้าหมายที่เหมือนกัน

การใช้โทเค็นประวัติการทำงานกับเป้าหมายอื่นจะไม่ได้รับการสนับสนุนและอาจล้มเหลว

Timestamp

เริ่มฟังหลังจาก read_time ที่เฉพาะเจาะจง

ในขณะนี้ลูกค้าต้องทราบสถานะของเอกสารที่ตรงกัน

string

ชื่อเอกสารที่จะเรียกดู ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents/{document_path} คำขอจะล้มเหลวหากเอกสารใดไม่ใช่ทรัพยากรย่อยของ database ที่ระบุ โดยจะไม่มีการลบชื่อที่ซ้ำกัน

string

ชื่อทรัพยากรระดับบนสุด ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents หรือ projects/{project_id}/databases/{database_id}/documents/{document_path} เช่น projects/my-project/databases/my-database/documents หรือ projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

การค้นหาแบบมีโครงสร้าง

TargetChangeType

ประเภทของการเปลี่ยนแปลงที่เกิดขึ้น

int32

รหัสเป้าหมายของเป้าหมายที่เปลี่ยนแปลง

หากว่างเปล่า การเปลี่ยนแปลงจะมีผลกับเป้าหมายทั้งหมด

ไม่ได้กำหนดลำดับของรหัสเป้าหมาย

Status

ข้อผิดพลาดที่ทำให้เกิดการเปลี่ยนแปลงนี้ (หากมี)

bytes

โทเค็นที่ใช้ในการทำให้สตรีมกลับมาทำงานอีกครั้งสำหรับ target_ids ที่ระบุ หรือเป้าหมายทั้งหมดได้หาก target_ids ว่างเปล่า

ไม่ได้กำหนดไว้สำหรับการเปลี่ยนแปลงเป้าหมายทุกครั้ง

Timestamp

read_time ที่สอดคล้องกันสำหรับ target_ids ที่ระบุ (ละเว้นเมื่อ target_id ไม่ได้อยู่ในสแนปชอตที่สอดคล้องกัน)

เรารับประกันว่าสตรีมจะส่ง read_time ที่มี target_ids ว่างเปล่าเมื่อใดก็ตามที่ทั้งสตรีมมีสแนปชอตใหม่ที่สอดคล้องกัน ข้อความ ADD, CURRENT และ RESET จะทำให้เกิดสแนปชอตใหม่ที่สอดคล้องกัน (แต่ข้อความ NO_CHANGE และ REMOVE จะไม่มี)

สำหรับสตรีมหนึ่งๆ รับประกันได้ว่า read_time จะเพิ่มขึ้นแบบโดดๆ

ReadOnly

ธุรกรรมนี้สามารถใช้สำหรับการดำเนินการอ่านเท่านั้น

ReadWrite

ธุรกรรมนี้สามารถนำไปใช้ทั้งการดำเนินการอ่านและเขียน

Timestamp

อ่านเอกสารในเวลาที่ระบุ

โดยต้องเป็นการประทับเวลาที่มีความแม่นยำระดับไมโครวินาทีในช่วง 1 ชั่วโมงที่ผ่านมา หรือหากมีการเปิดใช้การกู้คืนช่วงเวลา ก็อาจเป็นการประทับเวลาแบบเต็มนาทีภายใน 7 วันที่ผ่านมาได้

bytes

ธุรกรรมที่ไม่บังคับที่จะลองอีกครั้ง

Document

ต้องระบุ เอกสารที่อัปเดตแล้ว สร้างเอกสารหากยังไม่มี

DocumentMask

ช่องที่จะอัปเดต เส้นทางช่องในมาสก์ต้องไม่มีชื่อที่สงวนไว้

หากเอกสารอยู่บนเซิร์ฟเวอร์และมีฟิลด์ที่ไม่ได้อ้างอิงในมาสก์ จะไม่มีการเปลี่ยนแปลง ฟิลด์ที่อ้างอิงในมาสก์ แต่ไม่ปรากฏในเอกสารอินพุต จะถูกลบออกจากเอกสารบนเซิร์ฟเวอร์

DocumentMask

ช่องที่จะแสดง หากไม่ได้ตั้งค่า ระบบจะแสดงช่องทั้งหมด

หากเอกสารมีช่องที่ไม่อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในการตอบกลับ

Precondition

เงื่อนไขที่ต้องดำเนินการก่อนในเอกสาร (ไม่บังคับ) คำขอจะล้มเหลวหากตั้งค่าไว้แต่ไม่บรรลุผลโดยเอกสารเป้าหมาย

NullValue

ค่า Null

bool

ค่าบูลีน

int64

ค่าจำนวนเต็ม

double

ค่า Double

Timestamp

ค่าการประทับเวลา

เจาะจงเฉพาะไมโครวินาที เมื่อจัดเก็บ ระบบจะปัดเศษความแม่นยำเพิ่มเติมลง

string

ค่าสตริง

สตริงที่แสดงเป็น UTF-8 ต้องมีขนาดไม่เกิน 1 MiB - 89 ไบต์ เฉพาะการค้นหา 1,500 ไบต์แรกของการแสดง UTF-8 เท่านั้น

bytes

ค่าไบต์

ต้องไม่เกิน 1 MiB - 89 ไบต์ การค้นหาจะพิจารณาเฉพาะ 1,500 ไบต์แรกเท่านั้น

string

การอ้างอิงเอกสาร เช่น projects/{project_id}/databases/{database_id}/documents/{document_path}

LatLng

ค่าจุดทางภูมิศาสตร์ที่แสดงจุดบนพื้นผิวโลก

ArrayValue

ค่าอาร์เรย์

ต้องไม่มีค่าอาร์เรย์อื่นโดยตรง แต่สามารถมีแผนที่ที่มีอาร์เรย์อื่น

MapValue

ค่าแมป

DocumentMask

ช่องที่จะอัปเดตในการเขียนนี้

ตั้งค่าช่องนี้ได้เมื่อการดำเนินการupdateอยู่เท่านั้น หากไม่ได้ตั้งค่ามาสก์สำหรับ update และเอกสารมีอยู่แล้ว ระบบจะเขียนทับข้อมูลที่มีอยู่ หากกำหนดมาสก์ไว้และเอกสารในเซิร์ฟเวอร์มีช่องที่มาสก์ไม่ครอบคลุม ช่องดังกล่าวก็จะไม่เปลี่ยนแปลง ฟิลด์ที่อ้างอิงในมาสก์ แต่ไม่ปรากฏในเอกสารอินพุต จะถูกลบออกจากเอกสารบนเซิร์ฟเวอร์ เส้นทางช่องในมาสก์นี้ต้องไม่มีชื่อช่องที่สงวนไว้

FieldTransform

การแปลงที่จะดำเนินการหลังการอัปเดต

ตั้งค่าช่องนี้ได้เมื่อการดำเนินการupdateอยู่เท่านั้น หากมี การเขียนนี้จะเทียบเท่ากับการใช้ update และ transform กับเอกสารเดียวกันโดยเรียงตามลำดับและเรียงกันไป

Precondition

เงื่อนไขที่ต้องดำเนินการก่อนในเอกสาร (ไม่บังคับ)

การเขียนจะล้มเหลวหากตั้งค่าไว้แต่ไม่เป็นไปตามเอกสารเป้าหมาย

Document

เอกสารที่จะเขียน

string

ชื่อเอกสารที่จะลบ ในรูปแบบ: projects/{project_id}/databases/{database_id}/documents/{document_path}

DocumentTransform

ใช้การเปลี่ยนรูปแบบกับเอกสาร

string

ต้องระบุ ชื่อฐานข้อมูล ในรูปแบบ: projects/{project_id}/databases/{database_id} จำเป็นต้องระบุในข้อความแรกเท่านั้น

string

รหัสของสตรีมการเขียนที่จะดำเนินการต่อ ซึ่งอาจตั้งได้เฉพาะในข้อความแรก เมื่อเว้นว่างไว้ ระบบจะสร้างสตรีมการเขียนใหม่

Write

การเขียนที่จะใช้

ดำเนินการโดยอัตโนมัติเสมอและเรียงตามลำดับ ต้องเว้นว่างไว้ในคำขอแรก คำขอสุดท้ายอาจว่างเปล่า ต้องระบุข้อมูลนี้ในคำขออื่นๆ ทั้งหมด

bytes

โทเค็นสตรีมที่เซิร์ฟเวอร์ส่งก่อนหน้านี้

ไคลเอ็นต์ควรตั้งค่าช่องนี้เป็นโทเค็นจาก WriteResponse ล่าสุดที่ได้รับ ซึ่งเป็นการรับทราบว่าไคลเอ็นต์ได้รับการตอบกลับสำหรับโทเค็นนี้ หลังจากส่งโทเค็นนี้แล้ว คุณจะไม่สามารถใช้โทเค็นก่อนหน้านี้ได้อีกต่อไป

เซิร์ฟเวอร์อาจปิดสตรีมหากมีการตอบกลับที่ยังไม่ได้ตอบรับมากเกินไป

ไม่ต้องตั้งค่าช่องนี้เมื่อสร้างสตรีมใหม่ ตั้งค่าช่องนี้และช่อง stream_id เพื่อเริ่มสตรีมต่อ ณ เวลาที่ต้องการ

ไม่ต้องตั้งค่าช่องนี้เมื่อสร้างสตรีมใหม่

map<string, string>

ป้ายกำกับที่เชื่อมโยงกับคำขอเขียนนี้

string

รหัสของสตรีม กำหนดไว้ในข้อความแรกเท่านั้น เมื่อมีการสร้างสตรีมใหม่

bytes

โทเค็นที่แสดงตำแหน่งของคำตอบนี้ในสตรีม ในกรณีนี้ ลูกค้าสามารถสตรีมต่อได้

ตั้งค่าช่องนี้ไว้เสมอ

WriteResult

ผลลัพธ์ของการใช้การเขียน

ผลการเขียน i-th นี้สอดคล้องกับการเขียน i-th ในคำขอ

Timestamp

เวลาที่การคอมมิตเกิดขึ้น การอ่านที่มี read_time เท่ากันหรือมากกว่าได้เห็นผลของการเขียน

Timestamp

เวลาอัปเดตเอกสารครั้งล่าสุดหลังจากใช้การเขียน ไม่ได้ตั้งค่าหลังจาก delete

หากการเขียนไม่ได้เปลี่ยนแปลงเอกสารจริงๆ นี่จะเป็นupdate_time ก่อนหน้า

Value

ผลลัพธ์ของการใช้ DocumentTransform.FieldTransform แต่ละรายการในลำดับเดียวกัน