ScriptsProxy Класс

Интерфейс для взаимодействия с хранимыми процедурами.

Экземпляр этого класса не следует создавать напрямую. Вместо этого используйте scripts атрибут .

Наследование

builtins.object

ScriptsProxy

Конструктор

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

Параметры

container

client_connection

container_link

Методы

create_stored_procedure	Создайте новую хранимую процедуру в контейнере. Чтобы заменить существующую хранимую процедуру, используйте <xref:Container.scripts.replace_stored_procedure> метод .
create_trigger	Создайте триггер в контейнере. Чтобы заменить существующий триггер, используйте <xref:ContainerProxy.scripts.replace_trigger> метод .
create_user_defined_function	Создайте определяемую пользователем функцию в контейнере. Чтобы заменить существующую определяемую пользователем <xref:ContainerProxy.scripts.replace_user_defined_function> функцию, используйте метод .
delete_stored_procedure	Удалите указанную хранимую процедуру из контейнера. Если хранимая процедура еще не существует в контейнере, возникает исключение.
delete_trigger	Удалите указанный триггер из контейнера. Если триггер еще не существует в контейнере, возникает исключение.
delete_user_defined_function	Удалите указанную определяемую пользователем функцию из контейнера. Если определяемая пользователем функция еще не существует в контейнере, возникает исключение.
execute_stored_procedure	Выполнение указанной хранимой процедуры. Если хранимая процедура еще не существует в контейнере, возникает исключение.
get_stored_procedure	Получите хранимую процедуру, определяемую sproc.
get_trigger	Получение триггера, определяемого идентификатором.
get_user_defined_function	Получение определяемой пользователем функции по идентификатору.
list_stored_procedures	Вывод списка всех хранимых процедур в контейнере.
list_triggers	Вывод списка всех триггеров в контейнере.
list_user_defined_functions	Вывод списка всех определяемых пользователем функций в контейнере.
query_stored_procedures	Возвращает все хранимые процедуры, соответствующие заданному запросу.
query_triggers	Возвращает все триггеры, соответствующие заданному запросу.
query_user_defined_functions	Возвращает определяемые пользователем функции, соответствующие заданному запросу.
replace_stored_procedure	Замените указанную хранимую процедуру в контейнере. Если хранимая процедура еще не существует в контейнере, возникает исключение.
replace_trigger	Замените указанный триггер в контейнере. Если триггер еще не существует в контейнере, возникает исключение.
replace_user_defined_function	Замените указанную определяемую пользователем функцию в контейнере. Если определяемая пользователем функция еще не существует в контейнере, возникает исключение.

create_stored_procedure

Создайте новую хранимую процедуру в контейнере.

Чтобы заменить существующую хранимую процедуру, используйте <xref:Container.scripts.replace_stored_procedure> метод .

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

Параметры

body

Dict[str, Any]

Обязательно

Объект, похожий на диктовку, представляющий хранимую процедуру для создания.

Возвращаемое значение

Дикт, представляющий новую хранимую процедуру.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось создать данную хранимую процедуру.

create_trigger

Создайте триггер в контейнере.

Чтобы заменить существующий триггер, используйте <xref:ContainerProxy.scripts.replace_trigger> метод .

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

Параметры

body

Dict[str, Any]

Обязательно

Объект, похожий на диктовку, представляющий создаваемый триггер.

Возвращаемое значение

Дикт, представляющий новый триггер.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось создать указанный триггер.

create_user_defined_function

Создайте определяемую пользователем функцию в контейнере.

Чтобы заменить существующую определяемую пользователем <xref:ContainerProxy.scripts.replace_user_defined_function> функцию, используйте метод .

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

Параметры

body

Dict[str, Any]

Обязательно

Объект, похожий на диктовку, представляющий определяемую пользователем функцию для создания.

Возвращаемое значение

Дикт, представляющий новую определяемую пользователем функцию.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Не удалось создать определяемую пользователем функцию.

delete_stored_procedure

Удалите указанную хранимую процедуру из контейнера.

Если хранимая процедура еще не существует в контейнере, возникает исключение.

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

Параметры

sproc

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или словарь, представляющий удаляемую хранимую процедуру.

Возвращаемый тип

None

Исключения

CosmosHttpResponseError

Хранимая процедура не была успешно удалена.

CosmosResourceNotFoundError

Хранимая процедура не существует в контейнере.

delete_trigger

Удалите указанный триггер из контейнера.

Если триггер еще не существует в контейнере, возникает исключение.

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

Параметры

trigger

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий удаляемого триггера.

Возвращаемый тип

None

Исключения

CosmosHttpResponseError

Триггер не был успешно удален.

CosmosResourceNotFoundError

Триггер не существует в контейнере.

delete_user_defined_function

Удалите указанную определяемую пользователем функцию из контейнера.

Если определяемая пользователем функция еще не существует в контейнере, возникает исключение.

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

Параметры

udf

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий удаляемую определяемую пользователем функцию.

Возвращаемый тип

None

Исключения

CosmosHttpResponseError

Определяемая пользователем функция не была успешно удалена.

CosmosResourceNotFoundError

Определяемая пользователем функция не существует в контейнере.

execute_stored_procedure

Выполнение указанной хранимой процедуры.

Если хранимая процедура еще не существует в контейнере, возникает исключение.

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

Параметры

sproc

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий хранимую процедуру для выполнения.

partition_key

Union[str, int, float, bool]

Указывает ключ секции, указывающий, в какой секции должна выполняться хранимая процедура.

parameters

List[Dict[str, Any]]

Список параметров, передаваемых хранимой процедуре для выполнения.

enable_script_logging

bool

Включает или отключает ведение журнала скрипта для текущего запроса.

Возвращаемое значение

