Package google.firestore.v1

map<string, Value >

Результат функций агрегирования, например: COUNT(*) AS total_docs .

Ключом является alias , назначенный функции агрегации на входе, а размер этой карты равен количеству функций агрегации в запросе.

Value

Значения в массиве.

string

Необходимый. Имя базы данных. В формате: projects/{project_id}/databases/{database_id} .

string

Имена документов, которые необходимо получить. В формате: projects/{project_id}/databases/{database_id}/documents/{document_path} . Запрос не будет выполнен, если какой-либо документ не является дочерним ресурсом данной database . Повторяющиеся имена будут удалены.

DocumentMask

Поля для возврата. Если не установлено, возвращает все поля.

Если в документе есть поле, которого нет в этой маске, это поле не будет возвращено в ответе.

bytes

Считывает документы в транзакции.

TransactionOptions

Начинает новую транзакцию и читает документы. По умолчанию используется транзакция только для чтения. Новый идентификатор транзакции будет возвращен в качестве первого ответа в потоке.

Timestamp

Читает документы в том виде, в каком они были на данный момент.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

bytes

Транзакция, которая была запущена в рамках этого запроса. Будет установлено только в первом ответе и только в том случае, если в запросе был установлен BatchGetDocumentsRequest.new_transaction .

Timestamp

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

Document

Документ, который был запрошен.

string

Имя документа, которое было запрошено, но не существует. В формате: projects/{project_id}/databases/{database_id}/documents/{document_path} .

string

Необходимый. Имя базы данных. В формате: projects/{project_id}/databases/{database_id} .

Write

Пишет подать заявку.

Метод не применяет атомарную запись и не гарантирует упорядочивание. Каждая запись завершается успешно или неудачно независимо. Вы не можете писать в один и тот же документ более одного раза за запрос.

map<string, string>

Метки, связанные с этой пакетной записью.

WriteResult

Результат применения записи.

Этот i-й результат записи соответствует i-й записи в запросе.

Status

Статус применения пишет.

Этот i-й статус записи соответствует i-й записи в запросе.

string

Необходимый. Имя базы данных. В формате: projects/{project_id}/databases/{database_id} .

TransactionOptions

Варианты сделки. По умолчанию используется транзакция чтения-записи.

bytes

Транзакция, которая была начата.

bytes

Байты, которые кодируют последовательность битов. Может иметь нулевую длину.

int32

Число бит последнего байта в bitmap , которое игнорируется как «заполнение». Если длина bitmap равна нулю, то это значение должно быть 0 . В противном случае это значение должно находиться в диапазоне от 0 до 7 включительно.

BitSequence

Данные фильтра Блума.

int32

Количество хешей, используемых алгоритмом.

string

Необходимый. Имя базы данных. В формате: projects/{project_id}/databases/{database_id} .

Write

Пишет подать заявку.

Всегда выполняется атомарно и по порядку.

bytes

Если установлено, применяются все записи в этой транзакции и фиксируются.

WriteResult

Результат применения записи.

Этот i-й результат записи соответствует i-й записи в запросе.

Timestamp

Время, когда произошла фиксация. Любое чтение с равным или большим read_time гарантированно увидит эффект фиксации.

string

Необходимый. Родительский ресурс. Например: projects/{project_id}/databases/{database_id}/documents или projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}

string

Необходимый. Идентификатор коллекции относительно parent для вывода в список. Например: chatrooms .

string

Идентификатор документа, назначенный клиентом, который будет использоваться для этого документа.

Необязательный. Если не указано, идентификатор будет назначен службой.

Document

Необходимый. Документ, который нужно создать. name не должно быть установлено.

DocumentMask

Поля для возврата. Если не установлено, возвращает все поля.

Если в документе есть поле, которого нет в этой маске, это поле не будет возвращено в ответе.

Value

Значения, представляющие позицию, в том порядке, в котором они появляются в предложении запроса.

Может содержать меньше значений, чем указано в предложении order by.

