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	컨테이너에 새 저장 프로시저를 만듭니다. 기존 스프록을 바꾸려면 메서드를 <xref:Container.scripts.replace_stored_procedure> 사용합니다.
create_trigger	컨테이너에 트리거를 만듭니다. 기존 트리거를 바꾸려면 메서드를 <xref:ContainerProxy.scripts.replace_trigger> 사용합니다.
create_user_defined_function	컨테이너에 사용자 정의 함수를 만듭니다. 기존 UDF를 바꾸려면 메서드를 <xref:ContainerProxy.scripts.replace_user_defined_function> 사용합니다.
delete_stored_procedure	컨테이너에서 지정된 저장 프로시저를 삭제합니다. 컨테이너에 저장 프로시저가 아직 없는 경우 예외가 발생합니다.
delete_trigger	컨테이너에서 지정된 트리거를 삭제합니다. 트리거가 컨테이너에 아직 없는 경우 예외가 발생합니다.
delete_user_defined_function	컨테이너에서 지정된 사용자 정의 함수를 삭제합니다. UDF가 컨테이너에 아직 없는 경우 예외가 발생합니다.
execute_stored_procedure	지정된 저장 프로시저를 실행합니다. 컨테이너에 저장 프로시저가 아직 없는 경우 예외가 발생합니다.
get_stored_procedure	ID로 식별된 저장 프로시저를 가져옵니다.
get_trigger	ID로 식별된 트리거를 가져옵니다.
get_user_defined_function	ID로 식별된 사용자 정의 함수를 가져옵니다.
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	컨테이너에서 지정된 사용자 정의 함수를 바꿉 있습니다. UDF가 컨테이너에 아직 없는 경우 예외가 발생합니다.

create_stored_procedure

컨테이너에 새 저장 프로시저를 만듭니다.

기존 스프록을 바꾸려면 메서드를 <xref:Container.scripts.replace_stored_procedure> 사용합니다.

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

매개 변수

body

필수

만들 스프록을 나타내는 dict와 유사한 개체입니다.

반환

새 저장 프로시저를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

지정된 저장 프로시저를 만들 수 없는 경우

create_trigger

컨테이너에 트리거를 만듭니다.

기존 트리거를 바꾸려면 메서드를 <xref:ContainerProxy.scripts.replace_trigger> 사용합니다.

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

매개 변수

body

필수

만들 트리거를 나타내는 dict와 유사한 개체입니다.

반환

새 트리거를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

지정된 트리거를 만들 수 없는 경우

create_user_defined_function

컨테이너에 사용자 정의 함수를 만듭니다.

기존 UDF를 바꾸려면 메서드를 <xref:ContainerProxy.scripts.replace_user_defined_function> 사용합니다.

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

매개 변수

body

필수

만들 udf를 나타내는 dict와 유사한 개체입니다.

반환

새 사용자 정의 함수를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

사용자 정의 함수를 만들 수 없는 경우

delete_stored_procedure

컨테이너에서 지정된 저장 프로시저를 삭제합니다.

컨테이너에 저장 프로시저가 아직 없는 경우 예외가 발생합니다.

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

매개 변수

sproc

필수

삭제할 저장 프로시저를 나타내는 ID(이름) 또는 받아쓰기입니다.

반환 형식

None

예외

CosmosHttpResponseError

스프록이 성공적으로 삭제되지 않았습니다.

CosmosResourceNotFoundError

스프록이 컨테이너에 없습니다.

delete_trigger

컨테이너에서 지정된 트리거를 삭제합니다.

트리거가 컨테이너에 아직 없는 경우 예외가 발생합니다.

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

매개 변수

trigger

필수

삭제할 트리거를 나타내는 ID(이름) 또는 받아쓰기입니다.

반환 형식

None

예외

CosmosHttpResponseError

트리거가 성공적으로 삭제되지 않았습니다.

CosmosResourceNotFoundError

트리거가 컨테이너에 없습니다.

delete_user_defined_function

컨테이너에서 지정된 사용자 정의 함수를 삭제합니다.

UDF가 컨테이너에 아직 없는 경우 예외가 발생합니다.

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

매개 변수

udf

필수

