ScriptsProxy Classe

  • Referência

Uma interface para interagir com procedimentos armazenados.

Esta classe não deve ser instanciada diretamente. Em vez disso, utilize o scripts atributo .

Herança
builtins.object
ScriptsProxy

Construtor

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

Parâmetros

client_connection
Necessário
container_link
Necessário
is_system_key
Necessário

Métodos

create_stored_procedure

Crie um novo procedimento armazenado no contentor.

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

Crie um acionador no contentor.

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

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

Para substituir um UDF existente, utilize o <xref:ContainerProxy.scripts.replace_user_defined_function> método .
delete_stored_procedure

Elimine um procedimento armazenado especificado do contentor.

Se o procedimento armazenado ainda não existir no contentor, é gerada uma exceção.
delete_trigger

Elimine um acionador especificado do contentor.

Se o acionador ainda não existir no contentor, é gerada uma exceção.
delete_user_defined_function

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

Se o UDF ainda não existir no contentor, será gerada uma exceção.
execute_stored_procedure

Execute um procedimento armazenado especificado.

Se o procedimento armazenado ainda não existir no contentor, é gerada uma exceção.
get_stored_procedure

Obtenha o procedimento armazenado identificado pelo ID.
get_trigger

Obter um acionador identificado pelo ID.
get_user_defined_function

Obter funções definidas pelo utilizador identificadas pelo ID.
list_stored_procedures

Liste todos os procedimentos armazenados no contentor.
list_triggers

Listar todos os acionadores no contentor.
list_user_defined_functions

Liste todas as funções definidas pelo utilizador no contentor.
query_stored_procedures

Devolver todos os procedimentos armazenados correspondentes à consulta especificada.
query_triggers

Devolver todos os acionadores correspondentes à consulta especificada.
query_user_defined_functions

Devolver funções definidas pelo utilizador correspondentes a uma determinada consulta.
replace_stored_procedure

Substitua um procedimento armazenado especificado no contentor.

Se o procedimento armazenado ainda não existir no contentor, é gerada uma exceção.
replace_trigger

Substitua um acionador especificado no contentor.

Se o acionador ainda não existir no contentor, é gerada uma exceção.
replace_user_defined_function

Substitua uma função definida pelo utilizador especificada no contentor.

Se o UDF ainda não existir no contentor, será gerada uma exceção.

create_stored_procedure

Crie um novo procedimento armazenado no contentor.

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

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

Parâmetros

body
Necessário

Um objeto tipo dict que representa o sproc a criar.

Devoluções

Um ditado que representa o novo procedimento armazenado.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não for possível criar o procedimento armazenado especificado.

create_trigger

Crie um acionador no contentor.

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

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

Parâmetros

body
Necessário

Um objeto tipo dict que representa o acionador a criar.

Devoluções

Um ditado que representa o novo acionador.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não foi possível criar o acionador especificado.

create_user_defined_function

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

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

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

Parâmetros

body
Necessário

Um objeto tipo dict que representa o udf a criar.

Devoluções

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

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não foi possível criar a função definida pelo utilizador.

delete_stored_procedure

Elimine um procedimento armazenado especificado do contentor.

Se o procedimento armazenado ainda não existir no contentor, é gerada uma exceção.

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

Parâmetros

sproc
Necessário

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

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O sproc não foi eliminado com êxito.

CosmosResourceNotFoundError

O sproc não existe no contentor.

delete_trigger

Elimine um acionador especificado do contentor.

Se o acionador ainda não existir no contentor, é gerada uma exceção.

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

Parâmetros

trigger
Necessário

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

Tipo de retorno

None

Exceções

CosmosHttpResponseError

O acionador não foi eliminado com êxito.

CosmosResourceNotFoundError

O acionador não existe no contentor.

delete_user_defined_function

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

Se o UDF ainda não existir no contentor, será gerada uma exceção.

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

Parâmetros

udf
Necessário

O ID (nome) ou o ditado que representa o udf a ser eliminado.

Tipo de retorno

None

Exceções

CosmosHttpResponseError

A udf não foi eliminada com êxito.

CosmosResourceNotFoundError

O UDF não existe no contentor.

execute_stored_procedure

Execute um procedimento armazenado especificado.

Se o procedimento armazenado ainda não existir no contentor, é gerada uma exceção.

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

Parâmetros

sproc
Necessário

O ID (nome) ou o ditado que representa o procedimento armazenado a ser executado.

partition_key
valor predefinido: None

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

params
valor predefinido: None

