ContainerProxy クラス

コンテナーに項目を作成します。

既存の項目を更新または置換するには、 メソッドを使用します upsert_item 。

create_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, indexing_directive: Any | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

新しい項目を表すディクテーション。

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

パーティション キーによる削除機能は、Cosmos SDK を使用して同じ論理パーティション キー値を持つすべてのドキュメントを削除できるようにする、非同期のバックグラウンド操作です。 パーティション キー 操作による削除は、毎秒コンテナーで使用可能な RU/秒の合計の最大 10% までしか消費できないように制限されています。 これは、このバックグラウンド タスクで使用されるリソースを制限するのに役立ちます。

delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

指定した競合をコンテナーから削除します。

競合がまだコンテナーに存在しない場合は、例外が発生します。

delete_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

例外

競合が正常に削除されませんでした。

競合はコンテナーに存在しません。

指定した項目をコンテナーから削除します。

項目がまだコンテナーに存在しない場合は、例外が発生します。

delete_item(item: Dict[str, Any] | str, partition_key: Any, populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

例外

アイテムが正常に削除されませんでした。

項目がコンテナーに存在しません。

競合によって識別される競合を取得 します。

get_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

取得した競合を表すディクテーション。

の戻り値の型 :

例外

指定された競合を取得できませんでした。

このコンテナーの ThroughputProperties オブジェクトを取得します。

コンテナーに対して ThroughputProperties が既に存在しない場合は、例外が発生します。 :キーワード (keyword) 呼び出し可能なresponse_hook: 応答メタデータを使用して呼び出される呼び出し可能。 :returns: コンテナーのスループット。 :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: コンテナーまたは

スループット プロパティを取得できませんでした。

get_throughput(**kwargs: Any) -> ThroughputProperties

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

コンテナー内のすべての競合を一覧表示します。

list_conflicts(max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

パラメーター

戻り値

競合のイテラーブル (ディクテーション)。

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

暫定メソッド 指定された項目がコンテナー内に存在する場合は、指定された操作で修正プログラムを適用します。

項目がまだコンテナーに存在しない場合は、例外が発生します。

patch_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, patch_operations: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

パッチ操作が完了した後の項目を表すディクテーション。

の戻り値の型 :

例外

パッチ操作が失敗したか、指定された ID の項目が存在しません。

特定のクエリに一致するすべての競合を返 します。

query_conflicts(query: str, parameters: List[str] | None = None, enable_cross_partition_query: bool | None = None, partition_key: Any | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

パラメーター

戻り値

競合のイテラーブル (ディクテーション)。

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

指定されたクエリに一致するすべての結果を返 します。

FROM 句ではコンテナー名に任意の値を使用できますが、多くの場合、コンテナー名が使用されます。 次の例では、コンテナー名は "products" で、WHERE 句で参照しやすくするために "p" として別名が付けられます。

クエリ応答の応答継続トークン。 有効な値は正の整数です。 値 0 は、値を渡さない場合と同じです (既定値は制限なし)。 :キーワード (keyword) int max_integrated_cache_staleness_in_ms: の統合キャッシュの最大キャッシュ制約

ミリ秒。 セッションまたは最終的な整合性を使用して統合キャッシュを使用するように構成されたアカウントの場合、応答はこの値よりも古くないことを保証されます。

query_items(query: str, parameters: List[Dict[str, object]] | None = None, partition_key: Any | None = None, enable_cross_partition_query: bool | None = None, max_item_count: int | None = None, enable_scan_in_query: bool | None = None, populate_query_metrics: bool | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

戻り値

項目のイテナブル (ディクテーション)。

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

例

廃止されていないすべての製品を取得します。

   import json

   for item in container.query_items(
       query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"',
       enable_cross_partition_query=True,
   ):
       print(json.dumps(item, indent=True))

廃止されたすべての製品を取得するためのパラメーター化されたクエリ:

   discontinued_items = container.query_items(
       query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName="Widget"',
       parameters=[dict(name="@model", value="DISCONTINUED")],
   )
   for item in discontinued_items:
       print(json.dumps(item, indent=True))

変更されたアイテムの並べ替えられたリストを、変更された順序で取得します。

query_items_change_feed(partition_key_range_id: str | None = None, is_start_from_beginning: bool = False, continuation: str | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

パラメーター

戻り値

項目のイテナブル (ディクテーション)。

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

コンテナーのプロパティを読み取る。

read(*, populate_partition_key_range_statistics: bool | None = None, populate_quota_info: bool | None = None, **kwargs)

パラメーター

戻り値

取得したコンテナーを表す Dict。

の戻り値の型 :

例外

コンテナーを取得できなかった場合に発生します。 これには、コンテナーが存在しない場合も含まれます。

コンテナー内のすべての項目を一覧表示します。

read_all_items(max_item_count: int | None = None, populate_query_metrics: bool | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

パラメーター

戻り値

項目のイテナブル (ディクテーション)。

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

項目で識別される項目を取得 します。

read_item(item: str | Dict[str, Any], partition_key: Any, populate_query_metrics: bool | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

取得する項目を表す Dict。

の戻り値の型 :

例外

指定された項目を取得できませんでした。

例

データベースから項目を取得し、そのプロパティのいずれかを更新します。

   item = container.read_item("item2", partition_key="Widget")
   item["productModel"] = "DISCONTINUED"
   updated_item = container.upsert_item(item)

このコンテナーの ThroughputProperties オブジェクトを取得します。 コンテナーに対して ThroughputProperties が既に存在しない場合は、例外が発生します。 :キーワード (keyword) 呼び出し可能なresponse_hook: 応答メタデータを使用して呼び出される呼び出し可能。 :returns: コンテナーのスループット。 :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: コンテナーのスループット プロパティが存在しません。

スループット プロパティを取得できませんでした。

read_offer(**kwargs: Any) -> Offer

の戻り値の型 :

例外

指定された ID の項目は既に存在します。

指定した項目がコンテナーに存在する場合は置き換えます。

項目がコンテナーにまだ存在しない場合は、例外が発生します。

replace_item(item: str | Dict[str, Any], body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

置換が完了した後の項目を表すディクテーション。

の戻り値の型 :

例外

置換に失敗したか、指定された ID を持つ項目が存在しません。

コンテナーのスループットを置き換えます。

コンテナーに対して ThroughputProperties が既に存在しない場合は、例外が発生します。

replace_throughput(throughput: int | ThroughputProperties | None, **kwargs: Any) -> ThroughputProperties

パラメーター

戻り値

新しいスループットで更新されたコンテナーの ThroughputProperties。

の戻り値の型 :

例外

コンテナーのスループット プロパティが存在しないか、スループット プロパティを更新できませんでした。

指定した項目を挿入または更新します。

項目がコンテナーに既に存在する場合は、置き換えられます。 項目がまだ存在しない場合は、挿入されます。

upsert_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

戻り値

アップサートされた項目を表すディクテーション。

の戻り値の型 :

例外

指定された項目をアップサートできませんでした。