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

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

コンテナーに新しいストアド プロシージャを作成します。

既存の sproc を置き換えるには、 メソッドを使用します <xref:Container.scripts.replace_stored_procedure> 。

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

パラメーター

body
必須

作成する sproc を表す dict に似たオブジェクト。

戻り値

新しいストアド プロシージャを表す dict。

の戻り値の型 :

例外

指定されたストアド プロシージャを作成できなかった場合。

create_trigger

コンテナーにトリガーを作成します。

既存のトリガーを置き換えるには、 メソッドを使用します <xref:ContainerProxy.scripts.replace_trigger> 。

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

パラメーター

body
必須

作成するトリガーを表す dict に似たオブジェクト。

戻り値

新しいトリガーを表すディクテーション。

の戻り値の型 :

例外

指定されたトリガーを作成できなかった場合。

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。

の戻り値の型 :

例外

ユーザー定義関数を作成できなかった場合。

delete_stored_procedure

指定したストアド プロシージャをコンテナーから削除します。

ストアド プロシージャがまだコンテナーに存在しない場合は、例外が発生します。

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

パラメーター

sproc
必須

削除するストアド プロシージャを表す ID (名前) または dict。

の戻り値の型 :

例外

sproc が正常に削除されませんでした。

sproc はコンテナーに存在しません。

delete_trigger

指定したトリガーをコンテナーから削除します。

トリガーがまだコンテナーに存在しない場合は、例外が発生します。

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

パラメーター

trigger
必須

削除するトリガーを表す ID (名前) または dict。

の戻り値の型 :

例外

トリガーが正常に削除されませんでした。

トリガーがコンテナーに存在しません。

delete_user_defined_function

指定したユーザー定義関数をコンテナーから削除します。

UDF がまだコンテナーに存在しない場合は、例外が発生します。

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

パラメーター

udf
必須

削除する udf を表す ID (名前) または dict。

の戻り値の型 :

例外

udf が正常に削除されませんでした。

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 (名前) または dict。

partition_key
既定値: None

sproc を実行するパーティションを示すパーティション キーを指定します。

params
既定値: None

実行するストアド プロシージャに渡されるパラメーターの一覧。

enable_script_logging
bool
既定値: None

現在の要求のスクリプト ログを有効または無効にします。

戻り値

指定されたパラメーターに対して実行されたストアド プロシージャの結果。

の戻り値の型 :

例外

ストアド プロシージャの実行に失敗した場合、または指定された ID を持つストアド プロシージャがコンテナーに存在しない場合。

get_stored_procedure

id で識別されるストアド プロシージャを取得します。

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

パラメーター

sproc
必須

取得するストアド プロシージャを表す ID (名前) または dict。

戻り値

取得したストアド プロシージャを表す dict。

の戻り値の型 :

例外

指定されたストアド プロシージャを取得できなかった場合。

get_trigger

id で識別されるトリガーを取得 します

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

パラメーター

trigger
必須

取得するトリガーを表す ID (名前) または dict。

戻り値

取得したトリガーを表すディクテーション。

の戻り値の型 :

例外

指定されたトリガーを取得できなかった場合。

get_user_defined_function

id で識別されるユーザー定義関数を取得 します

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

パラメーター

udf
必須

取得する udf を表す ID (名前) または dict。

戻り値

取得したユーザー定義関数を表す dict。

の戻り値の型 :

例外

ユーザー定義関数を取得できなかった場合。

list_stored_procedures

コンテナー内のすべてのストアド プロシージャを一覧表示します。

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

パラメーター

max_item_count
int
既定値: None

列挙操作で返されるアイテムの最大数。

戻り値

ストアド プロシージャ (ディクテーション) の Iterable。

の戻り値の型 :

例外

指定されたストアド プロシージャを作成できなかった場合。

list_triggers

コンテナー内のすべてのトリガーを一覧表示します。

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

パラメーター

max_item_count
既定値: None

列挙操作で返されるアイテムの最大数。

戻り値

トリガー (ディクテーション) の Iterable。

の戻り値の型 :

例外

指定されたストアド プロシージャを作成できなかった場合。

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。

の戻り値の型 :

例外

指定されたストアド プロシージャを作成できなかった場合。

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。

の戻り値の型 :

例外

指定されたストアド プロシージャを作成できなかった場合。

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。

の戻り値の型 :

例外

指定されたストアド プロシージャを作成できなかった場合。

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。

の戻り値の型 :

例外

指定されたストアド プロシージャを作成できなかった場合。

replace_stored_procedure

コンテナー内の指定したストアド プロシージャを置き換えます。

ストアド プロシージャがまだコンテナーに存在しない場合は、例外が発生します。

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

パラメーター

sproc
必須

置き換えるストアド プロシージャを表す ID (名前) または dict。

body
必須

置換する sproc を表す dict に似たオブジェクト。

戻り値

置換後のストアド プロシージャを表すディクテーションが完了しました。

の戻り値の型 :

例外

置換に失敗した場合、または指定された ID を持つストアド プロシージャが存在しない場合。

replace_trigger

コンテナー内の指定したトリガーを置き換えます。

トリガーがまだコンテナーに存在しない場合は、例外が発生します。

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

パラメーター

trigger
必須

置き換えるトリガーを表す ID (名前) または dict。

body
必須

置換するトリガーを表す dict に似たオブジェクト。

戻り値

置換が完了した後のトリガーを表すディクテーション。

の戻り値の型 :

例外

置換に失敗した場合、または指定された 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 (名前) または dict。

body
必須

置換する udf を表す dict に似たオブジェクト。

戻り値

置換後のユーザー定義関数を表す dict が実行されます。

の戻り値の型 :

例外

置換に失敗した場合、または指定された ID を持つユーザー定義関数が存在しない場合。