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

RequestOptions interface

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

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

Extends
SharedOptions

Свойства

accessCondition

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

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

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

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

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

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

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

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

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

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

Указывает, что вызывается после операции после выполнения операции.
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()
bypassIntegratedCache

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

Значение по умолчанию — false. По умолчанию включен интегрированный кэш
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

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

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

bypassIntegratedCache

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

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

bypassIntegratedCache?: boolean

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

boolean

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

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