次の方法で共有

Container class

  • リファレンス
パッケージ:
@azure/cosmos

ID による特定の既存のコンテナーの読み取り、置換、または削除を行う操作。

新しいコンテナーを作成し、すべてのコンテナーの読み取り/クエリを実行する方法については、「コンテナーの」を参照してください。.containersを使用します。

注: これらすべての操作は、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブリニアにスケーリングされるようにシステムを設計する必要があります。 たとえば、コンテナーが存在することを確認するために、すべての item.read() 呼び出しの前に container(id).read() を呼び出さないでください。これは、アプリケーションの起動時に 1 回行います。

プロパティ

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)

既存の特定の Conflict を 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)

既存の特定の Conflict を 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 パーティション キーの値

戻り値

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>