ScriptsProxy Classe

Uma interface para interagir com procedimentos armazenados.

Essa classe não deve ser instanciada 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 contêiner. Para substituir um procedimento armazenado existente, use o <xref:Container.scripts.replace_stored_procedure> método .
create_trigger	Crie um gatilho no contêiner. Para substituir um gatilho existente, use o <xref:ContainerProxy.scripts.replace_trigger> método .
create_user_defined_function	Crie uma função definida pelo usuário no contêiner. Para substituir uma função definida pelo usuário existente, use o <xref:ContainerProxy.scripts.replace_user_defined_function> método .
delete_stored_procedure	Exclua um procedimento armazenado especificado do contêiner. Se o procedimento armazenado ainda não existir no contêiner, uma exceção será gerada.
delete_trigger	Exclua um gatilho especificado do contêiner. Se o gatilho ainda não existir no contêiner, uma exceção será gerada.
delete_user_defined_function	Exclua uma função definida pelo usuário especificada do contêiner. Se a função definida pelo usuário ainda não existir no contêiner, uma exceção será gerada.
execute_stored_procedure	Execute um procedimento armazenado especificado. Se o procedimento armazenado ainda não existir no contêiner, uma exceção será gerada.
get_stored_procedure	Obtenha o procedimento armazenado identificado por sproc.
get_trigger	Obter um gatilho identificado pela ID.
get_user_defined_function	Obtenha uma função definida pelo usuário identificada pela ID.
list_stored_procedures	Liste todos os procedimentos armazenados no contêiner.
list_triggers	Liste todos os gatilhos no contêiner.
list_user_defined_functions	Liste todas as funções definidas pelo usuário no contêiner.
query_stored_procedures	Retornar todos os procedimentos armazenados correspondentes à consulta fornecida.
query_triggers	Retornar todos os gatilhos correspondentes à consulta fornecida.
query_user_defined_functions	Retornar funções definidas pelo usuário correspondentes a uma determinada consulta.
replace_stored_procedure	Substitua um procedimento armazenado especificado no contêiner. Se o procedimento armazenado ainda não existir no contêiner, uma exceção será gerada.
replace_trigger	Substitua um gatilho especificado no contêiner. Se o gatilho ainda não existir no contêiner, uma exceção será gerada.
replace_user_defined_function	Substitua uma função definida pelo usuário especificada no contêiner. Se a função definida pelo usuário ainda não existir no contêiner, uma exceção será gerada.

create_stored_procedure

Crie um novo procedimento armazenado no contêiner.

Para substituir um procedimento armazenado existente, use 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]

Obrigatório

Um objeto semelhante a um dict que representa o procedimento armazenado a ser criado.

Retornos

Um dict que representa o novo procedimento armazenado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser criado.

create_trigger

Crie um gatilho no contêiner.

Para substituir um gatilho existente, use 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]

Obrigatório

Um objeto semelhante a um dict que representa o gatilho a ser criado.

Retornos

Um dict que representa o novo gatilho.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o gatilho determinado não puder ser criado.

create_user_defined_function

Crie uma função definida pelo usuário no contêiner.

Para substituir uma função definida pelo usuário existente, use 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]

Obrigatório

Um objeto semelhante a um dict que representa a função definida pelo usuário a ser criada.

Retornos

Um dict que representa a nova função definida pelo usuário.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a função definida pelo usuário não puder ser criada.

delete_stored_procedure

Exclua um procedimento armazenado especificado do contêiner.

Se o procedimento armazenado ainda não existir no contêiner, uma exceção será gerada.

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

Parâmetros

sproc

Union[str, Dict[str, Any]]

Obrigatório

A ID (nome) ou o dict que representa o procedimento armazenado a ser excluído.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O procedimento armazenado não foi excluído com êxito.

CosmosResourceNotFoundError

O procedimento armazenado não existe no contêiner.

delete_trigger

Exclua um gatilho especificado do contêiner.

Se o gatilho ainda não existir no contêiner, uma exceção será gerada.

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

Parâmetros

trigger

Union[str, Dict[str, Any]]

Obrigatório

A ID (nome) ou o dict que representa o gatilho a ser excluído.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O gatilho não foi excluído com êxito.

CosmosResourceNotFoundError

O gatilho não existe no contêiner.

delete_user_defined_function

Exclua uma função definida pelo usuário especificada do contêiner.

Se a função definida pelo usuário ainda não existir no contêiner, uma exceção será gerada.

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

Parâmetros

udf

Union[str, Dict[str, Any]]

Obrigatório

A ID (nome) ou o dict que representa udf a ser excluído.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O udf não foi excluído com êxito.

CosmosResourceNotFoundError

A UDF não existe no contêiner.

execute_stored_procedure

Execute um procedimento armazenado especificado.

Se o procedimento armazenado ainda não existir no contêiner, uma exceção será gerada.

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

Parâmetros

sproc

Union[str, Dict[str, Any]]

Obrigatório

