ScriptsProxy Klass

Ett gränssnitt för att interagera med lagrade procedurer.

Den här klassen ska inte instansieras direkt. Använd i stället attributet scripts .

Arv

builtins.object

ScriptsProxy

Konstruktor

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

Parametrar

container

client_connection

container_link

Metoder

create_stored_procedure	Skapa en ny lagrad procedur i containern. Om du vill ersätta en befintlig lagrad procedur använder du <xref:Container.scripts.replace_stored_procedure> metoden .
create_trigger	Skapa en utlösare i containern. Om du vill ersätta en befintlig utlösare använder du <xref:ContainerProxy.scripts.replace_trigger> metoden .
create_user_defined_function	Skapa en användardefinierad funktion i containern. Om du vill ersätta en befintlig användardefinierad funktion använder du <xref:ContainerProxy.scripts.replace_user_defined_function> metoden .
delete_stored_procedure	Ta bort en angiven lagrad procedur från containern. Om den lagrade proceduren inte redan finns i containern utlöses ett undantag.
delete_trigger	Ta bort en angiven utlösare från containern. Om utlösaren inte redan finns i containern utlöses ett undantag.
delete_user_defined_function	Ta bort en angiven användardefinierad funktion från containern. Om den användardefinierade funktionen inte redan finns i containern utlöses ett undantag.
execute_stored_procedure	Kör en angiven lagrad procedur. Om den lagrade proceduren inte redan finns i containern utlöses ett undantag.
get_stored_procedure	Hämta den lagrade proceduren som identifieras av sproc.
get_trigger	Hämta en utlösare som identifieras med ID.
get_user_defined_function	Hämta en användardefinierad funktion som identifieras med ID.
list_stored_procedures	Visa en lista över alla lagrade procedurer i containern.
list_triggers	Visa en lista över alla utlösare i containern.
list_user_defined_functions	Visa en lista över alla användardefinierade funktioner i containern.
query_stored_procedures	Returnera alla lagrade procedurer som matchar den angivna frågan.
query_triggers	Returnera alla utlösare som matchar den angivna frågan.
query_user_defined_functions	Returnera användardefinierade funktioner som matchar en viss fråga.
replace_stored_procedure	Ersätt en angiven lagrad procedur i containern. Om den lagrade proceduren inte redan finns i containern utlöses ett undantag.
replace_trigger	Ersätt en angiven utlösare i containern. Om utlösaren inte redan finns i containern utlöses ett undantag.
replace_user_defined_function	Ersätt en angiven användardefinierad funktion i containern. Om den användardefinierade funktionen inte redan finns i containern utlöses ett undantag.

create_stored_procedure

Skapa en ny lagrad procedur i containern.

Om du vill ersätta en befintlig lagrad procedur använder du <xref:Container.scripts.replace_stored_procedure> metoden .

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

Parametrar

body

Dict[str, Any]

Obligatorisk

Ett diktaliknande objekt som representerar den lagrade proceduren som ska skapas.

Returer

En diktamen som representerar den nya lagrade proceduren.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde skapas.

create_trigger

Skapa en utlösare i containern.

Om du vill ersätta en befintlig utlösare använder du <xref:ContainerProxy.scripts.replace_trigger> metoden .

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

Parametrar

body

Dict[str, Any]

Obligatorisk

Ett diktaliknande objekt som representerar utlösaren som ska skapas.

Returer

En diktamen som representerar den nya utlösaren.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om det inte gick att skapa den angivna utlösaren.

create_user_defined_function

Skapa en användardefinierad funktion i containern.

Om du vill ersätta en befintlig användardefinierad funktion använder du <xref:ContainerProxy.scripts.replace_user_defined_function> metoden .

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

Parametrar

body

Dict[str, Any]

Obligatorisk

Ett diktaliknande objekt som representerar den användardefinierade funktion som ska skapas.

Returer

En dikta som representerar den nya användardefinierade funktionen.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om det inte gick att skapa den användardefinierade funktionen.

delete_stored_procedure

Ta bort en angiven lagrad procedur från containern.

Om den lagrade proceduren inte redan finns i containern utlöses ett undantag.

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

Parametrar

sproc

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar den lagrade proceduren som ska tas bort.

Returtyp

None

Undantag

CosmosHttpResponseError

Den lagrade proceduren har inte tagits bort.

CosmosResourceNotFoundError

Den lagrade proceduren finns inte i containern.

delete_trigger

Ta bort en angiven utlösare från containern.

Om utlösaren inte redan finns i containern utlöses ett undantag.

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

Parametrar

trigger

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar utlösaren som ska tas bort.

Returtyp

None

Undantag

CosmosHttpResponseError

Utlösaren har inte tagits bort.

CosmosResourceNotFoundError

Utlösaren finns inte i containern.

delete_user_defined_function

Ta bort en angiven användardefinierad funktion från containern.

Om den användardefinierade funktionen inte redan finns i containern utlöses ett undantag.

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

Parametrar

udf

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar udf som ska tas bort.

Returtyp

None

Undantag

CosmosHttpResponseError

Udf har inte tagits bort.

CosmosResourceNotFoundError

UDF finns inte i containern.

execute_stored_procedure

Kör en angiven lagrad procedur.

Om den lagrade proceduren inte redan finns i containern utlöses ett undantag.

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

Parametrar

sproc

Union[str, Dict[str, Any]]

Obligatorisk

ID:t (namn) eller diktamen som representerar den lagrade proceduren som ska köras.

partition_key

Union[str, int, float, bool]

Anger partitionsnyckeln för att ange vilken partition som den lagrade proceduren ska köras på.

parameters

List[Dict[str, Any]]

Lista över parametrar som ska skickas till den lagrade proceduren som ska köras.

