ScriptsProxy Klasa

Interfejs umożliwiający interakcję z procedurami składowanymi.

Ta klasa nie powinna być tworzone bezpośrednio. Zamiast tego użyj atrybutu scripts .

Dziedziczenie

builtins.object

ScriptsProxy

Konstruktor

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

Parametry

client_connection

Wymagane

container_link

Wymagane

is_system_key

Wymagane

Metody

create_stored_procedure	Utwórz nową procedurę składowaną w kontenerze. Aby zastąpić istniejący sproc, użyj <xref:Container.scripts.replace_stored_procedure> metody .
create_trigger	Utwórz wyzwalacz w kontenerze. Aby zastąpić istniejący wyzwalacz, użyj <xref:ContainerProxy.scripts.replace_trigger> metody .
create_user_defined_function	Utwórz funkcję zdefiniowaną przez użytkownika w kontenerze. Aby zastąpić istniejącą funkcję UDF, użyj <xref:ContainerProxy.scripts.replace_user_defined_function> metody .
delete_stored_procedure	Usuń określoną procedurę składowaną z kontenera. Jeśli procedura składowana nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.
delete_trigger	Usuń określony wyzwalacz z kontenera. Jeśli wyzwalacz jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.
delete_user_defined_function	Usuń określoną funkcję zdefiniowaną przez użytkownika z kontenera. Jeśli funkcja UDF nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.
execute_stored_procedure	Wykonaj określoną procedurę składowaną. Jeśli procedura składowana nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.
get_stored_procedure	Pobierz procedurę składowaną zidentyfikowaną przez identyfikator.
get_trigger	Pobierz wyzwalacz zidentyfikowany przez identyfikator.
get_user_defined_function	Pobierz funkcje zdefiniowane przez użytkownika zidentyfikowane według identyfikatora.
list_stored_procedures	Wyświetl listę wszystkich procedur składowanych w kontenerze.
list_triggers	Wyświetl listę wszystkich wyzwalaczy w kontenerze.
list_user_defined_functions	Wyświetl listę wszystkich funkcji zdefiniowanych przez użytkownika w kontenerze.
query_stored_procedures	Zwróć wszystkie procedury składowane zgodne z danym zapytaniem.
query_triggers	Zwróć wszystkie wyzwalacze pasujące do danego zapytania.
query_user_defined_functions	Zwracanie funkcji zdefiniowanych przez użytkownika pasujących do danego zapytania.
replace_stored_procedure	Zastąp określoną procedurę składowaną w kontenerze. Jeśli procedura składowana nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.
replace_trigger	Zastąp określony wyzwalacz w kontenerze. Jeśli wyzwalacz jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.
replace_user_defined_function	Zastąp określoną funkcję zdefiniowaną przez użytkownika w kontenerze. Jeśli funkcja UDF nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.

create_stored_procedure

Utwórz nową procedurę składowaną w kontenerze.

Aby zastąpić istniejący sproc, użyj <xref:Container.scripts.replace_stored_procedure> metody .

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

Parametry

body

Wymagane

Obiekt przypominający dykt reprezentujący sproc do utworzenia.

Zwraca

Dykt reprezentujący nową procedurę składowaną.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danej procedury składowanej.

create_trigger

Utwórz wyzwalacz w kontenerze.

Aby zastąpić istniejący wyzwalacz, użyj <xref:ContainerProxy.scripts.replace_trigger> metody .

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

Parametry

body

Wymagane

Obiekt przypominający dykt reprezentujący wyzwalacz do utworzenia.

Zwraca

Dykt reprezentujący nowy wyzwalacz.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danego wyzwalacza.

create_user_defined_function

Utwórz funkcję zdefiniowaną przez użytkownika w kontenerze.

Aby zastąpić istniejącą funkcję UDF, użyj <xref:ContainerProxy.scripts.replace_user_defined_function> metody .

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

Parametry

body

Wymagane

Obiekt przypominający dykt reprezentujący funkcję udf do utworzenia.

Zwraca

Dykt reprezentujący nową funkcję zdefiniowaną przez użytkownika.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć funkcji zdefiniowanej przez użytkownika.

delete_stored_procedure

Usuń określoną procedurę składowaną z kontenera.

Jeśli procedura składowana nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.

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

Parametry

sproc

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący procedurę składowaną do usunięcia.

Typ zwracany

None

Wyjątki

CosmosHttpResponseError

Plik sproc nie został pomyślnie usunięty.

CosmosResourceNotFoundError

Obiekt sproc nie istnieje w kontenerze.

delete_trigger

Usuń określony wyzwalacz z kontenera.

Jeśli wyzwalacz jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.

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

Parametry

trigger

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący wyzwalacz do usunięcia.

Typ zwracany

None

Wyjątki

CosmosHttpResponseError

Wyzwalacz nie został pomyślnie usunięty.

CosmosResourceNotFoundError

Wyzwalacz nie istnieje w kontenerze.

delete_user_defined_function

Usuń określoną funkcję zdefiniowaną przez użytkownika z kontenera.

Jeśli funkcja UDF nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.

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

Parametry

udf

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący udf do usunięcia.

Typ zwracany

None

Wyjątki

CosmosHttpResponseError

Udf nie został pomyślnie usunięty.

CosmosResourceNotFoundError

Funkcja UDF nie istnieje w kontenerze.

execute_stored_procedure

Wykonaj określoną procedurę składowaną.

Jeśli procedura składowana nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.

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

Parametry

sproc

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący procedurę składowaną do wykonania.

partition_key

wartość domyślna: None

Określa klucz partycji, aby wskazać, na której partycji ma być wykonywany element sproc.

