StructuredQuery

{
  "select": {
    object (Projection)
  },
  "from": [
    {
      object (CollectionSelector)
    }
  ],
  "where": {
    object (Filter)
  },
  "orderBy": [
    {
      object (Order)
    }
  ],
  "startAt": {
    object (Cursor)
  },
  "endAt": {
    object (Cursor)
  },
  "offset": integer,
  "limit": integer,
  "findNearest": {
    object (FindNearest)
  }
}

object (Projection)

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

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

object (CollectionSelector)

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

object (Filter)

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

object (Order)

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

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

• ต้องระบุ orderBy เพื่ออ้างอิงทุกช่องที่ใช้กับตัวกรองอสมการ
• ช่องทั้งหมดที่จำเป็นต้องอยู่ใน orderBy แต่ยังไม่มีอยู่แล้วจะต่อท้ายด้วยการจัดลำดับพจนานุกรมของชื่อช่อง
• หากไม่ได้ระบุคำสั่งซื้อใน __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

object (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

object (Cursor)

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

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

ข้อกำหนด

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

integer

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

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

ข้อกำหนด

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

integer

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

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

ข้อกำหนด

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

object (FindNearest)

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

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

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