التشغيل السريع: مكتبة Azure Cosmos DB ل NoSQL Node.js

ينطبق على: NoSQL

• NET.
• JavaScript/Node.js
• Java
• Python
• ذهب

ابدأ مع مكتبة عميل Azure Cosmos DB for NoSQL Node.js للاستعلام عن البيانات في حاوياتك وتنفيذ العمليات الشائعة على العناصر الفردية. اتبع هذه الخطوات لنشر الحد الأدنى من الحل إلى البيئة الخاصة بك باستخدام Azure Developer CLI.

الوثائق | المرجعية لواجهة برمجة التطبيقات حزمة التعليمات البرمجية | المصدر لمكتبة (npm) | Azure Developer CLI

المتطلبات الأساسية

• حساب Azure مع اشتراك نشط. أنشئ حساباً مجاناً.
• حساب GitHub

• حساب Azure مع اشتراك نشط. أنشئ حساباً مجاناً.
• Azure Developer CLI
• Docker Desktop

الإعداد

نشر حاوية تطوير هذا المشروع إلى البيئة الخاصة بك. ثم استخدم Azure Developer CLI (azd) لإنشاء حساب Azure Cosmos DB ل NoSQL ونشر نموذج تطبيق حاوية. يستخدم نموذج التطبيق مكتبة العميل لإدارة البيانات النموذجية وإنشاءها وقراءتها والاستعلام عن البيانات.

هام

تتضمن حسابات GitHub استحقاق التخزين والساعات الأساسية دون أي تكلفة. لمزيد من المعلومات، راجع التخزين المضمن والساعات الأساسية لحسابات GitHub.

1. افتح محطة طرفية في الدليل الجذر للمشروع.

2. المصادقة على Azure Developer CLI باستخدام azd auth login. اتبع الخطوات المحددة بواسطة الأداة للمصادقة على CLI باستخدام بيانات اعتماد Azure المفضلة لديك.

   azd auth login
   

3. استخدم azd init لتهيئة المشروع.

   azd init --template cosmos-db-nosql-nodejs-quickstart
   

   إشعار

   يستخدم هذا التشغيل السريع مستودع GitHub لقالب azure-samples/cosmos-db-nosql-nodejs-quickstart . سيقوم Azure Developer CLI تلقائيا باستنساخ هذا المشروع إلى جهازك إذا لم يكن موجودا بالفعل.

4. أثناء التهيئة، قم بتكوين اسم بيئة فريد.

   تلميح

   سيتم أيضا استخدام اسم البيئة كاسم مجموعة الموارد الهدف. لهذا التشغيل السريع، ضع في اعتبارك استخدام msdocs-cosmos-db.

5. انشر حساب Azure Cosmos DB باستخدام azd up. تنشر قوالب Bicep أيضا نموذج تطبيق ويب.

   azd up
   

6. أثناء عملية التوفير، حدد اشتراكك والموقع المطلوب. انتظر حتى اكتمال عملية التوفير. قد تستغرق العملية حوالي خمس دقائق.

7. بمجرد توفير موارد Azure الخاصة بك، يتم تضمين عنوان URL لتطبيق الويب قيد التشغيل في الإخراج.

   Deploying services (azd deploy)
   
     (✓) Done: Deploying service web
   - Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>
   
   SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
   

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

   

تثبيت مكتبة العميل

تتوفر مكتبة العميل من خلال مدير الحِزَم العقدة، كحزمة@azure/cosmos.

1. افتح terminal وانتقل إلى /src المجلد.

   cd ./src
   

2. إذا لم يكن مثبتا بالفعل، فقم بتثبيت الحزمة @azure/cosmos باستخدام npm install.

   npm install --save @azure/cosmos
   

3. أيضا، قم بتثبيت الحزمة @azure/identity إذا لم تكن مثبتة بالفعل.

   npm install --save @azure/identity
   

4. افتح الملف src/package.json وراجعه للتحقق من وجود azure-cosmos الإدخالين وazure-identity.

نموذج الكائن

