다음을 통해 공유

FeedOptions interface

  • 참조
패키지:
@azure/cosmos

피드 옵션 및 쿼리 메서드입니다.

Extends
SharedOptions

속성

accessCondition

요청과 관련된 조건입니다.
allowUnboundedNonStreamingQueries

쿼리별 비 스트리밍 순서에만 유효합니다. 기본값: false; true로 설정하면 쿼리가 top 또는 limit 절 없이 비Streaming 쿼리를 차단하는 기본 동작을 무시할 수 있습니다.
bufferItems

쿼리 중에 추가 항목을 버퍼링할 수 있습니다. 기본값: false

그러면 백그라운드 서버에서 한 번에 추가 페이지(maxDegreeOfParallelism 곱하기)가 버퍼링됩니다. 이렇게 하면 클라이언트에서 필요하기 전에 페이지를 가져와 대기 시간을 향상시킵니다. .fetchAll같이 서버에서 모든 결과를 드레이닝하는 경우 일반적으로 이를 사용하도록 설정해야 합니다. 연속 토큰을 통해 한 번에 한 페이지만 가져오는 경우 이를 피해야 합니다. 전체 결과 집합이 아닌 둘 이상의 페이지를 드레이닝하는 경우 대기 시간을 개선하는 데 도움이 될 수 있지만 전체 쿼리를 제공하는 데 사용되는 총 RU/s 양이 증가합니다(일부 페이지는 두 번 이상 인출되므로).
continuation

열거를 계속하기 위한 불투명 토큰입니다. 기본값: 정의되지 않음
continuationToken

열거를 계속하기 위한 불투명 토큰입니다. 기본값: 정의되지 않음
continuationTokenLimitInKB

응답에서 연속 토큰의 크기를 제한합니다. 기본값: 정의되지 않음

연속 토큰에는 헤더에 쓰기 전에 serialization에서 제거할 수 있는 선택적 데이터가 포함되어 있습니다. 기본적으로 긴 헤더를 방지하기 위해 1kb로 제한합니다(Node.js 전역 헤더 크기 제한이 있음). 사용자는 이 필드를 설정하여 더 긴 헤더를 허용하여 백 엔드가 쿼리 실행을 최적화하는 데 도움이 될 수 있습니다."
disableNonStreamingOrderByQuery

지원되는 쿼리 기능에서 nonStreamingOrderBy 쿼리 기능을 사용하지 않도록 설정합니다. 기본값: false. 이 기능을 지원하지 않는 이전 게이트웨이의 오류를 방지하려면 true로 설정합니다.
enableScanInQuery

요청된 경로에서 인덱싱으로 사용할 수 없는 쿼리에 대한 검사 허용이 옵트아웃되었습니다. 기본값: false

일반적으로 이 설정을 사용하지 않는 것이 가장 좋습니다. 스캔은 상대적으로 비싸며 제공하는 데 시간이 오래 소요됩니다.
forceQueryPlan

이 설정은 쿼리 계획을 사용하도록 쿼리를 강제합니다. 기본값: false

참고: 단일 파티션 쿼리에 대해서도 연속 토큰 지원을 사용하지 않도록 설정합니다.

집계 및 대부분의 파티션 간 쿼리와 같은 쿼리의 경우 이 작업은 어쨌든 발생합니다. 그러나 라이브러리는 첫 번째 응답을 다시 가져올 때까지 쿼리 유형이 무엇인지 모르기 때문에 나중에 일부 최적화가 수행될 수 없습니다.

이 설정을 사용하도록 설정하면 쿼리에 대한 쿼리 계획이 강제로 적용되므로 일부 네트워크 요청이 저장되고 병렬 처리가 발생할 수 있습니다. 파티션 간 또는 집계 쿼리를 수행하는 경우 유용합니다.
maxDegreeOfParallelism

Azure Cosmos DB 데이터베이스 서비스에서 병렬 쿼리를 실행하는 동안 클라이언트 쪽을 실행하는 최대 동시 작업 수입니다. 음수 값을 사용하면 시스템이 실행할 동시 작업 수를 자동으로 결정합니다. 기본값: 0(병렬 처리 없음)
maxItemCount

열거형 작업에서 반환할 최대 항목 수입니다. 기본값: undefined(서버에서 페이로드를 정의합니다).

이 값을 사용하여 만료하면 일반적으로 쿼리의 성능이 가장 크게 변경될 수 있습니다.

