@azure/cosmos package

  • 참조

클래스

AbortError

이 오류는 비동기 작업이 중단된 경우 throw됩니다. 오류의 name 속성이 과 name 일치하는지 테스트하여 이 오류를 확인합니다 "AbortError".

예제

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}
ChangeFeedIterator

변경 피드에 대한 반복기를 제공합니다.

를 사용하여 Items.changeFeed() 반복기의 instance 가져옵니다.
ChangeFeedIteratorResponse

Azure Cosmos DB 변경 피드의 단일 응답 페이지
ChangeFeedResponse

Azure Cosmos DB 변경 피드의 단일 응답 페이지
ChangeFeedStartFrom

ChangeFeedIterator를 시작할 위치에 대한 기본 클래스입니다.
ClientSideMetrics
Conflict

ID별로 지정된 충돌을 읽거나 삭제하는 데 사용합니다.

모든 충돌을 쿼리하거나 읽으려면 충돌을 참조하세요.
ConflictResponse
Conflicts

를 사용하여 모든 충돌을 쿼리하거나 읽습니다.

ID별로 지정된 충돌을 읽거나 삭제하려면 충돌을 참조하세요.
Container

ID별로 특정 기존 컨테이너를 읽거나 바꾸거나 삭제하는 작업입니다.

새 컨테이너를 만들고 모든 컨테이너를 읽고 쿼리하려면 컨테이너를 참조하세요. 을 사용합니다 .containers.

참고: 이러한 모든 작업은 고정된 예산에 대해 호출합니다. 이러한 호출이 애플리케이션을 사용하여 하위 선형으로 확장되도록 시스템을 디자인해야 합니다. instance 경우 컨테이너가 있는지 확인하기 위해 모든 단일 item.read() 호출 전에 를 호출 container(id).read() 하지 마세요. 애플리케이션 시작 시 한 번 수행합니다.
ContainerResponse

컨테이너 작업에 대한 응답 개체
Containers

새 컨테이너를 만들고 모든 컨테이너를 읽고 쿼리하기 위한 작업

기존 컨테이너 를 읽거나 바꾸거나 삭제하려면 컨테이너를 참조하세요. 을 사용합니다 .container(id).

참고: 이러한 모든 작업은 고정된 예산에 대해 호출합니다. 이러한 호출이 애플리케이션을 사용하여 하위 선형으로 확장되도록 시스템을 디자인해야 합니다. instance 경우 컨테이너가 있는지 확인하기 위해 모든 단일 item.read() 호출 전에 를 호출 containers.readAll() 하지 마세요. 애플리케이션 시작 시 한 번 수행합니다.
CosmosClient

Azure Cosmos DB 데이터베이스 계정의 클라이언트 쪽 논리적 표현을 제공합니다. 이 클라이언트는 Azure Cosmos DB 데이터베이스 서비스에서 요청을 구성하고 실행하는 데 사용됩니다.

예제

클라이언트 인스턴스화 및 새 데이터베이스 만들기

const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}});
await client.databases.create({id: "<datbase name here>"});

예제

사용자 지정 연결 정책을 사용하여 클라이언트 인스턴스화

const connectionPolicy = new ConnectionPolicy();
connectionPolicy.RequestTimeout = 10000;
const client = new CosmosClient({
   endpoint: "<URL HERE>",
   auth: {masterKey: "<KEY HERE>"},
   connectionPolicy
});
CosmosDiagnostics
  • 클라이언트 작업 중에 수집된 진단 정보를 보유하는 Cosmos 진단 유형입니다. Ie. Item.read(), Container.create(). 3명의 멤버가 있습니다.
  1. clientSideRequestStatistics 멤버에는 - 를 비롯한 집계 진단 정보가 포함됩니다.
  • 메타데이터 조회. 여기서 최종 의도 리소스를 제외한 모든 서버 요청은 메타데이터 호출로 간주됩니다. 즉, item.read(id)의 경우 클라이언트가 엔드포인트를 검색하기 위해 서버를 호출하는 경우 메타데이터 호출로 간주됩니다.
  • retries
  • 연결한 엔드포인트
  • 요청, 응답 페이로드 통계.
  • gatewayStatistics - 기본 작업에 해당하는 정보입니다. 예를 들어 Item.read() 중에 클라이언트는 메타데이터 조회 등과 같은 많은 작업을 수행할 수 있지만 gatewayStatistics는 실제 읽기 작업에 대한 진단 정보를 나타냅니다.
  1. diagnosticNode - 자세한 진단 정보를 캡처하는 구조체와 같은 트리입니다. 기본적으로 사용하지 않도록 설정되며 비프로덕션 환경에서 디버깅에만 사용됩니다. diagnosticNode에 캡처된 세부 정보의 종류는 에 의해 CosmosDbDiagnosticLevel제어됩니다.
  • CosmosDbDiagnosticLevel.info - 기본값입니다. 이 수준에서는 clientSideRequestStatistics만 캡처됩니다. 는 프로덕션 환경을 위한 것입니다.
  • CosmosDbDiagnosticLevel.debug - diagnosticNode 및 clientConfig를 캡처합니다. 요청 및 응답 페이로드가 캡처되지 않습니다. 프로덕션 환경에서 사용할 수 없습니다.
  • CosmosDbDiagnosticLevel.debug-unsafe - CosmosDbDiagnosticLevel.debug에 캡처된 데이터 외에도 요청 및 응답 페이로드를 캡처합니다. 프로덕션 환경에서 사용할 수 없습니다.
  1. clientConfig - 초기화 중에 클라이언트가 구성된 방법과 관련된 정보를 캡처합니다.