bool

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

string

Необходимый. Имя ресурса документа, который необходимо удалить. В формате: projects/{project_id}/databases/{database_id}/documents/{document_path} .

Precondition

Необязательное предварительное условие в документе. Запрос завершится неудачей, если он установлен и не соответствует целевому документу.

string

Имя ресурса документа, например projects/{project_id}/databases/{database_id}/documents/{document_path} .

map<string, Value >

Timestamp

Только вывод. Время создания документа.

Это значение монотонно увеличивается, когда документ удаляется, а затем создается заново. Его также можно сравнить со значениями из других документов и read_time запроса.

Timestamp

Только вывод. Время последнего изменения документа.

Первоначально это значение установлено равным create_time а затем монотонно увеличивается с каждым изменением документа. Его также можно сравнить со значениями из других документов и read_time запроса.

Document

Новое состояние Document .

Если mask установлена, она содержит только те поля, которые были обновлены или добавлены.

int32

Набор целевых идентификаторов целей, соответствующих этому документу.

int32

Набор целевых идентификаторов для целей, которые больше не соответствуют этому документу.

string

Имя ресурса Document , который был удален.

int32

Набор целевых идентификаторов для целей, которые ранее соответствовали этому объекту.

Timestamp

Временная метка чтения, в которой было обнаружено удаление.

Больше или равно commit_time удаления.

string

Список путей к полям в маске. См. Document.fields для получения информации о синтаксисе пути к полю.

string

Имя ресурса Document , который исчез из поля зрения.

int32

Набор целевых идентификаторов для целей, которые ранее соответствовали этому документу.

Timestamp

Временная метка чтения, в которой наблюдалось удаление.

Больше или равно времени commit_time изменения/удаления/удаления.

string

Имя документа, который нужно преобразовать.

FieldTransform

Список преобразований, применяемых к полям документа, по порядку. Это не должно быть пусто.

string

Путь поля. См. Document.fields для получения информации о синтаксисе пути к полю.

ServerValue

Устанавливает в поле указанное значение сервера.

Value

Добавляет заданное значение к текущему значению поля.

Это должно быть целое число или двойное значение. Если поле не является целым или двойным числом или если поле еще не существует, преобразование установит для поля заданное значение. Если какое-либо из заданного значения или текущего значения поля имеет двойное значение, оба значения будут интерпретироваться как двойные. Двойная арифметика и представление двойных значений соответствуют семантике IEEE 754. Если происходит переполнение положительного/отрицательного целого числа, поле разрешается до положительного/отрицательного целого числа наибольшей величины.

Value

Устанавливает для поля максимальное значение из текущего значения и заданного значения.

Это должно быть целое число или двойное значение. Если поле не является целым или двойным числом или если поле еще не существует, преобразование установит для поля заданное значение. Если применяется операция максимума, когда поле и входное значение имеют смешанные типы (то есть одно целое число, а другое двойное), поле принимает тип большего операнда. Если операнды эквивалентны (например, 3 и 3.0), поле не изменяется. 0, 0,0 и -0,0 равны нулю. Максимум нулевого сохраненного значения и нулевого входного значения всегда является сохраненным значением. Максимум любого числового значения x и NaN равен NaN.

Value

Устанавливает для поля минимальное значение из его текущего значения и заданного значения.

Это должно быть целое число или двойное значение. Если поле не является целым или двойным числом или если поле еще не существует, преобразование установит для поля входное значение. Если применяется операция минимума, когда поле и входное значение имеют смешанные типы (то есть одно целое число, а другое двойное), поле принимает тип меньшего операнда. Если операнды эквивалентны (например, 3 и 3.0), поле не изменяется. 0, 0,0 и -0,0 равны нулю. Минимум нулевого сохраненного значения и нулевого входного значения всегда является сохраненным значением. Минимум любого числового значения x и NaN равен NaN.

ArrayValue

Добавьте данные элементы по порядку, если они еще не присутствуют в текущем значении поля. Если поле не является массивом или поле еще не существует, сначала ему присваивается пустой массив.

