ScriptsProxy Klasse

Eine Schnittstelle für die Interaktion mit gespeicherten Prozeduren.

Diese Klasse sollte nicht direkt instanziiert werden. Verwenden Sie stattdessen das scripts -Attribut.

Vererbung

builtins.object

ScriptsProxy

Konstruktor

ScriptsProxy(client_connection: CosmosClientConnection, container_link: str, is_system_key: bool)

Parameter

client_connection

Erforderlich

container_link

Erforderlich

is_system_key

Erforderlich

Methoden

create_stored_procedure	Erstellen Sie eine neue gespeicherte Prozedur im Container. Um einen vorhandenen Sproc zu ersetzen, verwenden Sie die <xref:Container.scripts.replace_stored_procedure> -Methode.
create_trigger	Erstellen Sie einen Trigger im Container. Verwenden Sie die <xref:ContainerProxy.scripts.replace_trigger> -Methode, um einen vorhandenen Trigger zu ersetzen.
create_user_defined_function	Erstellen Sie eine benutzerdefinierte Funktion im Container. Um eine vorhandene UDF zu ersetzen, verwenden Sie die <xref:ContainerProxy.scripts.replace_user_defined_function> -Methode.
delete_stored_procedure	Löschen Sie eine angegebene gespeicherte Prozedur aus dem Container. Wenn die gespeicherte Prozedur noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.
delete_trigger	Löschen Sie einen angegebenen Trigger aus dem Container. Wenn der Trigger noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.
delete_user_defined_function	Löschen Sie eine angegebene benutzerdefinierte Funktion aus dem Container. Wenn die UDF noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.
execute_stored_procedure	Führen Sie eine angegebene gespeicherte Prozedur aus. Wenn die gespeicherte Prozedur noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.
get_stored_procedure	Rufen Sie die gespeicherte Prozedur ab, die durch die ID identifiziert wird.
get_trigger	Rufen Sie einen Trigger ab, der durch die ID identifiziert wird.
get_user_defined_function	Rufen Sie eine benutzerdefinierte Funktionen ab, die durch die ID identifiziert werden.
list_stored_procedures	Listet alle gespeicherten Prozeduren im Container auf.
list_triggers	Listet alle Trigger im Container auf.
list_user_defined_functions	Listet alle benutzerdefinierten Funktionen im Container auf.
query_stored_procedures	Gibt alle gespeicherten Prozeduren zurück, die der angegebenen Abfrage entsprechen.
query_triggers	Gibt alle Trigger zurück, die der angegebenen Abfrage entsprechen.
query_user_defined_functions	Gibt benutzerdefinierte Funktionen zurück, die einer bestimmten Abfrage entsprechen.
replace_stored_procedure	Ersetzen Sie eine angegebene gespeicherte Prozedur im Container. Wenn die gespeicherte Prozedur noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.
replace_trigger	Ersetzen Sie einen angegebenen Trigger im Container. Wenn der Trigger noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.
replace_user_defined_function	Ersetzen Sie eine angegebene benutzerdefinierte Funktion im Container. Wenn die UDF noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

create_stored_procedure

Erstellen Sie eine neue gespeicherte Prozedur im Container.

Um einen vorhandenen Sproc zu ersetzen, verwenden Sie die <xref:Container.scripts.replace_stored_procedure> -Methode.

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

Parameter

body

Erforderlich

Ein dict-ähnliches Objekt, das das zu erstellende Sproc darstellt.

Gibt zurück

Ein Diktat, das die neue gespeicherte Prozedur darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht erstellt werden konnte.

create_trigger

Erstellen Sie einen Trigger im Container.

Verwenden Sie die <xref:ContainerProxy.scripts.replace_trigger> -Methode, um einen vorhandenen Trigger zu ersetzen.

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

Parameter

body

Erforderlich

Ein dict-ähnliches Objekt, das den zu erstellenden Trigger darstellt.

Gibt zurück

Ein Diktat, das den neuen Trigger darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn der angegebene Trigger nicht erstellt werden konnte.

create_user_defined_function

Erstellen Sie eine benutzerdefinierte Funktion im Container.

