ScriptsProxy Класс

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

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

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

builtins.object

ScriptsProxy

Конструктор

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

Параметры

client_connection

Обязательно

container_link

Обязательно

is_system_key

Обязательно

Методы

create_stored_procedure	Создайте новую хранимую процедуру в контейнере. Чтобы заменить существующий sproc, используйте <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	Получите хранимую процедуру , определяемую идентификатором.
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

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

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

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

Параметры

body

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

create_trigger

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

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

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

Параметры

body

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

create_user_defined_function

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

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

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

Параметры

body

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

delete_stored_procedure

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

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

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

Параметры

sproc

Обязательно

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

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

None

Исключения

CosmosHttpResponseError

Sproc не был успешно удален.

CosmosResourceNotFoundError

Sproc не существует в контейнере.

delete_trigger

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

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

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

Параметры

trigger

Обязательно

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

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

None

Исключения

CosmosHttpResponseError

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

CosmosResourceNotFoundError

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

delete_user_defined_function

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

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

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

Параметры

udf

Обязательно

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

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

None

Исключения

CosmosHttpResponseError

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

CosmosResourceNotFoundError

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

execute_stored_procedure

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

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

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

Параметры

sproc

Обязательно

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

partition_key

значение по умолчанию: None

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

params

значение по умолчанию: None

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

enable_script_logging

bool

значение по умолчанию: None

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

get_stored_procedure

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

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

Параметры

sproc

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

get_trigger

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

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

Параметры

trigger

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

get_user_defined_function

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

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

Параметры

udf

Обязательно

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

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

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

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

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

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

list_stored_procedures

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

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

Параметры

max_item_count

int

значение по умолчанию: None

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

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

Итератор хранимых процедур (диктов).

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

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

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

list_triggers

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

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

Параметры

max_item_count

значение по умолчанию: None

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

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

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

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

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

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

list_user_defined_functions

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

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

Параметры

max_item_count

значение по умолчанию: None

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

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

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

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

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

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

query_stored_procedures

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

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

Параметры

query

Обязательно

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

parameters

значение по умолчанию: None

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

max_item_count

значение по умолчанию: None

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

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

Итератор хранимых процедур (диктов).

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

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

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

query_triggers

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

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

Параметры

query

Обязательно

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

parameters

значение по умолчанию: None

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

max_item_count

значение по умолчанию: None

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

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

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

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

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

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

query_user_defined_functions

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

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

Параметры

query

Обязательно

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

parameters

значение по умолчанию: None

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

max_item_count

значение по умолчанию: None

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

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

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

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

Iterable[dict[str, Any]]

Исключения

CosmosHttpResponseError

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

replace_stored_procedure

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

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

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

Параметры

sproc

Обязательно

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

body

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

replace_trigger

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

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

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

Параметры

trigger

Обязательно

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

body

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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

replace_user_defined_function

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

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

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

Параметры

udf

Обязательно

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

body

Обязательно

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

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

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

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

dict[str, Any]

Исключения

CosmosHttpResponseError

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