ScriptsProxy Kelas

Antarmuka untuk berinteraksi dengan prosedur tersimpan.

Kelas ini tidak boleh diinstansiasi secara langsung. Sebagai gantinya scripts , gunakan atribut .

Warisan

builtins.object

ScriptsProxy

Konstruktor

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

Parameter

client_connection

Diperlukan

container_link

Diperlukan

is_system_key

Diperlukan

Metode

create_stored_procedure	Buat prosedur tersimpan baru dalam kontainer. Untuk mengganti sproc yang ada, gunakan <xref:Container.scripts.replace_stored_procedure> metode .
create_trigger	Buat pemicu dalam kontainer. Untuk mengganti pemicu yang ada, gunakan <xref:ContainerProxy.scripts.replace_trigger> metode .
create_user_defined_function	Buat fungsi yang ditentukan pengguna dalam kontainer. Untuk mengganti UDF yang ada, gunakan metode .<xref:ContainerProxy.scripts.replace_user_defined_function>
delete_stored_procedure	Menghapus prosedur tersimpan tertentu dari kontainer. Jika prosedur tersimpan belum ada dalam kontainer, pengecualian akan dinaikkan.
delete_trigger	Menghapus pemicu tertentu dari kontainer. Jika pemicu belum ada dalam kontainer, pengecualian akan dinaikkan.
delete_user_defined_function	Menghapus fungsi yang ditentukan pengguna tertentu dari kontainer. Jika UDF belum ada dalam kontainer, pengecualian akan dinaikkan.
execute_stored_procedure	Jalankan prosedur tersimpan tertentu. Jika prosedur tersimpan belum ada dalam kontainer, pengecualian akan dinaikkan.
get_stored_procedure	Dapatkan prosedur tersimpan yang diidentifikasi dengan id.
get_trigger	Dapatkan pemicu yang diidentifikasi dengan id.
get_user_defined_function	Dapatkan fungsi yang ditentukan pengguna yang diidentifikasi oleh id.
list_stored_procedures	Cantumkan semua prosedur tersimpan dalam kontainer.
list_triggers	Cantumkan semua pemicu dalam kontainer.
list_user_defined_functions	Cantumkan semua fungsi yang ditentukan pengguna dalam kontainer.
query_stored_procedures	Mengembalikan semua prosedur tersimpan yang cocok dengan kueri yang diberikan.
query_triggers	Mengembalikan semua pemicu yang cocok dengan kueri yang diberikan.
query_user_defined_functions	Mengembalikan fungsi yang ditentukan pengguna yang cocok dengan kueri tertentu.
replace_stored_procedure	Ganti prosedur tersimpan tertentu dalam kontainer. Jika prosedur tersimpan belum ada dalam kontainer, pengecualian akan dinaikkan.
replace_trigger	Ganti pemicu tertentu dalam kontainer. Jika pemicu belum ada dalam kontainer, pengecualian akan dinaikkan.
replace_user_defined_function	Ganti fungsi yang ditentukan pengguna tertentu dalam kontainer. Jika UDF belum ada dalam kontainer, pengecualian akan dinaikkan.

create_stored_procedure

Buat prosedur tersimpan baru dalam kontainer.

Untuk mengganti sproc yang ada, gunakan <xref:Container.scripts.replace_stored_procedure> metode .

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

Parameter

body

Diperlukan

Objek seperti dict yang mewakili sproc untuk dibuat.

Mengembalikan

Dict yang mewakili prosedur tersimpan baru.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat dibuat.

create_trigger

Buat pemicu dalam kontainer.

Untuk mengganti pemicu yang ada, gunakan <xref:ContainerProxy.scripts.replace_trigger> metode .

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

Parameter

body

Diperlukan

Objek seperti dikte yang mewakili pemicu untuk dibuat.

Mengembalikan

Dict yang mewakili pemicu baru.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika pemicu yang diberikan tidak dapat dibuat.

create_user_defined_function

Buat fungsi yang ditentukan pengguna dalam kontainer.

Untuk mengganti UDF yang ada, gunakan metode .<xref:ContainerProxy.scripts.replace_user_defined_function>

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

