ScriptsProxy Classe

Interfaccia da interagire con stored procedure.

Questa classe non deve essere creata direttamente. Usare invece l'attributo scripts .

Ereditarietà

builtins.object

ScriptsProxy

Costruttore

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

Parametri

client_connection

Necessario

container_link

Necessario

is_system_key

Necessario

Metodi

create_stored_procedure	Creare una nuova stored procedure nel contenitore. Per sostituire uno sproc esistente, usare il <xref:Container.scripts.replace_stored_procedure> metodo .
create_trigger	Creare un trigger nel contenitore. Per sostituire un trigger esistente, usare il <xref:ContainerProxy.scripts.replace_trigger> metodo .
create_user_defined_function	Creare una funzione definita dall'utente nel contenitore. Per sostituire una funzione definita dall'utente esistente, usare il <xref:ContainerProxy.scripts.replace_user_defined_function> metodo .
delete_stored_procedure	Eliminare una stored procedure specificata dal contenitore. Se la stored procedure non esiste già nel contenitore, viene generata un'eccezione.
delete_trigger	Eliminare un trigger specificato dal contenitore. Se il trigger non esiste già nel contenitore, viene generata un'eccezione.
delete_user_defined_function	Eliminare una funzione definita dall'utente specificata dal contenitore. Se la funzione definita dall'utente non esiste già nel contenitore, viene generata un'eccezione.
execute_stored_procedure	Eseguire una stored procedure specificata. Se la stored procedure non esiste già nel contenitore, viene generata un'eccezione.
get_stored_procedure	Ottenere la stored procedure identificata dall'ID.
get_trigger	Ottenere un trigger identificato dall'ID.
get_user_defined_function	Ottenere funzioni definite dall'utente identificate dall'ID.
list_stored_procedures	Elencare tutte le stored procedure nel contenitore.
list_triggers	Elencare tutti i trigger nel contenitore.
list_user_defined_functions	Elencare tutte le funzioni definite dall'utente nel contenitore.
query_stored_procedures	Restituisce tutte le stored procedure corrispondenti alla query specificata.
query_triggers	Restituisce tutti i trigger corrispondenti alla query specificata.
query_user_defined_functions	Restituisce funzioni definite dall'utente corrispondenti a una determinata query.
replace_stored_procedure	Sostituire una stored procedure specificata nel contenitore. Se la stored procedure non esiste già nel contenitore, viene generata un'eccezione.
replace_trigger	Sostituire un trigger specificato nel contenitore. Se il trigger non esiste già nel contenitore, viene generata un'eccezione.
replace_user_defined_function	Sostituire una funzione definita dall'utente specificata nel contenitore. Se la funzione UDF non esiste già nel contenitore, viene generata un'eccezione.

create_stored_procedure

Creare una nuova stored procedure nel contenitore.

Per sostituire uno sproc esistente, usare il <xref:Container.scripts.replace_stored_procedure> metodo .

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

Parametri

body

Necessario

Oggetto dict-like che rappresenta lo sproc da creare.

Restituisce

Oggetto dict che rappresenta la nuova stored procedure.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la stored procedure specificata.

create_trigger

Creare un trigger nel contenitore.

Per sostituire un trigger esistente, usare il <xref:ContainerProxy.scripts.replace_trigger> metodo .

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

Parametri

body

Necessario

Oggetto simile a ct che rappresenta il trigger da creare.

Restituisce

Oggetto dict che rappresenta il nuovo trigger.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare il trigger specificato.

create_user_defined_function

Creare una funzione definita dall'utente nel contenitore.

Per sostituire una funzione definita dall'utente esistente, usare il <xref:ContainerProxy.scripts.replace_user_defined_function> metodo .

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

Parametri

body

Necessario

Oggetto dict-like che rappresenta la funzione definita dall'utente da creare.

Restituisce

Oggetto dict che rappresenta la nuova funzione definita dall'utente.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la funzione definita dall'utente.