항목 수가 작을수록 첫 번째 결과가 더 빨리 전달됩니다(비 집계의 경우). 더 많은 양의 경우 요청을 제공하는 데 시간이 더 오래 걸리지만 대용량 쿼리에 대한 처리량이 향상됩니다(즉, 다른 작업을 수행하려면 1000개 항목이 필요한 경우 maxItemCount 1000으로 설정합니다. 처음 100 이후에 작업을 시작할 수 있는 경우 maxItemCount 100으로 설정합니다.)
partitionKey

쿼리를 특정 파티션 키로 제한합니다. 기본값: 정의되지 않음

단일 파티션에 대한 쿼리 범위 지정은 다음 두 가지 방법으로 수행할 수 있습니다.

container.items.query('SELECT * from c', { partitionKey: "foo" }).toArray() container.items.query('SELECT * from c WHERE c.yourPartitionKey = "foo"').toArray()

전자는 쿼리 본문이 제어할 수 없지만 단일 파티션으로 제한하려는 경우에 유용합니다. 예: 최종 사용자가 지정한 쿼리입니다.
populateIndexMetrics

응답 헤더에서 인덱스 메트릭 반환을 사용하도록 설정합니다. 기본값: false
populateQueryMetrics

응답 헤더에서 쿼리 메트릭 반환을 사용하도록 설정합니다. 기본값: false

느리거나 비용이 많이 드는 쿼리를 디버깅하는 데 사용됩니다. 또한 응답 크기가 증가하고 Node.js낮은 최대 헤더 크기를 사용하는 경우 문제가 더 빠르게 발생할 수 있습니다.
useIncrementalFeed

참고: 대신 changeFeed를 사용하는 것이 좋습니다.

변경 피드 요청을 나타냅니다. "증분 피드"로 설정하거나 생략해야 합니다. 기본값: false
vectorSearchBufferSize

비StreamingOrderBy 쿼리에 대한 최종 결과를 저장하기 위한 사용자 지정 최대 버퍼 크기를 지정합니다. 쿼리에 top/offset+limit 절이 포함된 경우 이 값은 무시됩니다.

상속된 속성

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 }

allowUnboundedNonStreamingQueries

쿼리별 비 스트리밍 순서에만 유효합니다. 기본값: false; true로 설정하면 쿼리가 top 또는 limit 절 없이 비Streaming 쿼리를 차단하는 기본 동작을 무시할 수 있습니다.

allowUnboundedNonStreamingQueries?: boolean

속성 값

boolean

bufferItems

쿼리 중에 추가 항목을 버퍼링할 수 있습니다. 기본값: false

그러면 백그라운드 서버에서 한 번에 추가 페이지(maxDegreeOfParallelism 곱하기)가 버퍼링됩니다. 이렇게 하면 클라이언트에서 필요하기 전에 페이지를 가져와 대기 시간을 향상시킵니다. .fetchAll같이 서버에서 모든 결과를 드레이닝하는 경우 일반적으로 이를 사용하도록 설정해야 합니다. 연속 토큰을 통해 한 번에 한 페이지만 가져오는 경우 이를 피해야 합니다. 전체 결과 집합이 아닌 둘 이상의 페이지를 드레이닝하는 경우 대기 시간을 개선하는 데 도움이 될 수 있지만 전체 쿼리를 제공하는 데 사용되는 총 RU/s 양이 증가합니다(일부 페이지는 두 번 이상 인출되므로).

bufferItems?: boolean

속성 값

boolean

continuation

경고

이 API는 이제 사용되지 않습니다.

Use continuationToken instead.

열거를 계속하기 위한 불투명 토큰입니다. 기본값: 정의되지 않음

continuation?: string

속성 값

string

continuationToken

열거를 계속하기 위한 불투명 토큰입니다. 기본값: 정의되지 않음

continuationToken?: string

속성 값

string

continuationTokenLimitInKB

응답에서 연속 토큰의 크기를 제한합니다. 기본값: 정의되지 않음

연속 토큰에는 헤더에 쓰기 전에 serialization에서 제거할 수 있는 선택적 데이터가 포함되어 있습니다. 기본적으로 긴 헤더를 방지하기 위해 1kb로 제한합니다(Node.js 전역 헤더 크기 제한이 있음). 사용자는 이 필드를 설정하여 더 긴 헤더를 허용하여 백 엔드가 쿼리 실행을 최적화하는 데 도움이 될 수 있습니다."

continuationTokenLimitInKB?: number

속성 값

number

disableNonStreamingOrderByQuery

지원되는 쿼리 기능에서 nonStreamingOrderBy 쿼리 기능을 사용하지 않도록 설정합니다. 기본값: false. 이 기능을 지원하지 않는 이전 게이트웨이의 오류를 방지하려면 true로 설정합니다.

