ScriptsProxy Osztály

A tárolt eljárások kezelésére használható felület.

Ezt az osztályt nem szabad közvetlenül példányosítani. Ehelyett használja az scripts attribútumot.

Öröklődés

builtins.object

ScriptsProxy

Konstruktor

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

Paraméterek

client_connection

Kötelező

container_link

Kötelező

is_system_key

Kötelező

Metódusok

create_stored_procedure	Hozzon létre egy új tárolt eljárást a tárolóban. Meglévő sproc cseréjéhez használja a metódust <xref:Container.scripts.replace_stored_procedure> .
create_trigger	Hozzon létre egy eseményindítót a tárolóban. Meglévő eseményindító cseréjéhez használja a metódust <xref:ContainerProxy.scripts.replace_trigger> .
create_user_defined_function	Hozzon létre egy felhasználó által definiált függvényt a tárolóban. Meglévő UDF cseréjéhez használja a metódust <xref:ContainerProxy.scripts.replace_user_defined_function> .
delete_stored_procedure	Egy megadott tárolt eljárás törlése a tárolóból. Ha a tárolt eljárás még nem létezik a tárolóban, kivétel keletkezik.
delete_trigger	Töröljön egy adott eseményindítót a tárolóból. Ha az eseményindító még nem létezik a tárolóban, kivétel keletkezik.
delete_user_defined_function	Töröljön egy megadott, felhasználó által definiált függvényt a tárolóból. Ha az UDF még nem létezik a tárolóban, kivétel keletkezik.
execute_stored_procedure	Hajtsa végre a megadott tárolt eljárást. Ha a tárolt eljárás még nem létezik a tárolóban, kivétel keletkezik.
get_stored_procedure	Kérje le az azonosító által azonosított tárolt eljárást.
get_trigger	Az azonosító alapján azonosított eseményindító lekérése.
get_user_defined_function	Az azonosító alapján azonosított felhasználó által definiált függvények lekérése.
list_stored_procedures	A tárolóban tárolt összes eljárás listázása.
list_triggers	Listázhatja a tároló összes eseményindítóját.
list_user_defined_functions	A tárolóban található összes felhasználó által definiált függvény listázása.
query_stored_procedures	Adja vissza az adott lekérdezésnek megfelelő összes tárolt eljárást.
query_triggers	Adja vissza az adott lekérdezésnek megfelelő összes eseményindítót.
query_user_defined_functions	Egy adott lekérdezésnek megfelelő, felhasználó által definiált függvényeket ad vissza.
replace_stored_procedure	Cserélje le a tárolóban megadott tárolt eljárást. Ha a tárolt eljárás még nem létezik a tárolóban, kivétel keletkezik.
replace_trigger	Cserélje le a megadott eseményindítót a tárolóban. Ha az eseményindító még nem létezik a tárolóban, kivétel keletkezik.
replace_user_defined_function	Cserélje le a megadott felhasználó által definiált függvényt a tárolóban. Ha az UDF még nem létezik a tárolóban, kivétel keletkezik.

create_stored_procedure

Hozzon létre egy új tárolt eljárást a tárolóban.

Meglévő sproc cseréjéhez használja a metódust <xref:Container.scripts.replace_stored_procedure> .

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

Paraméterek

body

Kötelező

Egy dict-szerű objektum, amely a létrehozandó sproc objektumot jelöli.

Válaszok

Az új tárolt eljárást jelképező diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárás nem hozható létre.

create_trigger

Hozzon létre egy eseményindítót a tárolóban.

Meglévő eseményindító cseréjéhez használja a metódust <xref:ContainerProxy.scripts.replace_trigger> .

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

Paraméterek

body

Kötelező

A létrehozandó eseményindítót jelképező diktálási objektum.

Válaszok

Az új eseményindítót jelképező diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a megadott eseményindító nem hozható létre.

create_user_defined_function

Hozzon létre egy felhasználó által definiált függvényt a tárolóban.

Meglévő UDF cseréjéhez használja a metódust <xref:ContainerProxy.scripts.replace_user_defined_function> .

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

