Freigeben über

DatabaseProxy Klasse

  • Referenz

Eine Schnittstelle für die Interaktion mit einer bestimmten Datenbank.

Diese Klasse sollte nicht direkt instanziiert werden. Verwenden Sie stattdessen die <xref:CosmosClient.get_database_client> -Methode.

Eine Datenbank enthält einen oder mehrere Container, von denen jeder Elemente, gespeicherte Prozeduren, Trigger und benutzerdefinierte Funktionen enthalten kann.

Eine Datenbank kann auch über zugeordnete Benutzer verfügen, die jeweils mit einem Satz von Berechtigungen für den Zugriff auf bestimmte Container, gespeicherte Prozeduren, Trigger, benutzerdefinierte Funktionen oder Elemente konfiguriert sind.

Eine Azure Cosmos DB-SQL-API-Datenbank verfügt über die folgenden vom System generierten Eigenschaften. Diese Eigenschaften sind schreibgeschützt:

  • _rid: Die Ressourcen-ID.

  • _ts: Wann die Ressource zuletzt aktualisiert wurde. Der Wert ist ein Zeitstempel.

  • _self: Der eindeutige adressierbare URI für die Ressource.

  • _etag: Das Ressourcen-Etag, das für die Kontrolle der optimistischen Parallelität erforderlich ist.

  • _colls: Der adressierbare Pfad der Auflistungsressource.

  • _users: Der adressierbare Pfad der Benutzerressource.

Vererbung
builtins.object
DatabaseProxy

Konstruktor

DatabaseProxy(client_connection: CosmosClientConnection, id: str, properties: Dict[str, Any] = None)

Parameter

client_connection
<xref:ClientSession>
Erforderlich

Client, von dem diese Datenbank abgerufen wurde.

id
str
Erforderlich

ID (Name) der Datenbank.

properties
Standardwert: None

Variablen

id

Die ID (Name) der Datenbank.

Methoden

create_container

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_if_not_exists

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_user

Erstellen Sie einen neuen Benutzer im Container.

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

Löschen eines Containers.
delete_user

Löschen Sie den angegebenen Benutzer aus dem Container.
get_container_client

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

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_user_client

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

Listen Sie die Container in der Datenbank auf.
list_users

Listet alle Benutzer im Container auf.
query_containers

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

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

Lesen sie die Datenbankeigenschaften.
read_offer

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

Setzen Sie die Eigenschaften des Containers zurück.

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

Ersetzen Sie den Durchsatz auf Datenbankebene.
replace_user

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

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.

create_container

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

id
Erforderlich

ID (Name) des zu erstellenden Containers.

partition_key
Erforderlich

Der Partitionsschlüssel, der für den Container verwendet werden soll.

indexing_policy
Erforderlich

Die Auf den Container anzuwendende Indizierungsrichtlinie.

default_ttl
Erforderlich

Standardzeit (TTL) für Elemente im Container. Wenn sie nicht angegeben sind, laufen Elemente nicht ab.

offer_throughput
int oder <xref:azure.cosmos.ThroughputProperties.>
Erforderlich

Der bereitgestellte Durchsatz für dieses Angebot.

unique_key_policy
Erforderlich

Die Richtlinie für eindeutige Schlüssel, die auf den Container angewendet werden soll.

conflict_resolution_policy
Erforderlich

Die Konfliktlösungsrichtlinie, die auf den Container angewendet werden soll.

session_token
str

Token zur Verwendung mit Sitzungskonsistenz.

initial_headers
dict[str,str]

Anfängliche Header, die als Teil der Anforderung gesendet werden sollen.

etag
str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition
MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

analytical_storage_ttl
int

Gültigkeitsdauer des Analysespeichers für Elemente im Container. Der Wert None verlässt den analytischen Speicher, und der Wert -1 aktiviert den analytischen Speicher ohne Gültigkeitsdauer. Beachten Sie, dass analytischer Speicher nur für Synapse Link aktivierte Konten aktiviert werden kann.

Gibt zurück

Ein ContainerProxy-instance, der den neuen Container darstellt.

Rückgabetyp

ContainerProxy

Ausnahmen

CosmosHttpResponseError

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)

create_container_if_not_exists

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

id
Erforderlich

ID (Name) des zu lesenden oder zu erstellenden Containers.

partition_key
Erforderlich

Der Partitionsschlüssel, der für den Container verwendet werden soll.

indexing_policy
Erforderlich

Die Auf den Container anzuwendende Indizierungsrichtlinie.

default_ttl
Erforderlich

Standardzeit (TTL) für Elemente im Container. Wenn sie nicht angegeben sind, laufen Elemente nicht ab.