Database

기존 데이터베이스를 읽거나 삭제하기 위한 작업입니다.

새 데이터베이스를 만들고 모든 데이터베이스를 읽고 쿼리하려면 데이터베이스를 참조하세요. 을 사용합니다 client.databases.

참고: 이러한 모든 작업은 고정된 예산에 대해 호출합니다. 이러한 호출이 애플리케이션을 사용하여 하위 선형으로 확장되도록 시스템을 디자인해야 합니다. instance 데이터베이스가 있는지 확인하기 위해 모든 단일 item.read() 호출 전에 를 호출 database.read() 하지 마세요. 애플리케이션 시작 시 한 번 수행합니다.
DatabaseAccount

Azure Cosmos DB 데이터베이스 서비스의 DatabaseAccount를 나타냅니다.
DatabaseResponse

데이터베이스 작업에 대한 응답 개체
Databases

새 데이터베이스를 만들고 모든 데이터베이스를 읽고 쿼리하기 위한 작업

기존 데이터베이스 를 읽거나 삭제하는 경우 데이터베이스를 참조하세요. 을 사용합니다 client.database(id).

참고: 이러한 모든 작업은 고정된 예산에 대해 호출합니다. 이러한 호출이 애플리케이션을 사용하여 하위 선형으로 확장되도록 시스템을 디자인해야 합니다. instance 데이터베이스가 있는지 확인하기 위해 모든 단일 item.read() 호출 전에 를 호출 databases.readAll() 하지 마세요. 애플리케이션 시작 시 한 번 수행합니다.
ErrorResponse
FeedRange

변경 피드의 피드 범위를 지정합니다.
FeedResponse
Item

특정 항목에 대한 작업을 수행하는 데 사용됩니다.

모든 항목 에 대한 작업에 대한 항목; 을 참조하세요 container.items.
ItemResponse
Items

새 항목을 만들고 모든 항목을 읽고 쿼리하기 위한 작업

기존 컨테이너를 읽거나 바꾸거나 삭제하려면 항목을 참조하세요. 을 사용합니다 .item(id).
Offer

를 사용하여 기존 제품을 ID로 읽거나 바꿀 수 있습니다.

모든 제품을 쿼리하거나 읽으려면 제품을 참조하세요.
OfferResponse
Offers

를 사용하여 모든 제품을 쿼리하거나 읽습니다.

기존 제품을 ID로 읽거나 바꾸려면 제안을 참조하세요.
PartitionKeyBuilder

PartitionKey를 빌드하기 위한 작성기 클래스입니다.
Permission

지정된 사용 권한을 ID별로 읽거나 바꾸거나 삭제하는 데 사용합니다.

모든 권한을 만들거나, 업서트하거나, 쿼리하거나, 읽을 수 있는 권한을 참조하세요.
PermissionResponse
Permissions

를 사용하여 모든 권한을 만들고, 바꾸고, 쿼리하고, 읽습니다.

ID별로 특정 사용 권한을 읽거나 바꾸거나 삭제할 수 있는 권한을 참조하세요.
QueryIterator

Azure Cosmos DB 데이터베이스 서비스에서 응답을 통과하고 반복할 수 있도록 하는 피드 또는 쿼리 응답의 구현인 QueryIterator 개체를 나타냅니다.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError

실패한 파이프라인 요청에 대한 사용자 지정 오류 유형입니다.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure

ID별로 특정 기존 저장 프로시저를 읽고, 바꾸거나, 삭제하거나, 실행하기 위한 작업입니다.

저장 프로시저를 만들거나, 모두 읽거나, 쿼리하는 작업의 경우
StoredProcedureResponse
StoredProcedures