disableNonStreamingOrderByQuery?: boolean

속성 값

boolean

enableScanInQuery

요청된 경로에서 인덱싱으로 사용할 수 없는 쿼리에 대한 검사 허용이 옵트아웃되었습니다. 기본값: false

일반적으로 이 설정을 사용하지 않는 것이 가장 좋습니다. 스캔은 상대적으로 비싸며 제공하는 데 시간이 오래 소요됩니다.

enableScanInQuery?: boolean

속성 값

boolean

forceQueryPlan

이 설정은 쿼리 계획을 사용하도록 쿼리를 강제합니다. 기본값: false

참고: 단일 파티션 쿼리에 대해서도 연속 토큰 지원을 사용하지 않도록 설정합니다.

집계 및 대부분의 파티션 간 쿼리와 같은 쿼리의 경우 이 작업은 어쨌든 발생합니다. 그러나 라이브러리는 첫 번째 응답을 다시 가져올 때까지 쿼리 유형이 무엇인지 모르기 때문에 나중에 일부 최적화가 수행될 수 없습니다.

이 설정을 사용하도록 설정하면 쿼리에 대한 쿼리 계획이 강제로 적용되므로 일부 네트워크 요청이 저장되고 병렬 처리가 발생할 수 있습니다. 파티션 간 또는 집계 쿼리를 수행하는 경우 유용합니다.

forceQueryPlan?: boolean

속성 값

boolean

maxDegreeOfParallelism

Azure Cosmos DB 데이터베이스 서비스에서 병렬 쿼리를 실행하는 동안 클라이언트 쪽을 실행하는 최대 동시 작업 수입니다. 음수 값을 사용하면 시스템이 실행할 동시 작업 수를 자동으로 결정합니다. 기본값: 0(병렬 처리 없음)

maxDegreeOfParallelism?: number

속성 값

number

maxItemCount

열거형 작업에서 반환할 최대 항목 수입니다. 기본값: undefined(서버에서 페이로드를 정의합니다).

이 값을 사용하여 만료하면 일반적으로 쿼리의 성능이 가장 크게 변경될 수 있습니다.

항목 수가 작을수록 첫 번째 결과가 더 빨리 전달됩니다(비 집계의 경우). 더 많은 양의 경우 요청을 제공하는 데 시간이 더 오래 걸리지만 대용량 쿼리에 대한 처리량이 향상됩니다(즉, 다른 작업을 수행하려면 1000개 항목이 필요한 경우 maxItemCount 1000으로 설정합니다. 처음 100 이후에 작업을 시작할 수 있는 경우 maxItemCount 100으로 설정합니다.)

maxItemCount?: number

속성 값

number

partitionKey

쿼리를 특정 파티션 키로 제한합니다. 기본값: 정의되지 않음

단일 파티션에 대한 쿼리 범위 지정은 다음 두 가지 방법으로 수행할 수 있습니다.

container.items.query('SELECT * from c', { partitionKey: "foo" }).toArray() container.items.query('SELECT * from c WHERE c.yourPartitionKey = "foo"').toArray()

전자는 쿼리 본문이 제어할 수 없지만 단일 파티션으로 제한하려는 경우에 유용합니다. 예: 최종 사용자가 지정한 쿼리입니다.

partitionKey?: PartitionKey

속성 값

PartitionKey

populateIndexMetrics

응답 헤더에서 인덱스 메트릭 반환을 사용하도록 설정합니다. 기본값: false

populateIndexMetrics?: boolean

속성 값

boolean

populateQueryMetrics

응답 헤더에서 쿼리 메트릭 반환을 사용하도록 설정합니다. 기본값: false

느리거나 비용이 많이 드는 쿼리를 디버깅하는 데 사용됩니다. 또한 응답 크기가 증가하고 Node.js낮은 최대 헤더 크기를 사용하는 경우 문제가 더 빠르게 발생할 수 있습니다.

populateQueryMetrics?: boolean

속성 값

boolean

useIncrementalFeed

참고: 대신 changeFeed를 사용하는 것이 좋습니다.

변경 피드 요청을 나타냅니다. "증분 피드"로 설정하거나 생략해야 합니다. 기본값: false

useIncrementalFeed?: boolean

속성 값

boolean

vectorSearchBufferSize

비StreamingOrderBy 쿼리에 대한 최종 결과를 저장하기 위한 사용자 지정 최대 버퍼 크기를 지정합니다. 쿼리에 top/offset+limit 절이 포함된 경우 이 값은 무시됩니다.

vectorSearchBufferSize?: number

속성 값

number

상속된 속성 세부 정보

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 상속된