Container class

Paket:

@azure/cosmos

Kimliğe göre belirli bir kapsayıcıyı okuma, değiştirme veya silme işlemleri.

Bkz . Yeni kapsayıcılar oluşturmak ve tüm kapsayıcıları okumak/sorgulamak için kapsayıcılar; kullanın .containers.

Not: Tüm bu işlemler sabit bir bütçeye göre çağrı yapar. Sisteminizi, bu çağrıların uygulamanızla birlikte alt doğrusal olarak ölçeklendirilmesi için tasarlamanız gerekir. Örneğin, kapsayıcının var olduğundan emin olmak için her item.read() çağrıdan önce çağırmayıncontainer(id).read(); bunu uygulama başlatıldığında bir kez yapın.

Özellikler

conflicts	Verilen kapsayıcı için okuma ve sorgulama çakışmaları işlemleri. Belirli bir çakışmayı okumak veya silmek için kullanın .conflict(id).
database
id
items	Yeni öğe oluşturma ve tüm öğeleri okuma/sorgulama işlemleri Mevcut bir öğeyi okumak, değiştirmek veya silmek için kullanın .item(id). Örnek Yeni bir öğe oluşturun const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts	Saklı Yordamlar, Tetikleyiciler ve Kullanıcı Tanımlı İşlevler için tüm işlemler
url	Kaynağa bir başvuru URL'si döndürür. İzinler'de bağlantı için kullanılır.

Yöntemler

conflict(string, PartitionKey)	Kimliğe göre belirli bir çakışmayı okumak, değiştirmek veya silmek için kullanılır. Yeni çakışmalar oluşturmak veya tüm çakışmaları sorgulamak/okumak için kullanın .conflicts .
delete(RequestOptions)	Kapsayıcıyı silme
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)	Sağlanan bölüm anahtarı değeri için kapsayıcıya ait tüm belgeleri sil
getFeedRanges()
getPartitionKeyDefinition()	Önce önbelleğine bakarak bölüm anahtarı tanımını alır, aksi takdirde koleksiyonu okuyarak.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)	Kimliğe göre belirli bir öğeyi okumak, değiştirmek veya silmek için kullanılır. Yeni öğeler oluşturmak veya tüm öğeleri sorgulamak/okumak için kullanın .items . Örnek Öğeyi değiştirme const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)	Kapsayıcının tanımını okuma
readOffer(RequestOptions)	Kapsayıcıda teklif alır. Yoksa, undefined içeren bir OfferResponse döndürür.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)	Kapsayıcının tanımını değiştirme

Özellik Ayrıntıları

conflicts

Verilen kapsayıcı için okuma ve sorgulama çakışmaları işlemleri.

Belirli bir çakışmayı okumak veya silmek için kullanın .conflict(id).

Conflicts conflicts

Özellik Değeri

Conflicts

database

database: Database

Özellik Değeri

Database

id

id: string

Özellik Değeri

string

items

Yeni öğe oluşturma ve tüm öğeleri okuma/sorgulama işlemleri

Mevcut bir öğeyi okumak, değiştirmek veya silmek için kullanın .item(id).

Örnek

Yeni bir öğe oluşturun

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

Items items

Özellik Değeri

Items

scripts

Saklı Yordamlar, Tetikleyiciler ve Kullanıcı Tanımlı İşlevler için tüm işlemler

Scripts scripts

Özellik Değeri

Scripts

url

Kaynağa bir başvuru URL'si döndürür. İzinler'de bağlantı için kullanılır.

string url

Özellik Değeri

string

Yöntem Ayrıntıları

conflict(string, PartitionKey)

Kimliğe göre belirli bir çakışmayı okumak, değiştirmek veya silmek için kullanılır.

Yeni çakışmalar oluşturmak veya tüm çakışmaları sorgulamak/okumak için kullanın .conflicts .

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

Parametreler

id

string

Çakışma kimliği.

partitionKey

PartitionKey

Döndürülenler

Conflict

delete(RequestOptions)

Kapsayıcıyı silme

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

Parametreler

options

RequestOptions

Döndürülenler

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

Sağlanan bölüm anahtarı değeri için kapsayıcıya ait tüm belgeleri sil

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

Parametreler

partitionKey

PartitionKey

Silinecek öğelerin bölüm anahtarı değeri

options

RequestOptions

Döndürülenler

Promise<ContainerResponse>

getFeedRanges()

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

Döndürülenler

Promise<readonly FeedRange[]>

değişiklik akışının getirilebileceği tüm akış aralıkları.

getPartitionKeyDefinition()

Uyarı

Bu API artık kullanım dışıdır.

This method has been renamed to readPartitionKeyDefinition.

Önce önbelleğine bakarak bölüm anahtarı tanımını alır, aksi takdirde koleksiyonu okuyarak.

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

Döndürülenler

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec)

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

Parametreler

query

string | SqlQuerySpec

Döndürülenler

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

Kimliğe göre belirli bir öğeyi okumak, değiştirmek veya silmek için kullanılır.

Yeni öğeler oluşturmak veya tüm öğeleri sorgulamak/okumak için kullanın .items .

Örnek

Öğeyi değiştirme 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

Parametreler

id

string

Öğenin kimliği.

partitionKeyValue

PartitionKey

Öğe bölüm anahtarının değeri

Döndürülenler

Item

read(RequestOptions)

Kapsayıcının tanımını okuma

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

Parametreler

options

RequestOptions

Döndürülenler

Promise<ContainerResponse>

readOffer(RequestOptions)

Kapsayıcıda teklif alır. Yoksa, undefined içeren bir OfferResponse döndürür.

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

Parametreler

options

RequestOptions

Döndürülenler

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions)

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

Parametreler

feedOptions

FeedOptions

Döndürülenler

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

Kapsayıcının tanımını değiştirme

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

Parametreler

body

ContainerDefinition

options

RequestOptions

Döndürülenler

Promise<ContainerResponse>