ScriptsProxy Třída

Rozhraní pro interakci s uloženými procedurami.

Tato třída by neměla být vytvořena přímo. Místo toho použijte <xref:ContainerProxy.scripts> atribut .

Dědičnost

builtins.object

ScriptsProxy

Konstruktor

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

Parametry

client_connection

Vyžadováno

container_link

Vyžadováno

is_system_key

Vyžadováno

Metody

create_stored_procedure	V kontejneru vytvořte novou uloženou proceduru. Pokud chcete nahradit existující sproc, použijte metodu <xref:Container.scripts.replace_stored_procedure> .
create_trigger	Vytvořte trigger v kontejneru. Pokud chcete nahradit existující trigger, použijte metodu <xref:ContainerProxy.scripts.replace_trigger> .
create_user_defined_function	Vytvořte v kontejneru uživatelem definovanou funkci. Pokud chcete nahradit existující UDF, použijte metodu <xref:ContainerProxy.scripts.replace_user_defined_function> .
delete_stored_procedure	Odstraňte z kontejneru zadanou uloženou proceduru. Pokud uložená procedura ještě v kontejneru neexistuje, vyvolá se výjimka.
delete_trigger	Odstraňte z kontejneru zadanou aktivační událost. Pokud trigger v kontejneru ještě neexistuje, vyvolá se výjimka.
delete_user_defined_function	Odstraňte z kontejneru zadanou uživatelem definovanou funkci. Pokud ještě v kontejneru neexistuje objekt UDF, vyvolá se výjimka.
execute_stored_procedure	Spusťte zadanou uloženou proceduru. Pokud uložená procedura ještě v kontejneru neexistuje, vyvolá se výjimka.
get_stored_procedure	Získejte uloženou proceduru identifikovanou podle ID.
get_trigger	Získejte aktivační událost identifikovanou id.
get_user_defined_function	Získejte uživatelem definované funkce identifikované id.
list_stored_procedures	Vypíše všechny uložené procedury v kontejneru.
list_triggers	Vypíše všechny triggery v kontejneru.
list_user_defined_functions	Zobrazí seznam všech uživatelem definovaných funkcí v kontejneru.
query_stored_procedures	Vrátí všechny uložené procedury odpovídající danému dotazu.
query_triggers	Vrátí všechny triggery odpovídající danému dotazu.
query_user_defined_functions	Vrátí uživatelem definované funkce odpovídající danému dotazu.
replace_stored_procedure	Nahraďte zadanou uloženou proceduru v kontejneru. Pokud uložená procedura ještě v kontejneru neexistuje, vyvolá se výjimka.
replace_trigger	Nahraďte zadaný trigger v kontejneru. Pokud trigger v kontejneru ještě neexistuje, vyvolá se výjimka.
replace_user_defined_function	Nahraďte v kontejneru zadanou uživatelem definovanou funkci. Pokud ještě v kontejneru neexistuje objekt UDF, vyvolá se výjimka.

create_stored_procedure

V kontejneru vytvořte novou uloženou proceduru.

Pokud chcete nahradit existující sproc, použijte metodu <xref:Container.scripts.replace_stored_procedure> .

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

Parametry

body

Vyžadováno

Objekt podobný diktování představující objekt, který chcete vytvořit.

Návraty

Dikt představující novou uloženou proceduru.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se daná uložená procedura nedá vytvořit.

create_trigger

Vytvořte trigger v kontejneru.

Pokud chcete nahradit existující trigger, použijte metodu <xref:ContainerProxy.scripts.replace_trigger> .

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

Parametry

body

Vyžadováno

Objekt podobný diktování představující trigger, který se má vytvořit.

Návraty

Dikt představující novou aktivační událost.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se daný trigger nedal vytvořit.

create_user_defined_function

Vytvořte v kontejneru uživatelem definovanou funkci.

Pokud chcete nahradit existující UDF, použijte metodu <xref:ContainerProxy.scripts.replace_user_defined_function> .

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