Эквивалентные числа разных типов (например, 3L и 3.0) считаются равными при проверке отсутствия значения. NaN равно NaN, а Null равно Null. Если входные данные содержат несколько эквивалентных значений, будет учитываться только первое.

Соответствующий Transform_result будет иметь нулевое значение.

ArrayValue

Удалить все заданные элементы из массива в поле. Если поле не является массивом или поле еще не существует, ему присваивается пустой массив.

Эквивалентные количества разных типов (например, 3L и 3.0) считаются равными при принятии решения о необходимости удаления элемента. NaN равно NaN, а Null равно Null. Это удалит все эквивалентные значения, если есть дубликаты.

Соответствующий Transform_result будет иметь нулевое значение.

int64

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

Duration

Общее время выполнения запроса в серверной части.

int64

Общее количество оплачиваемых операций чтения.

Struct

Отладка статистики выполнения запроса. Обратите внимание, что статистика отладки может меняться по мере развития Firestore. Оно может включать: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" } }

int32

Целевой идентификатор, к которому применяется этот фильтр.

int32

Общее количество документов, соответствующих target_id .

Если количество соответствующих документов в клиенте отличается от числа, клиент должен вручную определить, какие документы больше не соответствуют целевому значению.

Клиент может использовать фильтр Блума unchanged_names чтобы помочь в этом определении, проверяя ВСЕ имена документов на соответствие фильтру; если имя документа НЕ находится в фильтре, это означает, что документ больше не соответствует цели.

BloomFilter

Фильтр Блума, который, несмотря на свое название, содержит байтовые кодировки UTF-8 имен ресурсов ВСЕХ документов, соответствующих target_id , в форме projects/{project_id}/databases/{database_id}/documents/{document_path} .

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

PlanSummary

Информация о этапе планирования для запроса.

ExecutionStats

Агрегированная статистика выполнения запроса. Присутствует только в том случае, если ExplainOptions.analyze установлено значение true.

bool

Необязательный. Выполнять ли этот запрос.

Если установлено значение false (по умолчанию), запрос будет планироваться, возвращая только метрики с этапов планирования.

Если значение равно true, запрос будет запланирован и выполнен, возвращая полные результаты запроса вместе с метриками этапов планирования и выполнения.

string

Необходимый. Имя ресурса документа, который требуется получить. В формате: projects/{project_id}/databases/{database_id}/documents/{document_path} .

DocumentMask

Поля для возврата. Если не установлено, возвращает все поля.

Если в документе есть поле, которого нет в этой маске, это поле не будет возвращено в ответе.

bytes

Считывает документ в транзакции.

Timestamp

Считывает версию документа в данный момент.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

string

Необходимый. Родительский документ. В формате: projects/{project_id}/databases/{database_id}/documents/{document_path} . Например: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

int32

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

string

Токен страницы. Должно быть значение из ListCollectionIdsResponse .

Timestamp

Читает документы в том виде, в каком они были на данный момент.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

string

Идентификаторы коллекции.

string

Токен страницы, который можно использовать для продолжения списка.

string

Необходимый. Имя родительского ресурса. В формате: projects/{project_id}/databases/{database_id}/documents или projects/{project_id}/databases/{database_id}/documents/{document_path} .

Например: projects/my-project/databases/my-database/documents или projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

string

Необязательный. Идентификатор коллекции относительно parent для вывода в список.

Например: chatrooms или messages .

Это необязательно, и если оно не указано, Firestore будет отображать документы из всех коллекций, принадлежащих указанному parent .

int32

Необязательный. Максимальное количество документов, возвращаемых в одном ответе.

Firestore может возвращать меньшее значение, чем это значение.

string

Необязательный. Токен страницы, полученный из предыдущего ответа ListDocuments .

Предоставьте это, чтобы получить следующую страницу. При разбиении на страницы все остальные параметры (за исключением page_size ) должны соответствовать значениям, установленным в запросе, сгенерировавшем токен страницы.

