ScriptsProxy クラス
ストアド プロシージャと対話するためのインターフェイス。
このクラスは直接インスタンス化しないでください。 代わりに、 属性を使用します scripts 。
- 継承
-
builtins.objectScriptsProxy
コンストラクター
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 |
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 |
コンテナー内の指定したユーザー定義関数を置き換えます。 ユーザー定義関数がまだコンテナーに存在しない場合は、例外が発生します。 |
create_stored_procedure
コンテナーに新しいストアド プロシージャを作成します。
既存のストアド プロシージャを置き換えるには、 メソッドを使用します <xref:Container.scripts.replace_stored_procedure> 。
async create_stored_procedure(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
新しいストアド プロシージャを表す dict。
の戻り値の型 :
例外
指定されたストアド プロシージャを作成できなかった場合。
create_trigger
コンテナーにトリガーを作成します。
既存のトリガーを置き換えるには、 メソッドを使用します <xref:ContainerProxy.scripts.replace_trigger> 。
async create_trigger(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
新しいトリガーを表すディクテーション。
の戻り値の型 :
例外
指定されたトリガーを作成できなかった場合。
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]パラメーター
戻り値
新しいユーザー定義関数を表す dict。
の戻り値の型 :
例外
ユーザー定義関数を作成できなかった場合。
delete_stored_procedure
指定したストアド プロシージャをコンテナーから削除します。
ストアド プロシージャがまだコンテナーに存在しない場合は、例外が発生します。
async delete_stored_procedure(sproc: str | Dict[str, Any], **kwargs: Any) -> Noneパラメーター
の戻り値の型 :
例外
ストアド プロシージャが正常に削除されませんでした。
ストアド プロシージャがコンテナーに存在しません。
delete_trigger
指定したトリガーをコンテナーから削除します。
トリガーがまだコンテナーに存在しない場合は、例外が発生します。
async delete_trigger(trigger: str | Dict[str, Any], **kwargs: Any) -> Noneパラメーター
の戻り値の型 :
例外
トリガーが正常に削除されませんでした。
トリガーがコンテナーに存在しません。
delete_user_defined_function
指定したユーザー定義関数をコンテナーから削除します。
ユーザー定義関数がまだコンテナーに存在しない場合は、例外が発生します。
async delete_user_defined_function(udf: str | Dict[str, Any], **kwargs: Any) -> Noneパラメーター
の戻り値の型 :
例外
udf が正常に削除されませんでした。
UDF はコンテナーに存在しません。
execute_stored_procedure
指定したストアド プロシージャを実行します。
ストアド プロシージャがまだコンテナーに存在しない場合は、例外が発生します。
async execute_stored_procedure(sproc: str | Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
- enable_script_logging
- bool
現在の要求のスクリプト ログを有効または無効にします。
戻り値
指定されたパラメーターに対して実行されたストアド プロシージャの結果。
の戻り値の型 :
例外
ストアド プロシージャの実行に失敗した場合、または指定された ID を持つストアド プロシージャがコンテナーに存在しない場合。
get_stored_procedure
sproc によって識別されるストアド プロシージャを取得します。
async get_stored_procedure(sproc: str | Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
取得したストアド プロシージャを表す dict。
の戻り値の型 :
例外
指定されたストアド プロシージャを取得できなかった場合。
get_trigger
id で識別されるトリガーを取得 します。
async get_trigger(trigger: str | Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
取得したトリガーを表すディクテーション。
の戻り値の型 :
例外
指定されたトリガーを取得できなかった場合。
get_user_defined_function
id で識別されるユーザー定義関数を取得 します。
async get_user_defined_function(udf: str | Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
取得したユーザー定義関数を表す dict。
の戻り値の型 :
例外
ユーザー定義関数を取得できなかった場合。
list_stored_procedures
コンテナー内のすべてのストアド プロシージャを一覧表示します。
list_stored_procedures(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
戻り値
ストアド プロシージャ (dicts) の AsyncItemPaged。
の戻り値の型 :
例外
指定されたストアド プロシージャを作成できなかった場合。
list_triggers
コンテナー内のすべてのトリガーを一覧表示します。
list_triggers(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
戻り値
トリガー (ディクテーション) の AsyncItemPaged。
の戻り値の型 :
例外
指定されたストアド プロシージャを作成できなかった場合。
list_user_defined_functions
コンテナー内のすべてのユーザー定義関数を一覧表示します。
list_user_defined_functions(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
戻り値
ユーザー定義関数 (dicts) の AsyncItemPaged。
の戻り値の型 :
例外
指定されたストアド プロシージャを作成できなかった場合。
query_stored_procedures
指定されたクエリに一致するすべてのストアド プロシージャを返 します。
query_stored_procedures(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
戻り値
ストアド プロシージャ (dicts) の AsyncItemPaged。
の戻り値の型 :
例外
指定されたストアド プロシージャを作成できなかった場合。
query_triggers
指定されたクエリに一致するすべてのトリガーを返 します。
query_triggers(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
戻り値
トリガー (ディクテーション) の AsyncItemPaged。
の戻り値の型 :
例外
指定されたストアド プロシージャを作成できなかった場合。
query_user_defined_functions
特定のクエリに一致するユーザー定義関数を返 します。
query_user_defined_functions(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]パラメーター
- max_item_count
- int
列挙操作で返されるアイテムの最大数。
戻り値
ユーザー定義関数 (dicts) の AsyncItemPaged。
の戻り値の型 :
例外
指定されたストアド プロシージャを作成できなかった場合。
replace_stored_procedure
コンテナー内の指定したストアド プロシージャを置き換えます。
ストアド プロシージャがまだコンテナーに存在しない場合は、例外が発生します。
async replace_stored_procedure(sproc: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
置換後のストアド プロシージャを表すディクテーションが完了しました。
の戻り値の型 :
例外
置換に失敗した場合、または指定された ID を持つストアド プロシージャが存在しない場合。
replace_trigger
コンテナー内の指定したトリガーを置き換えます。
トリガーがまだコンテナーに存在しない場合は、例外が発生します。
async replace_trigger(trigger: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
置換が完了した後のトリガーを表すディクテーション。
の戻り値の型 :
例外
置換に失敗した場合、または指定された ID を持つトリガーが存在しない場合。
replace_user_defined_function
コンテナー内の指定したユーザー定義関数を置き換えます。
ユーザー定義関数がまだコンテナーに存在しない場合は、例外が発生します。
async replace_user_defined_function(udf: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]パラメーター
戻り値
置換後のユーザー定義関数を表す dict が実行されます。
の戻り値の型 :
例外
置換に失敗した場合、または指定された ID を持つユーザー定義関数が存在しない場合。
Azure SDK for Python
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示