Результат выполнения хранимой процедуры для заданных параметров.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если выполнение хранимой процедуры завершилось сбоем или если хранимая процедура с заданным идентификатором не существует в контейнере.

get_stored_procedure

Получите хранимую процедуру, определяемую sproc.

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

Параметры

sproc

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий извлекаемую хранимую процедуру.

Возвращаемое значение

Дикт, представляющий полученную хранимую процедуру.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось получить данную хранимую процедуру.

get_trigger

Получение триггера, определяемого идентификатором.

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

Параметры

trigger

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий извлекаемого триггера.

Возвращаемое значение

Дикт, представляющий полученный триггер.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось получить указанный триггер.

get_user_defined_function

Получение определяемой пользователем функции по идентификатору.

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

Параметры

udf

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий определяемую пользователем функцию.

Возвращаемое значение

Дикт, представляющий полученную определяемую пользователем функцию.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если не удалось получить определяемую пользователем функцию.

list_stored_procedures

Вывод списка всех хранимых процедур в контейнере.

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

Параметры

max_item_count

int

Максимальное количество элементов, возвращаемых в операции перечисления.

Возвращаемое значение

AsyncItemPaged хранимых процедур (dicts).

Возвращаемый тип

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

Исключения

CosmosHttpResponseError

Если не удалось создать данную хранимую процедуру.

list_triggers

Вывод списка всех триггеров в контейнере.

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

Параметры

max_item_count

int

Максимальное количество элементов, возвращаемых в операции перечисления.

Возвращаемое значение

AsyncItemPaged триггеров (диктов).

Возвращаемый тип

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

Исключения

CosmosHttpResponseError

Если не удалось создать данную хранимую процедуру.

list_user_defined_functions

Вывод списка всех определяемых пользователем функций в контейнере.

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

Параметры

max_item_count

int

Максимальное количество элементов, возвращаемых в операции перечисления.

Возвращаемое значение

AsyncItemPaged определяемых пользователем функций (диктов).

Возвращаемый тип

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

Исключения

CosmosHttpResponseError

Если не удалось создать данную хранимую процедуру.

query_stored_procedures

Возвращает все хранимые процедуры, соответствующие заданному запросу.

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

Параметры

query

Union[str, Dict[str, Any]]

Обязательно

Выполняемый SQL-запрос Azure Cosmos DB.

parameters

List[Dict[str, Any]]

Необязательный массив параметров для запроса. Игнорируется, если запрос не предоставлен.

max_item_count

int

Максимальное количество элементов, возвращаемых в операции перечисления.

Возвращаемое значение

AsyncItemPaged хранимых процедур (dicts).

Возвращаемый тип

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

Исключения

CosmosHttpResponseError

Если не удалось создать данную хранимую процедуру.

query_triggers

Возвращает все триггеры, соответствующие заданному запросу.

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

Параметры

query

Union[str, Dict[str, Any]]

Обязательно

Выполняемый SQL-запрос Azure Cosmos DB.

parameters

List[Dict[str, Any]]

Необязательный массив параметров для запроса. Игнорируется, если запрос не предоставлен.

max_item_count

int

Максимальное количество элементов, возвращаемых в операции перечисления.

Возвращаемое значение

AsyncItemPaged триггеров (диктов).

Возвращаемый тип

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

Исключения

CosmosHttpResponseError

Если не удалось создать данную хранимую процедуру.

query_user_defined_functions

Возвращает определяемые пользователем функции, соответствующие заданному запросу.

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

Параметры

query

Union[str, Dict[str, Any]]

Обязательно

Выполняемый SQL-запрос Azure Cosmos DB.

parameters

List[Dict[str, Any]]

Необязательный массив параметров для запроса. Игнорируется, если запрос не предоставлен.

max_item_count

int

Максимальное количество элементов, возвращаемых в операции перечисления.

Возвращаемое значение

AsyncItemPaged определяемых пользователем функций (диктов).

Возвращаемый тип

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

Исключения

CosmosHttpResponseError

Если не удалось создать данную хранимую процедуру.

replace_stored_procedure

Замените указанную хранимую процедуру в контейнере.

Если хранимая процедура еще не существует в контейнере, возникает исключение.

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

Параметры

sproc

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий заменяемую хранимую процедуру.

body

Dict[str, Any]

Обязательно

Объект, похожий на диктовку, представляющий заменяемую хранимую процедуру.

Возвращаемое значение

Дикт, представляющий хранимую процедуру после выполнения замены.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если произошел сбой замены или хранимая процедура с заданным идентификатором не существует.

replace_trigger

Замените указанный триггер в контейнере.

Если триггер еще не существует в контейнере, возникает исключение.

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

Параметры

trigger

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий заменяемый триггер.

body

Dict[str, Any]

Обязательно

Объект, похожий на диктовку, представляющий заменяемый триггер.

Возвращаемое значение

Дикт, представляющий триггер после завершения замены.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если произошел сбой замены или триггер с заданным идентификатором не существует.

replace_user_defined_function

Замените указанную определяемую пользователем функцию в контейнере.

Если определяемая пользователем функция еще не существует в контейнере, возникает исключение.

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

Параметры

udf

Union[str, Dict[str, Any]]

Обязательно

Идентификатор (имя) или дикт, представляющий определяемую пользователем функцию для замены.

body

Dict[str, Any]

Обязательно

Объект, похожий на диктовку, представляющий заменяемую определяемую пользователем функцию.

Возвращаемое значение

Дикт, представляющий определяемую пользователем функцию после выполнения замены.

Возвращаемый тип

Dict[str, Any]

Исключения

CosmosHttpResponseError

Если произошел сбой замены или определяемая пользователем функция с заданным идентификатором не существует.