모든 저장 프로시저를 만들거나, 삽입하거나, 읽기/쿼리하기 위한 작업입니다.

ID별로 특정 기존 저장 프로시저를 읽거나 바꾸거나 삭제하거나 실행하는 작업은 를 참조하세요 container.storedProcedure().
TimeoutError
Trigger

트리거를 읽거나 바꾸거나 삭제하는 작업입니다.

를 사용하여 container.triggers 모든 것을 만들거나, 업서트하거나, 쿼리하거나, 읽습니다.
TriggerResponse
Triggers

모든 트리거를 만들고, 업서트하고, 쿼리하고, 읽는 작업입니다.

트리거를 읽거나 바꾸거나 삭제하는 데 사용합니다container.triggers.
User

사용자를 읽고, 바꾸고, 삭제하는 데 사용됩니다.

또한 및 user.permissions를 통해 user.permission 지정된 사용자에 대한 권한에 액세스할 수 있습니다.

사용자를 참조하여 만들기, upsert, 쿼리 또는 모두 읽기를 참조하세요.
UserDefinedFunction

ID로 지정된 사용자 정의 함수를 읽거나 바꾸거나 삭제하는 데 사용됩니다.

UserDefinedFunction을 참조하여 모든 사용자 정의 함수를 만들고, 업서트하고, 쿼리하고, 읽습니다.
UserDefinedFunctionResponse
UserDefinedFunctions

모든 사용자 정의 함수를 만들거나, 업서트하거나, 쿼리하거나, 읽는 데 사용됩니다.

지정된 사용자 정의 함수를 ID별로 읽거나 바꾸거나 삭제하려면 UserDefinedFunction 을 참조하세요.
UserResponse
Users

모든 사용자를 만들고, 업서트하고, 쿼리하고, 읽는 데 사용됩니다.

ID별로 특정 사용자를 읽거나 바꾸거나 삭제하려면 사용자를 참조하세요.

인터페이스

@azure/cosmos.Index
Agent
BulkOptions

대량 실행을 수정하는 데 사용되는 Options 개체입니다. continueOnError(기본값: false) - 작업이 실패할 때 대량 실행을 계속합니다** 참고 4.0 릴리스에서 기본값은 TRUE입니다.
ChangeFeedIteratorOptions

변경 피드에 대한 옵션을 지정합니다.

이러한 옵션이 설정되지 않은 경우 전체 컨테이너에 대한 변경 내용을 지금부터 읽기 시작합니다.
ChangeFeedOptions

변경 피드에 대한 옵션을 지정합니다.

이러한 옵션 중 일부는 변경 피드에서 읽기를 시작할 위치와 시기를 제어합니다. 우선 순위는 다음과 같습니다.

  • continuation
  • startTime
  • startFromBeginning

이러한 옵션이 설정되지 않은 경우 첫 번째 ChangeFeedIterator.fetchNext() 호출에서 변경 내용을 읽기 시작합니다.
ChangeFeedPullModelIterator

를 사용하여 Items.getChangeFeedIterator() 파티션 키, 피드 범위 또는 전체 컨테이너에 대한 모든 변경 내용을 반복할 수 있는 반복기를 반환합니다.
ConflictDefinition
ConflictResolutionPolicy

다른 지역의 쓰기로 인해 Azure Cosmos DB 서비스의 컬렉션에 있는 문서에 충돌이 발생하는 경우 충돌을 resolve 방법을 지정하기 위한 충돌 해결 정책 구성을 나타냅니다.
ConnectionPolicy

Azure Cosmos DB 데이터베이스 서비스의 CosmosClient와 연결된 연결 정책을 나타냅니다.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode

진단 정보를 캡처하기 위한 구조체와 같은 트리를 나타냅니다.
ErrorBody
FailedRequestAttemptDiagnostic

이 형식은 서버 API에 대한 실패한 요청에 대한 진단 정보를 캡처합니다.
FeedOptions

피드 옵션 및 쿼리 메서드입니다.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition

Cosmos DB의 항목은 단순히 JSON 개체입니다. 대부분의 항목 작업을 사용하면 매우 간단한 ItemDefinition을 확장하는 고유한 형식을 제공할 수 있습니다.

예약된 키는 사용할 수 없습니다. 에서 예약된 키 목록을 볼 수 있습니다. <xref:ItemBody>
JSONArray
JSONObject
Location

사용 가능한 위치를 지정하는 데 사용되며 읽기는 인덱스 1이고 쓰기는 인덱스 0입니다.
MetadataLookUpDiagnostic

이 형식에는 서버에 대한 단일 메타데이터 요청에 대한 진단 정보가 포함되어 있습니다.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions

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

