DatabaseProxy Classe

Crie um novo contentor com o ID (nome) especificado.

Se já existir um contentor com o ID especificado, é gerado um 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

Parâmetros

Devoluções

Uma instância do ContainerProxy que representa o novo contentor.

Tipo de retorno

Exceções

A criação do contentor falhou.

Exemplos

Criar um contentor com predefinições:

   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 contentor com definições específicas; neste 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 contentor se ainda não existir.

Se o contentor já existir, as definições existentes serão devolvidas. Nota: não verifica nem atualiza as definições de contentor existentes nem oferece débito se forem diferentes das que foram transmitidas 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

Devoluções

Uma instância do ContainerProxy que representa o contentor.

Tipo de retorno

Exceções

Falha na leitura ou criação do contentor.

Crie um novo utilizador no contentor.

Para atualizar ou substituir um utilizador existente, utilize o <xref:ContainerProxy.upsert_user> método .

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

Parâmetros

Devoluções

Uma instância do UserProxy que representa o novo utilizador.

Tipo de retorno

Exceções

Se não foi possível criar o utilizador especificado.

Exemplos

Criar um utilizador de base 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))

Eliminar um contentor.

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 não foi possível eliminar o contentor.

Elimine o utilizador especificado do contentor.

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

Parâmetros

Tipo de retorno

Exceções

O utilizador não foi eliminado com êxito.

O utilizador não existe no contentor.

Obtenha um ContainerProxy para um contentor com o ID (nome) especificado.

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

Parâmetros

Devoluções

Uma instância do ContainerProxy que representa a base de dados obtida.

Tipo de retorno

Exceções

A criação do contentor falhou.

Exemplos

Obtenha um contentor existente, lidar com uma falha se for encontrado:

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

Obtenha o objeto ThroughputProperties para esta base de dados. Se ainda não existirem ThroughputProperties para a base de dados, é gerada uma exceção. :keyword Callable response_hook: um callable invocado com os metadados de resposta. :returns: ThroughputProperties para a base de dados. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: não existem propriedades de débito para o contentor ou

não foi possível obter as propriedades de débito.

get_throughput(**kwargs: Any) -> ThroughputProperties

Tipo de retorno

Exceções

A criação do contentor falhou.

Obtenha um UserProxy para um utilizador com o ID especificado.

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

Parâmetros

Devoluções

Uma instância do UserProxy que representa o utilizador recuperado.

Tipo de retorno

Exceções

A criação do contentor falhou.

Listar os contentores na base de dados.

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

Parâmetros

Devoluções

Iterável de propriedades de contentor (dicts).

Tipo de retorno

Exceções

A criação do contentor falhou.

Exemplos

Listar todos os contentores na base de dados:

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

Liste todos os utilizadores no contentor.

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

Parâmetros

Devoluções

Iterável de propriedades de utilizador (dicts).

Tipo de retorno

Exceções

A criação do contentor falhou.

Liste as propriedades dos contentores na base 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

Devoluções

Iterável de propriedades de contentor (dicts).

Tipo de retorno

Exceções

A criação do contentor falhou.

Devolver todos os utilizadores que correspondam à consulta especificada.

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

Parâmetros

Devoluções

Iterável de propriedades de utilizador (dicts).

Tipo de retorno

Exceções

A criação do contentor falhou.

Leia as propriedades da base de dados.

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

Parâmetros

Tipo de retorno

Exceções

Se não foi possível obter a base de dados especificada.

Obtenha o objeto ThroughputProperties para esta base de dados. Se ainda não existirem ThroughputProperties para a base de dados, é gerada uma exceção. :keyword Callable response_hook: um callable invocado com os metadados de resposta. :returns: ThroughputProperties para a base de dados. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: não existem propriedades de débito para o contentor ou

não foi possível obter as propriedades de débito.

read_offer(**kwargs: Any) -> ThroughputProperties

Tipo de retorno

Exceções

A criação do contentor falhou.

Reponha as propriedades do contentor.

As alterações de propriedade são mantidas imediatamente. Quaisquer propriedades não especificadas serão repostas para os respetivos valores predefinidos.

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

Devoluções

Uma instância do ContainerProxy que representa o contentor após a substituição concluída.

Tipo de retorno

Exceções

Gerado se o contentor não puder ser substituído. Isto inclui se o contentor com o ID especificado não existir.

Exemplos

Reponha a propriedade TTL num contentor e apresente 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 o débito ao nível da base de dados.

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

Parâmetros

Devoluções

ThroughputProperties para a base de dados, atualizado com novo débito.

Tipo de retorno

Exceções

Se não existirem propriedades de débito para a base de dados ou se não foi possível atualizar as propriedades de débito.

Substitui o utilizador especificado se existir no contentor.

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

Parâmetros

Devoluções

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

Tipo de retorno

Exceções

Se a substituição tiver falhado ou o utilizador com o ID especificado não existir.

Insira ou atualize o utilizador especificado.

Se o utilizador já existir no contentor, este será substituído. Se o utilizador ainda não existir, é inserido.

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

Parâmetros

Devoluções

Uma instância do UserProxy que representa o utilizador upserted.

Tipo de retorno

Exceções

Se não for possível atualizar o utilizador especificado.