populate_query_metrics
Erforderlich

Aktivieren Sie die Rückgabe von Abfragemetriken in Antwortheadern.

offer_throughput
Erforderlich

Der bereitgestellte Durchsatz für dieses Angebot.

unique_key_policy
Erforderlich

Die Richtlinie für eindeutige Schlüssel, die auf den Container angewendet werden soll.

conflict_resolution_policy
Erforderlich

Die Konfliktlösungsrichtlinie, die auf den Container angewendet werden soll.

session_token
str

Token zur Verwendung mit Sitzungskonsistenz.

initial_headers
dict[str,str]

Anfängliche Header, die als Teil der Anforderung gesendet werden sollen.

etag
str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition
MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

analytical_storage_ttl
int

Gültigkeitsdauer des Analysespeichers für Elemente im Container. Der Wert None verlässt den analytischen Speicher, und der Wert -1 aktiviert den analytischen Speicher ohne Gültigkeitsdauer. Beachten Sie, dass analytischer Speicher nur für Synapse Link aktivierte Konten aktiviert werden kann.

Gibt zurück

Ein ContainerProxy-instance, der den Container darstellt.

Rückgabetyp

ContainerProxy

Ausnahmen

CosmosHttpResponseError

Fehler beim Lesen oder Erstellen des Containers.

create_user

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

body
Erforderlich

Ein diktierähnliches Objekt mit einem ID-Schlüssel und einem Wert, der den zu erstellenden Benutzer darstellt. Die Benutzer-ID muss innerhalb der Datenbank eindeutig sein und nicht mehr als 255 Zeichen umfassen.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Ein UserProxy-instance, der den neuen Benutzer darstellt.

Rückgabetyp

UserProxy

Ausnahmen

CosmosHttpResponseError

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

delete_container

Löschen eines Containers.

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

Parameter

container
Erforderlich

Die ID (Name) des zu löschenden Containers. Sie können entweder die ID des zu löschenden Containers, ein <xref:azure.cosmos.database.ContainerProxy> instance oder ein Diktat übergeben, das die Eigenschaften des Containers darstellt.

session_token
str

Token zur Verwendung mit Sitzungskonsistenz.

initial_headers
dict[str,str]

Anfängliche Header, die als Teil der Anforderung gesendet werden sollen.

etag
str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition
MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Rückgabetyp

None

Ausnahmen

CosmosHttpResponseError

Wenn der Container nicht gelöscht werden konnte.

delete_user

Löschen Sie den angegebenen Benutzer aus dem Container.

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

Parameter

user
Erforderlich

Die ID (Name), Diktat, die die Eigenschaften oder <xref:azure.cosmos.database.UserProxy> instance des zu löschenden Benutzers darstellt.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Rückgabetyp

None

Ausnahmen

CosmosHttpResponseError

Der Benutzer wurde nicht erfolgreich gelöscht.

CosmosResourceNotFoundError

Der Benutzer ist im Container nicht vorhanden.

get_container_client

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

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

Parameter

container
Erforderlich

Die ID (Name) des Containers, ein <xref:azure.cosmos.database.ContainerProxy> instance oder ein Diktat, das die Eigenschaften des abzurufenden Containers darstellt.

Gibt zurück

Ein ContainerProxy-instance, der die abgerufene Datenbank darstellt.

Rückgabetyp

ContainerProxy

Ausnahmen

CosmosHttpResponseError

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)

get_throughput

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

ThroughputProperties

Ausnahmen

CosmosHttpResponseError

Fehler bei der Containererstellung.

get_user_client

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

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

Parameter

user
Erforderlich

Die ID (Name), Diktat, die die Eigenschaften oder <xref:azure.cosmos.database.UserProxy> instance des abzurufenden Benutzers darstellt.

Gibt zurück

Ein UserProxy-instance, der den abgerufenen Benutzer darstellt.

Rückgabetyp

UserProxy

Ausnahmen

CosmosHttpResponseError

Fehler bei der Containererstellung.

list_containers

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

max_item_count
Erforderlich

Maximale Anzahl von Elementen, die im Enumerationsvorgang zurückgegeben werden sollen.

session_token
str

Token zur Verwendung mit Sitzungskonsistenz.

initial_headers
dict[str,str]

Anfängliche Header, die als Teil der Anforderung gesendet werden sollen.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Eine Iterable von Containereigenschaften (Diktaten).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

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

list_users

Listet alle Benutzer im Container auf.

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

Parameter

max_item_count
Erforderlich

Maximale Anzahl von Benutzern, die im Enumerationsvorgang zurückgegeben werden sollen.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Eine Iterable von Benutzereigenschaften (dicts).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Fehler bei der Containererstellung.

