RequestOptions interface

Условия, связанные с запросом.

accessCondition?: { condition: string, type: string }

Значение свойства

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

consistencyLevel?: string

Значение свойства

Отключение автоматического создания идентификаторов (приведет к сбою, если идентификатор не задан в определении)

disableAutomaticIdGeneration?: boolean

Значение свойства

DisableRUPerMinuteUsage используется для включения и отключения единиц запросов (ЕЗ)/минуты для обслуживания запроса, если обычные подготовленные единицы запросов в секунду исчерпаны.

disableRUPerMinuteUsage?: boolean

Значение свойства

Включает или отключает ведение журнала в хранимых процедурах JavaScript.

enableScriptLogging?: boolean

Значение свойства

Задает директивы индексирования (индекс, не индексировать .. и т. д.).

indexingDirective?: string

Значение свойства

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

offerThroughput?: number

Значение свойства

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

Этот параметр действителен только при создании контейнера документов.

offerType?: string

Значение свойства

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

populateQuotaInfo?: boolean

Значение свойства

Указывает, что вызывается после операции после выполнения операции.

postTriggerInclude?: string | string[]

Значение свойства

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

preTriggerInclude?: string | string[]

Значение свойства

Время истечения срока действия (в секундах) для маркера ресурса, связанного с разрешением (применимо только для запросов на разрешения).

resourceTokenExpirySeconds?: number

Значение свойства

(Расширенный вариант использования) URL-адрес для подключения.

urlConnection?: string

Значение свойства

abortSignal для передачи всех базовых сетевых запросов, созданных этим вызовом метода. См. https://developer.mozilla.org/en-US/docs/Web/API/AbortController

пример

Отмена запроса на чтение

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

Значение свойства

наследуется отSharedOptions.abortSignal

Задает, если интегрированный кэш следует обойти или включить для запроса в службе Azure CosmosDB.

Значение по умолчанию — false. По умолчанию включен интегрированный кэш

bypassIntegratedCache?: boolean

Значение свойства

унаследовано отSharedOptions.bypassIntegratedCache

(Расширенный вариант использования) Начальные заголовки для начала при отправке запросов в Cosmos

initialHeaders?: CosmosHeaders

Значение свойства

наследуется отSharedOptions.initialHeaders

Задает значение устаревших значений, связанных с запросом в службе Azure CosmosDB. Для запросов, в которых <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> или <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, ответы из встроенного кэша гарантированно не будут устаревшими, чем значение, указанное этим maxIntegratedCacheStaleness. Если уровень согласованности не задан, это свойство игнорируется.

Значение по умолчанию равно NULL

Устаревший кэш поддерживается в миллисекундах детализации. Все меньше миллисекунда будет игнорироваться.

maxIntegratedCacheStalenessInMs?: number

Значение свойства

унаследовано отSharedOptions.maxIntegratedCacheStalenessInMs

Уровень приоритета (низкий или высокий) для каждого запроса. Запросы с низким приоритетом всегда регулируются перед любыми запросами с высоким приоритетом.

Значение по умолчанию равно NULL. По умолчанию все запросы имеют высокий приоритет

priorityLevel?: PriorityLevel

Значение свойства

унаследован отSharedOptions.priorityLevel

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

sessionToken?: string

Значение свойства

унаследовано отSharedOptions.sessionToken