Parametry

body

Vyžadováno

Objekt podobný diktování představující objekt uživatele, který se má vytvořit.

Návraty

Dikt představující novou uživatelem definovanou funkci.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se nepodařilo vytvořit uživatelem definovanou funkci.

delete_stored_procedure

Odstraňte z kontejneru zadanou uloženou proceduru.

Pokud uložená procedura ještě v kontejneru neexistuje, vyvolá se výjimka.

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

Parametry

sproc

Vyžadováno

ID (název) nebo diktát představující uloženou proceduru, která má být odstraněna.

Návratový typ

None

Výjimky

CosmosHttpResponseError

Sproc se úspěšně neodstranil.

CosmosResourceNotFoundError

Sproc v kontejneru neexistuje.

delete_trigger

Odstraňte z kontejneru zadanou aktivační událost.

Pokud trigger v kontejneru ještě neexistuje, vyvolá se výjimka.

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

Parametry

trigger

Vyžadováno

ID (název) nebo diktát představující aktivační událost, která se má odstranit.

Návratový typ

None

Výjimky

CosmosHttpResponseError

Trigger se úspěšně neodstranil.

CosmosResourceNotFoundError

Trigger v kontejneru neexistuje.

delete_user_defined_function

Odstraňte z kontejneru zadanou uživatelem definovanou funkci.

Pokud ještě v kontejneru neexistuje objekt UDF, vyvolá se výjimka.

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

Parametry

udf

Vyžadováno

ID (název) nebo diktát představující udf, který se má odstranit.

Návratový typ

None

Výjimky

CosmosHttpResponseError

Uživatelská identita nebyla úspěšně odstraněna.

CosmosResourceNotFoundError

UDF v kontejneru neexistuje.

execute_stored_procedure

Spusťte zadanou uloženou proceduru.

Pokud uložená procedura ještě v kontejneru neexistuje, vyvolá se výjimka.

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

Vyžadováno

ID (název) nebo diktování představující uloženou proceduru, která se má spustit.

partition_key

výchozí hodnota: None

Určuje klíč oddílu, který označuje, na kterém oddílu by se měl sproc spustit.

params

výchozí hodnota: None

Seznam parametrů, které se mají předat uložené proceduře, která se má spustit.

enable_script_logging

bool

výchozí hodnota: None

Povolí nebo zakáže protokolování skriptů pro aktuální požadavek.

Návraty

Výsledek spuštěné uložené procedury pro dané parametry.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se spuštění uložené procedury nezdařilo nebo pokud uložená procedura s daným ID v kontejneru neexistuje.

get_stored_procedure

Získejte uloženou proceduru identifikovanou podle ID.

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

Parametry

sproc

Vyžadováno

ID (název) nebo diktát představující uloženou proceduru, která se má načíst.

Návraty

Dikt představující načtenou uloženou proceduru.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se danou uloženou proceduru nepodařilo načíst.

get_trigger

Získejte aktivační událost identifikovanou id.

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

Parametry

trigger

Vyžadováno

ID (název) nebo diktát představující aktivační událost, která se má načíst.

Návraty

Dikt představující načtený trigger.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud se daný trigger nepodařilo načíst.

get_user_defined_function

Získejte uživatelem definované funkce identifikované id.

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

Parametry

udf

Vyžadováno

ID (název) nebo diktování představující udf, které se mají načíst.

Návraty

Dikt představující načtenou uživatelem definovanou funkci.

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se nepodařilo načíst uživatelem definovanou funkci.

list_stored_procedures

Vypíše všechny uložené procedury v kontejneru.

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

Parametry

max_item_count

int

výchozí hodnota: None

Maximální počet položek, které se mají vrátit v operaci výčtu.

Návraty

Iterable uložených procedur (diktátů).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se daná uložená procedura nedá vytvořit.

list_triggers

Vypíše všechny triggery v kontejneru.

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

Parametry

max_item_count

výchozí hodnota: None