Azure Cosmos DB 데이터베이스 서비스에서 제한된 요청으로 할당된 재시도 정책을 나타냅니다.
SharedOptions

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

SqlQuerySpec에 지정된 매개 변수가 있는 SQL 쿼리의 매개 변수를 나타냅니다.
SqlQuerySpec

Azure Cosmos DB 서비스의 SQL 쿼리를 나타냅니다.

입력이 있는 쿼리는 SQL 삽입으로부터 보호하기 위해 매개 변수화되어야 합니다.

예제

매개 변수가 있는 SQL 쿼리

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};
StoredProcedureDefinition
TriggerDefinition
UniqueKey

UniqueKeyPolicy의 일부로 전달된 단일 고유 키에 대한 인터페이스
UniqueKeyPolicy

컨테이너 만들기에서 고유 키를 설정하기 위한 인터페이스
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

형식 별칭

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic

이 형식은 의 초기화와 관련된 정보를 보유합니다. CosmosClient
ClientSideRequestStatistics

모든 클라이언트 쪽 진단 정보에 대한 컬렉션 유형입니다.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics

이 형식에는 CosmosDB 클라이언트 작업 중 서버에 대한 모든 메타데이터 요청에 대한 진단 정보가 포함되어 있습니다.
NonePartitionKeyType

반환된 개체는 파티션 키 값 없이 항목을 만들고 액세스할 수 있는 파티션 키 값을 나타냅니다.
NullPartitionKeyType

반환된 개체는 파티션 키에 대해 null 값이 있는 항목을 만들고 액세스할 수 있는 파티션 키 값을 나타냅니다.
Operation
OperationInput
OperationWithItem
PartitionKey

컨테이너의 PartitionKey입니다.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue

기본 파티션 키 값입니다.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics

이 형식은 CosmosDB 클라이언트 작업 중 재시도 시도와 관련된 진단 정보를 캡처합니다.
TokenProvider
UpsertOperation

열거형

ConflictResolutionMode
ConnectionMode

CosmosClient의 연결 동작을 결정합니다. 현재 게이트웨이 모드만 지원합니다.
ConsistencyLevel

Azure Cosmos DB 클라이언트 작업에 지원되는 일관성 수준을 나타냅니다.
요청된 ConsistencyLevel은 데이터베이스 계정에 대해 프로비전된 것과 일치하거나 약해야 합니다. 일관성 수준.

강도 순서별 일관성 수준은 Strong, BoundedStaleness, Session, Consistent Prefix 및 Eventual입니다.

일관성 수준에 대한 자세한 설명서는 를 참조하세요 https://aka.ms/cosmos-consistency .
CosmosDbDiagnosticLevel

Cosmos DB 진단 수준
DataType

Azure Cosmos DB 서비스에서 인덱스 경로 사양의 대상 데이터 형식을 정의합니다.
GeospatialType
IndexKind

지원되는 인덱스 형식을 지정합니다.
IndexingMode

지원되는 인덱싱 모드를 지정합니다.
MetadataLookUpType

이는 가능한 메타데이터 조회 유형에 대한 열거형입니다.
PartitionKeyDefinitionVersion

PartitionKey 정의 버전
PartitionKeyKind

PartitionKey 유형(예: 해시, MultiHash)
PermissionMode

사용 권한 모드 값에 대한 열거형입니다.
PriorityLevel

각 Azure Cosmos DB 클라이언트 요청과 연결된 우선 순위 수준을 나타냅니다.
우선 순위가 낮은 요청은 항상 높은 우선 순위 요청 전에 제한됩니다.

기본적으로 모든 요청은 높은 우선 순위 요청으로 간주됩니다.

우선 순위 기반 제한에 대한 자세한 설명서는 를 참조하세요 https://aka.ms/CosmosDB/PriorityBasedExecution .
SpatialType
TriggerOperation

트리거 작업 값에 대한 열거형입니다. 는 트리거를 실행해야 하는 작업을 지정합니다.
TriggerType

트리거 형식 값에 대한 열거형입니다. 트리거의 유형을 지정합니다.
UserDefinedFunctionType

udf 형식 값의 열거형입니다. 사용자 정의 함수의 형식을 지정합니다.

함수

createAuthorizationSasToken(string, SasTokenProperties)

실험적 내부 전용 sas 토큰에 대한 권한 구성을 나타내는 페이로드를 생성합니다.

함수 세부 정보

createAuthorizationSasToken(string, SasTokenProperties)

실험적 내부 전용 sas 토큰에 대한 권한 구성을 나타내는 페이로드를 생성합니다.

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

매개 변수

masterKey

string

sasTokenProperties
SasTokenProperties

반환

Promise<string>