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 )

Необязательный подмножество возвращаемых полей.

Это действует как DocumentMask для документов, возвращаемых по запросу. Если не установлено, предполагается, что вызывающая сторона хочет вернуть все поля.

object ( CollectionSelector )

Коллекции для запроса.

object ( Filter )

Фильтр, который нужно применить.

object ( Order )

Порядок применения к результатам запроса.

Firestore позволяет вызывающим абонентам обеспечить полный или частичный порядок или вообще не упорядочивать. Во всех случаях Firestore гарантирует стабильный заказ, соблюдая следующие правила:

• orderBy необходим для ссылки на все поля, используемые с фильтром неравенства.
• Все поля, которые должны присутствовать в orderBy , но еще не присутствуют, добавляются в лексикографическом порядке имени поля.
• Если заказ на __name__ не указан, он добавляется по умолчанию.

Поля добавляются в том же направлении сортировки, что и последний указанный порядок, или по возрастанию, если порядок не был указан. Например:

• ORDER BY a становится ORDER BY a ASC, __name__ ASC
• ORDER BY a DESC становится ORDER BY a DESC, __name__ DESC
• WHERE a > 1 становится WHERE a > 1 ORDER BY a ASC, __name__ ASC
• WHERE __name__ > ... AND a > 1 становится WHERE __name__ > ... AND a > 1 ORDER BY a ASC, __name__ ASC

object ( Cursor )

Потенциальный префикс позиции в наборе результатов, с которой начинается запрос.

Порядок набора результатов основан на предложении ORDER BY исходного запроса.

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

Результаты этого запроса упорядочены по (b ASC, __name__ ASC) .

Курсоры могут ссылаться либо на полный порядок, либо на префикс местоположения, однако они не могут ссылаться на большее количество полей, чем указано в предоставленном ORDER BY .

Продолжая приведенный выше пример, добавление следующих начальных курсоров будет иметь различный эффект:

• START BEFORE (2, /k/123) : начать запрос непосредственно перед a = 1 AND b > 2 AND __name__ > /k/123 .
• START AFTER (10) : начать запрос сразу после a = 1 AND b > 10 .

В отличие от OFFSET , который требует пропуска первых N результатов, начальный курсор позволяет начать запрос с логической позиции. Это положение не обязательно должно соответствовать фактическому результату, оно будет сканироваться вперед от этого положения, чтобы найти следующий документ.

Требует:

• Количество значений не может превышать количество полей, указанных в предложении ORDER BY .

object ( Cursor )

Потенциальный префикс позиции в наборе результатов, на которой завершается запрос.

Это похоже на START_AT , но контролирует конечную позицию, а не начальную.

Требует:

• Количество значений не может превышать количество полей, указанных в предложении ORDER BY .

integer

Количество документов, которые необходимо пропустить перед возвратом первого результата.

Это применяется после ограничений, указанных в WHERE , START AT и END AT , но до предложения LIMIT .

Требует:

• Значение должно быть больше или равно нулю, если оно указано.

integer

Максимальное количество возвращаемых результатов.

Применяется после всех остальных ограничений.

Требует:

• Значение должно быть больше или равно нулю, если оно указано.

object ( FindNearest )

Необязательный. Потенциальный поиск ближайших соседей.

Применяется после всех остальных фильтров и упорядочения.

Находит ближайшие векторные внедрения к заданному вектору запроса.