string

Необязательный. Факультативный заказ документов для возврата.

Например: priority desc, __name__ desc .

Это отражает ORDER BY , используемый в запросах Firestore, но в строковом представлении. Если он отсутствует, документы упорядочиваются на основе __name__ ASC .

DocumentMask

Необязательный. Поля для возврата. Если не установлено, возвращает все поля.

Если в документе есть поле, которого нет в этой маске, это поле не будет возвращено в ответе.

bool

Если в списке должны быть указаны недостающие документы.

Документ отсутствует, если он не существует, но под ним находятся вложенные документы. Если это правда, такие отсутствующие документы будут возвращены с ключом, но не будут иметь установленных полей, create_time или update_time .

Запросы с show_missing могут не указывать where или order_by .

bytes

Выполните чтение как часть уже активной транзакции.

Timestamp

Выполняйте чтение в отведенное время.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

Document

Документы найдены.

string

Токен для получения следующей страницы документов.

Если это поле опущено, последующие страницы отсутствуют.

string

Необходимый. Имя базы данных. В формате: projects/{project_id}/databases/{database_id} .

map<string, string>

Ярлыки, связанные с этой целью, изменяются.

Target

Цель, которую нужно добавить в этот поток.

int32

Идентификатор цели, которую необходимо удалить из этого потока.

TargetChange

Цели изменились.

DocumentChange

Document изменился.

DocumentDelete

Document удален.

DocumentRemove

Document был удален из цели (поскольку он больше не имеет отношения к этой цели).

ExistenceFilter

Фильтр, применяемый к набору документов, ранее возвращенных для данного целевого объекта.

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

map<string, Value >

Поля карты.

Ключи карты представляют имена полей. Имена полей, соответствующие регулярному выражению __.*__ зарезервированы. Зарезервированные имена полей запрещены, за исключением определенных документированных контекстов. Ключи карты, представленные в формате UTF-8, не должны превышать 1500 байт и не могут быть пустыми.

string

Необходимый. Имя родительского ресурса. В формате: projects/{project_id}/databases/{database_id}/documents . Имена ресурсов документа не поддерживаются; можно указать только имена ресурсов базы данных.

int64

Желаемое максимальное количество точек разделения. Разделы могут возвращаться на нескольких страницах результатов. Число должно быть положительным. Фактическое количество возвращаемых разделов может быть меньше.

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

string

Значение next_page_token , возвращенное из предыдущего вызова PartitionQuery, которое можно использовать для получения дополнительного набора результатов. Нет никаких гарантий упорядочения между наборами результатов. Таким образом, использование нескольких наборов результатов потребует объединения различных наборов результатов.

Например, два последующих вызова с использованием page_token могут вернуть:

• курсор B, курсор M, курсор Q
• курсор A, курсор U, курсор W

Чтобы получить полный набор результатов, упорядоченный по результатам запроса, переданного в PartitionQuery, наборы результатов следует объединить: курсор A, курсор B, курсор M, курсор Q, курсор U, курсор W.

int32

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

Например, если partition_count = 10 и page_size = 8, первый вызов PartitionQuery вернет до 8 разделов и next_page_token , если существует больше результатов. Второй вызов PartitionQuery вернет до 2 разделов, чтобы завершить общее количество 10, указанных в partition_count .

StructuredQuery

Структурированный запрос. Запрос должен указывать коллекцию со всеми потомками и быть упорядочен по возрастанию имени. Другие фильтры, порядок, пределы, смещения и курсоры начала/конца не поддерживаются.

Timestamp

Читает документы в том виде, в каком они были на данный момент.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

Cursor

Результаты раздела. Каждый раздел представляет собой точку разделения, которую RunQuery может использовать в качестве начальной или конечной точки для результатов запроса. Запросы RunQuery должны выполняться с использованием того же запроса, который указан в этом запросе PartitionQuery. Курсоры разделов будут упорядочены в том же порядке, что и результаты запроса, переданного в PartitionQuery.