Parameter

body

Diperlukan

Objek seperti dikte yang mewakili udf untuk dibuat.

Mengembalikan

Dict yang mewakili fungsi baru yang ditentukan pengguna.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika fungsi yang ditentukan pengguna tidak dapat dibuat.

delete_stored_procedure

Menghapus prosedur tersimpan tertentu dari kontainer.

Jika prosedur tersimpan belum ada dalam kontainer, pengecualian akan dinaikkan.

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

Parameter

sproc

Diperlukan

ID (nama) atau dict yang mewakili prosedur tersimpan yang akan dihapus.

Tipe hasil

None

Pengecualian

CosmosHttpResponseError

Sproc tidak berhasil dihapus.

CosmosResourceNotFoundError

Sproc tidak ada dalam kontainer.

delete_trigger

Menghapus pemicu tertentu dari kontainer.

Jika pemicu belum ada dalam kontainer, pengecualian akan dinaikkan.

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

Parameter

trigger

Diperlukan

ID (nama) atau dict yang mewakili pemicu yang akan dihapus.

Tipe hasil

None

Pengecualian

CosmosHttpResponseError

Pemicu tidak berhasil dihapus.

CosmosResourceNotFoundError

Pemicu tidak ada dalam kontainer.

delete_user_defined_function

Menghapus fungsi yang ditentukan pengguna tertentu dari kontainer.

Jika UDF belum ada dalam kontainer, pengecualian akan dinaikkan.

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

Parameter

udf

Diperlukan

ID (nama) atau dict yang mewakili udf yang akan dihapus.

Tipe hasil

None

Pengecualian

CosmosHttpResponseError

Udf tidak berhasil dihapus.

CosmosResourceNotFoundError

UDF tidak ada dalam kontainer.

execute_stored_procedure

Jalankan prosedur tersimpan tertentu.

Jika prosedur tersimpan belum ada dalam kontainer, pengecualian akan dinaikkan.

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

Parameter

sproc

Diperlukan

ID (nama) atau dict yang mewakili prosedur tersimpan yang akan dijalankan.

partition_key

nilai default: None

Menentukan kunci partisi untuk menunjukkan partisi mana yang harus dijalankan sproc.

params

nilai default: None

Daftar parameter yang akan diteruskan ke prosedur tersimpan yang akan dijalankan.

enable_script_logging

bool

nilai default: None

Mengaktifkan atau menonaktifkan pengelogan skrip untuk permintaan saat ini.

Mengembalikan

Hasil dari prosedur tersimpan yang dijalankan untuk parameter yang diberikan.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika eksekusi prosedur tersimpan gagal atau jika prosedur tersimpan dengan id yang diberikan tidak ada dalam kontainer.

get_stored_procedure

Dapatkan prosedur tersimpan yang diidentifikasi dengan id.

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

Parameter

sproc

Diperlukan

ID (nama) atau dict yang mewakili prosedur tersimpan untuk diambil.

Mengembalikan

Dict yang mewakili prosedur tersimpan yang diambil.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat diambil.

get_trigger

Dapatkan pemicu yang diidentifikasi dengan id.

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

Parameter

trigger

Diperlukan

ID (nama) atau dict yang mewakili pemicu untuk diambil.

Mengembalikan

Dict yang mewakili pemicu yang diambil.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika pemicu yang diberikan tidak dapat diambil.

get_user_defined_function

Dapatkan fungsi yang ditentukan pengguna yang diidentifikasi oleh id.

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

Parameter

udf

Diperlukan

ID (nama) atau dict yang mewakili udf untuk diambil.

Mengembalikan

Dict yang mewakili fungsi yang ditentukan pengguna yang diambil.

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika fungsi yang ditentukan pengguna tidak dapat diambil.

list_stored_procedures

Cantumkan semua prosedur tersimpan dalam kontainer.

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

Parameter

max_item_count

int

nilai default: None

Jumlah maksimum item yang akan dikembalikan dalam operasi enumerasi.

Mengembalikan

