ScriptsProxy الفصل

واجهة للتفاعل مع الإجراءات المخزنة.

يجب عدم إنشاء مثيل لهذه الفئة مباشرة. بدلا من ذلك، استخدم السمة scripts .

توريث

builtins.object

ScriptsProxy

الدالمنشئ

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	احصل على مشغل تم تحديده بواسطة المعرف.
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	استبدل دالة محددة معرفة من قبل المستخدم في الحاوية. إذا لم تكن الدالة المعرفة من قبل المستخدم موجودة بالفعل في الحاوية، يتم رفع استثناء.

create_stored_procedure

إنشاء إجراء مخزن جديد في الحاوية.

لاستبدال إجراء مخزن موجود، استخدم <xref:Container.scripts.replace_stored_procedure> الأسلوب .

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

المعلمات

body

Dict[str, Any]

مطلوب

كائن يشبه الإملاء يمثل الإجراء المخزن المراد إنشاؤه.

المرتجعات

إملاء يمثل الإجراء المخزن الجديد.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الإجراء المخزن المحدد.

create_trigger

إنشاء مشغل في الحاوية.

لاستبدال مشغل موجود، استخدم <xref:ContainerProxy.scripts.replace_trigger> الأسلوب .

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

المعلمات

body

Dict[str, Any]

مطلوب

كائن يشبه الإملاء يمثل المشغل المراد إنشاؤه.

المرتجعات

إملاء يمثل المشغل الجديد.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء المشغل المحدد.

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]

المعلمات

body

Dict[str, Any]

مطلوب

كائن يشبه الإملاء يمثل الدالة المعرفة من قبل المستخدم لإنشائها.

المرتجعات

إملاء يمثل الدالة الجديدة المعرفة من قبل المستخدم.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الدالة المعرفة من قبل المستخدم.

delete_stored_procedure

حذف إجراء مخزن محدد من الحاوية.

إذا لم يكن الإجراء المخزن موجودا بالفعل في الحاوية، يتم رفع استثناء.

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

المعلمات

sproc

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل الإجراء المخزن المراد حذفه.

نوع الإرجاع

None

استثناءات

CosmosHttpResponseError

لم يتم حذف الإجراء المخزن بنجاح.

CosmosResourceNotFoundError

الإجراء المخزن غير موجود في الحاوية.

delete_trigger

حذف مشغل محدد من الحاوية.

إذا لم يكن المشغل موجودا بالفعل في الحاوية، يتم رفع استثناء.

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

المعلمات

trigger

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل المشغل المراد حذفه.

نوع الإرجاع

None

استثناءات

CosmosHttpResponseError

لم يتم حذف المشغل بنجاح.

CosmosResourceNotFoundError

المشغل غير موجود في الحاوية.

delete_user_defined_function

حذف دالة محددة معرفة من قبل المستخدم من الحاوية.

إذا لم تكن الدالة المعرفة من قبل المستخدم موجودة بالفعل في الحاوية، يتم رفع استثناء.

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

المعلمات

udf

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل udf المراد حذفه.

نوع الإرجاع

None

استثناءات

CosmosHttpResponseError

لم يتم حذف udf بنجاح.

CosmosResourceNotFoundError

UDF غير موجود في الحاوية.

execute_stored_procedure

تنفيذ إجراء مخزن محدد.

إذا لم يكن الإجراء المخزن موجودا بالفعل في الحاوية، يتم رفع استثناء.

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

المعلمات

sproc

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل الإجراء المخزن الذي سيتم تنفيذه.

partition_key

Union[str, int, float, bool]

يحدد مفتاح القسم للإشارة إلى القسم الذي يجب تنفيذ الإجراء المخزن عليه.

parameters

List[Dict[str, Any]]

قائمة المعلمات التي سيتم تمريرها إلى الإجراء المخزن ليتم تنفيذه.

enable_script_logging

bool

تمكين تسجيل البرنامج النصي للطلب الحالي أو تعطيله.

المرتجعات

نتيجة الإجراء المخزن المنفذ للمعلمات المحددة.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا فشل تنفيذ الإجراء المخزن أو إذا كان الإجراء المخزن مع معرف معين غير موجود في الحاوية.

get_stored_procedure

احصل على الإجراء المخزن الذي تم تحديده بواسطة sproc.

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

المعلمات

sproc

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل الإجراء المخزن لاسترداده.

المرتجعات

إملاء يمثل الإجراء المخزن الذي تم استرداده.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا تعذر استرداد الإجراء المخزن المحدد.

get_trigger

احصل على مشغل تم تحديده بواسطة المعرف.

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

المعلمات

trigger

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل المشغل المراد استرداده.

المرتجعات

إملاء يمثل المشغل الذي تم استرداده.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا تعذر استرداد المشغل المحدد.

get_user_defined_function

احصل على دالة معرفة من قبل المستخدم محددة بواسطة المعرف.

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

المعلمات

udf

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل udf لاسترداده.

المرتجعات

إملاء يمثل الدالة المعرفة من قبل المستخدم التي تم استردادها.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا تعذر استرداد الدالة المعرفة من قبل المستخدم.

