ScriptsProxy Klasa

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

Nie należy bezpośrednio utworzyć wystąpienia tej klasy. Zamiast tego użyj atrybutu scripts .

Dziedziczenie

builtins.object

ScriptsProxy

Konstruktor

ScriptsProxy(container: ContainerProxy, client_connection: CosmosClientConnection, container_link: str)

Parametry

container

client_connection

container_link

Metody

create_stored_procedure	Utwórz nową procedurę składowaną w kontenerze. Aby zastąpić istniejącą procedurę składowaną, 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ę zdefiniowaną przez użytkownika, 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 zdefiniowana przez użytkownika nie istnieje jeszcze w kontenerze, zgłaszany jest 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 element sproc.
get_trigger	Pobierz wyzwalacz zidentyfikowany według identyfikatora.
get_user_defined_function	Pobierz zdefiniowaną przez użytkownika funkcję zidentyfikowaną przez identyfikator.
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 pasujące do danego zapytania.
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 zdefiniowana przez użytkownika nie istnieje jeszcze w kontenerze, zgłaszany jest wyjątek.

create_stored_procedure

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

Aby zastąpić istniejącą procedurę składowaną, użyj <xref:Container.scripts.replace_stored_procedure> metody .

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

Parametry

body

Dict[str, Any]

Wymagane

Obiekt przypominający dykt reprezentujący procedurę składowaną 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 .

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

Parametry

body

Dict[str, Any]

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ę zdefiniowaną przez użytkownika, użyj <xref:ContainerProxy.scripts.replace_user_defined_function> metody .

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

Parametry

body

Dict[str, Any]

Wymagane

Obiekt przypominający dykt reprezentujący funkcję zdefiniowaną przez użytkownika 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.

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

Parametry

sproc

Union[str, Dict[str, Any]]

Wymagane

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

Typ zwracany

None

Wyjątki

CosmosHttpResponseError

Procedura składowana nie została pomyślnie usunięta.

CosmosResourceNotFoundError

Procedura składowana 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.

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

Parametry

trigger

Union[str, Dict[str, Any]]

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 zdefiniowana przez użytkownika nie istnieje jeszcze w kontenerze, zgłaszany jest wyjątek.

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

Parametry

udf

Union[str, Dict[str, Any]]

Wymagane

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

Typ zwracany

None

Wyjątki

CosmosHttpResponseError

Funkcja udf nie została pomyślnie usunięta.

CosmosResourceNotFoundError

Funkcja zdefiniowanej przez użytkownika 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.

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

Parametry

sproc

Union[str, Dict[str, Any]]

Wymagane

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

partition_key

Union[str, int, float, bool]

Określa klucz partycji, aby wskazać, na której partycji ma być wykonywana procedura składowana.

parameters

List[Dict[str, Any]]

Lista parametrów, które mają zostać przekazane do procedury składowanej do wykonania.

enable_script_logging

bool

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 o podanym identyfikatorze nie istnieje w kontenerze.

get_stored_procedure

Pobierz procedurę składowaną zidentyfikowaną przez element sproc.

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

Parametry

sproc

Union[str, Dict[str, Any]]

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 według identyfikatora.

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

Parametry

trigger

Union[str, Dict[str, Any]]

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 zdefiniowaną przez użytkownika funkcję zidentyfikowaną przez identyfikator.

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

Parametry

udf

Union[str, Dict[str, Any]]

Wymagane

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

Zwraca

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

Typ zwracany

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(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametry

max_item_count

int

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

Zwraca

Element AsyncItemPaged procedur składowanych (dykt).

Typ zwracany

<xref:AsyncItemPaged>[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(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametry

max_item_count

int

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

Zwraca

Element AsyncItemPaged wyzwalaczy (dykt).

Typ zwracany

<xref:AsyncItemPaged>[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(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametry

max_item_count

int

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

Zwraca

Element AsyncItemPaged funkcji zdefiniowanych przez użytkownika (dykt).

Typ zwracany

<xref:AsyncItemPaged>[Dict[str, Any]]

Wyjątki

CosmosHttpResponseError

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

query_stored_procedures

Zwróć wszystkie procedury składowane pasujące do danego zapytania.

query_stored_procedures(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametry

query

Union[str, Dict[str, Any]]

Wymagane

Zapytanie SQL usługi Azure Cosmos DB do wykonania.

parameters

List[Dict[str, Any]]

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

max_item_count

int

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

Zwraca

Element AsyncItemPaged procedur składowanych (dykt).

Typ zwracany

<xref:AsyncItemPaged>[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 | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametry

query

Union[str, Dict[str, Any]]

Wymagane

Zapytanie SQL usługi Azure Cosmos DB do wykonania.

parameters

List[Dict[str, Any]]

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

max_item_count

int

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

Zwraca

Element AsyncItemPaged wyzwalaczy (dykt).

Typ zwracany

<xref:AsyncItemPaged>[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 | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametry

query

Union[str, Dict[str, Any]]

Wymagane

Zapytanie SQL usługi Azure Cosmos DB do wykonania.

parameters

List[Dict[str, Any]]

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

max_item_count

int

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

Zwraca

Element AsyncItemPaged funkcji zdefiniowanych przez użytkownika (dykt).

Typ zwracany

<xref:AsyncItemPaged>[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.

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

Parametry

sproc

Union[str, Dict[str, Any]]

Wymagane

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

body

Dict[str, Any]

Wymagane

Obiekt przypominający dykt reprezentujący procedurę składowaną do zastąpienia.

Zwraca

Po zastąpieniu przeszedł dykt reprezentujący procedurę składowaną.

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.

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

Parametry

trigger

Union[str, Dict[str, Any]]

Wymagane

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

body

Dict[str, Any]

Wymagane

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

Zwraca

Po zastąpieniu przeszedł dykt reprezentujący wyzwalacz.

Typ zwracany

Dict[str, Any]

Wyjątki

CosmosHttpResponseError

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

replace_user_defined_function

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

Jeśli funkcja zdefiniowana przez użytkownika nie istnieje jeszcze w kontenerze, zgłaszany jest wyjątek.

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

Parametry

udf

Union[str, Dict[str, Any]]

Wymagane

Identyfikator (nazwa) lub dykt reprezentujący funkcję zdefiniowaną przez użytkownika do zastąpienia.

body

Dict[str, Any]

Wymagane

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

Zwraca

Po zastąpieniu przeszedł dykt reprezentujący funkcję zdefiniowaną przez użytkownika.

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.