ContainerProxy الفصل
واجهة للتفاعل مع حاوية DB معينة.
يجب عدم إنشاء مثيل لهذه الفئة مباشرة. بدلا من ذلك، استخدم <xref:azure.cosmos.aio.database.DatabaseProxy.get_container_client> الأسلوب للحصول على حاوية موجودة، أو <xref:azure.cosmos.aio.database.DatabaseProxy.create_container> الأسلوب لإنشاء حاوية جديدة.
الحاوية في قاعدة بيانات Azure Cosmos DB SQL API هي مجموعة من المستندات، يتم تمثيل كل منها كعنصر.
- توريث
-
builtins.objectContainerProxy
الدالمنشئ
ContainerProxy(client_connection: CosmosClientConnection, database_link: str, id: str, properties: Dict[str, Any] = None)
المعلمات
- client_connection
- database_link
- id
- properties
المتغيرات
- 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 موجود بالفعل للحاوية، يتم رفع استثناء. |
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 |
احصل على العنصر المحدد حسب العنصر. |
replace_item |
يستبدل العنصر المحدد إذا كان موجودا في الحاوية. إذا لم يكن العنصر موجودا بالفعل في الحاوية، يتم رفع استثناء. |
replace_throughput |
استبدل معدل نقل الحاوية. إذا لم تكن هناك أي ThroughputProperties موجودة بالفعل للحاوية، يتم رفع استثناء. |
upsert_item |
إدراج العنصر المحدد أو تحديثه. إذا كان العنصر موجودا بالفعل في الحاوية، يتم استبداله. إذا لم يكن العنصر موجودا بالفعل، يتم إدراجه. |
create_item
إنشاء عنصر في الحاوية.
لتحديث عنصر موجود أو استبداله upsert_item ، استخدم الأسلوب .
async create_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
المعلمات
- pre_trigger_include
- str
معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.
- post_trigger_include
- str
معرف المشغل لاستخدامه كمشغل عملية نشر.
- indexing_directive
- Union[int, IndexingDirective]
تعداد القيم المحتملة للإشارة إلى ما إذا كان يجب حذف المستند من الفهرسة. تتضمن القيم المحتملة: 0 للإعداد الافتراضي أو 1 لاستبعاد أو 2 للتضمين.
- enable_automatic_id_generation
- bool
تمكين إنشاء المعرف التلقائي إذا لم يكن هناك معرف موجود.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
- etag
- str
قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، والعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag.
المرتجعات
إملاء يمثل العنصر الجديد.
نوع الإرجاع
استثناءات
العنصر الذي يحمل المعرف المحدد موجود بالفعل.
delete_all_items_by_partition_key
الحذف بواسطة ميزة مفتاح القسم هي عملية خلفية غير متزامنة تسمح لك بحذف جميع المستندات بنفس قيمة مفتاح القسم المنطقي، باستخدام Cosmos SDK. يتم تقييد الحذف بواسطة عملية مفتاح القسم لاستهلاك 10٪ على الأكثر من إجمالي وحدات الطلب/الثانية المتوفرة على الحاوية كل ثانية. يساعد هذا في الحد من الموارد المستخدمة من قبل مهمة الخلفية هذه.
async delete_all_items_by_partition_key(partition_key: str | int | float | bool, **kwargs: Any) -> None
المعلمات
- pre_trigger_include
- str
معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.
- post_trigger_include
- str
معرف المشغل لاستخدامه كمشغل عملية نشر.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
- etag
- str
قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، والعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag.
- response_hook
- Callable
استدعاء مع بيانات تعريف الاستجابة.
نوع الإرجاع
استثناءات
العنصر الذي يحمل المعرف المحدد موجود بالفعل.
delete_conflict
حذف تعارض محدد من الحاوية.
إذا لم يكن التعارض موجودا بالفعل في الحاوية، يتم رفع استثناء.
async delete_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> None
المعلمات
المعرف (الاسم) أو الإملاء الذي يمثل التعارض المراد استرداده.
نوع الإرجاع
استثناءات
لم يتم حذف التعارض بنجاح.
التعارض غير موجود في الحاوية.
delete_item
احذف العنصر المحدد من الحاوية.
إذا لم يكن العنصر موجودا بالفعل في الحاوية، يتم رفع استثناء.
async delete_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> None
المعلمات
- pre_trigger_include
- str
معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.
- post_trigger_include
- str
معرف المشغل لاستخدامه كمشغل عملية نشر.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
- etag
- str
قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، والعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag.
نوع الإرجاع
استثناءات
لم يتم حذف العنصر بنجاح.
العنصر غير موجود في الحاوية.
get_conflict
احصل على التعارض الذي تم تحديده بواسطة التعارض.
async get_conflict(conflict: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]
المعلمات
المعرف (الاسم) أو الإملاء الذي يمثل التعارض المراد استرداده.
المرتجعات
إملاء يمثل التعارض الذي تم استرداده.
نوع الإرجاع
استثناءات
تعذر استرداد التعارض المحدد.
get_throughput
احصل على كائن ThroughputProperties لهذه الحاوية.
إذا لم يكن هناك أي ThroughputProperties موجود بالفعل للحاوية، يتم رفع استثناء.
async get_throughput(**kwargs: Any) -> ThroughputProperties
المعلمات
استدعاء مع بيانات تعريف الاستجابة.
المرتجعات
معدل النقل للحاوية.
نوع الإرجاع
استثناءات
لا توجد خصائص معدل النقل للحاوية أو تعذر استرداد خصائص معدل النقل.
list_conflicts
سرد جميع التعارضات في الحاوية.
list_conflicts(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
المعلمات
- max_item_count
- int
الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.
استدعاء مع بيانات تعريف الاستجابة.
المرتجعات
AsyncItemPaged من التعارضات (الإملاءات).
نوع الإرجاع
استثناءات
العنصر الذي يحمل المعرف المحدد موجود بالفعل.
patch_item
أسلوب مؤقت تصحيح العنصر المحدد بالعمليات المقدمة إذا كان موجودا في الحاوية.
إذا لم يكن العنصر موجودا بالفعل في الحاوية، يتم رفع استثناء.
async patch_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, patch_operations: List[Dict[str, Any]], **kwargs: Any) -> 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
استدعاء مع بيانات تعريف الاستجابة.
المرتجعات
إملاء يمثل العنصر بعد مرور عمليات التصحيح.
نوع الإرجاع
استثناءات
فشلت عمليات التصحيح أو أن العنصر ذي المعرف المحدد غير موجود.
query_conflicts
إرجاع كافة التعارضات المطابقة لاستعلام معين.
query_conflicts(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
المعلمات
صفيف اختياري من المعلمات للاستعلام. يتم تجاهله إذا لم يتم توفير استعلام.
يحدد قيمة مفتاح القسم للعنصر. إذا لم يتم تمرير أي منها، فسيتم تنفيذ استعلام عبر الأقسام.
- max_item_count
- int
الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.
استدعاء مع بيانات تعريف الاستجابة.
المرتجعات
AsyncItemPaged من التعارضات (الإملاءات).
نوع الإرجاع
استثناءات
العنصر الذي يحمل المعرف المحدد موجود بالفعل.
query_items
إرجاع جميع النتائج المطابقة للاستعلام المحدد.
يمكنك استخدام أي قيمة لاسم الحاوية في عبارة FROM، ولكن غالبا ما يتم استخدام اسم الحاوية. في الأمثلة أدناه، اسم الحاوية هو "products"، ويسمى باسم "p" للرجوع إليها بسهولة في عبارة WHERE.
رمز متابعة الاستجابة في استجابة الاستعلام. القيم الصالحة هي أعداد صحيحة موجبة. القيمة 0 هي نفسها التي لا تمرر قيمة (افتراضيا لا يوجد حد). :الكلمة الأساسية int max_integrated_cache_staleness_in_ms: الحد الأقصى لذاكرة التخزين المؤقت القديمة لذاكرة التخزين المؤقت المتكاملة في
ميلي ثانيه. بالنسبة للحسابات التي تم تكوينها لاستخدام ذاكرة التخزين المؤقت المتكاملة، باستخدام تناسق الجلسة أو التناسق النهائي، يتم ضمان عدم ثبات الاستجابات من هذه القيمة.
query_items(query: str | Dict[str, Any], **kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
المرتجعات
AsyncItemPaged من العناصر (الإملاءات).
نوع الإرجاع
استثناءات
العنصر الذي يحمل المعرف المحدد موجود بالفعل.
أمثلة
احصل على جميع المنتجات التي لم يتم إيقافها:
import json
async for item in container.query_items(
query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"'
):
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")],
)
async for item in discontinued_items:
print(json.dumps(item, indent=True))
query_items_change_feed
احصل على قائمة تم فرزها من العناصر التي تم تغييرها بالترتيب الذي تم تعديلها به.
query_items_change_feed(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
المعلمات
- is_start_from_beginning
- bool
الحصول على ما إذا كان يجب أن يبدأ موجز التغيير من البداية (صحيح) أو من الحالي (خطأ). بشكل افتراضي، يبدأ من الحالي (خطأ).
- partition_key_range_id
- str
يمكن تنفيذ طلبات ChangeFeed مقابل نطاقات مفاتيح قسم معينة. يتم استخدام هذا لمعالجة موجز التغيير بالتوازي عبر العديد من المستهلكين.
- continuation
- str
e_tag القيمة لاستخدامها كمتابعة لقراءة موجز التغيير.
- max_item_count
- int
الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.
استدعاء مع بيانات تعريف الاستجابة.
المرتجعات
AsyncItemPaged من العناصر (الإملاءات).
نوع الإرجاع
استثناءات
العنصر الذي يحمل المعرف المحدد موجود بالفعل.
read
اقرأ خصائص الحاوية.
async read(**kwargs: Any) -> Dict[str, Any]
المعلمات
- populate_partition_key_range_statistics
- bool
تمكين إرجاع إحصائيات نطاق مفتاح القسم في عناوين الاستجابة.
- populate_quota_info
- bool
تمكين إرجاع معلومات الحصة النسبية لتخزين المجموعة في عناوين الاستجابة.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
المرتجعات
إملاء يمثل الحاوية المستردة.
نوع الإرجاع
استثناءات
يرفع إذا تعذر استرداد الحاوية. يتضمن ذلك ما إذا كانت الحاوية غير موجودة.
read_all_items
سرد كافة العناصر في الحاوية.
read_all_items(**kwargs: Any) -> AsyncItemPaged[Dict[str, Any]]
المعلمات
- max_item_count
- int
الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
استدعاء مع بيانات تعريف الاستجابة.
- max_integrated_cache_staleness_in_ms
- int
الحد الأقصى لذاكرة التخزين المؤقت القديمة لذاكرة التخزين المؤقت المتكاملة بالمللي ثانية. بالنسبة للحسابات التي تم تكوينها لاستخدام ذاكرة التخزين المؤقت المتكاملة، باستخدام تناسق الجلسة أو التناسق النهائي، يتم ضمان عدم ثبات الاستجابات من هذه القيمة.
المرتجعات
AsyncItemPaged من العناصر (الإملاءات).
نوع الإرجاع
استثناءات
العنصر الذي يحمل المعرف المحدد موجود بالفعل.
read_item
احصل على العنصر المحدد حسب العنصر.
async read_item(item: str | Dict[str, Any], partition_key: str | int | float | bool, **kwargs: Any) -> Dict[str, Any]
المعلمات
- post_trigger_include
- str
معرف المشغل لاستخدامه كمشغل عملية نشر.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
- max_integrated_cache_staleness_in_ms
- int
الحد الأقصى لذاكرة التخزين المؤقت القديمة لذاكرة التخزين المؤقت المتكاملة بالمللي ثانية. بالنسبة للحسابات التي تم تكوينها لاستخدام ذاكرة التخزين المؤقت المتكاملة، باستخدام تناسق الجلسة أو التناسق النهائي، يتم ضمان عدم ثبات الاستجابات من هذه القيمة.
المرتجعات
إملاء يمثل العنصر المراد استرداده.
نوع الإرجاع
استثناءات
تعذر استرداد العنصر المحدد.
أمثلة
احصل على عنصر من قاعدة البيانات وقم بتحديث إحدى خصائصه:
item = await container.read_item("item2", partition_key="Widget")
item["productModel"] = "DISCONTINUED"
updated_item = await container.upsert_item(item)
replace_item
يستبدل العنصر المحدد إذا كان موجودا في الحاوية.
إذا لم يكن العنصر موجودا بالفعل في الحاوية، يتم رفع استثناء.
async replace_item(item: str | Dict[str, Any], body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
المعلمات
- pre_trigger_include
- str
معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.
- post_trigger_include
- str
معرف المشغل لاستخدامه كمشغل عملية نشر.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
- etag
- str
قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag.
المرتجعات
مرر إملاء يمثل العنصر بعد استبداله.
نوع الإرجاع
استثناءات
فشل استبدال أو العنصر ذي المعرف المحدد غير موجود.
replace_throughput
استبدل معدل نقل الحاوية.
إذا لم تكن هناك أي ThroughputProperties موجودة بالفعل للحاوية، يتم رفع استثناء.
async replace_throughput(throughput: int | ThroughputProperties, **kwargs: Any) -> ThroughputProperties
المعلمات
المرتجعات
معدل النقل الخاص بالحاوية، تم تحديثه بمعدل نقل جديد.
نوع الإرجاع
استثناءات
لا توجد خصائص معدل النقل للحاوية أو تعذر تحديث خصائص معدل النقل.
upsert_item
إدراج العنصر المحدد أو تحديثه.
إذا كان العنصر موجودا بالفعل في الحاوية، يتم استبداله. إذا لم يكن العنصر موجودا بالفعل، يتم إدراجه.
async upsert_item(body: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
المعلمات
- pre_trigger_include
- str
معرف المشغل لاستخدامه كمشغل ما قبل التشغيل.
- post_trigger_include
- str
معرف المشغل لاستخدامه كمشغل عملية نشر.
- session_token
- str
رمز مميز للاستخدام مع تناسق الجلسة.
- etag
- str
قيمة ETag أو حرف البدل (*). يستخدم للتحقق مما إذا كان المورد قد تغير، ويعمل وفقا للشرط المحدد بواسطة المعلمة match_condition .
- match_condition
- MatchConditions
شرط المطابقة لاستخدامه على etag.
المرتجعات
إملاء يمثل العنصر الذي تمت إعادة إدراجه.
نوع الإرجاع
استثناءات
تعذر رفع إدراج العنصر المحدد.
السمات
is_system_key
scripts
Azure SDK for Python