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)

Tập hợp con không bắt buộc gồm các trường cần trả về.

Tham số này hoạt động như một DocumentMask trên các tài liệu được trả về từ truy vấn. Khi bạn không đặt chính sách này, hãy giả định rằng phương thức gọi muốn trả về tất cả các trường.

object (CollectionSelector)

Các tập hợp cần truy vấn.

object (Filter)

Bộ lọc để áp dụng.

object (Order)

Thứ tự áp dụng cho các kết quả truy vấn.

Firestore cho phép người gọi đặt hàng đầy đủ, đặt hàng một phần hoặc không đặt hàng. Trong mọi trường hợp, Firestore đảm bảo thứ tự ổn định thông qua các quy tắc sau:

• orderBy là bắt buộc để tham chiếu tất cả các trường được dùng với bộ lọc bất đẳng thức.
• Tất cả các trường bắt buộc phải có trong orderBy nhưng chưa có thì sẽ được nối theo thứ tự từ điển của tên trường.
• Nếu bạn không chỉ định đơn đặt hàng trên __name__, đơn đặt hàng sẽ được thêm vào theo mặc định.

Các trường được nối với cùng hướng sắp xếp như thứ tự gần đây nhất được chỉ định hoặc "DỰA VÀO" nếu không có đơn đặt hàng nào được chỉ định. Ví dụ:

• ORDER BY a trở thành ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC trở thành ORDER BY a DESC, __name__ DESC
• WHERE a > 1 trở thành WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 trở thành WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

object (Cursor)

Tiền tố tiềm năng của vị trí trong tập hợp kết quả để bắt đầu truy vấn.

Thứ tự của nhóm kết quả dựa trên mệnh đề ORDER BY của truy vấn ban đầu.

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

Kết quả của truy vấn này được sắp xếp theo (b ASC, __name__ ASC).

Con trỏ có thể tham chiếu thứ tự đầy đủ hoặc tiền tố của vị trí, mặc dù con trỏ không thể tham chiếu nhiều trường hơn những trường có trong ORDER BY được cung cấp.

Tiếp tục ví dụ trên, việc đính kèm các con trỏ bắt đầu sau đây sẽ có tác động khác nhau:

• START BEFORE (2, /k/123): bắt đầu truy vấn ngay trước a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): bắt đầu truy vấn ngay sau a = 1 AND b > 10.

Không giống như OFFSET yêu cầu quét qua N kết quả đầu tiên để bỏ qua, con trỏ bắt đầu cho phép truy vấn bắt đầu tại vị trí logic. Vị trí này không bắt buộc phải khớp với kết quả thực tế, nó sẽ quét phía trước từ vị trí này để tìm tài liệu tiếp theo.

Yêu cầu:

• Số lượng giá trị không được lớn hơn số lượng trường được chỉ định trong mệnh đề ORDER BY.

object (Cursor)

Tiền tố tiềm năng của vị trí trong kết quả được đặt để kết thúc truy vấn tại.

Hàm này tương tự như START_AT nhưng với việc kiểm soát vị trí kết thúc thay vì vị trí bắt đầu.

Yêu cầu:

• Số lượng giá trị không được lớn hơn số lượng trường được chỉ định trong mệnh đề ORDER BY.

integer

Số tài liệu cần bỏ qua trước khi trả về kết quả đầu tiên.

Điều này áp dụng sau các điều kiện ràng buộc do WHERE, START AT và END AT nhưng trước mệnh đề LIMIT.

Yêu cầu:

• Giá trị phải lớn hơn hoặc bằng 0 nếu được chỉ định.

integer

Số lượng kết quả tối đa cần trả về.

Áp dụng sau mọi quy tắc ràng buộc khác.

Yêu cầu:

• Giá trị phải lớn hơn hoặc bằng 0 nếu được chỉ định.

object (FindNearest)

Không bắt buộc. Một người hàng xóm gần nhất có thể đang tìm kiếm.

Áp dụng sau tất cả các bộ lọc và thứ tự khác.

Tìm các vectơ nhúng gần nhất với vectơ truy vấn đã cho.