Container class

パッケージ:

@azure/cosmos

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

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

注: これらの操作はすべて、固定予算に対して呼び出しを行います。 これらの呼び出しがアプリケーションと共にサブインラインでスケーリングされるように、システムを設計する必要があります。 たとえば、コンテナーが存在することを確認するために、1 回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)	特定の既存の 競合 を 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

Item の 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>