Database class

الحزمة:

@azure/cosmos

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

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

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

المنشئون

Database(CosmosClient, string, ClientContext)

إرجاع مثيل قاعدة بيانات جديد. ملاحظة: الهدف هو الحصول على هذا الكائن من CosmosClient عبر client.database(id)، وليس لإنشاء مثيل له بنفسك.

الخصائص

client
containers	يستخدم لإنشاء حاويات جديدة، أو الاستعلام/قراءة جميع الحاويات. استخدم .database(id) لقراءة قاعدة بيانات معينة موجودة أو استبدالها أو حذفها بواسطة المعرف. مثال إنشاء حاوية واحدة const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	إرجاع عنوان URL مرجعي إلى المورد. يستخدم للارتباط في الأذونات.
users	يستخدم لإنشاء مستخدمين جدد، أو الاستعلام/قراءة جميع المستخدمين. استخدم .user(id) لقراءة مستخدم موجود أو استبداله أو حذفه حسب المعرف.

الأساليب

container(string)	يستخدم لقراءة قاعدة بيانات موجودة معينة أو استبدالها أو حذفها بواسطة المعرف. استخدم .containers إنشاء حاويات جديدة، أو الاستعلام/قراءة جميع الحاويات. مثال حذف حاوية await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	احذف قاعدة البيانات المحددة.
read(RequestOptions)	اقرأ تعريف قاعدة البيانات المحددة.
readOffer(RequestOptions)	الحصول على عرض على قاعدة البيانات. إذا لم يكن هناك أي منها، فترجع OfferResponse مع غير محدد.
user(string)	يستخدم لقراءة مستخدم موجود أو استبداله أو حذفه حسب المعرف. يستخدم .users لإنشاء مستخدمين جدد، أو الاستعلام/قراءة جميع المستخدمين.

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

Database(CosmosClient, string, ClientContext)

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

ملاحظة: الهدف هو الحصول على هذا الكائن من CosmosClient عبر client.database(id)، وليس لإنشاء مثيل له بنفسك.

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

المعلمات

client

CosmosClient

id

string

clientContext

ClientContext

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

client

client: CosmosClient

قيمة الخاصية

CosmosClient

containers

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

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

مثال

إنشاء حاوية واحدة

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

قيمة الخاصية

Containers

id

id: string

قيمة الخاصية

string

url

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

string url

قيمة الخاصية

string

users

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

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

users: Users

قيمة الخاصية

Users

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

container(string)

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

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

مثال

حذف حاوية

await client.database("<db id>").container("<container id>").delete();

function container(id: string): Container

المعلمات

id

string

المرتجعات

Container

delete(RequestOptions)

احذف قاعدة البيانات المحددة.

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

المعلمات

options

RequestOptions

المرتجعات

Promise<DatabaseResponse>

read(RequestOptions)

اقرأ تعريف قاعدة البيانات المحددة.

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

المعلمات

options

RequestOptions

المرتجعات

Promise<DatabaseResponse>

readOffer(RequestOptions)

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

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

المعلمات

options

RequestOptions

المرتجعات

Promise<OfferResponse>

user(string)

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

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

function user(id: string): User

المعلمات

id

string

المرتجعات

User