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

إذا فشل استبدال أو لم تكن الدالة المعرفة من قبل المستخدم بالمعرف المحدد موجودة.