Например, если запрос PartitionQuery возвращает курсоры разделов A и B, выполнение следующих трех запросов вернет весь набор результатов исходного запроса:

• запрос, end_at A
• запрос, начало_в А, конец_в Б
• запрос, start_at B

Пустой результат может указывать на то, что запрос имеет слишком мало результатов для секционирования или что запрос еще не поддерживается для секционирования.

string

Токен страницы, который можно использовать для запроса дополнительного набора результатов, вплоть до числа, указанного в partition_count в запросе PartitionQuery. Если пусто, результатов больше нет.

Struct

Индексы, выбранные для запроса. Например: [ {"query_scope": "Коллекция", "properties": "(foo ASC, name ASC)"}, {"query_scope": "Collection", "properties": "(bar ASC, name ASC)" } ]

bool

Если установлено значение true , целевой документ должен существовать. Если установлено значение false , целевой документ не должен существовать.

Timestamp

Если этот параметр установлен, целевой документ должен существовать и быть последний раз обновлен на данный момент. Временная метка должна быть выровнена по микросекундам.

string

Необходимый. Имя базы данных. В формате: projects/{project_id}/databases/{database_id} .

bytes

Необходимый. Транзакция для отката.

string

Необходимый. Имя родительского ресурса. В формате: projects/{project_id}/databases/{database_id}/documents или projects/{project_id}/databases/{database_id}/documents/{document_path} . Например: projects/my-project/databases/my-database/documents или projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Необязательный. Объясните варианты запроса. Если установлено, будет возвращена дополнительная статистика запросов. В противном случае будут возвращены только результаты запроса.

StructuredAggregationQuery

Агрегирующий запрос.

bytes

Запустите агрегацию в рамках уже активной транзакции.

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

TransactionOptions

Запускает новую транзакцию как часть запроса, по умолчанию доступную только для чтения.

Новый идентификатор транзакции будет возвращен в качестве первого ответа в потоке.

Timestamp

Выполняет запрос в заданную временную метку.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

AggregationResult

Единый результат агрегирования.

Не отображается при сообщении о частичном прогрессе.

bytes

Транзакция, которая была запущена в рамках этого запроса.

Присутствует только в первом ответе, когда запрос запрашивает начало новой транзакции.

Timestamp

Время, за которое был вычислен совокупный результат. Оно всегда монотонно возрастает; в этом случае предыдущий AggregationResult в потоке результатов гарантированно не изменится между их read_time и этим.

Если запрос не возвращает результатов, будет отправлен ответ с read_time и отсутствием result , что представляет собой время выполнения запроса.

ExplainMetrics

Метрики объяснения запроса. Он присутствует только в том случае, если указан RunAggregationQueryRequest.explain_options , и отправляется только один раз вместе с последним ответом в потоке.

string

Необходимый. Имя родительского ресурса. В формате: projects/{project_id}/databases/{database_id}/documents или projects/{project_id}/databases/{database_id}/documents/{document_path} . Например: projects/my-project/databases/my-database/documents или projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

ExplainOptions

Необязательный. Объясните варианты запроса. Если установлено, будет возвращена дополнительная статистика запросов. В противном случае будут возвращены только результаты запроса.

StructuredQuery

Структурированный запрос.

bytes

Запустите запрос в рамках уже активной транзакции.

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

TransactionOptions

Начинает новую транзакцию и читает документы. По умолчанию используется транзакция только для чтения. Новый идентификатор транзакции будет возвращен в качестве первого ответа в потоке.

Timestamp

Читает документы в том виде, в каком они были на данный момент.

Это должна быть метка времени с точностью до микросекунды за последний час или, если включено восстановление на момент времени, дополнительно может быть метка времени с точностью до целой минуты за последние 7 дней.

bytes

Транзакция, которая была запущена в рамках этого запроса. Может быть задано только в первом ответе и только в том случае, если в запросе был установлен RunQueryRequest.new_transaction . Если установлено, в этом ответе не будут заданы никакие другие поля.

