다음을 통해 공유

SharedOptions interface

패키지:
@azure/cosmos

Azure Cosmos DB 서버에 발급된 요청된 옵션에 대해 지정할 수 있습니다.=

속성

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,
});
bypassIntegratedCache

Azure CosmosDB 서비스에서 요청에 대해 통합 캐시를 바이패스하거나 사용하도록 설정해야 하는지 여부를 설정합니다.

기본값은 false입니다. 기본적으로 통합 캐시는 사용하도록 설정됩니다.
consistencyLevel

클라이언트에 필요한 일관성 수준입니다.
disableRUPerMinuteUsage

DisableRUPerMinuteUsage는 일반 프로비전된 RU/초가 소진된 경우 요청을 제공하기 위해 RU(요청 단위)/분 용량을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다.
excludedLocations

작업에 대해 하나 이상의 Azure 지역을 제외합니다.

이 옵션은 enableEndPointDiscovery가 true로 설정된 경우에만 적용됩니다.
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

문서 컨테이너 읽기 요청에 대한 문서 컨테이너 할당량 관련 통계를 가져오거나 사용하지 않도록 설정합니다.
throughputBucket

요청에 대한 처리량 버킷입니다.

기본값은 null입니다. 이 경우 요청은 파티션 처리량의 100%를 사용할 수 있습니다.

자세한 내용은 [Cosmos DB 처리량 버킷팅](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는 일반 프로비전된 RU/초가 소진된 경우 요청을 제공하기 위해 RU(요청 단위)/분 용량을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다.

disableRUPerMinuteUsage?: boolean

속성 값

boolean

excludedLocations

작업에 대해 하나 이상의 Azure 지역을 제외합니다.

이 옵션은 enableEndPointDiscovery가 true로 설정된 경우에만 적용됩니다.

excludedLocations?: string[]

속성 값

string[]

initialHeaders

(고급 사용 사례) Cosmos에 요청을 보낼 때 시작할 초기 헤더

initialHeaders?: CosmosHeaders

속성 값

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

속성 값

PriorityLevel

sessionToken

문서 컨테이너 읽기 요청에 대한 문서 컨테이너 할당량 관련 통계를 가져오거나 사용하지 않도록 설정합니다.

sessionToken?: string

속성 값

string

throughputBucket

요청에 대한 처리량 버킷입니다.

기본값은 null입니다. 이 경우 요청은 파티션 처리량의 100%를 사용할 수 있습니다.

자세한 내용은 [Cosmos DB 처리량 버킷팅](https://aka.ms/cosmsodb-bucketing). 
throughputBucket?: number

속성 값

number