ScriptsProxy Classe

Interface permettant d’interagir avec les procédures stockées.

Cette classe ne doit pas être instanciée directement. Utilisez plutôt l’attribut <xref:ContainerProxy.scripts> .

Héritage

builtins.object

ScriptsProxy

Constructeur

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

Paramètres

client_connection

Obligatoire

container_link

Obligatoire

is_system_key

Obligatoire

Méthodes

create_stored_procedure	Créez une procédure stockée dans le conteneur. Pour remplacer un sproc existant, utilisez la <xref:Container.scripts.replace_stored_procedure> méthode .
create_trigger	Créez un déclencheur dans le conteneur. Pour remplacer un déclencheur existant, utilisez la <xref:ContainerProxy.scripts.replace_trigger> méthode .
create_user_defined_function	Créez une fonction définie par l’utilisateur dans le conteneur. Pour remplacer une fonction UDF existante, utilisez la <xref:ContainerProxy.scripts.replace_user_defined_function> méthode .
delete_stored_procedure	Supprimez une procédure stockée spécifiée du conteneur. Si la procédure stockée n’existe pas encore dans le conteneur, une exception est levée.
delete_trigger	Supprimez un déclencheur spécifié du conteneur. Si le déclencheur n’existe pas encore dans le conteneur, une exception est levée.
delete_user_defined_function	Supprime une fonction définie par l’utilisateur spécifiée du conteneur. Si l’UDF n’existe pas encore dans le conteneur, une exception est levée.
execute_stored_procedure	Exécutez une procédure stockée spécifiée. Si la procédure stockée n’existe pas encore dans le conteneur, une exception est levée.
get_stored_procedure	Obtient la procédure stockée identifiée par id.
get_trigger	Obtenez un déclencheur identifié par id.
get_user_defined_function	Obtenez une fonction définie par l’utilisateur identifiée par id.
list_stored_procedures	Répertoriez toutes les procédures stockées dans le conteneur.
list_triggers	Répertoriez tous les déclencheurs dans le conteneur.
list_user_defined_functions	Répertorie toutes les fonctions définies par l’utilisateur dans le conteneur.
query_stored_procedures	Retourne toutes les procédures stockées correspondant à la requête donnée.
query_triggers	Retourne tous les déclencheurs correspondant à la requête donnée.
query_user_defined_functions	Retourne des fonctions définies par l’utilisateur correspondant à une requête donnée.
replace_stored_procedure	Remplacez une procédure stockée spécifiée dans le conteneur. Si la procédure stockée n’existe pas encore dans le conteneur, une exception est levée.
replace_trigger	Remplacez un déclencheur spécifié dans le conteneur. Si le déclencheur n’existe pas encore dans le conteneur, une exception est levée.
replace_user_defined_function	Remplacez une fonction définie par l’utilisateur spécifiée dans le conteneur. Si l’UDF n’existe pas encore dans le conteneur, une exception est levée.

create_stored_procedure

Créez une procédure stockée dans le conteneur.

Pour remplacer un sproc existant, utilisez la <xref:Container.scripts.replace_stored_procedure> méthode .

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

Paramètres

body

Obligatoire

Objet de type dict représentant le sproc à créer.

Retours

dict représentant la nouvelle procédure stockée.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être créée.

create_trigger

Créez un déclencheur dans le conteneur.

Pour remplacer un déclencheur existant, utilisez la <xref:ContainerProxy.scripts.replace_trigger> méthode .

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

Paramètres

body

Obligatoire

Objet de type dict représentant le déclencheur à créer.

Retours

dict représentant le nouveau déclencheur.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si le déclencheur donné n’a pas pu être créé.

create_user_defined_function

Créez une fonction définie par l’utilisateur dans le conteneur.

Pour remplacer une fonction UDF existante, utilisez la <xref:ContainerProxy.scripts.replace_user_defined_function> méthode .

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

Paramètres

body

Obligatoire

Objet de type dict représentant l’udf à créer.

Retours

dict représentant la nouvelle fonction définie par l’utilisateur.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si la fonction définie par l’utilisateur n’a pas pu être créée.

delete_stored_procedure

Supprimez une procédure stockée spécifiée du conteneur.

Si la procédure stockée n’existe pas encore dans le conteneur, une exception est levée.

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

Paramètres

sproc

Obligatoire

ID (nom) ou dict représentant la procédure stockée à supprimer.

Type de retour

None

Exceptions

CosmosHttpResponseError

Le sproc n’a pas été supprimé avec succès.

CosmosResourceNotFoundError

Le sproc n’existe pas dans le conteneur.

delete_trigger

Supprimez un déclencheur spécifié du conteneur.

Si le déclencheur n’existe pas encore dans le conteneur, une exception est levée.

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

Paramètres

trigger

Obligatoire

ID (nom) ou dict représentant le déclencheur à supprimer.

Type de retour

None

Exceptions

CosmosHttpResponseError

Le déclencheur n’a pas été supprimé avec succès.

CosmosResourceNotFoundError

Le déclencheur n’existe pas dans le conteneur.

delete_user_defined_function

Supprime une fonction définie par l’utilisateur spécifiée du conteneur.

Si l’UDF n’existe pas encore dans le conteneur, une exception est levée.

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

Paramètres

udf

Obligatoire

ID (nom) ou dict représentant udf à supprimer.

Type de retour

None

Exceptions

CosmosHttpResponseError

L’udf n’a pas été supprimé avec succès.

CosmosResourceNotFoundError

La fonction UDF n’existe pas dans le conteneur.

execute_stored_procedure

Exécutez une procédure stockée spécifiée.

Si la procédure stockée n’existe pas encore dans le conteneur, une exception est levée.

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ètres