Document

Результат запроса, не заданный при сообщении о частичном ходе выполнения.

Timestamp

Время чтения документа. Это может быть монотонно возрастающим; в этом случае предыдущие документы в потоке результатов гарантированно не изменились между их read_time и этим.

Если запрос не возвращает результатов, будет отправлен ответ с read_time и document не будет, что представляет собой время выполнения запроса.

int32

Количество результатов, которые были пропущены из-за смещения между последним ответом и текущим ответом.

ExplainMetrics

Метрики объяснения запроса. Он присутствует только в том случае, если указан RunQueryRequest.explain_options , и отправляется только один раз вместе с последним ответом в потоке.

bool

Если он присутствует, Firestore полностью выполнил запрос и документы больше не возвращаются.

Aggregation

Необязательный. Серия агрегатов, применяемых к результатам structured_query .

Требует:

• Минимум одно и максимум пять агрегатов на запрос.

StructuredQuery

Вложенный структурированный запрос.

string

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

Если оно не указано, Firestore выберет имя по умолчанию в формате field_<incremental_id++> . Например:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2),
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*)
OVER (
  ...
);

становится:

AGGREGATE
  COUNT_UP_TO(1) AS count_up_to_1,
  COUNT_UP_TO(2) AS field_1,
  COUNT_UP_TO(3) AS count_up_to_3,
  COUNT(*) AS field_2
OVER (
  ...
);

Требует:

• Должен быть уникальным для всех псевдонимов агрегации.
• Соответствуйте ограничениям document field name .

Count

Счетный агрегатор.

Sum

Суммарный агрегатор.

Avg

Средний агрегатор.

FieldReference

Поле для агрегирования.

Int64Value

Необязательный. Необязательное ограничение на максимальное количество документов для подсчета.

Это дает возможность установить верхнюю границу количества сканируемых документов, ограничивая задержку и стоимость.

Unspecified интерпретируется как отсутствие ограничений.

Пример высокого уровня:

AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );

Требует:

• Должно быть больше нуля, если оно присутствует.

FieldReference

Поле для агрегирования.

Projection

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

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

CollectionSelector

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

Filter

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

Order

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

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

• order_by необходим для ссылки на все поля, используемые с фильтром неравенства.
• Все поля, которые должны быть в order_by , но еще не присутствуют, прилагаются при лексикографическом упорядочении имени поля.
• Если заказ на __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

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 .

Cursor

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

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

Требует:

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

int32

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

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

Требует:

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

Int32Value

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

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

Требует:

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

FindNearest

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

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

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

string

Идентификатор коллекции. Если установлено, выбираются только коллекции с этим идентификатором.

bool

Если установлено значение false, выбираются только коллекции, которые являются непосредственными дочерними элементами parent , указанного в содержащем RunQueryRequest . Если установлено значение true, выбираются все коллекции-потомки.

Operator

Оператор объединения нескольких фильтров.

Filter

Список фильтров для объединения.

Требует:

• Имеется хотя бы один фильтр.

FieldReference

Поле для фильтрации.

Operator

Оператор для фильтрации.

Value

Значение для сравнения.

string

Ссылка на поле в документе.

Требует:

• Должен быть дот-делимитированная ( . ) Строка сегментов, где каждый сегмент соответствует ограничениям document field name .

CompositeFilter

Составной фильтр.

FieldFilter

Фильтр по полю документа.

UnaryFilter

Фильтр, который принимает ровно один аргумент.

FieldReference

Необходимый. Индексированное векторное поле для поиска. Только документы, которые содержат векторы, размерность которых соответствует Query_Vector, могут быть возвращены.

Value

Необходимый. Вектор запроса, по которому мы ищем. Должен быть вектором не более 2048 измерений.

DistanceMeasure

Необходимый. Требуется мера расстояния.

Int32Value

