DatabaseProxy Classe

Creare un nuovo contenitore con l'ID specificato (nome).

Se esiste già un contenitore con l'ID specificato, viene generato un oggetto 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

Parametri

Restituisce

Istanza di ContainerProxy che rappresenta il nuovo contenitore.

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Esempio

Creare un contenitore con impostazioni predefinite:

   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)

Creare un contenitore con impostazioni specifiche; in questo caso, una chiave di partizione personalizzata:

   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)

Creare un contenitore se non esiste già.

Se il contenitore esiste già, vengono restituite le impostazioni esistenti. Nota: non controlla o aggiorna le impostazioni del contenitore esistenti o offre velocità effettiva se differiscono da ciò che è stato passato al metodo.

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

Parametri

Restituisce

Istanza di ContainerProxy che rappresenta il contenitore.

Tipo restituito

Eccezioni

Impossibile leggere o creare il contenitore.

Creare un nuovo utente nel contenitore.

Per aggiornare o sostituire un utente esistente, usare il <xref:ContainerProxy.upsert_user> metodo .

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

Parametri

Restituisce

Istanza userProxy che rappresenta il nuovo utente.

Tipo restituito

Eccezioni

Se non è stato possibile creare l'utente specificato.

Esempio

Creare un utente del database:

   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 contenitore.

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

Parametri

Tipo restituito

Eccezioni

Se non è stato possibile eliminare il contenitore.

Eliminare l'utente specificato dal contenitore.

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

Parametri

Tipo restituito

Eccezioni

L'utente non è stato eliminato correttamente.

L'utente non esiste nel contenitore.

Ottenere un oggetto ContainerProxy per un contenitore con ID (nome) specificato.

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

Parametri

Restituisce

Istanza containerProxy che rappresenta il database recuperato.

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Esempio

Ottenere un contenitore esistente, gestendo un errore se rilevato:

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

Ottiene l'oggetto ThroughputProperties per questo database. Se non esiste già un oggetto ThroughputProperties per il database, viene generata un'eccezione. :keyword Callable response_hook: chiamata richiamabile con i metadati della risposta. :returns: ThroughputProperties per il database. :genera ~azure.cosmos.exceptions.CosmosHttpResponseError: non esistono proprietà di velocità effettiva per il contenitore o

Impossibile recuperare le proprietà della velocità effettiva.

get_throughput(**kwargs: Any) -> ThroughputProperties

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Ottenere un userProxy per un utente con l'ID specificato.

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

Parametri

Restituisce

Istanza userProxy che rappresenta l'utente recuperato.

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Elencare i contenitori nel database.

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

Parametri

Restituisce

Iterabile di proprietà del contenitore (dict).

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Esempio

Elencare tutti i contenitori nel database:

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

Elencare tutti gli utenti nel contenitore.

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

Parametri

Restituisce

Iterabile di proprietà utente (dict).

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Elencare le proprietà per i contenitori nel database corrente.

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

Parametri

Restituisce

Iterabile di proprietà del contenitore (dict).

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Restituisce tutti gli utenti corrispondenti alla query specificata.

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

Parametri

Restituisce

Iterabile di proprietà utente (dict).

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Leggere le proprietà del database.

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

Parametri

Tipo restituito

Eccezioni

Se non è stato possibile recuperare il database specificato.

Ottiene l'oggetto ThroughputProperties per questo database. Se non esiste già un oggetto ThroughputProperties per il database, viene generata un'eccezione. :keyword Callable response_hook: chiamata richiamabile con i metadati della risposta. :returns: ThroughputProperties per il database. :genera ~azure.cosmos.exceptions.CosmosHttpResponseError: non esistono proprietà di velocità effettiva per il contenitore o

Impossibile recuperare le proprietà della velocità effettiva.

read_offer(**kwargs: Any) -> ThroughputProperties

Tipo restituito

Eccezioni

La creazione del contenitore non è riuscita.

Reimpostare le proprietà del contenitore.

Le modifiche alle proprietà vengono rese persistenti immediatamente. Tutte le proprietà non specificate verranno reimpostate nei valori predefiniti.

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

Parametri

Restituisce

Istanza containerProxy che rappresenta il contenitore dopo il completamento della sostituzione.

Tipo restituito

Eccezioni

Generato se non è stato possibile sostituire il contenitore. Ciò include se il contenitore con ID specificato non esiste.

Esempio

Reimpostare la proprietà TTL in un contenitore e visualizzare le proprietà aggiornate:

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

Sostituire la velocità effettiva a livello di database.

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

Parametri

Restituisce

ThroughputProperties per il database, aggiornato con una nuova velocità effettiva.

Tipo restituito

Eccezioni

Se non esistono proprietà di velocità effettiva per il database o se non è stato possibile aggiornare le proprietà della velocità effettiva.

Sostituisce l'utente specificato, se presente nel contenitore.

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

Parametri

Restituisce

Istanza userProxy che rappresenta l'utente dopo che è stata sostituita.

Tipo restituito

Eccezioni

Se la sostituzione non è riuscita o l'utente con id specificato non esiste.

Inserire o aggiornare l'utente specificato.

Se l'utente esiste già nel contenitore, viene sostituito. Se l'utente non esiste già, viene inserito.

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

Parametri

Restituisce

Istanza di UserProxy che rappresenta l'utente con stato in alto.

Tipo restituito

Eccezioni

Se l'utente specificato non è riuscito a essere ignorato.