sproc

Obligatoire

ID (nom) ou dict représentant la procédure stockée à exécuter.

partition_key

valeur par défaut: None

Spécifie la clé de partition pour indiquer la partition sur laquelle le sproc doit s’exécuter.

params

valeur par défaut: None

Liste des paramètres à passer à la procédure stockée à exécuter.

enable_script_logging

bool

valeur par défaut: None

Active ou désactive la journalisation des scripts pour la requête actuelle.

Retours

Résultat de la procédure stockée exécutée pour les paramètres donnés.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si l’exécution de la procédure stockée a échoué ou si la procédure stockée avec l’ID donné n’existe pas dans le conteneur.

get_stored_procedure

Obtient la procédure stockée identifiée par id.

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

Paramètres

sproc

Obligatoire

ID (nom) ou dict représentant la procédure stockée à récupérer.

Retours

dict représentant la procédure stockée récupérée.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être récupérée.

get_trigger

Obtenez un déclencheur identifié par id.

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

Paramètres

trigger

Obligatoire

ID (nom) ou dict représentant le déclencheur à récupérer.

Retours

dict représentant le déclencheur récupéré.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si le déclencheur donné n’a pas pu être récupéré.

get_user_defined_function

Obtenez une fonction définie par l’utilisateur identifiée par id.

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

Paramètres

udf

Obligatoire

ID (nom) ou dict représentant udf à récupérer.

Retours

dict représentant la fonction définie par l’utilisateur récupérée.

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si la fonction définie par l’utilisateur n’a pas pu être récupérée.

list_stored_procedures

Répertoriez toutes les procédures stockées dans le conteneur.

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

Paramètres

max_item_count

int

valeur par défaut: None

Nombre maximal d’éléments à retourner dans l’opération d’énumération.

Retours

Itérable de procédures stockées (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être créée.

list_triggers

Répertoriez tous les déclencheurs dans le conteneur.

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

Paramètres

max_item_count

valeur par défaut: None

Nombre maximal d’éléments à retourner dans l’opération d’énumération.

Retours

Itérable de déclencheurs (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être créée.

list_user_defined_functions

Répertorie toutes les fonctions définies par l’utilisateur dans le conteneur.

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

Paramètres

max_item_count

valeur par défaut: None

Nombre maximal d’éléments à retourner dans l’opération d’énumération.

Retours

Itérable des fonctions définies par l’utilisateur (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être créée.

query_stored_procedures

Retourne toutes les procédures stockées correspondant à la requête donnée.

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

Paramètres

query

Obligatoire

Requête SQL Azure Cosmos DB à exécuter.

parameters

valeur par défaut: None

Tableau facultatif de paramètres de la requête. Ignoré si aucune requête n’est fournie.

max_item_count

valeur par défaut: None

Nombre maximal d’éléments à retourner dans l’opération d’énumération.

Retours

Itérable de procédures stockées (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être créée.

query_triggers

Retourne tous les déclencheurs correspondant à la requête donnée.

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

Paramètres

query

Obligatoire

Requête SQL Azure Cosmos DB à exécuter.

parameters

valeur par défaut: None

Tableau facultatif de paramètres de la requête. Ignoré si aucune requête n’est fournie.

max_item_count

valeur par défaut: None

Nombre maximal d’éléments à retourner dans l’opération d’énumération.

Retours

Itérable de déclencheurs (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être créée.

query_user_defined_functions

Retourne des fonctions définies par l’utilisateur correspondant à une requête donnée.

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

Paramètres

query

Obligatoire

Requête SQL Azure Cosmos DB à exécuter.

parameters

valeur par défaut: None

Tableau facultatif de paramètres de la requête. Ignoré si aucune requête n’est fournie.

max_item_count

valeur par défaut: None

Nombre maximal d’éléments à retourner dans l’opération d’énumération.

Retours

Itérable des fonctions définies par l’utilisateur (dicts).

Type de retour

Iterable[dict[str, Any]]

Exceptions

CosmosHttpResponseError

Si la procédure stockée donnée n’a pas pu être créée.

replace_stored_procedure

Remplacez une procédure stockée spécifiée dans le conteneur.

Si la procédure stockée n’existe pas encore dans le conteneur, une exception est levée.

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

Paramètres

sproc

Obligatoire

ID (nom) ou dict représentant la procédure stockée à remplacer.

body

Obligatoire

Objet de type dict représentant le sproc à remplacer.

Retours

dict représentant la procédure stockée après l’opération de remplacement.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si le remplacement a échoué ou si la procédure stockée avec un ID donné n’existe pas.

replace_trigger

Remplacez un déclencheur spécifié dans le conteneur.

Si le déclencheur n’existe pas encore dans le conteneur, une exception est levée.

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

Paramètres

trigger

Obligatoire

ID (nom) ou dict représentant le déclencheur à remplacer.

body

Obligatoire

Objet de type dict représentant le déclencheur à remplacer.

Retours

dict représentant le déclencheur après le remplacement.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si le remplacement a échoué ou si le déclencheur avec l’ID donné n’existe pas.

replace_user_defined_function

Remplacez une fonction définie par l’utilisateur spécifiée dans le conteneur.

Si l’UDF n’existe pas encore dans le conteneur, une exception est levée.

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

Paramètres

udf

Obligatoire

ID (nom) ou dict représentant udf à remplacer.

body

Obligatoire

Objet de type dict représentant l’udf à remplacer.

Retours

dict représentant la fonction définie par l’utilisateur après l’opération de remplacement.

Type de retour

dict[str, Any]

Exceptions

CosmosHttpResponseError

Si le remplacement a échoué ou si la fonction définie par l’utilisateur avec l’ID donné n’existe pas.