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	在容器中建立使用者定義的函式。 若要取代現有的 UDF，請使用 <xref:ContainerProxy.scripts.replace_user_defined_function> 方法。
delete_stored_procedure	從容器中刪除指定的預存程式。 如果預存程式不存在於容器中，則會引發例外狀況。
delete_trigger	從容器中刪除指定的觸發程式。 如果容器中還沒有觸發程式，就會引發例外狀況。
delete_user_defined_function	從容器中刪除指定的使用者定義函式。 如果容器中還沒有任何 UDF 存在，就會引發例外狀況。
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	取代容器中的指定使用者定義函式。 如果容器中還沒有任何 UDF 存在，則會引發例外狀況。

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

在容器中建立使用者定義的函式。

若要取代現有的 UDF，請使用 <xref:ContainerProxy.scripts.replace_user_defined_function> 方法。

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

參數

body

必要

類似聽寫的物件，表示要建立的 udf。

傳回

表示新使用者定義函式的聽寫。

傳回類型

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

從容器中刪除指定的使用者定義函式。

如果容器中還沒有任何 UDF 存在，就會引發例外狀況。

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

參數

udf

必要

識別碼 (名稱) 或表示要刪除之 udf 的聽寫。

傳回類型

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

必要

識別碼 (名稱) 或聽寫，代表要執行的預存程式。

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

必要

識別碼 (名稱) 或表示要擷取之 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

必要

要執行的 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

列舉作業中要傳回的專案數目上限。

傳回

使用者定義函式的反覆運算 (聽寫) 。

傳回類型

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

取代容器中的指定使用者定義函式。

如果容器中還沒有任何 UDF 存在，則會引發例外狀況。

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

參數

udf

必要

識別碼 (名稱) 或表示要取代之 udf 的聽寫。

body

必要

類似聽寫的物件，代表要取代的 udf。

傳回

聽寫，表示取代之後的使用者定義函式。

傳回類型

dict[str, Any]

例外狀況

CosmosHttpResponseError

如果取代失敗，或具有指定識別碼的使用者定義函式不存在。