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, bir sorgudan döndürülen dokümanlar üzerinde bir DocumentMask işlevi görür. Ayarlanmazsa 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 sipariş veya kısmi sipariş vermelerine ya da hiç sipariş vermemelerine olanak tanır. Firestore her durumda, aşağıdaki kurallar aracılığıyla istikrarlı bir sıralamayı garanti eder:

• orderBy, 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 alanlara, alan adının sözlük sıralamasına göre eklenir.
• __name__ üzerinde bir sipariş belirtilmezse varsayılan olarak bu sipariş eklenir.

Alanlara, belirtilen son sırayla aynı sıralama yönü veya herhangi bir sıra belirtilmemişse "ASCENDING" ifadesi eklenir. Örnek:

• 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)

Sonuç kümesindeki sorgunun başlatılacağı konumun potansiyel ön eki.

Sonuç kümesinin sıralaması, orijinal sorgunun ORDER BY ifadesine göredir.

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ıralanıyor.

İmleçler tam sıralamaya veya konumun önekine referans verebilir. Ancak sağlanan ORDER BY alanında bulunandan daha fazla alana atıfta bulunamaz.

Yukarıdaki örnekten devam edeceğimiz için, aşağıdaki başlatma imleçlerini eklemenin çeşitli etkileri olacaktır:

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

Atlanması için ilk N sonucun taranmasını gerektiren OFFSET işlevinin aksine, başlatma imleci sorgunun mantıksal bir konumda başlamasını sağlar. Bu konumun gerçek bir sonuçla eşleşmesi gerekmez. Sonraki dokümanı bulmak için bu konumdan ileriye doğru tarama yapar.

Gerekenler:

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

object (Cursor)

Sonuç kümesinde sorgunun sona ereceği konumun potansiyel ön eki.

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

Gerekenler:

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

integer

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

Bu, WHERE, START AT ve END AT tarafından belirtilen kısıtlamalardan sonra, LIMIT ifadesinden önce geçerlidir.

Gerekenler:

• Değer belirtilirse 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 geçerlidir.

Gerekenler:

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

object (FindNearest)

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

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

Verilen sorgu vektörüne en yakın vektör yerleştirmeleri bulur.