Containers class

الحزمة:

@azure/cosmos

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

راجع الحاوية لقراءة حاوية موجودة أو استبدالها أو حذفها؛ استخدم .container(id).

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

المنشئون

Containers(Database, ClientContext)

الخصائص

database

الأساليب

create(ContainerRequest, RequestOptions)	إنشاء حاوية. الحاوية هي حاوية منطقية مسماة للعناصر. قد تحتوي قاعدة البيانات على حاويات مسماة صفرية أو أكثر وكل حاوية تتكون من صفر أو أكثر من عناصر JSON. لكونها خالية من المخطط، لا تحتاج العناصر الموجودة في الحاوية إلى مشاركة نفس البنية أو الحقول. نظرا لأن الحاويات هي موارد تطبيق، يمكن التصريح بها باستخدام المفتاح الرئيسي أو مفاتيح الموارد.
createIfNotExists(ContainerRequest, RequestOptions)	يتحقق ما إذا كانت الحاوية موجودة، وإذا لم تكن موجودة، فإنها تنشئها. سيؤدي هذا إلى إجراء عملية قراءة استنادا إلى المعرف في body، ثم إذا لم يتم العثور عليه، عملية إنشاء. يجب التأكد من أن الإخراج يطابق النص الأساسي الذي قمت بتمريره للخصائص غير الافتراضية (أي نهج الفهرسة/إلخ.) الحاوية هي حاوية منطقية مسماة للعناصر. قد تحتوي قاعدة البيانات على حاويات مسماة صفرية أو أكثر وكل حاوية تتكون من صفر أو أكثر من عناصر JSON. لكونها خالية من المخطط، لا تحتاج العناصر الموجودة في الحاوية إلى مشاركة نفس البنية أو الحقول. نظرا لأن الحاويات هي موارد تطبيق، يمكن التصريح بها باستخدام المفتاح الرئيسي أو مفاتيح الموارد.
query(SqlQuerySpec, FeedOptions)	الاستعلام عن جميع الحاويات. مثال اقرأ جميع الحاويات إلى الصفيف. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
query<T>(SqlQuerySpec, FeedOptions)	الاستعلام عن جميع الحاويات. مثال اقرأ جميع الحاويات إلى الصفيف. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *
readAll(FeedOptions)	اقرأ جميع الحاويات. مثال اقرأ جميع الحاويات إلى الصفيف. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

تفاصيل المنشئ

Containers(Database, ClientContext)

new Containers(database: Database, clientContext: ClientContext)

المعلمات

database

Database

clientContext

ClientContext

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

database

database: Database

قيمة الخاصية

Database

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

create(ContainerRequest, RequestOptions)

إنشاء حاوية.

الحاوية هي حاوية منطقية مسماة للعناصر.

قد تحتوي قاعدة البيانات على حاويات مسماة صفرية أو أكثر وكل حاوية تتكون من صفر أو أكثر من عناصر JSON.

لكونها خالية من المخطط، لا تحتاج العناصر الموجودة في الحاوية إلى مشاركة نفس البنية أو الحقول.

نظرا لأن الحاويات هي موارد تطبيق، يمكن التصريح بها باستخدام المفتاح الرئيسي أو مفاتيح الموارد.

function create(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

المعلمات

body

ContainerRequest

يمثل نص الحاوية.

options

RequestOptions

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

المرتجعات

Promise<ContainerResponse>

createIfNotExists(ContainerRequest, RequestOptions)

يتحقق ما إذا كانت الحاوية موجودة، وإذا لم تكن موجودة، فإنها تنشئها. سيؤدي هذا إلى إجراء عملية قراءة استنادا إلى المعرف في body، ثم إذا لم يتم العثور عليه، عملية إنشاء. يجب التأكد من أن الإخراج يطابق النص الأساسي الذي قمت بتمريره للخصائص غير الافتراضية (أي نهج الفهرسة/إلخ.)

الحاوية هي حاوية منطقية مسماة للعناصر.

قد تحتوي قاعدة البيانات على حاويات مسماة صفرية أو أكثر وكل حاوية تتكون من صفر أو أكثر من عناصر JSON.

لكونها خالية من المخطط، لا تحتاج العناصر الموجودة في الحاوية إلى مشاركة نفس البنية أو الحقول.

نظرا لأن الحاويات هي موارد تطبيق، يمكن التصريح بها باستخدام المفتاح الرئيسي أو مفاتيح الموارد.

function createIfNotExists(body: ContainerRequest, options?: RequestOptions): Promise<ContainerResponse>

المعلمات

body

ContainerRequest

يمثل نص الحاوية.

options

RequestOptions

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

المرتجعات

Promise<ContainerResponse>

query(SqlQuerySpec, FeedOptions)

الاستعلام عن جميع الحاويات.

مثال

اقرأ جميع الحاويات إلى الصفيف. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

المعلمات

query

SqlQuerySpec

تكوين الاستعلام للعملية. راجع SqlQuerySpec لمزيد من المعلومات حول كيفية تكوين استعلام.

options

FeedOptions

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

المرتجعات

QueryIterator<any>

QueryIterator يسمح لك بإعادة حاويات معينة في صفيف أو تكرارها واحدا تلو الآخر. *

query<T>(SqlQuerySpec, FeedOptions)

الاستعلام عن جميع الحاويات.

مثال

اقرأ جميع الحاويات إلى الصفيف. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @container", * parameters: [ * {name: "@container", value: "Todo"} * ] * }; * const {body: containerList} = await client.database("<db id>").containers.query(querySpec).fetchAll(); *

function query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

المعلمات

query

SqlQuerySpec

تكوين الاستعلام للعملية. راجع SqlQuerySpec لمزيد من المعلومات حول كيفية تكوين استعلام.

options

FeedOptions

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

المرتجعات

QueryIterator<T>

QueryIterator يسمح لك بإعادة حاويات معينة في صفيف أو تكرارها واحدا تلو الآخر. *

readAll(FeedOptions)

اقرأ جميع الحاويات.

مثال

اقرأ جميع الحاويات إلى الصفيف. * typescript * const {body: containerList} = await client.database("<db id>").containers.readAll().fetchAll(); *

function readAll(options?: FeedOptions): QueryIterator<ContainerDefinition & Resource>

المعلمات

options

FeedOptions

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

المرتجعات

QueryIterator<ContainerDefinition & Resource>

QueryIterator يسمح لك بإعادة جميع الحاويات في صفيف أو التكرار فوقها واحدا تلو الآخر. *