Paraméterek

body

Kötelező

A létrehozandó udf-et jelölő diktátumszerű objektum.

Válaszok

Az új, felhasználó által definiált függvényt jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a felhasználó által definiált függvény nem hozható létre.

delete_stored_procedure

Egy megadott tárolt eljárás törlése a tárolóból.

Ha a tárolt eljárás még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

sproc

Kötelező

A törölni kívánt tárolt eljárást jelölő azonosító (név) vagy diktálás.

Visszatérési típus

None

Kivételek

CosmosHttpResponseError

A sproc törlése nem sikerült.

CosmosResourceNotFoundError

A sproc nem létezik a tárolóban.

delete_trigger

Töröljön egy adott eseményindítót a tárolóból.

Ha az eseményindító még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

trigger

Kötelező

A törölni kívánt eseményindítót jelölő azonosító (név) vagy diktálás.

Visszatérési típus

None

Kivételek

CosmosHttpResponseError

Az eseményindító nem lett sikeresen törölve.

CosmosResourceNotFoundError

Az eseményindító nem létezik a tárolóban.

delete_user_defined_function

Töröljön egy megadott, felhasználó által definiált függvényt a tárolóból.

Ha az UDF még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

udf

Kötelező

A törölni kívánt udf azonosító (név) vagy diktálás.

Visszatérési típus

None

Kivételek

CosmosHttpResponseError

Az udf törlése nem sikerült.

CosmosResourceNotFoundError

Az UDF nem létezik a tárolóban.

execute_stored_procedure

Hajtsa végre a megadott tárolt eljárást.

Ha a tárolt eljárás még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

sproc

Kötelező

A végrehajtandó tárolt eljárást jelölő azonosító (név) vagy diktálás.

partition_key

alapértelmezett érték: None

Megadja a partíciókulcsot, amely jelzi, hogy a sproc melyik partíción legyen végrehajtva.

params

alapértelmezett érték: None

A végrehajtandó tárolt eljárásnak átadandó paraméterek listája.

enable_script_logging

bool

alapértelmezett érték: None

Engedélyezi vagy letiltja az aktuális kérés szkriptnaplózását.

Válaszok

A megadott paraméterekhez végrehajtott tárolt eljárás eredménye.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a tárolt eljárás végrehajtása sikertelen volt, vagy ha a megadott azonosítóval rendelkező tárolt eljárás nem létezik a tárolóban.

get_stored_procedure

Kérje le az azonosító által azonosított tárolt eljárást.

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

Paraméterek

sproc

Kötelező

A lekérni kívánt tárolt eljárást jelölő azonosító (név) vagy diktálás.

Válaszok

A lekért tárolt eljárást jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárást nem sikerült lekérni.

get_trigger

Az azonosító alapján azonosított eseményindító lekérése.

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

Paraméterek

trigger

Kötelező

A lekérni kívánt eseményindítót jelölő azonosító (név) vagy diktálás.

Válaszok

A lekért eseményindítót jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a megadott eseményindítót nem sikerült lekérni.

get_user_defined_function

Az azonosító alapján azonosított felhasználó által definiált függvények lekérése.

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

Paraméterek

udf

Kötelező

A lekérendő udf azonosító (név) vagy diktálás.

Válaszok

A lekért felhasználó által definiált függvényt jelölő diktálás.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a felhasználó által definiált függvény nem kérhető le.

list_stored_procedures

A tárolóban tárolt összes eljárás listázása.

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

Paraméterek

max_item_count

int

alapértelmezett érték: None

Az enumerálási műveletben visszaadandó elemek maximális száma.

Válaszok

Tárolt eljárások (diktálások) Iterable eleme.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárás nem hozható létre.

list_triggers

Listázhatja a tároló összes eseményindítóját.

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

Paraméterek

max_item_count

alapértelmezett érték: None

Az enumerálási műveletben visszaadandó elemek maximális száma.

Válaszok

Eseményindítók (diktálások) Iterable eleme.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárás nem hozható létre.

list_user_defined_functions