삭제할 udf를 나타내는 ID(이름) 또는 받아쓰기입니다.

반환 형식

None

예외

CosmosHttpResponseError

udf가 성공적으로 삭제되지 않았습니다.

CosmosResourceNotFoundError

UDF가 컨테이너에 없습니다.

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

필수

실행할 저장 프로시저를 나타내는 ID(이름) 또는 받아쓰기입니다.

partition_key

기본값: None

스프록이 실행되어야 하는 파티션을 나타내는 파티션 키를 지정합니다.

params

기본값: None

실행할 저장 프로시저에 전달할 매개 변수 목록입니다.

enable_script_logging

bool

기본값: None

현재 요청에 대한 스크립트 로깅을 사용하거나 사용하지 않도록 설정합니다.

반환

지정된 매개 변수에 대해 실행된 저장 프로시저의 결과입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

저장 프로시저 실행이 실패했거나 지정된 ID가 있는 저장 프로시저가 컨테이너에 없는 경우

get_stored_procedure

ID로 식별된 저장 프로시저를 가져옵니다.

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

매개 변수

sproc

필수

검색할 저장 프로시저를 나타내는 ID(이름) 또는 받아쓰기입니다.

반환

검색된 저장 프로시저를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

지정된 저장 프로시저를 검색할 수 없는 경우

get_trigger

ID로 식별된 트리거를 가져옵니다.

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

매개 변수

trigger

필수

검색할 트리거를 나타내는 ID(이름) 또는 받아쓰기입니다.

반환

검색된 트리거를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

지정된 트리거를 검색할 수 없는 경우

get_user_defined_function

ID로 식별된 사용자 정의 함수를 가져옵니다.

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

매개 변수

udf

필수

검색할 udf를 나타내는 ID(이름) 또는 받아쓰기입니다.

반환

검색된 사용자 정의 함수를 나타내는 받아쓰기입니다.

반환 형식

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

열거형 작업에서 반환할 최대 항목 수입니다.

반환

사용자 정의 함수(dicts)의 반복 가능

반환 형식

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

필수

실행할 Azure Cosmos DB SQL 쿼리입니다.

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

필수

실행할 Azure Cosmos DB SQL 쿼리입니다.

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

필수

실행할 Azure Cosmos DB SQL 쿼리입니다.

parameters

기본값: None

쿼리에 대한 매개 변수의 선택적 배열입니다. 쿼리가 제공되지 않으면 무시됩니다.

max_item_count

기본값: None

열거형 작업에서 반환할 최대 항목 수입니다.

반환

사용자 정의 함수(dicts)의 반복 가능

반환 형식

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

필수

바꿀 저장 프로시저를 나타내는 ID(이름) 또는 받아쓰기입니다.

body

필수

바꿀 스프록을 나타내는 dict와 유사한 개체입니다.

반환

바꾸기를 통과한 후 저장 프로시저를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

바꾸기에 실패했거나 지정된 ID를 가진 저장 프로시저가 없는 경우

replace_trigger

컨테이너에서 지정된 트리거를 바꿉다.

트리거가 컨테이너에 아직 없는 경우 예외가 발생합니다.

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

매개 변수

trigger

필수

바꿀 트리거를 나타내는 ID(이름) 또는 받아쓰기입니다.

body

필수

바꿀 트리거를 나타내는 dict와 유사한 개체입니다.

반환

바꾸기를 통과한 후 트리거를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

바꾸기에 실패했거나 지정된 ID를 가진 트리거가 없는 경우

replace_user_defined_function

컨테이너에서 지정된 사용자 정의 함수를 바꿉 있습니다.

UDF가 컨테이너에 아직 없는 경우 예외가 발생합니다.

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

매개 변수

udf

필수

바꿀 udf를 나타내는 ID(이름) 또는 받아쓰기입니다.

body

필수

바꿀 udf를 나타내는 dict와 유사한 개체입니다.

반환

바꾸기를 통과한 후 사용자 정의 함수를 나타내는 받아쓰기입니다.

반환 형식

dict[str, Any]

예외

CosmosHttpResponseError

바꾸기에 실패했거나 지정된 ID를 가진 사용자 정의 함수가 없는 경우