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 element DocumentMask nad dokumentami zwróconymi w wyniku zapytania. Gdy zasada jest nieskonfigurowana, zakładamy, że 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ść, która ma być stosowana do wyników zapytania.

Firestore umożliwia wywołującym użytkownikom określenie pełnego sortowania, częściowego sortowania lub całkowity brak zamówień. We wszystkich przypadkach Firestore gwarantuje stabilną kolejność na podstawie tych reguł:

• Pole orderBy jest wymagane, aby odwoływać się do wszystkich pól używanych z filtrem nierówności.
• Wszystkie pola, które muszą znajdować się w elemencie orderBy, ale jeszcze go nie występują, są objęte leksykograficzną kolejnością nazw pól.
• Jeśli zamówienie z __name__ nie jest określone, jest dołączane domyślnie.

Pola są dodawane z tym samym kierunkiem sortowania co w przypadku ostatniej określonej kolejności lub „ASCENDING”, jeśli kolejność nie została określona. 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 ma się rozpoczynać zapytanie.

Kolejność w zbiorze wyników jest określana na podstawie klauzuli 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: (b ASC, __name__ ASC).

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

Wracając do powyższego przykładu, umieszczenie następujących kursorów początkowych będzie miało 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): rozpocznij zapytanie po a = 1 AND b > 10.

W przeciwieństwie do funkcji OFFSET, która wymaga skanowania pierwszych N wyników do pominięcia, kursor początkowy umożliwia rozpoczęcie zapytania w pozycji logicznej. To położenie nie musi odpowiadać rzeczywistemu wynikowi. Urządzenie przeskanuje od tej pozycji w celu znalezienia następnego dokumentu.

Wymagane:

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

object (Cursor)

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

Jest to podobne do funkcji START_AT, ale kontroluje pozycję końcową, a nie pozycję początkową.

Wymagane:

• Liczba wartości nie może być większa niż liczba pól określonych 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:

• Wartość musi być większa niż lub równa 0, jeśli została określona.

integer

Maksymalna liczba wyników do zwrócenia.

Ma zastosowanie po wszystkich innych ograniczeniach.

Wymagane:

• Wartość musi być większa niż lub równa 0, jeśli została określona.

object (FindNearest)

Opcjonalnie. Wyszukiwanie potencjalnych najbliższych sąsiadów.

Ma zastosowanie po wszystkich innych filtrach i kolejności.

Znajduje wektory dystrybucyjne najbliższe danemu wektorowi zapytania.