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)

Opcjonalny podzbiór pól do zwrócenia.

Działa jako DocumentMask nad dokumentami zwróconymi w wyniku zapytania. Jeśli zasada jest nieskonfigurowana, zakładamy, że element wywołujący chce zwrócić wszystkie pola.

object (CollectionSelector)

Kolekcje, których ma dotyczyć zapytanie.

object (Filter)

Filtr, który ma zostać zastosowany.

object (Order)

Kolejność zastosowania wyników zapytania.

Firestore umożliwia użytkownikom złożenie zamówienia w pełnej lub częściowej kolejności bądź w ogóle bez uporządkowania. We wszystkich przypadkach Firestore gwarantuje stabilne porządkowanie według tych reguł:

• orderBy jest wymagany, aby odwoływać się do wszystkich pól używanych z filtrem nierówności.
• Wszystkie pola, które muszą się znaleźć w polu orderBy, a które jeszcze nie istnieją, są dołączane w kolejności leksykograficznej nazw pól.
• Jeśli zamówienie w __name__ nie zostało określone, jest dołączane domyślnie.

Pola są dołączone z tym samym kierunkiem sortowania co w ostatnim podanym porządku lub „ASCENDING”, jeśli nie określono kolejności. Na przykład:

• ORDER BY a zmienia wartość na ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC zmienia wartość na ORDER BY a DESC, __name__ DESC
• WHERE a > 1 zmienia wartość na WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 zmienia wartość na WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

object (Cursor)

Potencjalny prefiks pozycji w zestawie wyników, od której rozpoczyna się zapytanie.

Kolejność w zestawie wyników jest zgodna z klauzulą ORDER BY w pierwotnym zapytaniu.

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

Wyniki tego zapytania są uporządkowane według kolumny (b ASC, __name__ ASC).

Kursory mogą odwoływać się do pełnej kolejności lub prefiksu lokalizacji, ale nie mogą odwoływać się do większej liczby pól niż jest w tym celu podany w polu ORDER BY.

Nawiązując do powyższego przykładu, zastosowanie tych kursorów startowych może mieć różny wpływ:

• START BEFORE (2, /k/123): rozpocznij zapytanie tuż przed a = 1 AND b > 2 AND __name__ > /k/123.
• START AFTER (10): rozpoczęcie zapytania zaraz po a = 1 AND b > 10.

W odróżnieniu od metody OFFSET, która wymaga skanowania pierwszych N wyników do pominięcia, kursor początkowy umożliwia rozpoczęcie zapytania w pozycji logicznej. Pozycja nie jest wymagana do dopasowania do rzeczywistego wyniku. Spowoduje to skanowanie od tego miejsca do przodu, aby znaleźć następny dokument.

Wymagane:

• Liczba wartości nie może być większa niż liczba pól określona w klauzuli ORDER BY.

object (Cursor)

Potencjalny prefiks pozycji w zestawie wyników, na której kończy się zapytanie.

Funkcja jest podobna do START_AT, ale kontroluje pozycję końcową, a nie początkową.

Wymagane:

• Liczba wartości nie może być większa niż liczba pól określona w klauzuli ORDER BY.

integer

Liczba dokumentów do pominięcia przed zwróceniem pierwszego wyniku.

Ma to zastosowanie po ograniczeniach określonych przez WHERE, START AT i END AT, ale przed klauzulą LIMIT.

Wymagane:

• Jeśli została określona, wartość nie może być mniejsza niż 0.

integer

Maksymalna liczba wyników do zwrócenia.

Ma zastosowanie po wszystkich innych ograniczeniach.

Wymagane:

• Jeśli została określona, wartość nie może być mniejsza niż 0.

object (FindNearest)

Opcjonalnie. Potencjalne wyszukiwanie w pobliżu sąsiadów.

Zostanie zastosowane po wszystkich innych filtrach i kolejności.

Znajduje wektory dystrybucyjne najbliżej danego wektora zapytania.