Um eine vorhandene UDF zu ersetzen, verwenden Sie die <xref:ContainerProxy.scripts.replace_user_defined_function> -Methode.

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

Parameter

body

Erforderlich

Ein dict-ähnliches Objekt, das die zu erstellende udf darstellt.

Gibt zurück

Ein Diktat, das die neue benutzerdefinierte Funktion darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn die benutzerdefinierte Funktion nicht erstellt werden konnte.

delete_stored_procedure

Löschen Sie eine angegebene gespeicherte Prozedur aus dem Container.

Wenn die gespeicherte Prozedur noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

delete_stored_procedure(sproc: str | Dict[str, Any], **kwargs: Any) -> None

Parameter

sproc

Erforderlich

Die ID (Name) oder das Diktat, das die zu löschende gespeicherte Prozedur darstellt.

Rückgabetyp

None

Ausnahmen

CosmosHttpResponseError

Der Sproc wurde nicht erfolgreich gelöscht.

CosmosResourceNotFoundError

Der Sproc ist im Container nicht vorhanden.

delete_trigger

Löschen Sie einen angegebenen Trigger aus dem Container.

Wenn der Trigger noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

delete_trigger(trigger: str | Dict[str, Any], **kwargs: Any) -> None

Parameter

trigger

Erforderlich

Die ID (Name) oder das Diktat, das den zu löschenden Trigger darstellt.

Rückgabetyp

None

Ausnahmen

CosmosHttpResponseError

Der Trigger wurde nicht erfolgreich gelöscht.

CosmosResourceNotFoundError

Der Trigger ist im Container nicht vorhanden.

delete_user_defined_function

Löschen Sie eine angegebene benutzerdefinierte Funktion aus dem Container.

Wenn die UDF noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

delete_user_defined_function(udf: str | Dict[str, Any], **kwargs: Any) -> None

Parameter

udf

Erforderlich

Die ID (Name) oder das Diktat, das die zu löschende udf darstellt.

Rückgabetyp

None

Ausnahmen

CosmosHttpResponseError

Die udf wurde nicht erfolgreich gelöscht.

CosmosResourceNotFoundError

Die UDF ist im Container nicht vorhanden.

execute_stored_procedure

Führen Sie eine angegebene gespeicherte Prozedur aus.

Wenn die gespeicherte Prozedur noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

execute_stored_procedure(sproc: str | Dict[str, Any], partition_key: str | None = None, params: List[Any] | None = None, enable_script_logging: bool | None = None, **kwargs: Any) -> Any

Parameter

sproc

Erforderlich

Die ID (Name) oder das Diktat, das die auszuführende gespeicherte Prozedur darstellt.

partition_key

Standardwert: None

Gibt den Partitionsschlüssel an, um anzugeben, auf welcher Partition der Sproc ausgeführt werden soll.

params

Standardwert: None

Liste der Parameter, die an die auszuführende gespeicherte Prozedur übergeben werden sollen.

enable_script_logging

bool

Standardwert: None

Aktiviert oder deaktiviert die Skriptprotokollierung für die aktuelle Anforderung.

Gibt zurück

Ergebnis der ausgeführten gespeicherten Prozedur für die angegebenen Parameter.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn bei der Ausführung der gespeicherten Prozedur ein Fehler aufgetreten ist oder wenn die gespeicherte Prozedur mit der angegebenen ID nicht im Container vorhanden ist.

get_stored_procedure

Rufen Sie die gespeicherte Prozedur ab, die durch die ID identifiziert wird.