Iterable prosedur tersimpan (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat dibuat.

list_triggers

Cantumkan semua pemicu dalam kontainer.

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

Parameter

max_item_count

nilai default: None

Jumlah maksimum item yang akan dikembalikan dalam operasi enumerasi.

Mengembalikan

Iterable pemicu (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat dibuat.

list_user_defined_functions

Cantumkan semua fungsi yang ditentukan pengguna dalam kontainer.

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

Parameter

max_item_count

nilai default: None

Jumlah maksimum item yang akan dikembalikan dalam operasi enumerasi.

Mengembalikan

Iterable fungsi yang ditentukan pengguna (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat dibuat.

query_stored_procedures

Mengembalikan semua prosedur tersimpan yang cocok dengan kueri yang diberikan.

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

Parameter

query

Diperlukan

Kueri Azure Cosmos DB SQL untuk dijalankan.

parameters

nilai default: None

Array parameter opsional ke kueri. Diabaikan jika tidak ada kueri yang disediakan.

max_item_count

nilai default: None

Jumlah maksimum item yang akan dikembalikan dalam operasi enumerasi.

Mengembalikan

Iterable prosedur tersimpan (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat dibuat.

query_triggers

Mengembalikan semua pemicu yang cocok dengan kueri yang diberikan.

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

Parameter

query

Diperlukan

Kueri Azure Cosmos DB SQL untuk dijalankan.

parameters

nilai default: None

Array parameter opsional ke kueri. Diabaikan jika tidak ada kueri yang disediakan.

max_item_count

nilai default: None

Jumlah maksimum item yang akan dikembalikan dalam operasi enumerasi.

Mengembalikan

Iterable pemicu (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat dibuat.

query_user_defined_functions

Mengembalikan fungsi yang ditentukan pengguna yang cocok dengan kueri tertentu.

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

Parameter

query

Diperlukan

Kueri Azure Cosmos DB SQL untuk dijalankan.

parameters

nilai default: None

Array parameter opsional ke kueri. Diabaikan jika tidak ada kueri yang disediakan.

max_item_count

nilai default: None

Jumlah maksimum item yang akan dikembalikan dalam operasi enumerasi.

Mengembalikan

Iterable fungsi yang ditentukan pengguna (dicts).

Tipe hasil

Iterable[dict[str, Any]]

Pengecualian

CosmosHttpResponseError

Jika prosedur tersimpan yang diberikan tidak dapat dibuat.

replace_stored_procedure

Ganti prosedur tersimpan tertentu dalam kontainer.

Jika prosedur tersimpan belum ada dalam kontainer, pengecualian akan dinaikkan.

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

Parameter

sproc

Diperlukan

ID (nama) atau dict yang mewakili prosedur tersimpan yang akan diganti.

body

Diperlukan

Objek seperti dict yang mewakili sproc untuk diganti.

Mengembalikan

Dict yang mewakili prosedur tersimpan setelah penggantian dilalui.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika penggantian gagal atau prosedur tersimpan dengan id yang diberikan tidak ada.

replace_trigger

Ganti pemicu tertentu dalam kontainer.

Jika pemicu belum ada dalam kontainer, pengecualian akan dinaikkan.

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

Parameter

trigger

Diperlukan

ID (nama) atau dict yang mewakili pemicu untuk diganti.

body

Diperlukan

Objek seperti dikte yang mewakili pemicu untuk diganti.

Mengembalikan

Dict yang mewakili pemicu setelah penggantian dilalui.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika penggantian gagal atau pemicu dengan id yang diberikan tidak ada.

replace_user_defined_function

Ganti fungsi yang ditentukan pengguna tertentu dalam kontainer.

Jika UDF belum ada dalam kontainer, pengecualian akan dinaikkan.

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

Parameter

udf

Diperlukan

ID (nama) atau dict yang mewakili udf yang akan diganti.

body

Diperlukan

Objek seperti dict yang mewakili udf untuk diganti.

Mengembalikan

Dict yang mewakili fungsi yang ditentukan pengguna setelah penggantian dilalui.

Tipe hasil

dict[str, Any]

Pengecualian

CosmosHttpResponseError

Jika penggantian gagal atau fungsi yang ditentukan pengguna dengan id yang diberikan tidak ada.