DatabaseProxy Clase

Cree un contenedor con el identificador (nombre) especificado.

Si ya existe un contenedor con el identificador especificado, se genera un 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

Devoluciones

Una instancia de ContainerProxy que representa el nuevo contenedor.

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Ejemplos

Cree un contenedor con la configuración predeterminada:

   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)

Crear un contenedor con una configuración específica; en este caso, una clave de partición 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)

Cree un contenedor si aún no existe.

Si el contenedor ya existe, se devuelve la configuración existente. Nota: no comprueba ni actualiza la configuración de contenedor existente ni ofrece rendimiento si difieren de lo que se pasó al 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

Devoluciones

Una instancia de ContainerProxy que representa el contenedor.

Tipo de valor devuelto

Excepciones

Error en la lectura o creación del contenedor.

Cree un nuevo usuario en el contenedor.

Para actualizar o reemplazar un usuario existente, use el <xref:ContainerProxy.upsert_user> método .

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

Parámetros

Devoluciones

Una instancia de UserProxy que representa al nuevo usuario.

Tipo de valor devuelto

Excepciones

Si no se pudo crear el usuario especificado.

Ejemplos

Cree un usuario de base de datos:

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

Elimina un contenedor.

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

Parámetros

Tipo de valor devuelto

Excepciones

Si no se pudo eliminar el contenedor.

Elimine el usuario especificado del contenedor.

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

Parámetros

Tipo de valor devuelto

Excepciones

El usuario no se eliminó correctamente.

El usuario no existe en el contenedor.

Obtenga un containerProxy para un contenedor con el identificador (nombre) especificado.

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

Parámetros

Devoluciones

Una instancia de ContainerProxy que representa la base de datos recuperada.

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Ejemplos

Obtenga un contenedor existente y controle un error si se encuentra:

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

Obtenga el objeto ThroughputProperties para esta base de datos. Si no existe Ninguna propiedad de rendimiento para la base de datos, se genera una excepción. :keyword Callable response_hook: invocable con los metadatos de respuesta. :returns: ThroughputProperties para la base de datos. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: no existe ninguna propiedad de rendimiento para el contenedor o

no se pudieron recuperar las propiedades de rendimiento.

get_throughput(**kwargs: Any) -> ThroughputProperties

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Obtiene un userProxy para un usuario con el identificador especificado.

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

Parámetros

Devoluciones

Una instancia de UserProxy que representa al usuario recuperado.

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Enumere los contenedores de la base de datos.

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

Parámetros

Devoluciones

Iterable de propiedades de contenedor (dicts).

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Ejemplos

Enumere todos los contenedores de la base de datos:

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

Enumere todos los usuarios del contenedor.

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

Parámetros

Devoluciones

Iterable de propiedades de usuario (dicts).

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Enumere las propiedades de los contenedores de la base de datos actual.

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

Devoluciones

Iterable de propiedades de contenedor (dicts).

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Devuelve todos los usuarios que coinciden con la 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

Devoluciones

Iterable de propiedades de usuario (dicts).

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Lea las propiedades de la base de datos.

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

Parámetros

Tipo de valor devuelto

Excepciones

Si no se pudo recuperar la base de datos especificada.

Obtenga el objeto ThroughputProperties para esta base de datos. Si no existe Ninguna propiedad de rendimiento para la base de datos, se genera una excepción. :keyword Callable response_hook: invocable con los metadatos de respuesta. :returns: ThroughputProperties para la base de datos. :raises ~azure.cosmos.exceptions.CosmosHttpResponseError: no existe ninguna propiedad de rendimiento para el contenedor o

no se pudieron recuperar las propiedades de rendimiento.

read_offer(**kwargs: Any) -> ThroughputProperties

Tipo de valor devuelto

Excepciones

Error en la creación del contenedor.

Restablezca las propiedades del contenedor.

Los cambios de propiedad se conservan inmediatamente. Las propiedades no especificadas se restablecerán a sus valores predeterminados.

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

Devoluciones

Una instancia de ContainerProxy que representa el contenedor una vez completado el reemplazo.

Tipo de valor devuelto

Excepciones

Se genera si no se pudo reemplazar el contenedor. Esto incluye si el contenedor con el identificador especificado no existe.

Ejemplos

Restablezca la propiedad TTL en un contenedor y muestre las propiedades actualizadas:

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

Reemplace el rendimiento de nivel de base de datos.

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

Parámetros

Devoluciones

ThroughputProperties para la base de datos, actualizada con un nuevo rendimiento.

Tipo de valor devuelto

Excepciones

Si no existe ninguna propiedad de rendimiento para la base de datos o si no se pudieron actualizar las propiedades de rendimiento.

Reemplaza al usuario especificado si existe en el contenedor.

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

Parámetros

Devoluciones

Una instancia de UserProxy que representa al usuario después de pasar por el reemplazo.

Tipo de valor devuelto

Excepciones

Si no se pudo reemplazar o el usuario con el identificador especificado no existe.

Inserte o actualice el usuario especificado.

Si el usuario ya existe en el contenedor, se reemplaza. Si el usuario aún no existe, se inserta.

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

Parámetros

Devoluciones

Una instancia de UserProxy que representa el usuario con upserted.

Tipo de valor devuelto

Excepciones

Si no se pudo subir el usuario especificado.