Name	‏‏الوصف
CosmosClient	هذه الفئة هي فئة العميل الأساسية وتستخدم لإدارة بيانات التعريف أو قواعد البيانات على مستوى الحساب.
Database	تمثل هذه الفئة قاعدة بيانات داخل الحساب.
Container	تستخدم هذه الفئة بشكل أساسي لتنفيذ عمليات القراءة والتحديث والحذف على الحاوية أو العناصر المخزنة داخل الحاوية.
PartitionKey	تمثل هذه الفئة مفتاح قسم منطقي. هذه الفئة مطلوبة للعديد من العمليات والاستعلامات الشائعة.
SqlQuerySpec	تمثل هذه الواجهة استعلام SQL وأي معلمات استعلام.

أمثلة على التعليمات البرمجية

• مصادقة العميل
• الحصول على قاعدة بيانات
• الحصول على حاوية
• إنشاء عنصر
• الحصول على عنصر
• عناصر الاستعلام

يستخدم نموذج التعليمات البرمجية في القالب قاعدة بيانات باسم cosmicworks وحاوية باسم products. products تحتوي الحاوية على تفاصيل مثل الاسم والفئة والكمية والمعرف الفريد وعلامة البيع لكل منتج. تستخدم الحاوية الخاصية /category كمفتاح قسم منطقي.

مصادقة العميل

يجب التصريح بطلبات التطبيق إلى معظم خدمات Azure. DefaultAzureCredential استخدم النوع كطريقة مفضلة لتنفيذ اتصال بدون كلمة مرور بين تطبيقاتك وAzure Cosmos DB ل NoSQL. DefaultAzureCredential يدعم أساليب مصادقة متعددة ويحدد الأسلوب الذي يجب استخدامه في وقت التشغيل.

هام

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

ينشئ هذا النموذج مثيلا جديدا من CosmosClient النوع ويصادق باستخدام مثيل DefaultAzureCredential .

const credential = new DefaultAzureCredential();

const client = new CosmosClient({
    endpoint,
    aadCredentials: credential
});

الحصول على قاعدة بيانات

استخدم client.database لاسترداد قاعدة البيانات الموجودة المسماة cosmicworks.

const database = client.database('cosmicworks');

الحصول على حاوية

استرداد الحاوية الموجودة products باستخدام database.container.

const container = database.container('products');

إنشاء عنصر

أنشئ كائنا جديدا مع جميع الأعضاء الذين تريد تسلسلهم إلى JSON. في هذا المثال، يحتوي النوع على معرف فريد وحقول للفئة والاسم والكمية والسعر والبيع. إنشاء عنصر في الحاوية باستخدام container.items.upsert. هذا الأسلوب "upserts" العنصر استبدال العنصر بشكل فعال إذا كان موجودا بالفعل.

var item = {
    'id': '70b63682-b93a-4c77-aad2-65501347265f',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

var response = await container.items.upsert(item);

قراءة عنصر

تنفيذ عملية قراءة نقطة باستخدام كل من المعرف الفريد (id) وحقول مفتاح القسم. استخدم container.item للحصول على مؤشر إلى عنصر واسترداد item.read العنصر المحدد بكفاءة.

var id = '70b63682-b93a-4c77-aad2-65501347265f';
var partitionKey = 'gear-surf-surfboards';

var response = await container.item(id, partitionKey).read();
var read_item = response.resource;

عناصر الاستعلام

تنفيذ استعلام عبر عناصر متعددة في حاوية باستخدام container.items.query. ابحث عن كافة العناصر ضمن فئة محددة باستخدام هذا الاستعلام الذي تم تحديد معلمات له:

SELECT * FROM products p WHERE p.category = @category

إحضار كافة نتائج الاستعلام باستخدام query.fetchAll. التكرار الحلقي عبر نتائج الاستعلام.

const querySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

var response = await container.items.query(querySpec).fetchAll();
for (var item of response.resources) {

}

المحتوى ذو الصلة

• التشغيل السريع ل .NET
• التشغيل السريع ل Java
• التشغيل السريع ل Python
• التشغيل السريع

الخطوة التالية

البرنامج التعليمي: إنشاء تطبيق ويب Node.js