SharedOptions interface
Параметры, которые можно указать для запрошенного сервера Azure Cosmos DB.=
Свойства
abort |
abortSignal для передачи всех базовых сетевых запросов, созданных этим вызовом метода. См. https://developer.mozilla.org/en-US/docs/Web/API/AbortController Пример Отмена запроса на чтение
|
bypass |
Задает, если интегрированный кэш следует обойти или включить для запроса в службе Azure CosmosDB. Значение по умолчанию — false. По умолчанию включен интегрированный кэш |
consistency |
Уровень согласованности, необходимый клиенту. |
disable |
DisableRUPerMinuteUsage используется для включения и отключения единиц запросов (ЕЗ)/минуты для обслуживания запроса, если обычные подготовленные единицы запросов в секунду исчерпаны. |
initial |
(Расширенный вариант использования) Начальные заголовки для начала при отправке запросов в Cosmos |
max |
Задает значение устаревших значений, связанных с запросом в службе Azure CosmosDB. Для запросов, в которых <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> или <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>, ответы из встроенного кэша гарантированно не будут устаревшими, чем значение, указанное этим maxIntegratedCacheStaleness. Если уровень согласованности не задан, это свойство игнорируется. Значение по умолчанию равно NULL Устаревший кэш поддерживается в миллисекундах детализации. Все меньше миллисекунда будет игнорироваться. |
priority |
Уровень приоритета (низкий или высокий) для каждого запроса. Запросы с низким приоритетом всегда регулируются перед любыми запросами с высоким приоритетом. Значение по умолчанию равно NULL. По умолчанию все запросы имеют высокий приоритет |
session |
Включает или отключает получение статистики квоты контейнера документов для запросов на чтение контейнера документов. |
throughput |
Корзина пропускной способности для запроса. Значение по умолчанию равно NULL. В этом случае запрос может использовать 100% пропускной способности секции. Дополнительные сведения см. в разделе [Bucketing Cosmos DB Throughput Bucketing](https://aka.ms/cosmsodb-bucketing). |
Сведения о свойстве
abortSignal
abortSignal для передачи всех базовых сетевых запросов, созданных этим вызовом метода. См. https://developer.mozilla.org/en-US/docs/Web/API/AbortController
Пример
Отмена запроса на чтение
import { CosmosClient } from "@azure/cosmos";
const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });
const { database } = await client.databases.createIfNotExists({ id: "Test Database" });
const { container } = await database.containers.createIfNotExists({ id: "Test Container" });
const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
abortSignal: controller.signal,
});
abortSignal?: AbortSignal
Значение свойства
AbortSignal
bypassIntegratedCache
Задает, если интегрированный кэш следует обойти или включить для запроса в службе Azure CosmosDB.
Значение по умолчанию — false. По умолчанию включен интегрированный кэш
bypassIntegratedCache?: boolean
Значение свойства
boolean
consistencyLevel
Уровень согласованности, необходимый клиенту.
consistencyLevel?: string
Значение свойства
string
disableRUPerMinuteUsage
DisableRUPerMinuteUsage используется для включения и отключения единиц запросов (ЕЗ)/минуты для обслуживания запроса, если обычные подготовленные единицы запросов в секунду исчерпаны.
disableRUPerMinuteUsage?: boolean
Значение свойства
boolean
initialHeaders
(Расширенный вариант использования) Начальные заголовки для начала при отправке запросов в Cosmos
initialHeaders?: CosmosHeaders
Значение свойства
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
priorityLevel
Уровень приоритета (низкий или высокий) для каждого запроса. Запросы с низким приоритетом всегда регулируются перед любыми запросами с высоким приоритетом.
Значение по умолчанию равно NULL. По умолчанию все запросы имеют высокий приоритет
priorityLevel?: PriorityLevel
Значение свойства
sessionToken
Включает или отключает получение статистики квоты контейнера документов для запросов на чтение контейнера документов.
sessionToken?: string
Значение свойства
string
throughputBucket
Корзина пропускной способности для запроса.
Значение по умолчанию равно NULL. В этом случае запрос может использовать 100% пропускной способности секции.
Дополнительные сведения см. в разделе [Bucketing Cosmos DB Throughput Bucketing](https://aka.ms/cosmsodb-bucketing).throughputBucket?: number
Значение свойства
number