Maximální počet položek, které se mají vrátit v operaci výčtu.

Návraty

Iterable of triggers (dicts).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se daná uložená procedura nedá vytvořit.

list_user_defined_functions

Zobrazí seznam všech uživatelem definovaných funkcí v kontejneru.

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

Parametry

max_item_count

výchozí hodnota: None

Maximální počet položek, které se mají vrátit v operaci výčtu.

Návraty

Iterable of user-defined functions (dicts).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se daná uložená procedura nedá vytvořit.

query_stored_procedures

Vrátí všechny uložené procedury odpovídající danému dotazu.

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

Parametry

query

Vyžadováno

Dotaz SQL služby Azure Cosmos DB, který se má spustit.

parameters

výchozí hodnota: None

Volitelné pole parametrů dotazu. Ignorováno, pokud není zadaný žádný dotaz.

max_item_count

výchozí hodnota: None

Maximální počet položek, které se mají vrátit v operaci výčtu.

Návraty

Iterable uložených procedur (diktátů).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se daná uložená procedura nedá vytvořit.

query_triggers

Vrátí všechny triggery odpovídající danému dotazu.

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

Parametry

query

Vyžadováno

Dotaz SQL služby Azure Cosmos DB, který se má spustit.

parameters

výchozí hodnota: None

Volitelné pole parametrů dotazu. Ignorováno, pokud není zadaný žádný dotaz.

max_item_count

výchozí hodnota: None

Maximální počet položek, které se mají vrátit v operaci výčtu.

Návraty

Iterable of triggers (dicts).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se daná uložená procedura nedá vytvořit.

query_user_defined_functions

Vrátí uživatelem definované funkce odpovídající danému dotazu.

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

Vyžadováno

Dotaz SQL služby Azure Cosmos DB, který se má spustit.

parameters

výchozí hodnota: None

Volitelné pole parametrů dotazu. Ignorováno, pokud není zadaný žádný dotaz.

max_item_count

výchozí hodnota: None

Maximální počet položek, které se mají vrátit v operaci výčtu.

Návraty

Iterable of user-defined functions (dicts).

Návratový typ

Iterable[dict[str, Any]]

Výjimky

CosmosHttpResponseError

Pokud se daná uložená procedura nedá vytvořit.

replace_stored_procedure

Nahraďte zadanou uloženou proceduru v kontejneru.

Pokud uložená procedura ještě v kontejneru neexistuje, vyvolá se výjimka.

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

Parametry

sproc

Vyžadováno

ID (název) nebo diktování představující uloženou proceduru, která má být nahrazena.

body

Vyžadováno

Objekt podobný diktování představující sproc, který se má nahradit.

Návraty

Dikt představující uloženou proceduru po nahrazení prošla.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud nahrazení selhalo nebo uložená procedura s daným ID neexistuje.

replace_trigger

Nahraďte zadaný trigger v kontejneru.

Pokud trigger v kontejneru ještě neexistuje, vyvolá se výjimka.

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

Parametry

trigger

Vyžadováno

ID (název) nebo diktát představující aktivační událost, která se má nahradit.

body

Vyžadováno

Objekt podobný diktování představující aktivační událost, která se má nahradit.

Návraty

Prošel dikt, který představuje trigger po nahrazení.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud nahrazení selhalo nebo aktivační událost s daným ID neexistuje.

replace_user_defined_function

Nahraďte v kontejneru zadanou uživatelem definovanou funkci.

Pokud ještě v kontejneru neexistuje objekt UDF, vyvolá se výjimka.

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

Parametry

udf

Vyžadováno

ID (název) nebo diktát představující udf, který se má nahradit.

body

Vyžadováno

Objekt podobný diktování představující udf, který se má nahradit.

Návraty

Prošel dikt představující uživatelem definovanou funkci po nahrazení.

Návratový typ

dict[str, Any]

Výjimky

CosmosHttpResponseError

Pokud nahrazení selhalo nebo uživatelem definovaná funkce s daným ID neexistuje.