Поделиться через

RequestOptions interface

  • Ссылка
Пакет:
@azure/cosmos

Параметры, которые можно указать для запрошенного сервера Azure Cosmos DB.=

Extends
SharedOptions

Свойства

accessCondition

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Унаследованные свойства

abortSignal

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()
initialHeaders

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

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

Значение по умолчанию — NULL.

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

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

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

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

Сведения о свойстве

accessCondition

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

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

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

{ condition: string, type: string }

consistencyLevel

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

consistencyLevel?: string

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

string

disableAutomaticIdGeneration

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

disableAutomaticIdGeneration?: boolean

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

boolean

disableRUPerMinuteUsage

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

disableRUPerMinuteUsage?: boolean

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

boolean

enableScriptLogging

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

enableScriptLogging?: boolean

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

boolean

indexingDirective

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

indexingDirective?: string

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

string

offerThroughput

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

offerThroughput?: number

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

number

offerType

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

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

offerType?: string

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

string

populateQuotaInfo

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

populateQuotaInfo?: boolean

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

boolean

postTriggerInclude

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

postTriggerInclude?: string | string[]

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

string | string[]

preTriggerInclude

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

preTriggerInclude?: string | string[]

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

string | string[]

resourceTokenExpirySeconds

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

resourceTokenExpirySeconds?: number

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

number

urlConnection

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

urlConnection?: string

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

string

Сведения об унаследованном свойстве

abortSignal

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

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

AbortSignal

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

initialHeaders

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

initialHeaders?: CosmosHeaders

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

CosmosHeaders

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

maxIntegratedCacheStalenessInMs

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

Значение по умолчанию — NULL.

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

maxIntegratedCacheStalenessInMs?: number

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

number

Наследуется отSharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

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

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

priorityLevel?: PriorityLevel

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

PriorityLevel

Наследуется отSharedOptions.priorityLevel

sessionToken

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

sessionToken?: string

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

string

Наследуется отSharedOptions.sessionToken