Необходимый. Число ближайших соседей для возврата. Должно быть целым положительным числом не более 1000.

FieldReference

Поле для заказа.

Direction

Направление заказа. По умолчанию — ПО ASCENDING .

FieldReference

Поля для возврата.

Если пусто, возвращаются все поля. Чтобы вернуть только имя документа, используйте ['__name__'] .

Operator

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

FieldReference

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

int32

Целевой идентификатор, который идентифицирует цель на потоке. Должен быть положительное число и ненулевое.

Если target_id равен 0 (или неопределенным), сервер назначит идентификатор для этой цели и вернет его в событии TargetChange::ADD . После добавления цели с target_id=0 , все последующие цели также должны иметь target_id=0 . Если запрос AddTarget с target_id != 0 отправляется на сервер после того, как будет добавлен цель с target_id=0 , сервер немедленно отправит ответ с помощью события TargetChange::Remove .

Обратите внимание, что если клиент отправляет несколько запросов AddTarget без идентификатора, порядок идентификаторов, возвращаемый в TargetChage.target_ids , не определен. Поэтому клиенты должны предоставить целевой идентификатор, а не полагаться на сервер для назначения одного.

Если target_id не является нулевым, на этом потоке не должно быть существующей активной цели с тем же идентификатором.

bool

Если цель должна быть удалена после того, как она будет тока и последовательна.

Int32Value

Количество документов, которые в последний раз соответствовали запросу в токене резюме или времени чтения.

Это значение имеет отношение только к предоставлению resume_type . Это значение присутствует и больше нулевых сигналов, которые клиент хочет, чтобы ExistenceFilter.unchanged_names включалось в ответ.

QueryTarget

Цель, указанная в запросе.

DocumentsTarget

Цель, указанная набором имен документов.

bytes

Токен резюме от предыдущей TargetChange для идентичной цели.

Использование токена резюме с другой целью не поддерживается и может потерпеть неудачу.

Timestamp

Начните слушать после конкретного read_time .

Клиент должен знать состояние соответствующих документов в настоящее время.

string

Имена документов для извлечения. В формате: projects/{project_id}/databases/{database_id}/documents/{document_path} . Запрос потерпит неудачу, если какой -либо из документа не является дочерним ресурсом данной database . Дубликаты имена будутэлизованы.

string

Имя родительского ресурса. В формате: projects/{project_id}/databases/{database_id}/documents или projects/{project_id}/databases/{database_id}/documents/{document_path} . Например: projects/my-project/databases/my-database/documents или projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

StructuredQuery

Структурированный запрос.

TargetChangeType

Тип изменения, которые произошли.

int32

Целевые идентификаторы целей, которые изменились.

Если пустое, изменение относится ко всем целям.

Порядок целевых идентификаторов не определен.

Status

Ошибка, которая привела к этому изменению, если применимо.

bytes

Токен, который можно использовать для возобновления потока для данной target_ids , или всех целей, если target_ids пуст.

Не устанавливается на все изменения цели.

Timestamp

Последовательный read_time для данной target_ids (опущен, когда Target_IDS не находится в постоянном снимке).

Поток гарантированно отправит read_time с пустым target_ids всякий раз, когда весь поток достигает нового согласованного снимка. Добавить, текущие и сбросные сообщения гарантированно (в конечном итоге) приведут к новому согласованному моментальному снимку (в то время как no_change и удаление сообщений нет).

Для данного потока read_time гарантированно будет монотонно увеличивается.

ReadOnly

Транзакция может использоваться только для операций чтения.

ReadWrite

Транзакция может использоваться как для операций чтения, так и для записи.

Timestamp

Читает документы в данный момент.

Это должна быть микросекундная точная метка времени в течение последнего часа, или, если включено восстановление времени, может быть дополнительно быть целой минутной меткой времени в течение последних 7 дней.

bytes

Дополнительная транзакция для повторения.

Document

Необходимый. Обновленный документ. Создает документ, если его еще не существует.

DocumentMask

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

