DatabaseProxy クラス

指定した ID (名前) を使用して新しいコンテナーを作成します。

指定された ID を持つコンテナーが既に存在する場合は、CosmosResourceExistsError が発生します。

create_container(id: str, partition_key: Any, indexing_policy: Dict[str, Any] | None = None, default_ttl: int | None = None, populate_query_metrics: bool | None = None, offer_throughput: int | ThroughputProperties | None = None, unique_key_policy: Dict[str, Any] | None = None, conflict_resolution_policy: Dict[str, Any] | None = None, **kwargs: Any) -> ContainerProxy

パラメーター

戻り値

新しいコンテナーを表す ContainerProxy インスタンス。

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

例

既定の設定でコンテナーを作成します。

   container_name = "products"
   try:
       container = database.create_container(
           id=container_name, partition_key=PartitionKey(path="/productName")
       )
   except exceptions.CosmosResourceExistsError:
       container = database.get_container_client(container_name)

特定の設定を使用してコンテナーを作成します。この場合、カスタム パーティション キー:

   customer_container_name = "customers"
   try:
       customer_container = database.create_container(
           id=customer_container_name,
           partition_key=PartitionKey(path="/city"),
           default_ttl=200,
       )
   except exceptions.CosmosResourceExistsError:
       customer_container = database.get_container_client(customer_container_name)

コンテナーがまだ存在しない場合は作成します。

コンテナーが既に存在する場合は、既存の設定が返されます。 注: メソッドに渡されたものと異なる場合、既存のコンテナー設定をチェックまたは更新したり、スループットを提供したりすることはありません。

create_container_if_not_exists(id: str, partition_key: Any, indexing_policy: Dict[str, Any] | None = None, default_ttl: int | None = None, populate_query_metrics: bool | None = None, offer_throughput: int | ThroughputProperties | None = None, unique_key_policy: Dict[str, Any] | None = None, conflict_resolution_policy: Dict[str, Any] | None = None, **kwargs: Any) -> ContainerProxy

パラメーター

戻り値

コンテナーを表す ContainerProxy インスタンス。

の戻り値の型 :

例外

コンテナーの読み取りまたは作成に失敗しました。

コンテナーに新しいユーザーを作成します。

既存のユーザーを更新または置換するには、 メソッドを使用します <xref:ContainerProxy.upsert_user> 。

create_user(body: Dict[str, Any], **kwargs: Any) -> UserProxy

パラメーター

戻り値

新しいユーザーを表す UserProxy インスタンス。

の戻り値の型 :

例外

指定されたユーザーを作成できなかった場合。

例

データベース ユーザーを作成します。

   try:
       database.create_user(dict(id="Walter Harp"))
   except exceptions.CosmosResourceExistsError:
       print("A user with that ID already exists.")
   except exceptions.CosmosHttpResponseError as failure:
       print("Failed to create user. Status code:{}".format(failure.status_code))

コンテナーを削除します。

delete_container(container: str | ContainerProxy | Dict[str, Any], populate_query_metrics: bool | None = None, **kwargs: Any) -> None

パラメーター

の戻り値の型 :

例外

コンテナーを削除できなかった場合。

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

delete_user(user: str | UserProxy | Dict[str, Any], **kwargs: Any) -> None

パラメーター

の戻り値の型 :

例外

ユーザーが正常に削除されませんでした。

ユーザーがコンテナーに存在しません。

指定した ID (名前) を持つコンテナーの ContainerProxy を取得します。

get_container_client(container: str | ContainerProxy | Dict[str, Any]) -> ContainerProxy

パラメーター

戻り値

取得したデータベースを表す ContainerProxy インスタンス。

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

例

既存のコンテナーを取得し、発生した場合にエラーを処理します。

   database = client.get_database_client(database_name)
   container = database.get_container_client(container_name)

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

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

get_throughput(**kwargs: Any) -> ThroughputProperties

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

指定した ID を持つユーザーの UserProxy を取得します。

get_user_client(user: str | UserProxy | Dict[str, Any]) -> UserProxy

パラメーター

戻り値

取得したユーザーを表す UserProxy インスタンス。

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

データベース内のコンテナーを一覧表示します。

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

パラメーター

戻り値

コンテナー プロパティ (ディクテーション) の Iterable。

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

例

データベース内のすべてのコンテナーを一覧表示します。

   database = client.get_database_client(database_name)
   for container in database.list_containers():
       print("Container ID: {}".format(container['id']))

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

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

パラメーター

戻り値

ユーザー プロパティ (ディクテーション) の Iterable。

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

現在のデータベース内のコンテナーのプロパティを一覧表示します。

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

パラメーター

戻り値

コンテナー プロパティ (ディクテーション) の Iterable。

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

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

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

パラメーター

戻り値

ユーザー プロパティ (ディクテーション) の Iterable。

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

データベースのプロパティを読み取る。

read(populate_query_metrics: bool | None = None, **kwargs: Any) -> Dict[str, Any]

パラメーター

の戻り値の型 :

例外

指定されたデータベースを取得できなかった場合。

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

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

read_offer(**kwargs: Any) -> ThroughputProperties

の戻り値の型 :

例外

コンテナーの作成に失敗しました。

コンテナーのプロパティをリセットします。

プロパティの変更は直ちに永続化されます。 指定されていないプロパティは、既定値にリセットされます。

replace_container(container: str | ContainerProxy | Dict[str, Any], partition_key: Any, indexing_policy: Dict[str, Any] | None = None, default_ttl: int | None = None, conflict_resolution_policy: Dict[str, Any] | None = None, populate_query_metrics: bool | None = None, **kwargs: Any) -> ContainerProxy

パラメーター

戻り値

置換が完了した後のコンテナーを表す ContainerProxy インスタンス。

の戻り値の型 :

例外

コンテナーを置き換えられなかった場合に発生します。 これには、指定された ID を持つコンテナーが存在しない場合が含まれます。

例

コンテナーの TTL プロパティをリセットし、更新されたプロパティを表示します。

   # Set the TTL on the container to 3600 seconds (one hour)
   database.replace_container(container, partition_key=PartitionKey(path='/productName'), default_ttl=3600)

   # Display the new TTL setting for the container
   container_props = database.get_container_client(container_name).read()
   print("New container TTL: {}".format(json.dumps(container_props['defaultTtl'])))

データベース レベルのスループットを置き換えます。

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

パラメーター

戻り値

新しいスループットで更新されたデータベースの ThroughputProperties。

の戻り値の型 :

例外

データベースのスループット プロパティが存在しない場合、またはスループット プロパティを更新できなかった場合。

指定したユーザーがコンテナーに存在する場合は、そのユーザーを置き換えます。

replace_user(user: str | UserProxy | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> UserProxy

パラメーター

戻り値

置換後のユーザーを表す UserProxy インスタンスが完了しました。

の戻り値の型 :

例外

置換に失敗した場合、または指定された ID を持つユーザーが存在しない場合。

指定したユーザーを挿入または更新します。

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

upsert_user(body: Dict[str, Any], **kwargs: Any) -> UserProxy

パラメーター

戻り値

アップサートされたユーザーを表す UserProxy インスタンス。

の戻り値の型 :

例外

指定されたユーザーをアップサートできなかった場合。