ContainerProxy Clase

Cree un elemento en el contenedor.

Para actualizar o reemplazar un elemento existente, use el upsert_item método .

create_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, indexing_directive: Any | None = None, **kwargs: Any) -> Dict[str, Any]

Parámetros

Devoluciones

Un dict que representa el nuevo elemento.

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

La característica de eliminación por clave de partición es una operación asincrónica y en segundo plano que permite eliminar todos los documentos con el mismo valor de clave de partición lógica, mediante el SDK de Cosmos. La operación de eliminación por clave de partición se limita a un consumo máximo del 10 % del total de RU/s disponibles en el contenedor cada segundo. Esto ayuda a limitar los recursos utilizados por esta tarea en segundo plano.

delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> None

Parámetros

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

Elimine un conflicto especificado del contenedor.

Si el conflicto aún no existe en el contenedor, se genera una excepción.

delete_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> None

Parámetros

Tipo de valor devuelto

Excepciones

El conflicto no se eliminó correctamente.

El conflicto no existe en el contenedor.

Elimine el elemento especificado del contenedor.

Si el elemento aún no existe en el contenedor, se genera una excepción.

delete_item(item: Dict[str, Any] | str, partition_key: Any, populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> None

Parámetros

Tipo de valor devuelto

Excepciones

El elemento no se eliminó correctamente.

El elemento no existe en el contenedor.

Obtenga el conflicto identificado por conflicto.

get_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> Dict[str, Any]

Parámetros

Devoluciones

Un dict que representa el conflicto recuperado.

Tipo de valor devuelto

Excepciones

No se pudo recuperar el conflicto especificado.

Obtenga el objeto ThroughputProperties para este contenedor.

Si no existen propiedades de rendimiento para el contenedor, se genera una excepción. :keyword Response_hook invocable: invocable con los metadatos de respuesta. :returns: rendimiento del contenedor. :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

El elemento con el identificador especificado ya existe.

Enumere todos los conflictos del contenedor.

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

Parámetros

Devoluciones

Iterable de conflictos (dicts).

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

Método provisional Aplica revisiones al elemento especificado con las operaciones proporcionadas si existe en el contenedor.

Si el elemento aún no existe en el contenedor, se genera una excepción.

patch_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, patch_operations: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]

Parámetros

Devoluciones

Un dict que representa el elemento después de que se han pasado las operaciones de revisión.

Tipo de valor devuelto

Excepciones

Error en las operaciones de revisión o el elemento con el identificador especificado no existe.

Devuelve todos los conflictos que coinciden con una consulta determinada.

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

Parámetros

Devoluciones

Iterable de conflictos (dicts).

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

Devuelve todos los resultados que coinciden con la consulta especificada.

Puede usar cualquier valor para el nombre del contenedor en la cláusula FROM, pero a menudo se usa el nombre del contenedor. En los ejemplos siguientes, el nombre del contenedor es "products" y tiene el alias "p" para facilitar la referencia en la cláusula WHERE.

token de continuación de respuesta en la respuesta de consulta. Los valores válidos son enteros positivos. Un valor de 0 es el mismo que no pasar un valor (valor predeterminado sin límite). :keyword int max_integrated_cache_staleness_in_ms: obsolescencia máxima de caché para la caché integrada en

Milisegundos. Para las cuentas configuradas para usar la memoria caché integrada, mediante la coherencia De sesión o Eventual, se garantiza que las respuestas no sean obsoletas que este valor.

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

Devoluciones

Iterable de elementos (dicts).

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

Ejemplos

Obtenga todos los productos que no se han dejado de usar:

   import json

   for item in container.query_items(
       query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"',
       enable_cross_partition_query=True,
   ):
       print(json.dumps(item, indent=True))

Consulta con parámetros para obtener todos los productos que se han interrumpido:

   discontinued_items = container.query_items(
       query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName="Widget"',
       parameters=[dict(name="@model", value="DISCONTINUED")],
   )
   for item in discontinued_items:
       print(json.dumps(item, indent=True))

Obtiene una lista ordenada de elementos que se cambiaron, en el orden en que se modificaron.

query_items_change_feed(partition_key_range_id: str | None = None, is_start_from_beginning: bool = False, continuation: str | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

Parámetros

Devoluciones

Iterable de elementos (dicts).

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

Lea las propiedades del contenedor.

read(*, populate_partition_key_range_statistics: bool | None = None, populate_quota_info: bool | None = None, **kwargs)

Parámetros

Devoluciones

Dict que representa el contenedor recuperado.

Tipo de valor devuelto

Excepciones

Se genera si no se pudo recuperar el contenedor. Esto incluye si el contenedor no existe.

Enumere todos los elementos del contenedor.

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

Parámetros

Devoluciones

Iterable de elementos (dicts).

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

Obtenga el elemento identificado por elemento.

read_item(item: str | Dict[str, Any], partition_key: Any, populate_query_metrics: bool | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parámetros

Devoluciones

Dict que representa el elemento que se va a recuperar.

Tipo de valor devuelto

Excepciones

No se pudo recuperar el elemento especificado.

Ejemplos

Obtenga un elemento de la base de datos y actualice una de sus propiedades:

   item = container.read_item("item2", partition_key="Widget")
   item["productModel"] = "DISCONTINUED"
   updated_item = container.upsert_item(item)

Obtenga el objeto ThroughputProperties para este contenedor. Si no existen propiedades de rendimiento para el contenedor, se genera una excepción. :keyword Response_hook invocable: invocable con los metadatos de respuesta. :returns: rendimiento del contenedor. :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) -> Offer

Tipo de valor devuelto

Excepciones

El elemento con el identificador especificado ya existe.

Reemplaza el elemento especificado si existe en el contenedor.

Si el elemento aún no existe en el contenedor, se genera una excepción.

replace_item(item: str | Dict[str, Any], body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parámetros

Devoluciones

Un dict que representa el elemento después de reemplazar pasó.

Tipo de valor devuelto

Excepciones

Error en el reemplazo o el elemento con el identificador especificado no existe.

Reemplace el rendimiento del contenedor.

Si no existen propiedades de rendimiento para el contenedor, se genera una excepción.

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

Parámetros

Devoluciones

RendimientoPropiedades para el contenedor, actualizadas con un nuevo rendimiento.

Tipo de valor devuelto

Excepciones

No se pudieron actualizar las propiedades de rendimiento para el contenedor o no se pudieron actualizar las propiedades de rendimiento.

Inserte o actualice el elemento especificado.

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

upsert_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

Parámetros

Devoluciones

Un dict que representa el elemento upserted.

Tipo de valor devuelto

Excepciones

No se pudo subir el elemento especificado.