query_containers

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

query
Erforderlich

Die auszuführende Azure Cosmos DB-SQL-Abfrage.

parameters
Erforderlich

Optionales Array von Parametern für die Abfrage. Wird ignoriert, wenn keine Abfrage bereitgestellt wird.

max_item_count
Erforderlich

Maximale Anzahl von Elementen, die im Enumerationsvorgang zurückgegeben werden sollen.

session_token
str

Token zur Verwendung mit Sitzungskonsistenz.

initial_headers
dict[str,str]

Anfängliche Header, die als Teil der Anforderung gesendet werden sollen.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Eine Iterable von Containereigenschaften (Diktaten).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Fehler bei der Containererstellung.

query_users

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

query
Erforderlich

Die auszuführende Azure Cosmos DB-SQL-Abfrage.

parameters
Erforderlich

Optionales Array von Parametern für die Abfrage. Wird ignoriert, wenn keine Abfrage bereitgestellt wird.

max_item_count
Erforderlich

Maximale Anzahl von Benutzern, die im Enumerationsvorgang zurückgegeben werden sollen.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

Eine Iterable von Benutzereigenschaften (dicts).

Rückgabetyp

Iterable[str, Any]

Ausnahmen

CosmosHttpResponseError

Fehler bei der Containererstellung.

read

Lesen sie die Datenbankeigenschaften.

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

Parameter

session_token
str

Token zur Verwendung mit Sitzungskonsistenz.

initial_headers
dict[str,str]

Anfängliche Header, die als Teil der Anforderung gesendet werden sollen.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Rückgabetyp

Dict[<xref:Str>, Any]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene Datenbank nicht abgerufen werden konnte.

read_offer

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

ThroughputProperties

Ausnahmen

CosmosHttpResponseError

Fehler bei der Containererstellung.

replace_container

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

container
Erforderlich

Die ID (Name), ein Diktat, das die Eigenschaften oder <xref:azure.cosmos.database.ContainerProxy> instance des zu ersetzenden Containers darstellt.

partition_key
Erforderlich

Der Partitionsschlüssel, der für den Container verwendet werden soll.

indexing_policy
Erforderlich

Die Auf den Container anzuwendende Indizierungsrichtlinie.

default_ttl
Erforderlich

Standardzeit (TTL) für Elemente im Container. Wenn sie nicht angegeben sind, laufen Elemente nicht ab.

conflict_resolution_policy
Erforderlich

Die Konfliktlösungsrichtlinie, die auf den Container angewendet werden soll.

populate_query_metrics
Erforderlich

Aktivieren Sie die Rückgabe von Abfragemetriken in Antwortheadern.

session_token
str

Token zur Verwendung mit Sitzungskonsistenz.

etag
str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition
MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

initial_headers
dict[str,str]

Anfängliche Header, die als Teil der Anforderung gesendet werden sollen.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

analytical_storage_ttl
int

Gültigkeitsdauer des Analysespeichers für Elemente im Container. Der Wert None verlässt den analytischen Speicher, und der Wert -1 aktiviert den analytischen Speicher ohne Gültigkeitsdauer. Beachten Sie, dass analytischer Speicher nur für Synapse Link aktivierte Konten aktiviert werden kann.

Gibt zurück

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

Rückgabetyp

ContainerProxy

Ausnahmen

CosmosHttpResponseError

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

replace_throughput

Ersetzen Sie den Durchsatz auf Datenbankebene.

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

Parameter

throughput
Erforderlich

Der festzulegende Durchsatz (eine ganze Zahl).

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

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

Rückgabetyp

ThroughputProperties

Ausnahmen

CosmosHttpResponseError

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

replace_user

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

user
Erforderlich

Die ID (Name), ein Diktat, das die Eigenschaften oder <xref:azure.cosmos.database.UserProxy> instance des zu ersetzenden Benutzers darstellt.

body
Erforderlich

Ein diktierähnliches Objekt, das den zu ersetzenden Benutzer darstellt.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

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

Rückgabetyp

UserProxy

Ausnahmen

CosmosHttpResponseError

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

upsert_user

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

body
Erforderlich

Ein diktierähnliches Objekt, das den zu aktualisierenden oder einzufügenden Benutzer darstellt.

response_hook
Callable

Ein aufrufbarer, der mit den Antwortmetadaten aufgerufen wird.

Gibt zurück

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

Rückgabetyp

UserProxy

Ausnahmen

CosmosHttpResponseError

Wenn der angegebene Benutzer nicht durch upsertiert werden konnte.