DatabaseProxy Classe

Crie um novo contêiner com a ID fornecida (nome).

Se um contêiner com a ID fornecida já existir, um CosmosResourceExistsError será gerado.

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

Parâmetros

Retornos

Uma instância containerProxy que representa o novo contêiner.

Tipo de retorno

Exceções

Falha na criação do contêiner.

Exemplos

Crie um contêiner com configurações padrão:

   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)

Criar um contêiner com configurações específicas; nesse caso, uma chave de partição personalizada:

   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)

Crie um contêiner se ele ainda não existir.

Se o contêiner já existir, as configurações existentes serão retornadas. Observação: ele não marcar nem atualiza as configurações de contêiner existentes ou a taxa de transferência da oferta se forem diferentes do que foi passado para o método .

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

Parâmetros

Retornos

Uma instância containerProxy que representa o contêiner.

Tipo de retorno

Exceções

Falha na leitura ou na criação do contêiner.

Crie um novo usuário no contêiner.

Para atualizar ou substituir um usuário existente, use o <xref:ContainerProxy.upsert_user> método .

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

Parâmetros

Retornos

Uma instância do UserProxy que representa o novo usuário.

Tipo de retorno

Exceções

Se o usuário determinado não pôde ser criado.

Exemplos

Criar um usuário de banco de dados:

   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))

Excluir um contêiner.

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

Parâmetros

Tipo de retorno

Exceções

Se o contêiner não puder ser excluído.

Exclua o usuário especificado do contêiner.

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

Parâmetros

Tipo de retorno

Exceções

O usuário não foi excluído com êxito.

O usuário não existe no contêiner.

Obtenha um ContainerProxy para um contêiner com a ID especificada (nome).

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

Parâmetros

Retornos

Uma instância containerProxy que representa o banco de dados recuperado.

Tipo de retorno

Exceções

Falha na criação do contêiner.

Exemplos

Obtenha um contêiner existente, tratando uma falha se encontrado:

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

Obtenha o objeto ThroughputProperties para este banco de dados. Se nenhuma ThroughputProperties já existir para o banco de dados, uma exceção será gerada. :palavra-chave response_hook callable: um callable invocado com os metadados de resposta. :returns: ThroughputProperties para o banco de dados. :gera ~azure.cosmos.exceptions.CosmosHttpResponseError: não existem propriedades de taxa de transferência para o contêiner ou

as propriedades de taxa de transferência não puderam ser recuperadas.

get_throughput(**kwargs: Any) -> ThroughputProperties

Tipo de retorno

Exceções

Falha na criação do contêiner.

Obtenha um UserProxy para um usuário com a ID especificada.

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

Parâmetros

Retornos

Uma instância do UserProxy que representa o usuário recuperado.

Tipo de retorno

Exceções

Falha na criação do contêiner.

Liste os contêineres no banco de dados.

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

Parâmetros

Retornos

Um Iterável de propriedades de contêiner (dicts).

Tipo de retorno

Exceções

Falha na criação do contêiner.

Exemplos

Listar todos os contêineres no banco de dados:

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

Liste todos os usuários no contêiner.

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

Parâmetros

Retornos

Um Iterável de propriedades do usuário (dicts).

Tipo de retorno

Exceções

Falha na criação do contêiner.

Liste as propriedades para contêineres no banco de dados atual.

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]]

Parâmetros

Retornos

Um Iterável de propriedades de contêiner (dicts).

Tipo de retorno

Exceções

Falha na criação do contêiner.

Retornar todos os usuários correspondentes à consulta fornecida.

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

Parâmetros

Retornos

Um Iterável de propriedades do usuário (dicts).

Tipo de retorno

Exceções

Falha na criação do contêiner.

Leia as propriedades do banco de dados.

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

Parâmetros

Tipo de retorno

Exceções

Se o banco de dados especificado não puder ser recuperado.

Obtenha o objeto ThroughputProperties para este banco de dados. Se nenhuma ThroughputProperties já existir para o banco de dados, uma exceção será gerada. :palavra-chave response_hook callable: um callable invocado com os metadados de resposta. :returns: ThroughputProperties para o banco de dados. :gera ~azure.cosmos.exceptions.CosmosHttpResponseError: não existem propriedades de taxa de transferência para o contêiner ou

as propriedades de taxa de transferência não puderam ser recuperadas.

read_offer(**kwargs: Any) -> ThroughputProperties

Tipo de retorno

Exceções

Falha na criação do contêiner.

Redefina as propriedades do contêiner.

As alterações de propriedade são mantidas imediatamente. Todas as propriedades não especificadas serão redefinidas para seus valores padrão.

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

Parâmetros

Retornos

Uma instância containerProxy que representa o contêiner após a conclusão da substituição.

Tipo de retorno

Exceções

Gerado se o contêiner não puder ser substituído. Isso inclui se o contêiner com a ID fornecida não existir.

Exemplos

Redefina a propriedade TTL em um contêiner e exiba as propriedades atualizadas:

   # 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'])))

Substitua a taxa de transferência no nível do banco de dados.

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

Parâmetros

Retornos

ThroughputProperties para o banco de dados, atualizado com nova taxa de transferência.

Tipo de retorno

Exceções

Se nenhuma propriedade de taxa de transferência existir para o banco de dados ou se as propriedades de taxa de transferência não puderem ser atualizadas.

Substituirá o usuário especificado se ele existir no contêiner.

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

Parâmetros

Retornos

Uma instância do UserProxy que representa o usuário após a substituição.

Tipo de retorno

Exceções

Se a substituição falhou ou o usuário com determinada ID não existir.

Insira ou atualize o usuário especificado.

Se o usuário já existir no contêiner, ele será substituído. Se o usuário ainda não existir, ele será inserido.

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

Parâmetros

Retornos

Uma instância do UserProxy que representa o usuário upserted.

Tipo de retorno

Exceções

Se o usuário determinado não pôde ser upserted.