params

wartość domyślna: None

Lista parametrów do przekazania do procedury składowanej do wykonania.

enable_script_logging

bool

wartość domyślna: None

Włącza lub wyłącza rejestrowanie skryptów dla bieżącego żądania.

Zwraca

Wynik wykonanej procedury składowanej dla podanych parametrów.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli wykonanie procedury składowanej nie powiodło się lub jeśli procedura składowana z danym identyfikatorem nie istnieje w kontenerze.

get_stored_procedure

Pobierz procedurę składowaną zidentyfikowaną przez identyfikator.

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

Parametry

sproc

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący procedurę składowaną do pobrania.

Zwraca

Dykt reprezentujący pobraną procedurę składowaną.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można pobrać danej procedury składowanej.

get_trigger

Pobierz wyzwalacz zidentyfikowany przez identyfikator.

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

Parametry

trigger

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący wyzwalacz do pobrania.

Zwraca

Dykt reprezentujący pobrany wyzwalacz.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli nie można pobrać danego wyzwalacza.

get_user_defined_function

Pobierz funkcje zdefiniowane przez użytkownika zidentyfikowane według identyfikatora.

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

Parametry

udf

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący udf do pobrania.

Zwraca

Dykt reprezentujący pobraną funkcję zdefiniowaną przez użytkownika.

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można pobrać funkcji zdefiniowanej przez użytkownika.

list_stored_procedures

Wyświetl listę wszystkich procedur składowanych w kontenerze.

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

Parametry

max_item_count

int

wartość domyślna: None

Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.

Zwraca

Iterable procedur składowanych (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danej procedury składowanej.

list_triggers

Wyświetl listę wszystkich wyzwalaczy w kontenerze.

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

Parametry

max_item_count

wartość domyślna: None

Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.

Zwraca

Iterable wyzwalaczy (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danej procedury składowanej.

list_user_defined_functions

Wyświetl listę wszystkich funkcji zdefiniowanych przez użytkownika w kontenerze.

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

Parametry

max_item_count

wartość domyślna: None

Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.

Zwraca

Iterable funkcji zdefiniowanych przez użytkownika (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danej procedury składowanej.

query_stored_procedures

Zwróć wszystkie procedury składowane zgodne z danym zapytaniem.

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

Parametry

query

Wymagane

Zapytanie SQL usługi Azure Cosmos DB do wykonania.

parameters

wartość domyślna: None

Opcjonalna tablica parametrów zapytania. Ignorowane, jeśli nie podano kwerendy.

max_item_count

wartość domyślna: None

Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.

Zwraca

Iterable procedur składowanych (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danej procedury składowanej.

query_triggers

Zwróć wszystkie wyzwalacze pasujące do danego zapytania.

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

Parametry

query

Wymagane

Zapytanie SQL usługi Azure Cosmos DB do wykonania.

parameters

wartość domyślna: None

Opcjonalna tablica parametrów zapytania. Ignorowane, jeśli nie podano kwerendy.

max_item_count

wartość domyślna: None

Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.

Zwraca

Iterable wyzwalaczy (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danej procedury składowanej.

query_user_defined_functions

Zwracanie funkcji zdefiniowanych przez użytkownika pasujących do danego zapytania.

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

Parametry

query

Wymagane

Zapytanie SQL usługi Azure Cosmos DB do wykonania.

parameters

wartość domyślna: None

Opcjonalna tablica parametrów zapytania. Ignorowane, jeśli nie podano kwerendy.

max_item_count

wartość domyślna: None

Maksymalna liczba elementów do zwrócenia w operacji wyliczenia.

Zwraca

Iterable funkcji zdefiniowanych przez użytkownika (dykt).

Typ zwracany

Iterable[dict[str, Any]]

Wyjątki

CosmosHttpResponseError

Jeśli nie można utworzyć danej procedury składowanej.

replace_stored_procedure

Zastąp określoną procedurę składowaną w kontenerze.

Jeśli procedura składowana nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.

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

Parametry

sproc

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący procedurę składowaną do zastąpienia.

body

Wymagane

Obiekt przypominający dykt reprezentujący sproc do zastąpienia.

Zwraca

Dykt reprezentujący procedurę składowaną po zastąpieniu przeszedł.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli zamiana nie powiodła się lub procedura składowana o podanym identyfikatorze nie istnieje.

replace_trigger

Zastąp określony wyzwalacz w kontenerze.

Jeśli wyzwalacz jeszcze nie istnieje w kontenerze, zostanie zgłoszony wyjątek.

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

Parametry

trigger

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący wyzwalacz do zastąpienia.

body

Wymagane

Obiekt przypominający dykt reprezentujący wyzwalacz do zastąpienia.

Zwraca

Dykt reprezentujący wyzwalacz po zastąpieniu przeszedł.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli zamiana nie powiodła się lub wyzwalacz z danym identyfikatorem nie istnieje.

replace_user_defined_function

Zastąp określoną funkcję zdefiniowaną przez użytkownika w kontenerze.

Jeśli funkcja UDF nie istnieje jeszcze w kontenerze, zostanie zgłoszony wyjątek.

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

Parametry

udf

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący udf, który ma zostać zastąpiony.

body

Wymagane

Obiekt przypominający dykt reprezentujący funkcję udf do zastąpienia.

Zwraca

Dykt reprezentujący funkcję zdefiniowaną przez użytkownika po zastąpieniu przeszedł.

Typ zwracany

dict[str, Any]

Wyjątki

CosmosHttpResponseError

Jeśli zamiana nie powiodła się lub funkcja zdefiniowana przez użytkownika z danym identyfikatorem nie istnieje.