ContainerProxy الفصل

واجهة للتفاعل مع حاوية DB معينة.

يجب عدم إنشاء مثيل لهذه الفئة مباشرة. بدلا من ذلك، استخدم get_container_client الأسلوب للحصول على حاوية موجودة، أو create_container الأسلوب لإنشاء حاوية جديدة.

الحاوية في قاعدة بيانات Azure Cosmos DB SQL API هي مجموعة من المستندات، يتم تمثيل كل منها كعنصر.

توريث

builtins.object

ContainerProxy

الدالمنشئ

ContainerProxy(client_connection: CosmosClientConnection, database_link: str, id: str, properties: Dict[str, Any] = None)

المعلمات

client_connection

database_link

id

properties

القيمة الافتراضية: None

المتغيرات

id

str

معرف (اسم) الحاوية

session_token

str

رمز جلسة العمل للحاوية.

الأساليب

create_item	إنشاء عنصر في الحاوية. لتحديث عنصر موجود أو استبداله upsert_item ، استخدم الأسلوب .
delete_all_items_by_partition_key	الحذف بواسطة ميزة مفتاح القسم هي عملية خلفية غير متزامنة تسمح لك بحذف جميع المستندات بنفس قيمة مفتاح القسم المنطقي، باستخدام Cosmos SDK. يتم تقييد الحذف بواسطة عملية مفتاح القسم لاستهلاك 10٪ على الأكثر من إجمالي وحدات الطلب/الثانية المتوفرة على الحاوية كل ثانية. يساعد هذا في الحد من الموارد المستخدمة من قبل مهمة الخلفية هذه.
delete_conflict	حذف تعارض محدد من الحاوية. إذا لم يكن التعارض موجودا بالفعل في الحاوية، يتم رفع استثناء.
delete_item	احذف العنصر المحدد من الحاوية. إذا لم يكن العنصر موجودا بالفعل في الحاوية، يتم رفع استثناء.
get_conflict	الحصول على التعارض الذي تم تحديده بواسطة التعارض.
get_throughput	احصل على كائن ThroughputProperties لهذه الحاوية. إذا لم تكن هناك أي ThroughputProperties موجودة بالفعل للحاوية، يتم رفع استثناء. :الكلمة الأساسية القابلة للاستدعاء response_hook: قابل للاستدعاء يتم استدعاؤه ببيانات تعريف الاستجابة. :إرجاع: معدل النقل للحاوية. :يثير ~azure.cosmos.exceptions.CosmosHttpResponseError: لا توجد خصائص معدل النقل للحاوية أو تعذر استرداد خصائص معدل النقل.
list_conflicts	سرد كافة التعارضات في الحاوية.
patch_item	الأسلوب المؤقت تصحيح العنصر المحدد بالعمليات المقدمة إذا كان موجودا في الحاوية. إذا لم يكن العنصر موجودا بالفعل في الحاوية، يتم رفع استثناء.
query_conflicts	إرجاع كافة التعارضات المطابقة لاستعلام معين.
query_items	إرجاع جميع النتائج المطابقة للاستعلام المحدد. يمكنك استخدام أي قيمة لاسم الحاوية في عبارة FROM، ولكن غالبا ما يتم استخدام اسم الحاوية. في الأمثلة أدناه، اسم الحاوية هو "products"، ويسمى باسم "p" للرجوع إليها بسهولة في عبارة WHERE. رمز متابعة الاستجابة في استجابة الاستعلام. القيم الصالحة هي أعداد صحيحة موجبة. القيمة 0 هي نفسها التي لا تمرر قيمة (افتراضيا لا يوجد حد). :الكلمة الأساسية int max_integrated_cache_staleness_in_ms: الحد الأقصى لذاكرة التخزين المؤقت القديمة لذاكرة التخزين المؤقت المتكاملة في ميلي ثانيه. بالنسبة للحسابات التي تم تكوينها لاستخدام ذاكرة التخزين المؤقت المتكاملة، باستخدام تناسق الجلسة أو التناسق النهائي، يتم ضمان عدم ثبات الاستجابات من هذه القيمة.
query_items_change_feed	احصل على قائمة تم فرزها من العناصر التي تم تغييرها بالترتيب الذي تم تعديلها به.
read	اقرأ خصائص الحاوية.
read_all_items	سرد كافة العناصر في الحاوية.
read_item	احصل على العنصر المحدد حسب العنصر.
read_offer	احصل على كائن ThroughputProperties لهذه الحاوية. إذا لم تكن هناك أي ThroughputProperties موجودة بالفعل للحاوية، يتم رفع استثناء. :الكلمة الأساسية القابلة للاستدعاء response_hook: قابل للاستدعاء يتم استدعاؤه ببيانات تعريف الاستجابة. :إرجاع: معدل النقل للحاوية. :يثير ~azure.cosmos.exceptions.CosmosHttpResponseError: لا توجد خصائص معدل النقل للحاوية أو تعذر استرداد خصائص معدل النقل.
replace_item	يستبدل العنصر المحدد إذا كان موجودا في الحاوية. إذا لم يكن العنصر موجودا بالفعل في الحاوية، يتم رفع استثناء.
replace_throughput	استبدل معدل نقل الحاوية. إذا لم تكن هناك أي ThroughputProperties موجودة بالفعل للحاوية، يتم رفع استثناء.
upsert_item	إدراج العنصر المحدد أو تحديثه. إذا كان العنصر موجودا بالفعل في الحاوية، يتم استبداله. إذا لم يكن العنصر موجودا بالفعل، يتم إدراجه.

