Container class

패키지:

@azure/cosmos

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

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

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

속성

conflicts	지정된 컨테이너에 대한 충돌을 읽고 쿼리하기 위한 작업입니다. 특정 충돌을 읽거나 삭제하려면 를 사용합니다 .conflict(id).
database
id
items	새 항목을 만들고 모든 항목을 읽기/쿼리하기 위한 작업 기존 항목을 읽거나 바꾸거나 삭제하려면 를 사용합니다 .item(id). 예제 새 항목 만들기 const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	저장 프로시저, 트리거 및 사용자 정의 함수에 대한 모든 작업
url	리소스에 대한 참조 URL을 반환합니다. 사용 권한의 연결에 사용됩니다.

메서드

conflict(string, PartitionKey)	ID별 특정 기존 충돌을 읽거나 바꾸거나 삭제하는 데 사용됩니다. 새 충돌을 만들거나 모든 충돌을 쿼리/읽는 데 사용합니다 .conflicts .
delete(RequestOptions)	컨테이너 삭제
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	제공된 파티션 키 값에 대한 컨테이너에 속하는 모든 문서 삭제
getFeedRanges()
getPartitionKeyDefinition()	컬렉션을 읽어 캐시를 조사하여 파티션 키 정의를 먼저 가져옵니다.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	ID별로 특정 기존 항목을 읽거나 바꾸거나 삭제하는 데 사용됩니다. 새 항목을 만들거나 모든 항목을 쿼리/읽는 데 사용합니다 .items . 예제 항목 바꾸기 const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	컨테이너의 정의 읽기
readOffer(RequestOptions)	컨테이너에서 제안을 가져옵니다. 없는 경우 정의되지 않은 OfferResponse를 반환합니다.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	컨테이너의 정의 바꾸기

속성 세부 정보

conflicts

지정된 컨테이너에 대한 충돌을 읽고 쿼리하기 위한 작업입니다.

특정 충돌을 읽거나 삭제하려면 를 사용합니다 .conflict(id).

Conflicts conflicts

속성 값

Conflicts

database

database: Database

속성 값

Database

id

id: string

속성 값

string

items

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

기존 항목을 읽거나 바꾸거나 삭제하려면 를 사용합니다 .item(id).

예제

새 항목 만들기

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});

Items items

속성 값

Items

scripts

저장 프로시저, 트리거 및 사용자 정의 함수에 대한 모든 작업

Scripts scripts

속성 값

Scripts

url

리소스에 대한 참조 URL을 반환합니다. 사용 권한의 연결에 사용됩니다.

string url

속성 값

string

메서드 세부 정보

conflict(string, PartitionKey)

ID별 특정 기존 충돌을 읽거나 바꾸거나 삭제하는 데 사용됩니다.

새 충돌을 만들거나 모든 충돌을 쿼리/읽는 데 사용합니다 .conflicts .

function conflict(id: string, partitionKey?: PartitionKey): Conflict

매개 변수

id

string

충돌의 ID입니다.

partitionKey

PartitionKey

반환

Conflict

delete(RequestOptions)

컨테이너 삭제

function delete(options?: RequestOptions): Promise<ContainerResponse>

매개 변수

options

RequestOptions

반환

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

제공된 파티션 키 값에 대한 컨테이너에 속하는 모든 문서 삭제

function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>

매개 변수

partitionKey

PartitionKey

삭제할 항목의 파티션 키 값

options

RequestOptions

반환

Promise<ContainerResponse>

getFeedRanges()

function getFeedRanges(): Promise<readonly FeedRange[]>

반환

Promise<readonly FeedRange[]>

변경 피드를 가져올 수 있는 모든 피드 범위입니다.

getPartitionKeyDefinition()

경고

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

This method has been renamed to readPartitionKeyDefinition.

컬렉션을 읽어 캐시를 조사하여 파티션 키 정의를 먼저 가져옵니다.

function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>

반환

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>

매개 변수

query

string | SqlQuerySpec

반환

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

ID별로 특정 기존 항목을 읽거나 바꾸거나 삭제하는 데 사용됩니다.

새 항목을 만들거나 모든 항목을 쿼리/읽는 데 사용합니다 .items .

예제

항목 바꾸기 const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});

function item(id: string, partitionKeyValue?: PartitionKey): Item

매개 변수

id

string

항목의 ID 입니다.

partitionKeyValue

PartitionKey

항목 파티션 키의 값

반환

Item

read(RequestOptions)

컨테이너의 정의 읽기

function read(options?: RequestOptions): Promise<ContainerResponse>

매개 변수

options

RequestOptions

반환

Promise<ContainerResponse>

readOffer(RequestOptions)

컨테이너에서 제안을 가져옵니다. 없는 경우 정의되지 않은 OfferResponse를 반환합니다.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

매개 변수

options

RequestOptions

반환

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>

매개 변수

feedOptions

FeedOptions

반환

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

컨테이너의 정의 바꾸기

function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>

매개 변수

body

ContainerDefinition

options

RequestOptions

반환

Promise<ContainerResponse>