list_stored_procedures

سرد جميع الإجراءات المخزنة في الحاوية.

list_stored_procedures(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

المعلمات

max_item_count

int

الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.

المرتجعات

AsyncItemPaged للإجراءات المخزنة (الإملاءات).

نوع الإرجاع

<xref:AsyncItemPaged>[Dict[str, Any]]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الإجراء المخزن المحدد.

list_triggers

سرد جميع المشغلات في الحاوية.

list_triggers(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

المعلمات

max_item_count

int

الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.

المرتجعات

AsyncItemPaged من المشغلات (الإملاءات).

نوع الإرجاع

<xref:AsyncItemPaged>[Dict[str, Any]]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الإجراء المخزن المحدد.

list_user_defined_functions

سرد جميع الدالات المعرفة من قبل المستخدم في الحاوية.

list_user_defined_functions(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

المعلمات

max_item_count

int

الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.

المرتجعات

AsyncItemPaged من الوظائف المعرفة من قبل المستخدم (الإملاءات).

نوع الإرجاع

<xref:AsyncItemPaged>[Dict[str, Any]]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الإجراء المخزن المحدد.

query_stored_procedures

إرجاع جميع الإجراءات المخزنة المطابقة للاستعلام المحدد.

query_stored_procedures(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

المعلمات

query

Union[str, Dict[str, Any]]

مطلوب

استعلام Azure Cosmos DB SQL لتنفيذه.

parameters

List[Dict[str, Any]]

صفيف اختياري من المعلمات للاستعلام. يتم تجاهله إذا لم يتم توفير استعلام.

max_item_count

int

الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.

المرتجعات

AsyncItemPaged للإجراءات المخزنة (الإملاءات).

نوع الإرجاع

<xref:AsyncItemPaged>[Dict[str, Any]]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الإجراء المخزن المحدد.

query_triggers

إرجاع جميع المشغلات المطابقة للاستعلام المحدد.

query_triggers(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

المعلمات

query

Union[str, Dict[str, Any]]

مطلوب

استعلام Azure Cosmos DB SQL لتنفيذه.

parameters

List[Dict[str, Any]]

صفيف اختياري من المعلمات للاستعلام. يتم تجاهله إذا لم يتم توفير استعلام.

max_item_count

int

الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.

المرتجعات

AsyncItemPaged من المشغلات (الإملاءات).

نوع الإرجاع

<xref:AsyncItemPaged>[Dict[str, Any]]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الإجراء المخزن المحدد.

query_user_defined_functions

إرجاع دالات معرفة من قبل المستخدم مطابقة استعلام معين.

query_user_defined_functions(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]

المعلمات

query

Union[str, Dict[str, Any]]

مطلوب

استعلام Azure Cosmos DB SQL لتنفيذه.

parameters

List[Dict[str, Any]]

صفيف اختياري من المعلمات للاستعلام. يتم تجاهله إذا لم يتم توفير استعلام.

max_item_count

int

الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.

المرتجعات

AsyncItemPaged من الوظائف المعرفة من قبل المستخدم (الإملاءات).

نوع الإرجاع

<xref:AsyncItemPaged>[Dict[str, Any]]

استثناءات

CosmosHttpResponseError

إذا تعذر إنشاء الإجراء المخزن المحدد.

replace_stored_procedure

استبدل إجراء مخزنا محددا في الحاوية.

إذا لم يكن الإجراء المخزن موجودا بالفعل في الحاوية، يتم رفع استثناء.

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

المعلمات

sproc

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل الإجراء المخزن المراد استبداله.

body

Dict[str, Any]

مطلوب

كائن يشبه الإملاء يمثل الإجراء المخزن لاستبداله.

المرتجعات

مرر إملاء يمثل الإجراء المخزن بعد استبداله.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا فشل استبدال أو لم يكن الإجراء المخزن بمعرف معين موجودا.

replace_trigger

استبدل مشغلا محددا في الحاوية.

إذا لم يكن المشغل موجودا بالفعل في الحاوية، يتم رفع استثناء.

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

المعلمات

trigger

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل المشغل المراد استبداله.

body

Dict[str, Any]

مطلوب

كائن يشبه الإملاء يمثل المشغل المراد استبداله.

المرتجعات

مرر إملاء يمثل المشغل بعد استبداله.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

إذا فشل استبدال أو لم يكن المشغل بمعرف معين موجودا.

replace_user_defined_function

استبدل دالة محددة معرفة من قبل المستخدم في الحاوية.

إذا لم تكن الدالة المعرفة من قبل المستخدم موجودة بالفعل في الحاوية، يتم رفع استثناء.

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

المعلمات

udf

Union[str, Dict[str, Any]]

مطلوب

المعرف (الاسم) أو الإملاء الذي يمثل الدالة المعرفة من قبل المستخدم المراد استبداله.

body

Dict[str, Any]

مطلوب

كائن يشبه الإملاء يمثل udf لاستبداله.

المرتجعات

تم إدخال إملاء يمثل الدالة المعرفة من قبل المستخدم بعد استبدالها.

نوع الإرجاع

Dict[str, Any]

استثناءات

CosmosHttpResponseError

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