مشاركة عبر

CosmosClient class

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

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

المثال

إنشاء مثيل لعميل وإنشاء قاعدة بيانات جديدة

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

المثال

إنشاء مثيل لعميل باستخدام نهج اتصال مخصص

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

المنشئون

CosmosClient(CosmosClientOptions)

إنشاء كائن CosmosClient جديد. راجع CosmosClientOptions لمزيد من التفاصيل حول الخيارات التي يمكنك استخدامها.
CosmosClient(string)

إنشاء كائن CosmosClient جديد من سلسلة اتصال. يمكن العثور على سلسلة اتصال قاعدة البيانات في مدخل Microsoft Azure

الخصائص

databases

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

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

المثال

إنشاء قاعدة بيانات جديدة

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers

يستخدم للاستعلام عن & قراءة جميع العروض.

استخدم .offer(id) لقراءة العروض الموجودة أو استبدالها.

الأساليب

database(string)

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

لا يؤدي هذا إلى إجراء مكالمة على الشبكة. استخدم .read للحصول على معلومات حول قاعدة البيانات بعد الحصول على كائن قاعدة البيانات.

المثال

إنشاء حاوية جديدة خارج قاعدة بيانات موجودة

const container = client.database("<database id>").containers.create("<container id>");

المثال

حذف قاعدة بيانات موجودة

await client.database("<id here>").delete();
dispose()

مسح تحديث نقطة نهاية الخلفية. استخدم client.dispose() عند تدمير CosmosClient ضمن عملية أخرى.
getDatabaseAccount(RequestOptions)

الحصول على معلومات حول DatabaseAccount الحالية (بما في ذلك المناطق المدعومة وما إلى ذلك)
getReadEndpoint()

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

قد يحتوي url على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.
getReadEndpoints()

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

قد يحتوي url على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.
getWriteEndpoint()

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

قد يحتوي url على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.
getWriteEndpoints()

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

قد تحتوي عناوين URL على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.
offer(string)

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

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

CosmosClient(CosmosClientOptions)

إنشاء كائن CosmosClient جديد. راجع CosmosClientOptions لمزيد من التفاصيل حول الخيارات التي يمكنك استخدامها.

new CosmosClient(options: CosmosClientOptions)

المعلمات

options
CosmosClientOptions

حقيبة من الخيارات؛ يتطلب تكوين نقطة النهاية والمصادقة على الأقل

CosmosClient(string)

إنشاء كائن CosmosClient جديد من سلسلة اتصال. يمكن العثور على سلسلة اتصال قاعدة البيانات في مدخل Microsoft Azure

new CosmosClient(connectionString: string)

المعلمات

connectionString

string

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

databases

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

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

المثال

إنشاء قاعدة بيانات جديدة

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});

databases: Databases

قيمة الخاصية

Databases

offers

يستخدم للاستعلام عن & قراءة جميع العروض.

استخدم .offer(id) لقراءة العروض الموجودة أو استبدالها.

offers: Offers

قيمة الخاصية

Offers

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

database(string)

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

لا يؤدي هذا إلى إجراء مكالمة على الشبكة. استخدم .read للحصول على معلومات حول قاعدة البيانات بعد الحصول على كائن قاعدة البيانات.

المثال

إنشاء حاوية جديدة خارج قاعدة بيانات موجودة

const container = client.database("<database id>").containers.create("<container id>");

المثال

حذف قاعدة بيانات موجودة

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

function database(id: string): Database

المعلمات

id

string

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

المرتجعات

Database

dispose()

مسح تحديث نقطة نهاية الخلفية. استخدم client.dispose() عند تدمير CosmosClient ضمن عملية أخرى.

function dispose()

getDatabaseAccount(RequestOptions)

الحصول على معلومات حول DatabaseAccount الحالية (بما في ذلك المناطق المدعومة وما إلى ذلك)

function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>

المعلمات

options
RequestOptions

المرتجعات

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

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

قد يحتوي url على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.

function getReadEndpoint(): Promise<string>

المرتجعات

Promise<string>

getReadEndpoints()

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

قد يحتوي url على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.

function getReadEndpoints(): Promise<readonly string[]>

المرتجعات

Promise<readonly string[]>

getWriteEndpoint()

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

قد يحتوي url على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.

function getWriteEndpoint(): Promise<string>

المرتجعات

Promise<string>

getWriteEndpoints()

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

قد تحتوي عناوين URL على لاحقة منطقة (على سبيل المثال، "-eastus") إذا كنا نستخدم نقاط نهاية محددة للموقع.

function getWriteEndpoints(): Promise<readonly string[]>

المرتجعات

Promise<readonly string[]>

offer(string)

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

function offer(id: string): Offer

المعلمات

id

string

معرف العرض.

المرتجعات

Offer