A tárolóban található összes felhasználó által definiált függvény listázása.

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

Paraméterek

max_item_count

alapértelmezett érték: None

Az enumerálási műveletben visszaadandó elemek maximális száma.

Válaszok

A felhasználó által definiált függvények (diktálások) Iterable értéke.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárás nem hozható létre.

query_stored_procedures

Adja vissza az adott lekérdezésnek megfelelő összes tárolt eljárást.

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

Paraméterek

query

Kötelező

A végrehajtandó Azure Cosmos DB SQL-lekérdezés.

parameters

alapértelmezett érték: None

Nem kötelező paramétertömb a lekérdezéshez. Figyelmen kívül hagyja, ha nincs megadva lekérdezés.

max_item_count

alapértelmezett érték: None

Az enumerálási műveletben visszaadandó elemek maximális száma.

Válaszok

Tárolt eljárások (diktálások) Iterable eleme.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárás nem hozható létre.

query_triggers

Adja vissza az adott lekérdezésnek megfelelő összes eseményindítót.

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

Paraméterek

query

Kötelező

A végrehajtandó Azure Cosmos DB SQL-lekérdezés.

parameters

alapértelmezett érték: None

Nem kötelező paramétertömb a lekérdezéshez. Figyelmen kívül hagyja, ha nincs megadva lekérdezés.

max_item_count

alapértelmezett érték: None

Az enumerálási műveletben visszaadandó elemek maximális száma.

Válaszok

Eseményindítók (diktálások) Iterable eleme.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárás nem hozható létre.

query_user_defined_functions

Egy adott lekérdezésnek megfelelő, felhasználó által definiált függvényeket ad vissza.

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

Paraméterek

query

Kötelező

A végrehajtandó Azure Cosmos DB SQL-lekérdezés.

parameters

alapértelmezett érték: None

Nem kötelező paramétertömb a lekérdezéshez. Figyelmen kívül hagyja, ha nincs megadva lekérdezés.

max_item_count

alapértelmezett érték: None

Az enumerálási műveletben visszaadandó elemek maximális száma.

Válaszok

A felhasználó által definiált függvények (diktálások) Iterable értéke.

Visszatérési típus

Iterable[dict[str, Any]]

Kivételek

CosmosHttpResponseError

Ha a megadott tárolt eljárás nem hozható létre.

replace_stored_procedure

Cserélje le a tárolóban megadott tárolt eljárást.

Ha a tárolt eljárás még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

sproc

Kötelező

A lecserélendő tárolt eljárást jelölő azonosító (név) vagy diktálás.

body

Kötelező

Egy dict-szerű objektum, amely a lecserélni kívánt sproc-t jelöli.

Válaszok

A csere után a tárolt eljárást jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a csere sikertelen volt, vagy a tárolt eljárás a megadott azonosítóval nem létezik.

replace_trigger

Cserélje le a megadott eseményindítót a tárolóban.

Ha az eseményindító még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

trigger

Kötelező

A lecserélni kívánt eseményindítót jelölő azonosító (név) vagy diktálás.

body

Kötelező

Egy dict-szerű objektum, amely a lecserélni kívánt eseményindítót jelöli.

Válaszok

A csere után az eseményindítót jelölő diktálás.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a csere sikertelen, vagy a megadott azonosítójú eseményindító nem létezik.

replace_user_defined_function

Cserélje le a megadott felhasználó által definiált függvényt a tárolóban.

Ha az UDF még nem létezik a tárolóban, kivétel keletkezik.

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

Paraméterek

udf

Kötelező

A lecserélni kívánt udf azonosító (név) vagy diktálás.

body

Kötelező

Egy dict-szerű objektum, amely a lecserélni kívánt udf-et jelöli.

Válaszok

Egy diktálás, amely a felhasználó által definiált függvényt jelöli a csere után.

Visszatérési típus

dict[str, Any]

Kivételek

CosmosHttpResponseError

Ha a csere meghiúsult, vagy a felhasználó által megadott függvény nem létezik a megadott azonosítóval.