Если документ существует на сервере и имеет поля, не упомянутые в маске, они остаются без изменений. Поля, указанные в маске, но отсутствующие во входном документе, удаляются из документа на сервере.

DocumentMask

Поля для возврата. Если не установлено, возвращает все поля.

Если в документе есть поле, которого нет в этой маске, это поле не будет возвращено в ответ.

Precondition

Необязательное предварительное условие в документе. Запрос потерпит неудачу, если он будет установлен и не будет выполнен целевым документом.

NullValue

Нулевое значение.

bool

Логическое значение.

int64

Целочисленное значение.

double

Двойное значение.

Timestamp

Значение временной метки.

Точно только к микросекундам. При хранении любая дополнительная точность округлена.

string

Строковое значение.

Строка, представленная как UTF -8, не должна превышать 1 Mib - 89 байтов. Только первые 1500 байтов представления UTF-8 рассматриваются запросами.

bytes

Значение байтов.

Не должно превышать 1 миб - 89 байт. Только первые 1500 байтов рассматриваются по запросам.

string

Ссылка на документ. Например: projects/{project_id}/databases/{database_id}/documents/{document_path} .

LatLng

Значение точки гео, представляющее точку на поверхности Земли.

ArrayValue

Значение массива.

Не может напрямую содержать другое значение массива, хотя может содержать карту, которая содержит другой массив.

MapValue

Значение карты.

DocumentMask

Поля для обновления в этой записи.

Это поле можно установить только при операции update . Если маска для update не установлена ​​и документ существует, любые существующие данные будут перезаписаны. Если маска установлена ​​и в документе на сервере есть поля, не покрытые маской, они остаются без изменений. Поля, указанные в маске, но отсутствующие во входном документе, удаляются из документа на сервере. Пути к полям в этой маске не должны содержать зарезервированное имя поля.

FieldTransform

Преобразования, которые необходимо выполнить после обновления.

Это поле можно установить только при операции update . Если она присутствует, эта запись эквивалентна выполнению update и transform одного и того же документа атомарно и по порядку.

Precondition

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

Запись завершится неудачно, если это установлено и не соответствует целевому документу.

Document

Документ для написания.

string

Имя документа, который нужно удалить. В формате: projects/{project_id}/databases/{database_id}/documents/{document_path} .

DocumentTransform

Применяет преобразование к документу.

string

Необходимый. Имя базы данных. В формате: projects/{project_id}/databases/{database_id} . Это требуется только в первом сообщении.

string

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

Write

Пишет подать заявку.

Всегда выполняется атомно и в порядке. Это должно быть пусто по первым запросам. Это может быть пусто по последнему запросу. Это не должно быть пустым по всем другим запросам.

bytes

Токен потока, который ранее был отправлен сервером.

Клиент должен установить это поле в токен из последнего полученного WriteResponse . Это признает, что клиент получил ответы на этот токен. После отправки этого токена ранее токены больше не могут быть использованы.

Сервер может закрыть поток, если есть слишком много неподтвержденных ответов.

Оставьте это поле неоткрыто при создании нового потока. Чтобы возобновить поток в определенной точке, установите это поле и поле stream_id .

Оставьте это поле неоткрыто при создании нового потока.

map<string, string>

Метки, связанные с этим запросом на запись.

string

Идентификатор потока. Установите только первое сообщение, когда был создан новый поток.

bytes

Токен, который представляет позицию этого ответа в потоке. Это может использоваться клиентом для возобновления потока на этом этапе.

Это поле всегда установлено.

WriteResult

Результат применения записи.

Этот i-й результат записи соответствует i-й записи в запросе.

Timestamp

Время, в которое произошел коммит. Любое чтение с равным или большим read_time гарантированно увидит эффекты записи.

Timestamp

Последнее время обновления документа после применения записи. Не установлен после delete .

Если запись фактически не изменила документ, это будет предыдущее Update_time.

Value

Результаты применения каждого DocumentTransform.FieldTransform .