create_item

إنشاء عنصر في الحاوية.

لتحديث عنصر موجود أو استبداله upsert_item ، استخدم الأسلوب .

create_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, indexing_directive: Any | None = None, **kwargs: Any) -> Dict[str, Any]

المعلمات

body

مطلوب

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

pre_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.

post_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل عملية نشر.

indexing_directive

مطلوب

الإشارة إلى ما إذا كان يجب حذف المستند من الفهرسة.

enable_automatic_id_generation

bool

تمكين إنشاء المعرف التلقائي إذا لم يكن هناك معرف موجود.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

initial_headers

dict[str,str]

العناوين الأولية التي سيتم إرسالها كجزء من الطلب.

etag

str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

match_condition

MatchConditions

شرط المطابقة لاستخدامه على etag.

response_hook

Callable

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

المرتجعات

إملاء يمثل العنصر الجديد.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

delete_all_items_by_partition_key

الحذف بواسطة ميزة مفتاح القسم هي عملية خلفية غير متزامنة تسمح لك بحذف جميع المستندات بنفس قيمة مفتاح القسم المنطقي، باستخدام Cosmos SDK. يتم تقييد الحذف بواسطة عملية مفتاح القسم لاستهلاك 10٪ على الأكثر من إجمالي وحدات الطلب/الثانية المتوفرة على الحاوية كل ثانية. يساعد هذا في الحد من الموارد المستخدمة من قبل مهمة الخلفية هذه.

delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> None

المعلمات

partition_key

Any

مطلوب

مفتاح القسم للعناصر المراد حذفها.

pre_trigger_include

str

معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.

post_trigger_include

str

معرف المشغل لاستخدامه كمشغل عملية نشر.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

etag

str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

match_condition

MatchConditions

شرط المطابقة لاستخدامه على etag.

response_hook

Callable

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

نوع الإرجاع

None

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

delete_conflict

حذف تعارض محدد من الحاوية.

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

delete_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> None

المعلمات

conflict

مطلوب

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

partition_key

مطلوب

مفتاح القسم لحذف التعارض.

response_hook

Callable

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

نوع الإرجاع

None

استثناءات

CosmosHttpResponseError

لم يتم حذف التعارض بنجاح.

CosmosResourceNotFoundError

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

delete_item

احذف العنصر المحدد من الحاوية.

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

