RequestOptions interface

与请求关联的条件。

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

属性值

如果设置为 false，则服务不会在响应中返回有效负载。 它通过不通过网络发送回有效负载来减少网络和 CPU 负载。 默认值为 true。

注意：目前，此选项仅支持批量和批量作。

contentResponseOnWriteEnabled?: boolean

属性值

禁用自动 ID 生成（如果 ID 不在定义中会导致创建失败）

disableAutomaticIdGeneration?: boolean

属性值

启用或禁用 JavaScript 存储过程中的日志记录。

enableScriptLogging?: boolean

属性值

指定索引指令（索引、不为 .. 等编制索引）。

indexingDirective?: string

属性值

为容器预配的产品/服务吞吐量，用于度量每个单位的请求数。

offerThroughput?: number

属性值

创建文档容器时的产品/服务类型。

此选项仅在创建文档容器时有效。

offerType?: string

属性值

启用/禁用获取文档容器读取请求的文档容器配额相关统计信息。

populateQuotaInfo?: boolean

属性值

指示操作后要调用的 post 触发器是什么。

postTriggerInclude?: string | string[]

属性值

指示操作之前要调用的预触发器是什么。

preTriggerInclude?: string | string[]

属性值

与权限关联的资源令牌的到期时间（以秒为单位）（仅适用于权限请求）。

resourceTokenExpirySeconds?: number

属性值

（高级用例）要连接到的 URL。

urlConnection?: string

属性值

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

属性值

继承自 SharedOptions.abortSignal

设置是否应绕过或启用 Azure CosmosDB 服务中的请求的集成缓存。

默认值为 false。 默认情况下，已启用集成缓存

bypassIntegratedCache?: boolean

属性值

继承自 SharedOptions.bypassIntegratedCache

客户端所需的一致性级别。

consistencyLevel?: string

属性值

继承自SharedOptions.consistencyLevel

DisableRUPerMinuteUsage 用于启用/禁用请求单位（RU）/分钟容量，以便在常规预配 RU/秒耗尽时为请求提供服务。

disableRUPerMinuteUsage?: boolean

属性值

继承自SharedOptions.disableRUPerMinuteUsage

（高级用例）将请求发送到 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

吞吐量 请求 Bucket 的存储段。

默认值为 null。 在这种情况下，请求可以使用 100% 的分区吞吐量。

有关详细信息，请访问 [Cosmos DB 吞吐量分桶]（https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

属性值

继承自SharedOptions.throughputBucket