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)

Subkumpulan kolom opsional yang akan ditampilkan.

Hal ini bertindak sebagai DocumentMask atas dokumen yang ditampilkan dari kueri. Jika tidak ditetapkan, asumsikan 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 menyediakan pemesanan lengkap, pemesanan parsial, atau tidak ada pemesanan 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 wajib ada di orderBy, tetapi belum ada, akan ditambahkan dalam urutan leksikografis nama kolom.
• Jika pesanan pada __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 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 berdasarkan (b ASC, __name__ ASC).

Kursor dapat merujuk ke urutan lengkap atau awalan lokasi, meskipun tidak dapat merujuk lebih banyak kolom daripada yang ada di ORDER BY yang disediakan.

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

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

Tidak seperti OFFSET yang mengharuskan pemindaian hasil N pertama untuk dilewati, kursor awal memungkinkan kueri dimulai pada posisi logis. Posisi ini tidak harus sesuai dengan hasil sebenarnya, karena akan memindai maju dari posisi ini untuk menemukan dokumen berikutnya.

Memerlukan:

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

object (Cursor)

Awalan potensial dari posisi dalam hasil yang ditetapkan untuk mengakhiri kueri.

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

Memerlukan:

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

integer

Jumlah dokumen yang harus dilewati sebelum menampilkan hasil pertama.

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

Memerlukan:

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

integer

Jumlah hasil maksimum yang akan ditampilkan.

Berlaku setelah semua batasan lainnya.

Memerlukan:

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

object (FindNearest)

Opsional. Penelusuran Tetangga Terdekat potensial.

Berlaku setelah semua filter dan pengurutan lainnya.

Menemukan embedding vektor terdekat ke vektor kueri yang ditentukan.