Lista de parâmetros a transmitir ao procedimento armazenado a ser executado.

enable_script_logging
bool
valor predefinido: None

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

Devoluções

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

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a execução do procedimento armazenado tiver falhado ou se o procedimento armazenado com um determinado ID não existir no contentor.

get_stored_procedure

Obtenha o procedimento armazenado identificado pelo ID.

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

Parâmetros

sproc
Necessário

O ID (nome) ou o ditado que representa o procedimento armazenado a obter.

Devoluções

Um ditado que representa o procedimento armazenado obtido.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não for possível obter o procedimento armazenado especificado.

get_trigger

Obter um acionador identificado pelo ID.

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

Parâmetros

trigger
Necessário

O ID (nome) ou o acionador que representa o acionador a obter.

Devoluções

Um ditado que representa o acionador obtido.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se não foi possível obter o acionador especificado.

get_user_defined_function

Obter funções definidas pelo utilizador identificadas pelo ID.

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

Parâmetros

udf
Necessário

O ID (nome) ou o ditado que representa o udf a obter.

Devoluções

Um ditado que representa a função definida pelo utilizador obtida.

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não foi possível obter a função definida pelo utilizador.

list_stored_procedures

Liste todos os procedimentos armazenados no contentor.

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

Parâmetros

max_item_count
int
valor predefinido: None

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

Devoluções

Iterável de procedimentos armazenados (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não for possível criar o procedimento armazenado especificado.

list_triggers

Listar todos os acionadores no contentor.

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

Parâmetros

max_item_count
valor predefinido: None

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

Devoluções

Iterável de acionadores (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não for possível criar o procedimento armazenado especificado.

list_user_defined_functions

Liste todas as funções definidas pelo utilizador no contentor.

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

Parâmetros

max_item_count
valor predefinido: None

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

Devoluções

Iterável de funções definidas pelo utilizador (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não for possível criar o procedimento armazenado especificado.

query_stored_procedures

Devolver todos os procedimentos armazenados correspondentes à consulta especificada.

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

Parâmetros

query
Necessário

A consulta SQL do Azure Cosmos DB a executar.

parameters
valor predefinido: None

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

max_item_count
valor predefinido: None

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

Devoluções

Iterável de procedimentos armazenados (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não for possível criar o procedimento armazenado especificado.

query_triggers

Devolver todos os acionadores correspondentes à consulta especificada.

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

Parâmetros

query
Necessário

A consulta SQL do Azure Cosmos DB a executar.

parameters
valor predefinido: None

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

max_item_count
valor predefinido: None

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

Devoluções

Iterável de acionadores (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não for possível criar o procedimento armazenado especificado.

query_user_defined_functions

Devolver funções definidas pelo utilizador correspondentes a uma determinada consulta.

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

Parâmetros

query
Necessário

A consulta SQL do Azure Cosmos DB a executar.

parameters
valor predefinido: None

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

max_item_count
valor predefinido: None

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

Devoluções

Iterável de funções definidas pelo utilizador (dicts).

Tipo de retorno

Iterable[dict[str, Any]]

Exceções

CosmosHttpResponseError

Se não for possível criar o procedimento armazenado especificado.

replace_stored_procedure

Substitua um procedimento armazenado especificado no contentor.

Se o procedimento armazenado ainda não existir no contentor, é gerada uma exceção.

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

Parâmetros

sproc
Necessário

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

body
Necessário

Um objeto tipo dict que representa o sproc a substituir.

Devoluções

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

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição tiver falhado ou o procedimento armazenado com um determinado ID não existir.

replace_trigger

Substitua um acionador especificado no contentor.

Se o acionador ainda não existir no contentor, é gerada uma exceção.

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

Parâmetros

trigger
Necessário

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

body
Necessário

Um objeto tipo dict que representa o acionador a substituir.

Devoluções

Um ditado que representa o acionador após a substituição.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição tiver falhado ou o acionador por um determinado ID não existir.

replace_user_defined_function

Substitua uma função definida pelo utilizador especificada no contentor.

Se o UDF ainda não existir no contentor, será gerada uma exceção.

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

Parâmetros

udf
Necessário

O ID (nome) ou o ditado que representa o udf a ser substituído.

body
Necessário

Um objeto tipo dict que representa o udf a substituir.

Devoluções

Um ditado que representa a função definida pelo utilizador após a substituição.

Tipo de retorno

dict[str, Any]

Exceções

CosmosHttpResponseError

Se a substituição tiver falhado ou a função definida pelo utilizador pelo ID especificado não existir.