RequestOptions interface
Azure Cosmos DB 서버에 발급된 요청된 옵션에 대해 지정할 수 있습니다.=
- Extends
속성
| access |
요청과 관련된 조건입니다. |
| content |
false로 설정하면 서비스는 응답에 페이로드를 반환하지 않습니다. 네트워크를 통해 페이로드를 다시 보내지 않음으로써 네트워킹 및 CPU 부하를 줄입니다. 기본값은 true입니다. 참고: 현재 이 옵션은 대량 및 일괄 작업에만 지원됩니다. |
| disable |
자동 ID 생성을 사용하지 않도록 설정합니다(ID가 정의에 없으면 생성이 실패합니다.) |
| enable |
JavaScript 저장 프로시저에서 로깅을 사용하거나 사용하지 않도록 설정합니다. |
| indexing |
인덱싱 지시문(인덱스, 인덱스 안 함 등)을 지정합니다. |
| offer |
단위당 요청 수 측정에서 컨테이너에 대해 프로비전된 제품 처리량입니다. |
| offer |
문서 컨테이너를 만들 때의 제품 유형입니다. 이 옵션은 문서 컨테이너를 만들 때만 유효합니다. |
| populate |
문서 컨테이너 읽기 요청에 대한 문서 컨테이너 할당량 관련 통계를 가져오거나 사용하지 않도록 설정합니다. |
| post |
작업 후 호출할 post 트리거를 나타냅니다. |
| pre |
작업 전에 호출할 사전 트리거를 나타냅니다. |
| resource |
사용 권한과 연결된 리소스 토큰의 만료 시간(초)입니다(사용 권한에 대한 요청에만 적용됨). |
| url |
(고급 사용 사례) 연결할 URL입니다. |
상속된 속성
| abort |
abortSignal을 사용하여 이 메서드 호출에서 만든 모든 기본 네트워크 요청에 전달합니다. https://developer.mozilla.org/en-US/docs/Web/API/AbortController 참조 예제 읽기 요청 취소 |
| bypass |
Azure CosmosDB 서비스에서 요청에 대해 통합 캐시를 바이패스하거나 사용하도록 설정해야 하는지 여부를 설정합니다. 기본값은 false입니다. 기본적으로 통합 캐시는 사용하도록 설정됩니다. |
| consistency |
클라이언트에 필요한 일관성 수준입니다. |
| disable |
DisableRUPerMinuteUsage는 일반 프로비전된 RU/초가 소진된 경우 요청을 제공하기 위해 RU(요청 단위)/분 용량을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다. |
| excluded |
작업에 대해 하나 이상의 Azure 지역을 제외합니다. 이 옵션은 enableEndPointDiscovery가 true로 설정된 경우에만 적용됩니다. |
| 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%를 사용할 수 있습니다. 자세한 내용은 [Cosmos DB 처리량 버킷팅](https://aka.ms/cosmsodb-bucketing). |
속성 세부 정보
accessCondition
요청과 관련된 조건입니다.
accessCondition?: { condition: string, type: string }속성 값
{ condition: string, type: string }
contentResponseOnWriteEnabled
false로 설정하면 서비스는 응답에 페이로드를 반환하지 않습니다. 네트워크를 통해 페이로드를 다시 보내지 않음으로써 네트워킹 및 CPU 부하를 줄입니다. 기본값은 true입니다.
참고: 현재 이 옵션은 대량 및 일괄 작업에만 지원됩니다.
contentResponseOnWriteEnabled?: boolean속성 값
boolean
disableAutomaticIdGeneration
자동 ID 생성을 사용하지 않도록 설정합니다(ID가 정의에 없으면 생성이 실패합니다.)
disableAutomaticIdGeneration?: 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 참조
예제
읽기 요청 취소
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
disableRUPerMinuteUsage
DisableRUPerMinuteUsage는 일반 프로비전된 RU/초가 소진된 경우 요청을 제공하기 위해 RU(요청 단위)/분 용량을 사용하거나 사용하지 않도록 설정하는 데 사용됩니다.
disableRUPerMinuteUsage?: boolean속성 값
boolean
excludedLocations
작업에 대해 하나 이상의 Azure 지역을 제외합니다.
이 옵션은 enableEndPointDiscovery가 true로 설정된 경우에만 적용됩니다.
excludedLocations?: string[]속성 값
string[]
다음에서 상속됨SharedOptions.excludedLocations
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%를 사용할 수 있습니다.
자세한 내용은 [Cosmos DB 처리량 버킷팅](https://aka.ms/cosmsodb-bucketing).throughputBucket?: number속성 값
number
다음에서 상속됨SharedOptions.throughputBucket