delete_item(item: Dict[str, Any] | str, partition_key: Any, populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> None

المعلمات

item

مطلوب

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

partition_key

مطلوب

تحديد قيمة مفتاح القسم للعنصر.

pre_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.

post_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل عملية نشر.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

initial_headers

dict[str,str]

العناوين الأولية التي سيتم إرسالها كجزء من الطلب.

etag

str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

match_condition

MatchConditions

شرط المطابقة لاستخدامه على etag.

response_hook

Callable

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

نوع الإرجاع

None

استثناءات

CosmosHttpResponseError

لم يتم حذف العنصر بنجاح.

CosmosResourceNotFoundError

العنصر غير موجود في الحاوية.

get_conflict

الحصول على التعارض الذي تم تحديده بواسطة التعارض.

get_conflict(conflict: str | Dict[str, Any], partition_key: Any, **kwargs: Any) -> Dict[str, Any]

المعلمات

conflict

مطلوب

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

partition_key

مطلوب

مفتاح القسم لاسترداد التعارض.

response_hook

Callable

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

المرتجعات

إملاء يمثل التعارض الذي تم استرداده.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

تعذر استرداد التعارض المحدد.

get_throughput

احصل على كائن ThroughputProperties لهذه الحاوية.

إذا لم تكن هناك أي ThroughputProperties موجودة بالفعل للحاوية، يتم رفع استثناء. :الكلمة الأساسية القابلة للاستدعاء response_hook: قابل للاستدعاء يتم استدعاؤه ببيانات تعريف الاستجابة. :إرجاع: معدل النقل للحاوية. :يثير ~azure.cosmos.exceptions.CosmosHttpResponseError: لا توجد خصائص معدل النقل للحاوية أو

تعذر استرداد خصائص معدل النقل.

get_throughput(**kwargs: Any) -> ThroughputProperties

نوع الإرجاع

ThroughputProperties

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

list_conflicts

سرد كافة التعارضات في الحاوية.

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

المعلمات

max_item_count

مطلوب

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

response_hook

Callable

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

المرتجعات

تكرار التعارضات (الإملاءات).

نوع الإرجاع

Iterable[dict[str, Any]]

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

patch_item

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

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

patch_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, patch_operations: List[Dict[str, Any]], **kwargs: Any) -> Dict[str, Any]

المعلمات

item

Union[str, Dict[str, Any]]

مطلوب

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

partition_key

Union[str, int, float, bool]

مطلوب

مفتاح القسم للكائن المراد تصحيحه.

patch_operations

List[Dict[str, Any]]

مطلوب

قائمة عمليات التصحيح لتطبيقها على العنصر.

filter_predicate

str

عامل تصفية شرطي لتطبيقه على عمليات التصحيح.

pre_trigger_include

str

معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.

post_trigger_include

str

معرف المشغل لاستخدامه كمشغل عملية نشر.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

etag

str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

match_condition

MatchConditions

شرط المطابقة لاستخدامه على etag.

response_hook

Callable

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

المرتجعات

إملاء يمثل العنصر بعد مرور عمليات التصحيح.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

فشلت عمليات التصحيح أو العنصر ذي المعرف المحدد غير موجود.

query_conflicts

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

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

المعلمات

query

مطلوب

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

parameters

مطلوب

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

enable_cross_partition_query

مطلوب

يسمح بإرسال أكثر من طلب واحد لتنفيذ الاستعلام في خدمة Azure Cosmos DB. أكثر من طلب واحد ضروري إذا لم يتم تحديد نطاق الاستعلام لقيمة مفتاح قسم واحد.

partition_key

مطلوب

تحديد قيمة مفتاح القسم للعنصر.

max_item_count

مطلوب

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

response_hook

Callable

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

المرتجعات

تكرار التعارضات (الإملاءات).

نوع الإرجاع

Iterable[dict[str, Any]]

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

query_items

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

يمكنك استخدام أي قيمة لاسم الحاوية في عبارة FROM، ولكن غالبا ما يتم استخدام اسم الحاوية. في الأمثلة أدناه، اسم الحاوية هو "products"، ويسمى باسم "p" للرجوع إليها بسهولة في عبارة WHERE.

رمز متابعة الاستجابة في استجابة الاستعلام. القيم الصالحة هي أعداد صحيحة موجبة. القيمة 0 هي نفسها التي لا تمرر قيمة (افتراضيا لا يوجد حد). :الكلمة الأساسية int max_integrated_cache_staleness_in_ms: الحد الأقصى لذاكرة التخزين المؤقت القديمة لذاكرة التخزين المؤقت المتكاملة في

ميلي ثانيه. بالنسبة للحسابات التي تم تكوينها لاستخدام ذاكرة التخزين المؤقت المتكاملة، باستخدام تناسق الجلسة أو التناسق النهائي، يتم ضمان عدم ثبات الاستجابات من هذه القيمة.

