ScriptsProxy Classe

Uma interface para interagir com os procedimentos armazenados.

Esta aula não deve ser instantânea diretamente. Em vez disso, use o scripts atributo.

Herança

builtins.object

ScriptsProxy

Construtor

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

Parâmetros

container

client_connection

container_link

Métodos

create_stored_procedure	Crie um novo procedimento armazenado no recipiente. Para substituir um procedimento armazenado existente, utilize o <xref:Container.scripts.replace_stored_procedure> método.
create_trigger	Crie um gatilho no recipiente. Para substituir um gatilho existente, utilize o <xref:ContainerProxy.scripts.replace_trigger> método.
create_user_defined_function	Crie uma função definida pelo utilizador no recipiente. Para substituir uma função definida pelo utilizador existente, utilize o <xref:ContainerProxy.scripts.replace_user_defined_function> método.
delete_stored_procedure	Elimine um procedimento armazenado especificado do recipiente. Se o procedimento armazenado já não existir no recipiente, é levantada uma exceção.
delete_trigger	Elimine um gatilho especificado do recipiente. Se o gatilho já não existir no recipiente, é levantada uma exceção.
delete_user_defined_function	Elimine uma função definida pelo utilizador especificada do recipiente. Se a função definida pelo utilizador já não existir no recipiente, é levantada uma exceção.
execute_stored_procedure	Execute um procedimento armazenado especificado. Se o procedimento armazenado já não existir no recipiente, é levantada uma exceção.
get_stored_procedure	Obter o procedimento armazenado identificado por sproc.
get_trigger	Obter um gatilho identificado por identificação.
get_user_defined_function	Obtenha uma função definida pelo utilizador identificada por id.
list_stored_procedures	Lista todos os procedimentos armazenados no recipiente.
list_triggers	Lista todos os gatilhos no contentor.
list_user_defined_functions	Lista todas as funções definidas pelo utilizador no recipiente.
query_stored_procedures	Devolva todos os procedimentos armazenados correspondentes à consulta dada.
query_triggers	Devolva todos os gatilhos correspondentes à consulta dada.
query_user_defined_functions	Devolução as funções definidas pelo utilizador correspondem a uma determinada consulta.
replace_stored_procedure	Substitua um procedimento armazenado especificado no recipiente. Se o procedimento armazenado já não existir no recipiente, é levantada uma exceção.
replace_trigger	Substitua um gatilho especificado no recipiente. Se o gatilho já não existir no recipiente, é levantada uma exceção.
replace_user_defined_function	Substitua uma função definida pelo utilizador especificado no recipiente. Se a função definida pelo utilizador já não existir no recipiente, é levantada uma exceção.

create_stored_procedure

Crie um novo procedimento armazenado no recipiente.

Para substituir um procedimento armazenado existente, utilize o <xref:Container.scripts.replace_stored_procedure> método.

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

Parâmetros

body

Dict[str, Any]

Necessário

Um objeto semelhante a um dict que representa o procedimento armazenado para criar.

Devoluções

Um dict que representa o novo procedimento armazenado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não pudesse ser criado.

create_trigger

Crie um gatilho no recipiente.

Para substituir um gatilho existente, utilize o <xref:ContainerProxy.scripts.replace_trigger> método.

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

Parâmetros

body

Dict[str, Any]

Necessário

Um objeto dict que representa o gatilho para criar.

Devoluções

Um dict representando o novo gatilho.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o gatilho dado não pudesse ser criado.

create_user_defined_function

Crie uma função definida pelo utilizador no recipiente.

Para substituir uma função definida pelo utilizador existente, utilize o <xref:ContainerProxy.scripts.replace_user_defined_function> método.

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

Parâmetros

body

Dict[str, Any]

Necessário

Um objeto semelhante a um dict que representa a função definida pelo utilizador para criar.

Devoluções

Um dict que representa a nova função definida pelo utilizador.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a função definida pelo utilizador não puder ser criada.

delete_stored_procedure

Elimine um procedimento armazenado especificado do recipiente.

Se o procedimento armazenado já não existir no recipiente, é levantada uma exceção.

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

Parâmetros

sproc

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o procedimento armazenado a eliminar.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O procedimento armazenado não foi apagado com sucesso.

CosmosResourceNotFoundError

O procedimento armazenado não existe no recipiente.

delete_trigger

Elimine um gatilho especificado do recipiente.

Se o gatilho já não existir no recipiente, é levantada uma exceção.

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

Parâmetros

trigger

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o gatilho a ser eliminado.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O gatilho não foi apagado com sucesso.

CosmosResourceNotFoundError

O gatilho não existe no recipiente.

delete_user_defined_function

Elimine uma função definida pelo utilizador especificada do recipiente.

Se a função definida pelo utilizador já não existir no recipiente, é levantada uma exceção.

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

Parâmetros

udf

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o udf a eliminar.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O udf não foi apagado com sucesso.

CosmosResourceNotFoundError

O UDF não existe no contentor.

execute_stored_procedure

Execute um procedimento armazenado especificado.

Se o procedimento armazenado já não existir no recipiente, é levantada uma exceção.

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

Parâmetros

sproc

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o procedimento armazenado a executar.

partition_key

Union[str, int, float, bool]

