DatabaseProxy Klasse

Erstellen Sie einen neuen Container mit der angegebenen ID (Name).

Wenn bereits ein Container mit der angegebenen ID vorhanden ist, wird ein CosmosResourceExistsError ausgelöst.

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

Parameter

Gibt zurück

Ein ContainerProxy-instance, der den neuen Container darstellt.

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Beispiele

Erstellen Sie einen Container mit Standardeinstellungen:

   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)

Erstellen sie einen Container mit bestimmten Einstellungen. in diesem Fall ein benutzerdefinierter Partitionsschlüssel:

   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)

Erstellen Sie einen Container, wenn er noch nicht vorhanden ist.

Wenn der Container bereits vorhanden ist, werden die vorhandenen Einstellungen zurückgegeben. Hinweis: Es überprüft oder aktualisiert die vorhandenen Containereinstellungen nicht oder bietet keinen Durchsatz, wenn sie sich von dem unterscheiden, was an die -Methode übergeben wurde.

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

Parameter

Gibt zurück

Ein ContainerProxy-instance, der den Container darstellt.

Rückgabetyp

Ausnahmen

Fehler beim Lesen oder Erstellen des Containers.

Erstellen Sie einen neuen Benutzer im Container.

Verwenden Sie die <xref:ContainerProxy.upsert_user> -Methode, um einen vorhandenen Benutzer zu aktualisieren oder zu ersetzen.

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

Parameter

Gibt zurück

Ein UserProxy-instance, der den neuen Benutzer darstellt.

Rückgabetyp

Ausnahmen

Wenn der angegebene Benutzer nicht erstellt werden konnte.

Beispiele

Erstellen Eines Datenbankbenutzers:

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

Löschen eines Containers.

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

Parameter

Rückgabetyp

Ausnahmen

Wenn der Container nicht gelöscht werden konnte.

Löschen Sie den angegebenen Benutzer aus dem Container.

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

Parameter

Rückgabetyp

Ausnahmen

Der Benutzer wurde nicht erfolgreich gelöscht.

Der Benutzer ist im Container nicht vorhanden.

Ruft einen ContainerProxy für einen Container mit der angegebenen ID (Name) ab.

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

Parameter

Gibt zurück

Ein ContainerProxy-instance, der die abgerufene Datenbank darstellt.

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Beispiele

Rufen Sie einen vorhandenen Container ab, und behandeln Sie bei Auftreten einen Fehler:

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

Rufen Sie das ThroughputProperties-Objekt für diese Datenbank ab. Wenn für die Datenbank bereits keine ThroughputProperties vorhanden sind, wird eine Ausnahme ausgelöst. :Schlüsselwort (keyword) Aufrufbare response_hook: Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird. :returns: ThroughputProperties für die Datenbank. :löst ~azure.cosmos.exceptions.CosmosHttpResponseError: Für den Container oder sind keine Durchsatzeigenschaften vorhanden.

die Durchsatzeigenschaften konnten nicht abgerufen werden.

get_throughput(**kwargs: Any) -> ThroughputProperties

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Rufen Sie einen UserProxy für einen Benutzer mit der angegebenen ID ab.

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

Parameter

Gibt zurück

Ein UserProxy-instance, der den abgerufenen Benutzer darstellt.

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Listen Sie die Container in der Datenbank auf.

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

Parameter

Gibt zurück

Eine Iterable von Containereigenschaften (Diktaten).

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Beispiele

Auflisten aller Container in der Datenbank:

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

Listet alle Benutzer im Container auf.

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

Parameter

Gibt zurück

Eine Iterable von Benutzereigenschaften (dicts).

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Listet die Eigenschaften für Container in der aktuellen Datenbank auf.

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

Parameter

Gibt zurück

Eine Iterable von Containereigenschaften (Diktaten).

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Gibt alle Benutzer zurück, die der angegebenen Abfrage entsprechen.

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

Parameter

Gibt zurück

Eine Iterable von Benutzereigenschaften (dicts).

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Lesen sie die Datenbankeigenschaften.

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

Parameter

Rückgabetyp

Ausnahmen

Wenn die angegebene Datenbank nicht abgerufen werden konnte.

Rufen Sie das ThroughputProperties-Objekt für diese Datenbank ab. Wenn für die Datenbank bereits keine ThroughputProperties vorhanden sind, wird eine Ausnahme ausgelöst. :Schlüsselwort (keyword) Aufrufbare response_hook: Ein aufrufbarer Aufruf, der mit den Antwortmetadaten aufgerufen wird. :returns: ThroughputProperties für die Datenbank. :löst ~azure.cosmos.exceptions.CosmosHttpResponseError: Für den Container oder sind keine Durchsatzeigenschaften vorhanden.

die Durchsatzeigenschaften konnten nicht abgerufen werden.

read_offer(**kwargs: Any) -> ThroughputProperties

Rückgabetyp

Ausnahmen

Fehler bei der Containererstellung.

Setzen Sie die Eigenschaften des Containers zurück.

Eigenschaftsänderungen werden sofort beibehalten. Alle nicht angegebenen Eigenschaften werden auf ihre Standardwerte zurückgesetzt.

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

Parameter

Gibt zurück

Ein ContainerProxy-instance, der den Container nach Abschluss des Ersetzens darstellt.

Rückgabetyp

Ausnahmen

Wird ausgelöst, wenn der Container nicht ersetzt werden konnte. Dies schließt ein, wenn der Container mit der angegebenen ID nicht vorhanden ist.

Beispiele

Setzen Sie die TTL-Eigenschaft für einen Container zurück, und zeigen Sie die aktualisierten Eigenschaften an:

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

Ersetzen Sie den Durchsatz auf Datenbankebene.

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

Parameter

Gibt zurück

ThroughputProperties für die Datenbank, aktualisiert mit neuem Durchsatz.

Rückgabetyp

Ausnahmen

Wenn keine Durchsatzeigenschaften für die Datenbank vorhanden sind oder wenn die Durchsatzeigenschaften nicht aktualisiert werden konnten.

Ersetzt den angegebenen Benutzer, wenn er im Container vorhanden ist.

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

Parameter

Gibt zurück

Ein UserProxy-instance, der den Benutzer nach dem Ersetzen darstellt.

Rückgabetyp

Ausnahmen

Wenn beim Ersetzen ein Fehler aufgetreten ist oder der Benutzer mit der angegebenen ID nicht vorhanden ist.

Fügen Sie den angegebenen Benutzer ein, oder aktualisieren Sie sie.

Wenn der Benutzer bereits im Container vorhanden ist, wird er ersetzt. Wenn der Benutzer noch nicht vorhanden ist, wird er eingefügt.

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

Parameter

Gibt zurück

Ein UserProxy-instance, der den benutzer mit upsertiertem Benutzer darstellt.

Rückgabetyp

Ausnahmen

Wenn der angegebene Benutzer nicht durch upsertiert werden konnte.