query_items(query: str, parameters: List[Dict[str, object]] | None = None, partition_key: Any | None = None, enable_cross_partition_query: bool | None = None, max_item_count: int | None = None, enable_scan_in_query: bool | None = None, populate_query_metrics: bool | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

المرتجعات

قابل لل تكرار للعناصر (الإملاءات).

نوع الإرجاع

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

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

أمثلة

احصل على جميع المنتجات التي لم يتم إيقافها:

   import json

   for item in container.query_items(
       query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"',
       enable_cross_partition_query=True,
   ):
       print(json.dumps(item, indent=True))

استعلام ذات معلمات للحصول على جميع المنتجات التي تم إيقافها:

   discontinued_items = container.query_items(
       query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName="Widget"',
       parameters=[dict(name="@model", value="DISCONTINUED")],
   )
   for item in discontinued_items:
       print(json.dumps(item, indent=True))

query_items_change_feed

احصل على قائمة تم فرزها من العناصر التي تم تغييرها بالترتيب الذي تم تعديلها به.

query_items_change_feed(partition_key_range_id: str | None = None, is_start_from_beginning: bool = False, continuation: str | None = None, max_item_count: int | None = None, **kwargs: Any) -> Iterable[Dict[str, Any]]

المعلمات

partition_key_range_id

مطلوب

يمكن تنفيذ طلبات ChangeFeed مقابل نطاقات مفاتيح قسم معينة. يتم استخدام هذا لمعالجة موجز التغيير بالتوازي عبر العديد من المستهلكين.

partition_key

مطلوب

مفتاح القسم الذي يتم فيه استهداف طلبات ChangeFeed.

is_start_from_beginning

مطلوب

الحصول على ما إذا كان يجب أن يبدأ موجز التغيير من البداية (صحيح) أو من الحالي (خطأ). بشكل افتراضي، يبدأ من الحالي (خطأ).

continuation

مطلوب

e_tag القيمة لاستخدامها كمتابعة لقراءة موجز التغيير.

max_item_count

مطلوب

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

response_hook

Callable

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

المرتجعات

قابل لل تكرار للعناصر (الإملاءات).

نوع الإرجاع

Iterable[dict[str, Any]]

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

read

اقرأ خصائص الحاوية.

read(*, populate_partition_key_range_statistics: bool | None = None, populate_quota_info: bool | None = None, **kwargs)

المعلمات

populate_partition_key_range_statistics

bool

تمكين إرجاع إحصائيات نطاق مفتاح القسم في عناوين الاستجابة.

populate_quota_info

bool

تمكين إرجاع معلومات الحصة النسبية لتخزين المجموعة في عناوين الاستجابة.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

initial_headers

dict[str,str]

العناوين الأولية التي سيتم إرسالها كجزء من الطلب.

response_hook

Callable

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

المرتجعات

إملاء يمثل الحاوية المستردة.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

يرفع إذا تعذر استرداد الحاوية. يتضمن ذلك ما إذا كانت الحاوية غير موجودة.

read_all_items

سرد كافة العناصر في الحاوية.

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

المعلمات

max_item_count

مطلوب

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

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

initial_headers

dict[str,str]

العناوين الأولية التي سيتم إرسالها كجزء من الطلب.

response_hook

Callable

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

max_integrated_cache_staleness_in_ms

int

الحد الأقصى لذاكرة التخزين المؤقت القديمة لذاكرة التخزين المؤقت المتكاملة بالمللي ثانية. بالنسبة للحسابات التي تم تكوينها لاستخدام ذاكرة التخزين المؤقت المتكاملة، باستخدام تناسق الجلسة أو التناسق النهائي، يتم ضمان عدم ثبات الاستجابات من هذه القيمة.

المرتجعات

قابل لل تكرار للعناصر (الإملاءات).

نوع الإرجاع

Iterable[dict[str, Any]]

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

read_item

احصل على العنصر المحدد حسب العنصر.

read_item(item: str | Dict[str, Any], partition_key: Any, populate_query_metrics: bool | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

المعلمات

item

مطلوب

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

partition_key

مطلوب

مفتاح القسم للعنصر المراد استرداده.

post_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل عملية نشر.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

initial_headers

dict[str,str]

العناوين الأولية التي سيتم إرسالها كجزء من الطلب.

response_hook

Callable

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

max_integrated_cache_staleness_in_ms

int

الحد الأقصى لذاكرة التخزين المؤقت القديمة لذاكرة التخزين المؤقت المتكاملة بالمللي ثانية. بالنسبة للحسابات التي تم تكوينها لاستخدام ذاكرة التخزين المؤقت المتكاملة، باستخدام تناسق الجلسة أو التناسق النهائي، يتم ضمان عدم ثبات الاستجابات من هذه القيمة.

المرتجعات

إملاء يمثل العنصر المراد استرداده.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

تعذر استرداد العنصر المحدد.

أمثلة

احصل على عنصر من قاعدة البيانات وقم بتحديث إحدى خصائصه:

   item = container.read_item("item2", partition_key="Widget")
   item["productModel"] = "DISCONTINUED"
   updated_item = container.upsert_item(item)

read_offer

احصل على كائن ThroughputProperties لهذه الحاوية. إذا لم تكن هناك أي ThroughputProperties موجودة بالفعل للحاوية، يتم رفع استثناء. :الكلمة الأساسية القابلة للاستدعاء response_hook: قابل للاستدعاء يتم استدعاؤه ببيانات تعريف الاستجابة. :إرجاع: معدل النقل للحاوية. :يثير ~azure.cosmos.exceptions.CosmosHttpResponseError: لا توجد خصائص معدل النقل للحاوية أو

تعذر استرداد خصائص معدل النقل.

read_offer(**kwargs: Any) -> Offer

نوع الإرجاع

ThroughputProperties

استثناءات

CosmosHttpResponseError

العنصر الذي يحمل المعرف المحدد موجود بالفعل.

replace_item

يستبدل العنصر المحدد إذا كان موجودا في الحاوية.

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

replace_item(item: str | Dict[str, Any], body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

المعلمات

item

مطلوب

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

body

مطلوب

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

pre_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.

post_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل عملية نشر.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

initial_headers

dict[str,str]

العناوين الأولية التي سيتم إرسالها كجزء من الطلب.

etag

str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

match_condition

MatchConditions

شرط المطابقة لاستخدامه على etag.

response_hook

Callable

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

المرتجعات

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

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

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

replace_throughput

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

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

replace_throughput(throughput: int | ThroughputProperties | None, **kwargs: Any) -> ThroughputProperties

المعلمات

throughput

مطلوب

معدل النقل المطلوب تعيينه (عدد صحيح).

response_hook

Callable

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

المرتجعات

معدل النقل الخاص بالحاوية، تم تحديثه بمعدل نقل جديد.

نوع الإرجاع

ThroughputProperties

استثناءات

CosmosHttpResponseError

لا توجد خصائص معدل النقل للحاوية أو تعذر تحديث خصائص معدل النقل.

upsert_item

إدراج العنصر المحدد أو تحديثه.

إذا كان العنصر موجودا بالفعل في الحاوية، يتم استبداله. إذا لم يكن العنصر موجودا بالفعل، يتم إدراجه.

upsert_item(body: Dict[str, Any], populate_query_metrics: bool | None = None, pre_trigger_include: str | None = None, post_trigger_include: str | None = None, **kwargs: Any) -> Dict[str, Any]

المعلمات

body

مطلوب

كائن يشبه الإملاء يمثل العنصر المراد تحديثه أو إدراجه.

pre_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.

post_trigger_include

مطلوب

معرف المشغل لاستخدامه كمشغل عملية نشر.

session_token

str

رمز مميز للاستخدام مع تناسق الجلسة.

initial_headers

dict[str,str]

العناوين الأولية التي سيتم إرسالها كجزء من الطلب.

etag

str

قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .

match_condition

MatchConditions

شرط المطابقة لاستخدامه على etag.

response_hook

Callable

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

المرتجعات

إملاء يمثل العنصر الذي تمت إعادة إدراجه.

نوع الإرجاع

dict[str, Any]

استثناءات

CosmosHttpResponseError

تعذر رفع إدراج العنصر المحدد.

السمات

is_system_key

scripts