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)

Sub-kumpulan opsional kolom yang akan ditampilkan.

Ini bertindak sebagai DocumentMask pada dokumen yang ditampilkan dari kueri. Jika tidak ditetapkan, mengasumsikan bahwa pemanggil ingin semua kolom ditampilkan.

object (CollectionSelector)

Koleksi yang akan dikueri.

object (Filter)

Filter yang akan diterapkan.

object (Order)

Urutan yang akan diterapkan ke hasil kueri.

Firestore memungkinkan pemanggil untuk memberikan pengurutan lengkap, pengurutan parsial, atau tanpa pengurutan sama sekali. Dalam semua kasus, Firestore menjamin pengurutan yang stabil melalui aturan berikut:

• orderBy diperlukan untuk mereferensikan semua kolom yang digunakan dengan filter ketidaksetaraan.
• Semua kolom yang harus ada di orderBy, tetapi belum ada, ditambahkan dalam urutan leksikografis nama kolom.
• Jika pesanan di __name__ tidak ditentukan, pesanan tersebut akan ditambahkan secara default.

Kolom ditambahkan dengan arah pengurutan yang sama seperti urutan terakhir yang ditentukan, atau 'ASCENDING' jika tidak ada urutan yang ditentukan. Contoh:

• ORDER BY a menjadi ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC menjadi ORDER BY a DESC, __name__ DESC
• WHERE a > 1 menjadi WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 menjadi WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

object (Cursor)

Awalan potensial dari suatu posisi dalam kumpulan hasil untuk memulai kueri.

Urutan kumpulan hasil didasarkan pada klausa ORDER BY dari kueri asli.

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

Hasil kueri ini diurutkan menurut (b ASC, __name__ ASC).

Kursor dapat merujuk ke pengurutan lengkap atau awalan lokasi, meskipun tidak dapat merujuk lebih banyak kolom daripada yang ada dalam ORDER BY yang diberikan.

Melanjutkan contoh di atas, melampirkan kursor awal berikut akan memiliki dampak yang berbeda-beda:

• START BEFORE (2, /k/123): mulai kueri tepat sebelum a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): memulai kueri tepat setelah a = 1 AND b > 10.

Tidak seperti OFFSET yang memerlukan pemindaian pada N hasil pertama untuk dilewati, kursor awal memungkinkan kueri untuk dimulai pada posisi logis. Posisi ini tidak diperlukan untuk mencocokkan hasil yang sebenarnya. Posisi ini akan memindai maju dari posisi ini untuk menemukan dokumen berikutnya.

Membutuhkan:

• Jumlah nilai tidak boleh lebih besar dari jumlah kolom yang ditentukan dalam klausa ORDER BY.

object (Cursor)

Awalan potensial dari suatu posisi dalam kumpulan hasil untuk mengakhiri kueri.

Ini mirip dengan START_AT tetapi berfungsi mengontrol posisi akhir, bukan posisi awal.

Membutuhkan:

• Jumlah nilai tidak boleh lebih besar dari jumlah kolom yang ditentukan dalam klausa ORDER BY.

integer

Jumlah dokumen yang akan dilewati sebelum menampilkan hasil pertama.

Ini berlaku setelah batasan yang ditentukan oleh WHERE, START AT, & END AT tetapi sebelum klausa LIMIT.

Membutuhkan:

• Nilai harus lebih besar dari atau sama dengan nol jika ditentukan.

integer

Jumlah hasil maksimum yang akan ditampilkan.

Berlaku setelah semua batasan lainnya.

Membutuhkan:

• Nilai harus lebih besar dari atau sama dengan nol jika ditentukan.

object (FindNearest)

Opsional. Potensi penelusuran tetangga terdekat.

Berlaku setelah semua filter dan pengurutan lainnya.

Menemukan embedding vektor terdekat dengan vektor kueri yang diberikan.