delete_stored_procedure

Eliminare una stored procedure specificata dal contenitore.

Se la stored procedure non esiste già nel contenitore, viene generata un'eccezione.

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

Parametri

sproc

Necessario

ID (nome) o dict che rappresenta la stored procedure da eliminare.

Tipo restituito

None

Eccezioni

CosmosHttpResponseError

Lo sproc non è stato eliminato correttamente.

CosmosResourceNotFoundError

Lo sproc non esiste nel contenitore.

delete_trigger

Eliminare un trigger specificato dal contenitore.

Se il trigger non esiste già nel contenitore, viene generata un'eccezione.

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

Parametri

trigger

Necessario

ID (nome) o dict che rappresenta il trigger da eliminare.

Tipo restituito

None

Eccezioni

CosmosHttpResponseError

Il trigger non è stato eliminato correttamente.

CosmosResourceNotFoundError

Il trigger non esiste nel contenitore.

delete_user_defined_function

Eliminare una funzione definita dall'utente specificata dal contenitore.

Se la funzione definita dall'utente non esiste già nel contenitore, viene generata un'eccezione.

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

Parametri

udf

Necessario

ID (nome) o dict che rappresenta la funzione definita dall'utente da eliminare.

Tipo restituito

None

Eccezioni

CosmosHttpResponseError

La funzione definita dall'utente non è stata eliminata correttamente.

CosmosResourceNotFoundError

La funzione definita dall'utente non esiste nel contenitore.

execute_stored_procedure

Eseguire una stored procedure specificata.

Se la stored procedure non esiste già nel contenitore, viene generata un'eccezione.

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

Parametri

sproc

Necessario

ID (nome) o dict che rappresenta la stored procedure da eseguire.

partition_key

valore predefinito: None

Specifica la chiave di partizione per indicare la partizione in cui deve essere eseguita la sproc.

params

valore predefinito: None

Elenco di parametri da passare alla stored procedure da eseguire.

enable_script_logging

bool

valore predefinito: None

Abilita o disabilita la registrazione degli script per la richiesta corrente.

Restituisce

Risultato della stored procedure eseguita per i parametri specificati.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se l'esecuzione della stored procedure non è riuscita o se la stored procedure con ID specificato non esiste nel contenitore.

get_stored_procedure

Ottenere la stored procedure identificata dall'ID.

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

Parametri

sproc

Necessario

ID (nome) o dict che rappresenta la stored procedure da recuperare.

Restituisce

Oggetto dict che rappresenta la stored procedure recuperata.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile recuperare la stored procedure specificata.

get_trigger

Ottenere un trigger identificato dall'ID.

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

Parametri

trigger

Necessario

ID (nome) o dict che rappresenta il trigger da recuperare.

Restituisce

Oggetto dict che rappresenta il trigger recuperato.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile recuperare il trigger specificato.

get_user_defined_function

Ottenere funzioni definite dall'utente identificate dall'ID.

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

Parametri

udf

Necessario

ID (nome) o dict che rappresenta la funzione definita dall'utente da recuperare.

Restituisce

Dict che rappresenta la funzione definita dall'utente recuperata.

Tipo restituito

Iterable[dict[str, Any]]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile recuperare la funzione definita dall'utente.

list_stored_procedures

Elencare tutte le stored procedure nel contenitore.

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

Parametri

max_item_count

int

valore predefinito: None

Numero massimo di elementi da restituire nell'operazione di enumerazione.

Restituisce

Iterabile di stored procedure (dict).

Tipo restituito

Iterable[dict[str, Any]]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la stored procedure specificata.

list_triggers

Elencare tutti i trigger nel contenitore.

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

Parametri

max_item_count

valore predefinito: None

Numero massimo di elementi da restituire nell'operazione di enumerazione.

Restituisce

Iterabile di trigger (dict).

Tipo restituito

