ContainerProxy クラス
特定の DB コンテナーと対話するためのインターフェイス。
このクラスは直接インスタンス化しないでください。 代わりに、 メソッドを <xref:azure.cosmos.aio.database.DatabaseProxy.get_container_client> 使用して既存のコンテナーを取得するか、 メソッドを <xref:azure.cosmos.aio.database.DatabaseProxy.create_container> 使用して新しいコンテナーを作成します。
Azure Cosmos DB SQL API データベース内のコンテナーはドキュメントのコレクションであり、それぞれが Item として表されます。
- 継承
-
builtins.objectContainerProxy
コンストラクター
ContainerProxy(client_connection: CosmosClientConnection, database_link: str, id: str, properties: Dict[str, Any] = None)パラメーター
- client_connection
- database_link
- id
- properties
変数
- id
- str
コンテナーの ID (名前)
- session_token
- str
コンテナーのセッション トークン。
メソッド
| create_item |
コンテナーに項目を作成します。 既存の項目を更新または置換するには、 メソッドを upsert_item 使用します。 |
| delete_all_items_by_partition_key |
パーティション キーによる削除機能は、Cosmos SDK を使用して同じ論理パーティション キー値を持つすべてのドキュメントを削除できるようにする、非同期のバックグラウンド操作です。 パーティション キー 操作による削除は、毎秒コンテナーで使用可能な RU/秒の合計の最大 10% までしか消費できないように制限されています。 これは、このバックグラウンド タスクで使用されるリソースを制限するのに役立ちます。 |
| delete_conflict |
指定した競合をコンテナーから削除します。 競合がまだコンテナーに存在しない場合は、例外が発生します。 |
| delete_item |
指定した項目をコンテナーから削除します。 項目がコンテナーにまだ存在しない場合は、例外が発生します。 |
| get_conflict |
競合によって識別される競合を取得 します。 |
| get_throughput |
このコンテナーの ThroughputProperties オブジェクトを取得します。 コンテナーに対して ThroughputProperties が既に存在しない場合は、例外が発生します。 |
| list_conflicts |
コンテナー内のすべての競合を一覧表示します。 |
| patch_item |
暫定メソッド 指定された項目がコンテナー内に存在する場合は、指定された操作で修正プログラムを適用します。 項目がコンテナーにまだ存在しない場合は、例外が発生します。 |
| query_conflicts |
特定のクエリと一致するすべての競合を返 します。 |
| query_items |
指定されたクエリに一致するすべての結果を返 します。 FROM 句ではコンテナー名に任意の値を使用できますが、多くの場合、コンテナー名が使用されます。 次の例では、コンテナー名は "products" で、WHERE 句で参照しやすくするために "p" として別名が付けられます。 クエリ応答の応答継続トークン。 有効な値は正の整数です。 値 0 は、値を渡さない場合と同じです (既定値は制限なし)。 :キーワード (keyword) int max_integrated_cache_staleness_in_ms: の統合キャッシュの最大キャッシュ制約 ミリ秒。 セッションまたは最終的な整合性を使用して統合キャッシュを使用するように構成されたアカウントの場合、応答はこの値よりも古くないことを保証されます。 |
| query_items_change_feed |
変更されたアイテムの並べ替えられたリストを、変更された順序で取得します。 |
| read |
コンテナーのプロパティを読み取る。 |
| read_all_items |
コンテナー内のすべての項目を一覧表示します。 |
| read_item |
項目で識別される項目を取得 します。 |
| replace_item |
指定した項目がコンテナーに存在する場合は置き換えます。 項目がコンテナーにまだ存在しない場合は、例外が発生します。 |
| replace_throughput |
コンテナーのスループットを置き換えます。 コンテナーに対して ThroughputProperties が既に存在しない場合は、例外が発生します。 |
| upsert_item |
指定した項目を挿入または更新します。 項目がコンテナーに既に存在する場合は、置き換えられます。 項目がまだ存在しない場合は、挿入されます。 |
create_item
コンテナーに項目を作成します。
既存の項目を更新または置換するには、 メソッドを upsert_item 使用します。
async create_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
- pre_trigger_include
- str
操作前トリガーとして使用されるトリガー ID。
- post_trigger_include
- str
後操作トリガーとして使用されるトリガー ID。
- indexing_directive
- Union[int, IndexingDirective]
指定できる値を列挙して、ドキュメントのインデックス作成を省略するかどうかを示します。 使用できる値は、既定値の場合は 0、除外の場合は 1、含める場合は 2 です。
- enable_automatic_id_generation
- bool
ID がない場合は、ID の自動生成を有効にします。
- session_token
- str
セッション整合性で使用するトークン。
- etag
- str
ETag 値またはワイルドカード文字 (*)。 リソースが変更されたかどうかをチェックし、match_condition パラメーターで指定された条件に従って動作するために使用されます。
- match_condition
- MatchConditions
etag で使用する一致条件。
戻り値
新しい項目を表すディクテーション。
の戻り値の型 :
例外
指定された ID を持つ項目は既に存在します。
delete_all_items_by_partition_key
パーティション キーによる削除機能は、Cosmos SDK を使用して同じ論理パーティション キー値を持つすべてのドキュメントを削除できるようにする、非同期のバックグラウンド操作です。 パーティション キー 操作による削除は、毎秒コンテナーで使用可能な RU/秒の合計の最大 10% までしか消費できないように制限されています。 これは、このバックグラウンド タスクで使用されるリソースを制限するのに役立ちます。
async delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> Noneパラメーター
- pre_trigger_include
- str
操作前トリガーとして使用されるトリガー ID。
- post_trigger_include
- str
後操作トリガーとして使用されるトリガー ID。
- session_token
- str
セッション整合性で使用するトークン。
- etag
- str
ETag 値またはワイルドカード文字 (*)。 リソースが変更されたかどうかをチェックし、match_condition パラメーターで指定された条件に従って動作するために使用されます。
- match_condition
- MatchConditions
etag で使用する一致条件。
- response_hook
- Callable
応答メタデータを使用して呼び出される呼び出し可能。
の戻り値の型 :
例外
指定された ID を持つ項目は既に存在します。
delete_conflict
指定した競合をコンテナーから削除します。
競合がまだコンテナーに存在しない場合は、例外が発生します。
async delete_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Noneパラメーター
の戻り値の型 :
例外
競合が正常に削除されませんでした。
競合はコンテナーに存在しません。
delete_item
指定した項目をコンテナーから削除します。
項目がコンテナーにまだ存在しない場合は、例外が発生します。
async delete_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Noneパラメーター
- pre_trigger_include
- str
操作前トリガーとして使用されるトリガー ID。
- post_trigger_include
- str
後操作トリガーとして使用されるトリガー ID。
- session_token
- str
セッション整合性で使用するトークン。
- etag
- str
ETag 値またはワイルドカード文字 (*)。 リソースが変更されたかどうかをチェックし、match_condition パラメーターで指定された条件に従って動作するために使用されます。
- match_condition
- MatchConditions
etag で使用する一致条件。
の戻り値の型 :
例外
アイテムが正常に削除されませんでした。
項目がコンテナーに存在しません。
get_conflict
競合によって識別される競合を取得 します。
async get_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
取得した競合を表す dict。
の戻り値の型 :
例外
指定された競合を取得できませんでした。
get_throughput
このコンテナーの ThroughputProperties オブジェクトを取得します。
コンテナーに対して ThroughputProperties が既に存在しない場合は、例外が発生します。
async get_throughput(**kwargs: Any) -> ThroughputPropertiesパラメーター
戻り値
コンテナーの ThroughputProperties。
の戻り値の型 :
例外
コンテナーのスループット プロパティが存在しないか、スループット プロパティを取得できませんでした。
list_conflicts
コンテナー内のすべての競合を一覧表示します。
list_conflicts(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
応答メタデータを使用して呼び出される呼び出し可能。
戻り値
競合 (ディクテーション) の AsyncItemPaged。
の戻り値の型 :
例外
指定された ID を持つ項目は既に存在します。
patch_item
暫定メソッド 指定された項目がコンテナー内に存在する場合は、指定された操作で修正プログラムを適用します。
項目がコンテナーにまだ存在しない場合は、例外が発生します。
async patch_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, patch_operations: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]パラメーター
- filter_predicate
- str
パッチ操作に適用する条件付きフィルター。
- pre_trigger_include
- str
操作前トリガーとして使用されるトリガー ID。
- post_trigger_include
- str
後操作トリガーとして使用されるトリガー ID。
- session_token
- str
セッション整合性で使用するトークン。
- etag
- str
ETag 値またはワイルドカード文字 (*)。 リソースが変更されたかどうかをチェックし、match_condition パラメーターで指定された条件に従って動作するために使用されます。
- match_condition
- MatchConditions
etag で使用する一致条件。
- response_hook
- Callable
応答メタデータを使用して呼び出される呼び出し可能。
戻り値
パッチ操作が完了した後の項目を表すディクテーション。
の戻り値の型 :
例外
パッチ操作が失敗したか、指定された ID を持つ項目が存在しません。
query_conflicts
特定のクエリと一致するすべての競合を返 します。
query_conflicts(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
応答メタデータを使用して呼び出される呼び出し可能。
戻り値
競合 (ディクテーション) の AsyncItemPaged。
の戻り値の型 :
例外
指定された ID を持つ項目は既に存在します。
query_items
指定されたクエリに一致するすべての結果を返 します。
FROM 句ではコンテナー名に任意の値を使用できますが、多くの場合、コンテナー名が使用されます。 次の例では、コンテナー名は "products" で、WHERE 句で参照しやすくするために "p" として別名が付けられます。
クエリ応答の応答継続トークン。 有効な値は正の整数です。 値 0 は、値を渡さない場合と同じです (既定値は制限なし)。 :キーワード (keyword) int max_integrated_cache_staleness_in_ms: の統合キャッシュの最大キャッシュ制約
ミリ秒。 セッションまたは最終的な整合性を使用して統合キャッシュを使用するように構成されたアカウントの場合、応答はこの値よりも古くないことを保証されます。
query_items(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]戻り値
項目 (ディクテーション) の AsyncItemPaged。
の戻り値の型 :
例外
指定された ID を持つ項目は既に存在します。
例
廃止されていないすべての製品を取得します。
import json
async for item in container.query_items(
query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"'
):
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")],
)
async for item in discontinued_items:
print(json.dumps(item, indent=True))
query_items_change_feed
変更されたアイテムの並べ替えられたリストを、変更された順序で取得します。
query_items_change_feed(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- is_start_from_beginning
- bool
変更フィードを開始 (true) から開始するか、現在の (false) から開始するかを取得します。 既定では、現在から開始されます (false)。
- partition_key_range_id
- str
ChangeFeed 要求は、特定のパーティション キー範囲に対して実行できます。 これは、複数のコンシューマー間で変更フィードを並列に処理するために使用されます。
- continuation
- str
変更フィードを読み取るための継続として使用する値をe_tagします。
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
応答メタデータを使用して呼び出される呼び出し可能。
戻り値
項目 (ディクテーション) の AsyncItemPaged。
の戻り値の型 :
例外
指定された ID を持つ項目は既に存在します。
read
コンテナーのプロパティを読み取る。
async read(**kwargs: Any) -> Dict[str, Any]パラメーター
- populate_partition_key_range_statistics
- bool
応答ヘッダーでパーティション キー範囲統計の返しを有効にします。
- populate_quota_info
- bool
応答ヘッダーでコレクション ストレージ クォータ情報の返しを有効にします。
- session_token
- str
セッション整合性で使用するトークン。
戻り値
取得したコンテナーを表す Dict。
の戻り値の型 :
例外
コンテナーを取得できなかった場合に発生します。 これには、コンテナーが存在しない場合も含まれます。
read_all_items
コンテナー内のすべての項目を一覧表示します。
read_all_items(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
- session_token
- str
セッション整合性で使用するトークン。
応答メタデータを使用して呼び出される呼び出し可能。
- max_integrated_cache_staleness_in_ms
- int
統合キャッシュの最大キャッシュ整合性 (ミリ秒単位)。 セッションまたは最終的な整合性を使用して統合キャッシュを使用するように構成されたアカウントの場合、応答はこの値よりも古くないことを保証されます。
戻り値
項目 (ディクテーション) の AsyncItemPaged。
の戻り値の型 :
例外
指定された ID を持つ項目は既に存在します。
read_item
項目で識別される項目を取得 します。
async read_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]パラメーター
- post_trigger_include
- str
後操作トリガーとして使用されるトリガー ID。
- session_token
- str
セッション整合性で使用するトークン。
- max_integrated_cache_staleness_in_ms
- int
統合キャッシュの最大キャッシュ整合性 (ミリ秒単位)。 セッションまたは最終的な整合性を使用して統合キャッシュを使用するように構成されたアカウントの場合、応答はこの値よりも古くないことを保証されます。
戻り値
取得する項目を表す Dict。
の戻り値の型 :
例外
指定された項目を取得できませんでした。
例
データベースから項目を取得し、そのプロパティのいずれかを更新します。
item = await container.read_item("item2", partition_key="Widget")
item["productModel"] = "DISCONTINUED"
updated_item = await container.upsert_item(item)
replace_item
指定した項目がコンテナーに存在する場合は置き換えます。
項目がコンテナーにまだ存在しない場合は、例外が発生します。
async replace_item(item: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
- pre_trigger_include
- str
操作前トリガーとして使用されるトリガー ID。
- post_trigger_include
- str
後操作トリガーとして使用されるトリガー ID。
- session_token
- str
セッション整合性で使用するトークン。
- etag
- str
ETag 値またはワイルドカード文字 (*)。 リソースが変更されたかどうかをチェックし、match_condition パラメーターで指定された条件に従って動作するために使用されます。
- match_condition
- MatchConditions
etag で使用する一致条件。
戻り値
置換が完了した後の項目を表すディクテーション。
の戻り値の型 :
例外
置換に失敗したか、指定された ID を持つ項目が存在しません。
replace_throughput
コンテナーのスループットを置き換えます。
コンテナーに対して ThroughputProperties が既に存在しない場合は、例外が発生します。
async replace_throughput(throughput: int | ThroughputProperties, **kwargs: Any) -> ThroughputPropertiesパラメーター
戻り値
新しいスループットで更新されたコンテナーの ThroughputProperties。
の戻り値の型 :
例外
コンテナーのスループット プロパティが存在しないか、スループット プロパティを更新できませんでした。
upsert_item
指定した項目を挿入または更新します。
項目がコンテナーに既に存在する場合は、置き換えられます。 項目がまだ存在しない場合は、挿入されます。
async upsert_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
- pre_trigger_include
- str
操作前トリガーとして使用されるトリガー ID。
- post_trigger_include
- str
後操作トリガーとして使用されるトリガー ID。
- session_token
- str
セッション整合性で使用するトークン。
- etag
- str
ETag 値またはワイルドカード文字 (*)。 リソースが変更されたかどうかをチェックし、match_condition パラメーターで指定された条件に従って動作するために使用されます。
- match_condition
- MatchConditions
etag で使用する一致条件。
戻り値
アップサートされた項目を表すディクテーション。
の戻り値の型 :
例外
指定された項目をアップサートできませんでした。
属性
is_system_key
scripts
Azure SDK for Python