Especifica a chave de partição para indicar em que partição o procedimento armazenado deve ser executado.

parameters

List[Dict[str, Any]]

Lista de parâmetros a passar para o procedimento armazenado a executar.

enable_script_logging

bool

Permite ou desativa o registo de scripts para o pedido atual.

Devoluções

Resultado do procedimento armazenado executado para os parâmetros determinados.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a execução do procedimento armazenado falhar ou se o procedimento armazenado com identificação dada não existir no recipiente.

get_stored_procedure

Obter o procedimento armazenado identificado por sproc.

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

Parâmetros

sproc

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o procedimento armazenado para recuperar.

Devoluções

Um dict que representa o procedimento armazenado recuperado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não puder ser recuperado.

get_trigger

Obter um gatilho identificado por identificação.

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

Parâmetros

trigger

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o gatilho para recuperar.

Devoluções

Um dict representando o gatilho recuperado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o gatilho dado não pudesse ser recuperado.

get_user_defined_function

Obtenha uma função definida pelo utilizador identificada por id.

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

Parâmetros

udf

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o udf para recuperar.

Devoluções

Um dict que representa a função definida pelo utilizador recuperado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a função definida pelo utilizador não puder ser recuperada.

list_stored_procedures

Lista todos os procedimentos armazenados no recipiente.

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

Parâmetros

max_item_count

int

Número máximo de itens a devolver na operação de enumeração.

Devoluções

Um AsyncItemPaged de procedimentos armazenados (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não pudesse ser criado.

list_triggers

Lista todos os gatilhos no contentor.

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

Parâmetros

max_item_count

int

Número máximo de itens a devolver na operação de enumeração.

Devoluções

Um AsyncItemPaged de gatilhos (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não pudesse ser criado.

list_user_defined_functions

Lista todas as funções definidas pelo utilizador no recipiente.

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

Parâmetros

max_item_count

int

Número máximo de itens a devolver na operação de enumeração.

Devoluções

Um AsyncItemPaged de funções definidas pelo utilizador (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não pudesse ser criado.

query_stored_procedures

Devolva todos os procedimentos armazenados correspondentes à consulta dada.

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

Parâmetros

query

Union[str, Dict[str, Any]]

Necessário

A consulta Azure Cosmos DB SQL para executar.

parameters

List[Dict[str, Any]]

Matriz opcional de parâmetros para a consulta. Ignorado se não for fornecida qualquer consulta.

max_item_count

int

Número máximo de itens a devolver na operação de enumeração.

Devoluções

Um AsyncItemPaged de procedimentos armazenados (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não pudesse ser criado.

query_triggers

Devolva todos os gatilhos correspondentes à consulta dada.

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

Parâmetros

query

Union[str, Dict[str, Any]]

Necessário

A consulta Azure Cosmos DB SQL para executar.

parameters

List[Dict[str, Any]]

Matriz opcional de parâmetros para a consulta. Ignorado se não for fornecida qualquer consulta.

max_item_count

int

Número máximo de itens a devolver na operação de enumeração.

Devoluções

Um AsyncItemPaged de gatilhos (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não pudesse ser criado.

query_user_defined_functions

Devolução as funções definidas pelo utilizador correspondem a uma determinada consulta.

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

Parâmetros

query

Union[str, Dict[str, Any]]

Necessário

A consulta Azure Cosmos DB SQL para executar.

parameters

List[Dict[str, Any]]

Matriz opcional de parâmetros para a consulta. Ignorado se não for fornecida qualquer consulta.

max_item_count

int

Número máximo de itens a devolver na operação de enumeração.

Devoluções

Um AsyncItemPaged de funções definidas pelo utilizador (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado não pudesse ser criado.

replace_stored_procedure

Substitua um procedimento armazenado especificado no recipiente.

Se o procedimento armazenado já não existir no recipiente, é levantada uma exceção.

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

Parâmetros

sproc

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o procedimento armazenado a substituir.

body

Dict[str, Any]

Necessário

Um objeto semelhante a um dict que representa o procedimento armazenado para substituir.

Devoluções

Um dict que representa o procedimento armazenado após a substituição foi aprovado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição falhar ou o procedimento armazenado com identificação dada não existir.

replace_trigger

Substitua um gatilho especificado no recipiente.

Se o gatilho já não existir no recipiente, é levantada uma exceção.

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

Parâmetros

trigger

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa o gatilho a ser substituído.

body

Dict[str, Any]

Necessário

Um objeto dict que representa o gatilho para substituir.

Devoluções

Um dict que representa o gatilho depois de substituído.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição falhar ou o gatilho com identificação dada não existir.

replace_user_defined_function

Substitua uma função definida pelo utilizador especificado no recipiente.

Se a função definida pelo utilizador já não existir no recipiente, é levantada uma exceção.

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

Parâmetros

udf

Union[str, Dict[str, Any]]

Necessário

O ID (nome) ou dict que representa a função definida pelo utilizador a ser substituído.

body

Dict[str, Any]

Necessário

Um objeto dict que representa o udf para substituir.

Devoluções

Um dict que representa a função definida pelo utilizador após a substituição foi através.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição falhar ou a função definida pelo utilizador com o id dado não existir.