مشاركة عبر

Container class

  • ‏‏المرجع
الحزمة:
@azure/cosmos

عمليات لقراءة حاوية معينة موجودة أو استبدالها أو حذفها حسب المعرف.

راجع الحاويات لإنشاء حاويات جديدة، وقراءة/الاستعلام عن جميع الحاويات؛ استخدم .containers.

ملاحظة: تجري جميع هذه العمليات مكالمات مقابل ميزانية ثابتة. يجب عليك تصميم النظام الخاص بك بحيث يتم تغيير حجم هذه المكالمات بشكل فرعي مع التطبيق الخاص بك. على سبيل المثال، لا تتصل container(id).read() قبل كل استدعاء item.read() واحد، للتأكد من وجود الحاوية؛ قم بذلك مرة واحدة على بدء تشغيل التطبيق.

الخصائص

conflicts

تتعارض عمليات القراءة والاستعلام للحاوية المحددة.

لقراءة تعارض معين أو حذفه، استخدم .conflict(id).
database
id
items

عمليات إنشاء عناصر جديدة وقراءة/الاستعلام عن كافة العناصر

لقراءة عنصر موجود أو استبداله أو حذفه، استخدم .item(id).

المثال

إنشاء عنصر جديد

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});
scripts

كافة العمليات للإجراءات المخزنة والمشغلات والوظائف المعرفة من قبل المستخدم
url

إرجاع URL مرجع إلى المورد. يستخدم للارتباط في الأذونات.

الأساليب

conflict(string, PartitionKey)

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

استخدم .conflicts لإنشاء تعارضات جديدة، أو الاستعلام/قراءة كافة التعارضات.
delete(RequestOptions)

حذف الحاوية
deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

حذف كافة المستندات تنتمي إلى الحاوية لقيمة مفتاح القسم المتوفرة
getFeedRanges()
getPartitionKeyDefinition()

يحصل على تعريف مفتاح القسم أولا من خلال النظر في ذاكرة التخزين المؤقت بخلاف ذلك عن طريق قراءة المجموعة.
getQueryPlan(string | SqlQuerySpec)
item(string, PartitionKey)

يستخدم لقراءة عنصر موجود أو استبداله أو حذفه حسب المعرف.

استخدم .items لإنشاء عناصر جديدة أو الاستعلام عن كافة العناصر أو قراءتها.

المثال

استبدال عنصر const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});
read(RequestOptions)

قراءة تعريف الحاوية
readOffer(RequestOptions)

الحصول على عرض على الحاوية. إذا لم يكن هناك أي منها، فترجع OfferResponse مع غير معرف.
readPartitionKeyRanges(FeedOptions)
replace(ContainerDefinition, RequestOptions)

استبدال تعريف الحاوية

تفاصيل الخاصية

conflicts

تتعارض عمليات القراءة والاستعلام للحاوية المحددة.

لقراءة تعارض معين أو حذفه، استخدم .conflict(id).

Conflicts conflicts

قيمة الخاصية

Conflicts

database 

database: Database

قيمة الخاصية

Database

id 

id: string

قيمة الخاصية

string

items

عمليات إنشاء عناصر جديدة وقراءة/الاستعلام عن كافة العناصر

لقراءة عنصر موجود أو استبداله أو حذفه، استخدم .item(id).

المثال

إنشاء عنصر جديد

const {body: createdItem} = await container.items.create({id: "<item id>", properties: {}});

Items items

قيمة الخاصية

Items

scripts

كافة العمليات للإجراءات المخزنة والمشغلات والوظائف المعرفة من قبل المستخدم

Scripts scripts

قيمة الخاصية

Scripts

url

إرجاع URL مرجع إلى المورد. يستخدم للارتباط في الأذونات.

string url

قيمة الخاصية

string

تفاصيل الأسلوب

conflict(string, PartitionKey)

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

استخدم .conflicts لإنشاء تعارضات جديدة، أو الاستعلام/قراءة كافة التعارضات.

function conflict(id: string, partitionKey?: PartitionKey): Conflict

المعلمات

id

string

معرف تعارض .

partitionKey
PartitionKey

المرتجعات

Conflict

delete(RequestOptions)

حذف الحاوية

function delete(options?: RequestOptions): Promise<ContainerResponse>

المعلمات

options
RequestOptions

المرتجعات

Promise<ContainerResponse>

deleteAllItemsForPartitionKey(PartitionKey, RequestOptions)

حذف كافة المستندات تنتمي إلى الحاوية لقيمة مفتاح القسم المتوفرة

function deleteAllItemsForPartitionKey(partitionKey: PartitionKey, options?: RequestOptions): Promise<ContainerResponse>

المعلمات

partitionKey
PartitionKey

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

options
RequestOptions

المرتجعات

Promise<ContainerResponse>

getFeedRanges() 

function getFeedRanges(): Promise<readonly FeedRange[]>

المرتجعات

Promise<readonly FeedRange[]>

جميع نطاقات الموجزات التي يمكن إحضار ملف التغيير لها.

getPartitionKeyDefinition()

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

This method has been renamed to readPartitionKeyDefinition.

يحصل على تعريف مفتاح القسم أولا من خلال النظر في ذاكرة التخزين المؤقت بخلاف ذلك عن طريق قراءة المجموعة.

function getPartitionKeyDefinition(): Promise<ResourceResponse<PartitionKeyDefinition>>

المرتجعات

Promise<ResourceResponse<PartitionKeyDefinition>>

getQueryPlan(string | SqlQuerySpec) 

function getQueryPlan(query: string | SqlQuerySpec): Promise<Response_2<PartitionedQueryExecutionInfo>>

المعلمات

query

string | SqlQuerySpec

المرتجعات

Promise<Response_2<PartitionedQueryExecutionInfo>>

item(string, PartitionKey)

يستخدم لقراءة عنصر موجود أو استبداله أو حذفه حسب المعرف.

استخدم .items لإنشاء عناصر جديدة أو الاستعلام عن كافة العناصر أو قراءتها.

المثال

استبدال عنصر const {body: replacedItem} = await container.item("<item id>", "<partition key value>").replace({id: "<item id>", title: "Updated post", authorID: 5});

function item(id: string, partitionKeyValue?: PartitionKey): Item

المعلمات

id

string

معرف عنصر .

partitionKeyValue
PartitionKey

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

المرتجعات

Item

read(RequestOptions)

قراءة تعريف الحاوية

function read(options?: RequestOptions): Promise<ContainerResponse>

المعلمات

options
RequestOptions

المرتجعات

Promise<ContainerResponse>

readOffer(RequestOptions)

الحصول على عرض على الحاوية. إذا لم يكن هناك أي منها، فترجع OfferResponse مع غير معرف.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

المعلمات

options
RequestOptions

المرتجعات

Promise<OfferResponse>

readPartitionKeyRanges(FeedOptions) 

function readPartitionKeyRanges(feedOptions?: FeedOptions): QueryIterator<PartitionKeyRange>

المعلمات

feedOptions
FeedOptions

المرتجعات

QueryIterator<PartitionKeyRange>

replace(ContainerDefinition, RequestOptions)

استبدال تعريف الحاوية

function replace(body: ContainerDefinition, options?: RequestOptions): Promise<ContainerResponse>

المعلمات

body
ContainerDefinition
options
RequestOptions

المرتجعات

Promise<ContainerResponse>