A ID (nome) ou o dict que representa o procedimento armazenado a ser executado.

partition_key

Union[str, int, float, bool]

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

parameters

List[Dict[str, Any]]

Lista de parâmetros a serem passados para o procedimento armazenado a ser executado.

enable_script_logging

bool

Habilita ou desabilita o log de script para a solicitação atual.

Retornos

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 falhou ou se o procedimento armazenado com determinada ID não existir no contêiner.

get_stored_procedure

Obtenha 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]]

Obrigatório

A ID (nome) ou o dict que representa o procedimento armazenado a ser recuperado.

Retornos

Um dict que representa o procedimento armazenado recuperado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser recuperado.

get_trigger

Obter um gatilho identificado pela ID.

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

Parâmetros

trigger

Union[str, Dict[str, Any]]

Obrigatório

A ID (nome) ou o dict que representa o gatilho a ser recuperado.

Retornos

Um dict que representa o gatilho recuperado.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se o gatilho determinado não puder ser recuperado.

get_user_defined_function

Obtenha uma função definida pelo usuário identificada pela ID.

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

Parâmetros

udf

Union[str, Dict[str, Any]]

Obrigatório

A ID (nome) ou o dict que representa udf a ser recuperado.

Retornos

Um dict que representa a função definida pelo usuário recuperada.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a função definida pelo usuário não puder ser recuperada.

list_stored_procedures

Liste todos os procedimentos armazenados no contêiner.

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

Parâmetros

max_item_count

int

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

Retornos

Um AsyncItemPaged de procedimentos armazenados (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser criado.

list_triggers

Liste todos os gatilhos no contêiner.

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

Parâmetros

max_item_count

int

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

Retornos

Um AsyncItemPaged de gatilhos (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser criado.

list_user_defined_functions

Liste todas as funções definidas pelo usuário no contêiner.

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

Parâmetros

max_item_count

int

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

Retornos

Um AsyncItemPaged de funções definidas pelo usuário (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser criado.

query_stored_procedures

Retornar todos os procedimentos armazenados correspondentes à consulta fornecida.

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

Parâmetros

query

Union[str, Dict[str, Any]]

Obrigatório

A consulta SQL do Azure Cosmos DB a ser executada.

parameters

List[Dict[str, Any]]

Matriz opcional de parâmetros para a consulta. Ignorado se nenhuma consulta for fornecida.

max_item_count

int

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

Retornos

Um AsyncItemPaged de procedimentos armazenados (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser criado.

query_triggers

Retornar todos os gatilhos correspondentes à consulta fornecida.

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

Parâmetros

query

Union[str, Dict[str, Any]]

Obrigatório

A consulta SQL do Azure Cosmos DB a ser executada.

parameters

List[Dict[str, Any]]

Matriz opcional de parâmetros para a consulta. Ignorado se nenhuma consulta for fornecida.

max_item_count

int

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

Retornos

Um AsyncItemPaged de gatilhos (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser criado.

query_user_defined_functions

Retornar funções definidas pelo usuário correspondentes 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]]

Obrigatório

A consulta SQL do Azure Cosmos DB a ser executada.

parameters

List[Dict[str, Any]]

Matriz opcional de parâmetros para a consulta. Ignorado se nenhuma consulta for fornecida.

max_item_count

int

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

Retornos

Um AsyncItemPaged de funções definidas pelo usuário (dicts).

Tipo de retorno

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

Exceções

CosmosHttpResponseError

Se o procedimento armazenado determinado não puder ser criado.

replace_stored_procedure

Substitua um procedimento armazenado especificado no contêiner.

Se o procedimento armazenado ainda não existir no contêiner, uma exceção será gerada.

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]]

Obrigatório

A ID (nome) ou o dict que representa o procedimento armazenado a ser substituído.

body

Dict[str, Any]

Obrigatório

Um objeto semelhante a um dict que representa o procedimento armazenado a ser substituído.

Retornos

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

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição falhar ou o procedimento armazenado com a ID fornecida não existir.

replace_trigger

Substitua um gatilho especificado no contêiner.

Se o gatilho ainda não existir no contêiner, uma exceção será gerada.

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]]

Obrigatório

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

body

Dict[str, Any]

Obrigatório

Um objeto semelhante a um dict que representa o gatilho a ser substituído.

Retornos

Um dict que representa o gatilho após a substituição.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição falhou ou o gatilho com a ID fornecida não existir.

replace_user_defined_function

Substitua uma função definida pelo usuário especificada no contêiner.

Se a função definida pelo usuário ainda não existir no contêiner, uma exceção será gerada.

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]]

Obrigatório

A ID (nome) ou o dict que representa a função definida pelo usuário a ser substituída.

body

Dict[str, Any]

Obrigatório

Um objeto semelhante a um dict que representa o udf a ser substituído.

Retornos

Um dict que representa a função definida pelo usuário após a substituição.

Tipo de retorno

Dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição falhou ou a função definida pelo usuário com a ID fornecida não existir.