enable_script_logging

bool

Aktiverar eller inaktiverar skriptloggning för den aktuella begäran.

Returer

Resultatet av den utförda lagrade proceduren för de angivna parametrarna.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om körningen av den lagrade proceduren misslyckades eller om den lagrade proceduren med angivet ID inte finns i containern.

get_stored_procedure

Hämta den lagrade proceduren som identifieras av sproc.

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

Parametrar

sproc

Union[str, Dict[str, Any]]

Obligatorisk

ID :t (namn) eller diktamen som representerar den lagrade procedur som ska hämtas.

Returer

En diktamen som representerar den hämtade lagrade proceduren.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde hämtas.

get_trigger

Hämta en utlösare som identifieras med ID.

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

Parametrar

trigger

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar utlösaren som ska hämtas.

Returer

En diktamen som representerar den hämtade utlösaren.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om den angivna utlösaren inte kunde hämtas.

get_user_defined_function

Hämta en användardefinierad funktion som identifieras med ID.

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

Parametrar

udf

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar udf som ska hämtas.

Returer

En diktamen som representerar den hämtade användardefinierade funktionen.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om den användardefinierade funktionen inte kunde hämtas.

list_stored_procedures

Visa en lista över alla lagrade procedurer i containern.

list_stored_procedures(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametrar

max_item_count

int

Maximalt antal objekt som ska returneras i uppräkningsåtgärden.

Returer

AsyncItemPaged med lagrade procedurer (dikteringar).

Returtyp

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

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde skapas.

list_triggers

Visa en lista över alla utlösare i containern.

list_triggers(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametrar

max_item_count

int

Maximalt antal objekt som ska returneras i uppräkningsåtgärden.

Returer

En AsyncItemPaged med utlösare (dikteringar).

Returtyp

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

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde skapas.

list_user_defined_functions

Visa en lista över alla användardefinierade funktioner i containern.

list_user_defined_functions(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

Parametrar

max_item_count

int

Maximalt antal objekt som ska returneras i uppräkningsåtgärden.

Returer

AsyncItemPaged med användardefinierade funktioner (dikteringar).

Returtyp

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

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde skapas.

query_stored_procedures

Returnera alla lagrade procedurer som matchar den angivna frågan.

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

Parametrar

query

Union[str, Dict[str, Any]]

Obligatorisk

Azure Cosmos DB SQL-frågan som ska köras.

parameters

List[Dict[str, Any]]

Valfri matris med parametrar i frågan. Ignoreras om ingen fråga har angetts.

max_item_count

int

Maximalt antal objekt som ska returneras i uppräkningsåtgärden.

Returer

AsyncItemPaged med lagrade procedurer (dikteringar).

Returtyp

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

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde skapas.

query_triggers

Returnera alla utlösare som matchar den angivna frågan.

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

Parametrar

query

Union[str, Dict[str, Any]]

Obligatorisk

Azure Cosmos DB SQL-frågan som ska köras.

parameters

List[Dict[str, Any]]

Valfri matris med parametrar i frågan. Ignoreras om ingen fråga har angetts.

max_item_count

int

Maximalt antal objekt som ska returneras i uppräkningsåtgärden.

Returer

En AsyncItemPaged med utlösare (dikteringar).

Returtyp

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

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde skapas.

query_user_defined_functions

Returnera användardefinierade funktioner som matchar en viss fråga.

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

Parametrar

query

Union[str, Dict[str, Any]]

Obligatorisk

Azure Cosmos DB SQL-frågan som ska köras.

parameters

List[Dict[str, Any]]

Valfri matris med parametrar i frågan. Ignoreras om ingen fråga har angetts.

max_item_count

int

Maximalt antal objekt som ska returneras i uppräkningsåtgärden.

Returer

AsyncItemPaged med användardefinierade funktioner (dikteringar).

Returtyp

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

Undantag

CosmosHttpResponseError

Om den angivna lagrade proceduren inte kunde skapas.

replace_stored_procedure

Ersätt en angiven lagrad procedur i containern.

Om den lagrade proceduren inte redan finns i containern utlöses ett undantag.

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

Parametrar

sproc

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar den lagrade proceduren som ska ersättas.

body

Dict[str, Any]

Obligatorisk

Ett diktaliknande objekt som representerar den lagrade procedur som ska ersättas.

Returer

En diktamen som representerar den lagrade proceduren efter ersättningen gick igenom.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om ersättningen misslyckades eller om den lagrade proceduren med angivet ID inte finns.

replace_trigger

Ersätt en angiven utlösare i containern.

Om utlösaren inte redan finns i containern utlöses ett undantag.

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

Parametrar

trigger

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar utlösaren som ska ersättas.

body

Dict[str, Any]

Obligatorisk

Ett diktaliknande objekt som representerar utlösaren som ska ersättas.

Returer

En diktamen som representerar utlösaren efter ersättningen gick igenom.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om ersättningen misslyckades eller om utlösaren med angivet ID inte finns.

replace_user_defined_function

Ersätt en angiven användardefinierad funktion i containern.

Om den användardefinierade funktionen inte redan finns i containern utlöses ett undantag.

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

Parametrar

udf

Union[str, Dict[str, Any]]

Obligatorisk

Det ID (namn) eller diktat som representerar användardefinierad funktion som ska ersättas.

body

Dict[str, Any]

Obligatorisk

Ett diktaliknande objekt som representerar den udf som ska ersättas.

Returer

En diktamen som representerar den användardefinierade funktionen efter ersättningen gick igenom.

Returtyp

Dict[str, Any]

Undantag

CosmosHttpResponseError

Om ersättningen misslyckades eller om den användardefinierade funktionen med det angivna ID:t inte finns.