get_stored_procedure(sproc: str | Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

sproc

Erforderlich

Die ID (Name) oder das Diktat, das die abzurufende gespeicherte Prozedur darstellt.

Gibt zurück

Ein Diktat, das die abgerufene gespeicherte Prozedur darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht abgerufen werden konnte.

get_trigger

Rufen Sie einen Trigger ab, der durch die ID identifiziert wird.

get_trigger(trigger: str | Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

trigger

Erforderlich

Die ID (Name) oder das Dict, das den abzurufenden Trigger darstellt.

Gibt zurück

Ein Diktat, das den abgerufenen Trigger darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn der angegebene Trigger nicht abgerufen werden konnte.

get_user_defined_function

Rufen Sie eine benutzerdefinierte Funktionen ab, die durch die ID identifiziert werden.

get_user_defined_function(udf: str | Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

udf

Erforderlich

Die ID (Name) oder das Diktat, das die abzurufende udf darstellt.

Gibt zurück

Ein Diktat, das die abgerufene benutzerdefinierte Funktion darstellt.

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die benutzerdefinierte Funktion nicht abgerufen werden konnte.

list_stored_procedures

Listet alle gespeicherten Prozeduren im Container auf.

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

Parameter

max_item_count

int

Standardwert: None

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

Gibt zurück

Eine Iterable von gespeicherten Prozeduren (Diktate).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht erstellt werden konnte.

list_triggers

Listet alle Trigger im Container auf.

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

Parameter

max_item_count

Standardwert: None

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

Gibt zurück

Eine Iterable von Triggern (Dicts).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht erstellt werden konnte.

list_user_defined_functions

Listet alle benutzerdefinierten Funktionen im Container auf.

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

Parameter

max_item_count

Standardwert: None

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

Gibt zurück

Eine Iterable von benutzerdefinierten Funktionen (Dicts).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht erstellt werden konnte.

query_stored_procedures

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

query_stored_procedures(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

Standardwert: None

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

max_item_count

Standardwert: None

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

Gibt zurück

Eine Iterable von gespeicherten Prozeduren (Diktate).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht erstellt werden konnte.

query_triggers

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

query_triggers(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

Standardwert: None

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

max_item_count

Standardwert: None

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

Gibt zurück

Eine Iterable von Triggern (Dicts).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht erstellt werden konnte.

query_user_defined_functions

Gibt benutzerdefinierte Funktionen zurück, die einer bestimmten Abfrage entsprechen.

query_user_defined_functions(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

Standardwert: None

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

max_item_count

Standardwert: None

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

Gibt zurück

Eine Iterable von benutzerdefinierten Funktionen (Dicts).

Rückgabetyp

Iterable[dict[str, Any]]

Ausnahmen

CosmosHttpResponseError

Wenn die angegebene gespeicherte Prozedur nicht erstellt werden konnte.

replace_stored_procedure

Ersetzen Sie eine angegebene gespeicherte Prozedur im Container.

Wenn die gespeicherte Prozedur noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

replace_stored_procedure(sproc: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

sproc

Erforderlich

Die ID (Name) oder das Diktat, das die zu ersetzende gespeicherte Prozedur darstellt.

body

Erforderlich

Ein dict-ähnliches Objekt, das den zu ersetzenden Sproc darstellt.

Gibt zurück

Ein Diktat, das die gespeicherte Prozedur nach dem Ersetzen darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn beim Ersetzen ein Fehler aufgetreten ist oder die gespeicherte Prozedur mit der angegebenen ID nicht vorhanden ist.

replace_trigger

Ersetzen Sie einen angegebenen Trigger im Container.

Wenn der Trigger noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

replace_trigger(trigger: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

trigger

Erforderlich

Die ID (Name) oder das Dict, das den zu ersetzenden Trigger darstellt.

body

Erforderlich

Ein dict-ähnliches Objekt, das den zu ersetzenden Trigger darstellt.

Gibt zurück

Ein Diktat, das den Trigger nach dem Ersetzen darstellt.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

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

replace_user_defined_function

Ersetzen Sie eine angegebene benutzerdefinierte Funktion im Container.

Wenn die UDF noch nicht im Container vorhanden ist, wird eine Ausnahme ausgelöst.

replace_user_defined_function(udf: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

udf

Erforderlich

Die ID (Name) oder das Dict, das die zu ersetzende udf darstellt.

body

Erforderlich

Ein dict-ähnliches Objekt, das die zu ersetzende udf darstellt.

Gibt zurück

Ein Diktat, das die benutzerdefinierte Funktion darstellt, nachdem das Ersetzen durchlaufen wurde.

Rückgabetyp

dict[str, Any]

Ausnahmen

CosmosHttpResponseError

Wenn beim Ersetzen ein Fehler aufgetreten ist oder die benutzerdefinierte Funktion mit der angegebenen ID nicht vorhanden ist.