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)

Döndürülecek alanların isteğe bağlı alt kümesi.

Bu anahtar, sorgudan döndürülen belgeler üzerinde DocumentMask görevi görür. Ayarlanmadığında, arayanın tüm alanların döndürülmesini istediğini varsayar.

object (CollectionSelector)

Sorgulanacak koleksiyonlar.

object (Filter)

Uygulanacak filtre.

object (Order)

Sorgu sonuçlarına uygulanacak sıra.

Firestore, arayanların tam sıralama veya kısmi sıralama yapmalarına ya da hiç sipariş vermemelerine olanak tanır. Firestore her durumda aşağıdaki kurallarla tutarlı bir sıralamayı garanti eder:

• orderBy, bir eşitsizlik filtresiyle kullanılan tüm alanlara referans vermek için gereklidir.
• orderBy içinde olması gereken ancak halihazırda mevcut olmayan tüm alanlar, alan adının sözlükçe sıralamasına eklenir.
• __name__ üzerindeki bir sipariş belirtilmezse varsayılan olarak eklenir.

Alanlar, belirtilen son düzenle aynı sıralama yönüyle veya herhangi bir sıra belirtilmediyse "ASCENDING" (ASCENDING) ile eklenir. Örneğin:

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

object (Cursor)

Sorgunun başlatılacağı sonuç kümesindeki bir konumun olası ön eki.

Sonuç kümesinin sıralaması, orijinal sorgunun ORDER BY yan tümcesine bağlıdır.

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

Bu sorgunun sonuçları (b ASC, __name__ ASC) etiketine göre sıralanmıştır.

İmleçler konumun tam sırasına veya ön ekine başvurabilir ancak sağlanan ORDER BY alanında bulunandan daha fazla alana başvuramaz.

Yukarıdaki örnekten devam edersek, aşağıdaki başlangıç imleçlerini eklemenin çeşitli etkileri olacaktır:

• START BEFORE (2, /k/123): Sorguyu a = 1 AND b > 2 AND __name__ > /k/123 öncesinde başlatın.
• START AFTER (10): Sorguyu a = 1 AND b > 10 ifadesinden hemen sonra başlatın.

Atlamak için ilk N sonucun taranmasını gerektiren OFFSET'den farklı olarak, başlatma imleci, sorgunun mantıksal bir konumda başlamasını sağlar. Bu konum, gerçek bir sonuçla eşleşmesi gerekmez. Bir sonraki dokümanı bulmak için bu konumdan ileriye doğru tarar.

Gereken:

• Değer sayısı, ORDER BY yan tümcesinde belirtilen alan sayısından büyük olamaz.

object (Cursor)

Sonuç kümesindeki bir konumun, sorguyu sonlandıracak potansiyel ön eki.

Bu, START_AT özelliğine benzer ancak başlangıç konumunu değil bitiş konumunu kontrol eder.

Gereken:

• Değer sayısı, ORDER BY yan tümcesinde belirtilen alan sayısından büyük olamaz.

integer

İlk sonuç döndürülmeden önce atlanacak doküman sayısı.

Bu durum WHERE, START AT ve END AT tarafından belirtilen kısıtlamalardan sonra, ancak LIMIT yan tümcesinden önce geçerlidir.

Gereken:

• Değer belirtilmişse sıfırdan büyük veya sıfıra eşit olmalıdır.

integer

Döndürülecek maksimum sonuç sayısı.

Diğer tüm kısıtlamalardan sonra uygulanır.

Gereken:

• Değer belirtilmişse sıfırdan büyük veya sıfıra eşit olmalıdır.

object (FindNearest)

İsteğe bağlı. Olası En Yakın Komşular Araması.

Diğer tüm filtre ve sıralamalardan sonra uygulanır.

Verilen sorgu vektörüne en yakın vektör gömmelerini bulur.