Iterable[dict[str, Any]]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la stored procedure specificata.

list_user_defined_functions

Elencare tutte le funzioni definite dall'utente nel contenitore.

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

Parametri

max_item_count

valore predefinito: None

Numero massimo di elementi da restituire nell'operazione di enumerazione.

Restituisce

Iterabile di funzioni definite dall'utente (dict).

Tipo restituito

Iterable[dict[str, Any]]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la stored procedure specificata.

query_stored_procedures

Restituisce tutte le stored procedure corrispondenti alla query specificata.

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

Parametri

query

Necessario

Query SQL di Azure Cosmos DB da eseguire.

parameters

valore predefinito: None

Matrice facoltativa di parametri per la query. Ignorato se non viene specificata alcuna query.

max_item_count

valore predefinito: None

Numero massimo di elementi da restituire nell'operazione di enumerazione.

Restituisce

Iterabile di stored procedure (dict).

Tipo restituito

Iterable[dict[str, Any]]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la stored procedure specificata.

query_triggers

Restituisce tutti i trigger corrispondenti alla query specificata.

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

Parametri

query

Necessario

Query SQL di Azure Cosmos DB da eseguire.

parameters

valore predefinito: None

Matrice facoltativa di parametri per la query. Ignorato se non viene specificata alcuna query.

max_item_count

valore predefinito: None

Numero massimo di elementi da restituire nell'operazione di enumerazione.

Restituisce

Iterabile di trigger (dict).

Tipo restituito

Iterable[dict[str, Any]]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la stored procedure specificata.

query_user_defined_functions

Restituisce funzioni definite dall'utente corrispondenti a una determinata query.

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

Parametri

query

Necessario

Query SQL di Azure Cosmos DB da eseguire.

parameters

valore predefinito: None

Matrice facoltativa di parametri per la query. Ignorato se non viene specificata alcuna query.

max_item_count

valore predefinito: None

Numero massimo di elementi da restituire nell'operazione di enumerazione.

Restituisce

Iterabile di funzioni definite dall'utente (dict).

Tipo restituito

Iterable[dict[str, Any]]

Eccezioni

CosmosHttpResponseError

Se non è stato possibile creare la stored procedure specificata.

replace_stored_procedure

Sostituire una stored procedure specificata nel contenitore.

Se la stored procedure non esiste già nel contenitore, viene generata un'eccezione.

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

Parametri

sproc

Necessario

ID (nome) o dict che rappresenta la stored procedure da sostituire.

body

Necessario

Oggetto dict-like che rappresenta lo sproc da sostituire.

Restituisce

Oggetto dict che rappresenta la stored procedure dopo che è stata sostituita.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se la sostituzione non è riuscita o la stored procedure con id specificato non esiste.

replace_trigger

Sostituire un trigger specificato nel contenitore.

Se il trigger non esiste già nel contenitore, viene generata un'eccezione.

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

Parametri

trigger

Necessario

ID (nome) o dict che rappresenta il trigger da sostituire.

body

Necessario

Oggetto dict-like che rappresenta il trigger da sostituire.

Restituisce

Valore dict che rappresenta il trigger dopo il passaggio della sostituzione.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se la sostituzione non è riuscita o il trigger con id specificato non esiste.

replace_user_defined_function

Sostituire una funzione definita dall'utente specificata nel contenitore.

Se la funzione UDF non esiste già nel contenitore, viene generata un'eccezione.

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

Parametri

udf

Necessario

ID (nome) o dict che rappresenta la funzione definita dall'utente da sostituire.

body

Necessario

Oggetto dict-like che rappresenta la funzione definita dall'utente da sostituire.

Restituisce

Un dict che rappresenta la funzione definita dall'utente dopo aver eseguito la sostituzione.

Tipo restituito

dict[str, Any]

Eccezioni

CosmosHttpResponseError

Se la sostituzione non è riuscita o la funzione definita dall'utente con l'ID specificato non esiste.