@azure/cosmos package

يتم طرح هذا الخطأ عند إجهاض عملية غير متزامنة. تحقق من هذا الخطأ عن طريق اختبار name أن خاصية اسم الخطأ تتطابق مع "AbortError".

مثال

const controller = new AbortController();
controller.abort();
try {
  doAsyncWork(controller.signal)
} catch (e) {
  if (e.name === 'AbortError') {
    // handle abort error here.
  }
}

يوفر مكرر لموجز التغيير.

استخدم Items.changeFeed() للحصول على مثيل من المكرر.

صفحة استجابة واحدة من موجز تغيير Azure Cosmos DB

يمثل تكوين نهج موجز التغيير لحاوية في خدمة Azure Cosmos DB.

صفحة استجابة واحدة من موجز تغيير Azure Cosmos DB

الفئة الأساسية لمكان بدء تشغيل ChangeFeedIterator.

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

راجع التعارضات للاستعلام عن كافة التعارضات أو قراءتها.

استخدم للاستعلام عن كافة التعارضات أو قراءتها.

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

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

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

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

كائن الاستجابة لعمليات الحاوية

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

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

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

يوفر تمثيلا منطقيا من جانب العميل لحساب قاعدة بيانات 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,
   },
});

• هذا هو نوع تشخيص Cosmos الذي يحتوي على معلومات التشخيص المجمعة أثناء عمليات العميل. اي. Item.read(), Container.create(). لديها ثلاثة أعضاء -

1. يحتوي عضو clientSideRequestStatistics على معلومات تشخيصية مجمعة، بما في ذلك -

• عمليات البحث عن بيانات التعريف. هنا تعتبر جميع طلبات الخادم، بصرف النظر عن المورد المقصود النهائي استدعاءات بيانات التعريف. أي بالنسبة إلى item.read(id)، إذا قام العميل بإجراء استدعاء الخادم لاكتشاف نقاط النهاية، اعتباره استدعاء بيانات التعريف.
• المحاولات
• نقاط النهاية التي تم الاتصال بها.
• طلب، إحصائيات حمولة الاستجابة.
• gatewayStatistics - معلومات مطابقة للعملية الرئيسية. على سبيل المثال أثناء Item.read()، قد يقوم العميل بالعديد من العمليات، مثل البحث عن بيانات التعريف وما إلى ذلك، ولكن gatewayStatistics تمثل معلومات التشخيص لعملية القراءة الفعلية.

2. diagnosticNode - هي شجرة مثل البنية التي تلتقط معلومات التشخيص التفصيلية. بشكل افتراضي، يتم تعطيله، ويهدف إلى استخدامه فقط لتصحيح الأخطاء في البيئات غير الإنتاجية. يتم التحكم في نوع التفاصيل التي تم التقاطها في diagnosticNode بواسطة CosmosDbDiagnosticLevel.

• CosmosDbDiagnosticLevel.info - هي القيمة الافتراضية. في هذا المستوى يتم التقاط clientSideRequestStatistics فقط. هو مخصص لبيئات الإنتاج.
• CosmosDbDiagnosticLevel.debug - يلتقط diagnosticNode و clientConfig. لا يتم التقاط أي حمولات طلب واستجابة. لا يقصد استخدامه في بيئة الإنتاج.
• CosmosDbDiagnosticLevel.debug-unsafe - بالإضافة إلى البيانات التي تم التقاطها في CosmosDbDiagnosticLevel.debug، يلتقط أيضا حمولات الطلب والاستجابة. لا يقصد استخدامه في بيئة الإنتاج.

3. clientConfig - يلتقط المعلومات المتعلقة بكيفية تكوين العميل أثناء التهيئة.

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

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

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

يمثل DatabaseAccount في خدمة قاعدة بيانات Azure Cosmos DB.

كائن الاستجابة لعمليات قاعدة البيانات

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

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

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

تحديد نطاق موجز لملف التغيير.

يستخدم لتنفيذ عمليات على عنصر معين.

راجع عناصر للعمليات على كافة العناصر؛ راجع .

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

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

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

راجع العروض للاستعلام عن جميع العروض أو قراءتها.

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

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

فئة المنشئ لبناء PartitionKey.

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

راجع الأذونات لإنشاء كافة الأذونات أو رفعها أو الاستعلام أو قراءتها.

استخدم لإنشاء كافة الأذونات واستبدالها والاستعلام عنها وقراءتها.

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

يمثل كائن QueryIterator، وهو تنفيذ للموجز أو استجابة الاستعلام التي تمكن الاجتياز والتكرار عبر الاستجابة في خدمة قاعدة بيانات Azure Cosmos DB.

نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.

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

لعمليات إنشاء أو قراءة الكل أو الاستعلام عن الإجراءات المخزنة،

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

لعمليات قراءة إجراء مخزن محدد موجود أو استبداله أو حذفه أو تنفيذه حسب المعرف، راجع container.storedProcedure().

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

استخدم container.triggers لإنشاء الكل أو رفعه أو الاستعلام أو قراءته.

عمليات إنشاء جميع المشغلات وتكبيرها والاستعلام وقراءتها.

استخدم لقراءةمشغل أو استبداله أو حذفه.

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

بالإضافة إلى ذلك، يمكنك الوصول إلى أذونات مستخدم معين عبر user.permissionuser.permissions.

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

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

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

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

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

يستخدم لإنشاء جميع المستخدمين وتكبيرهم والاستعلام عن بياناتهم وقراءتها.

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

عنصر الخيارات المستخدم لتعديل التنفيذ المجمع. continueOnError (القيمة الافتراضية: false) - يستمر التنفيذ المجمع عند فشل عملية ** ملاحظة هذا الافتراضي إلى TRUE في الإصدار 4.0

تحديد خيارات لموجز التغيير

إذا لم يتم تعيين أي من هذه الخيارات، فسيبدأ في قراءة التغييرات من الآن للحاوية بأكملها.

تحديد خيارات لموجز التغيير

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

• استمرار
• وقت البدء
• startFromBeginning

إذا لم يتم تعيين أي من هذه الخيارات، فسيبدأ في قراءة التغييرات من المكالمة ChangeFeedIterator.fetchNext() الأولى.

استخدم Items.getChangeFeedIterator() لإرجاع مكرر يمكنه تكرار جميع التغييرات لمفتاح قسم أو نطاق موجز أو حاوية بأكملها.

يمثل مسارا مركبا في نهج الفهرسة.

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

يمثل نهج الاتصال المقترن ب CosmosClient في خدمة قاعدة بيانات Azure Cosmos DB.

يمثل شجرة مثل البنية، لالتقاط معلومات التشخيص.

يلتقط هذا النوع معلومات التشخيص المتعلقة بطلب فاشل لواجهة برمجة تطبيقات الخادم.

خيارات الموجز وأساليب الاستعلام.

يمثل فهرس نص كامل في نهج الفهرسة.

يمثل مسار نص كامل ليتم فهرسته في خدمة Azure Cosmos DB.

يمثل نهج نص كامل لمجموعة في خدمة Azure Cosmos DB.

العناصر في Cosmos DB هي ببساطة كائنات JSON. تسمح معظم عمليات Item بتوفير النوع الخاص بك الذي يوسع ItemDefinition البسيط جدا.

لا يمكنك استخدام أي مفاتيح محجوزة. يمكنك مشاهدة قائمة المفاتيح المحجوزة في <xref:ItemBody>

تستخدم لتحديد المواقع المتوفرة، تكون القراءة هي الفهرس 1 والكتابة هي الفهرس 0.

يحتوي هذا النوع على معلومات تشخيصية تتعلق بطلب بيانات تعريف واحدة إلى الخادم.

الخيارات التي يمكن تحديدها لإصدار مطلوب لخوادم Azure Cosmos DB.=

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

الخيارات التي يمكن تحديدها لإصدار مطلوب لخوادم Azure Cosmos DB.=

يمثل معلمة في استعلام SQL معلمات، محدد في SqlQuerySpec

يمثل استعلام SQL في خدمة Azure Cosmos DB.

يجب تحديد معلمات الاستعلامات ذات المدخلات للحماية من حقن SQL.

مثال

استعلام SQL ذات معلمات

const query: SqlQuerySpec = {
  query: "SELECT * FROM Families f where f.lastName = @lastName",
  parameters: [
    {name: "@lastName", value: "Wakefield"}
  ]
};

واجهة لمفتاح فريد واحد تم تمريره كجزء من UniqueKeyPolicy

واجهة لإعداد مفاتيح فريدة على إنشاء الحاوية

يمثل تضمين متجه. يتم استخدام تضمين متجه لتعريف حقل متجه في المستندات.

يمثل تكوين النهج لتضمين المتجهات في خدمة Azure Cosmos DB.

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

يحتوي هذا النوع على معلومات تتعلق بتهيئة CosmosClient

هذا نوع مجموعة لكافة معلومات التشخيص من جانب العميل.

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

يمثل الكائن الذي تم إرجاعه قيمة مفتاح القسم التي تسمح بإنشاء العناصر والوصول إليها دون قيمة لمفتاح القسم

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

PartitionKey للحاوية.

قيمة مفتاح قسم بدائية.

يلتقط هذا النوع معلومات التشخيص المتعلقة بمحاولة إعادة المحاولة أثناء عملية عميل CosmosDB.

تحديد سلوك الاتصال ل CosmosClient. ملاحظة، نحن ندعم حاليا وضع البوابة فقط.

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

مستويات التناسق حسب ترتيب القوة هي Strong و BoundedStaleness و Session و Consistent Prefix و Eventual.

راجع https://aka.ms/cosmos-consistency للحصول على وثائق أكثر تفصيلا حول مستويات التناسق.

مستوى تشخيص Cosmos DB

تعريف نوع البيانات الهدف لمواصفات مسار الفهرس في خدمة Azure Cosmos DB.

تحديد أنواع الفهرس المدعومة.

تحديد أوضاع الفهرسة المدعومة.

هذا تعداد لنوع عمليات البحث عن بيانات التعريف الممكنة.

إصدار تعريف PartitionKey

نوع PartitionKey، أي التجزئة، MultiHash

تعداد لقيم وضع الأذونات.

يمثل مستوى الأولوية المقترن بكل طلبات عميل Azure Cosmos DB.
يتم دائما تقييد الطلبات ذات الأولوية المنخفضة قبل أي طلبات ذات أولوية عالية.

بشكل افتراضي، تعتبر جميع الطلبات طلبات ذات أولوية عالية.

راجع https://aka.ms/CosmosDB/PriorityBasedExecution للحصول على وثائق أكثر تفصيلا حول التقييد المستند إلى الأولوية.

تعداد لقيم عملية المشغل. يحدد العمليات التي يجب تنفيذ المشغل عليها.

تعداد لقيم نوع المشغل. تحديد نوع المشغل.

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

يمثل نوع بيانات المتجه.

تمثل دالة المسافة لاستخدامها في حساب المسافة بين المتجهات.

يمثل نوع الفهرس للمتجه.

الداخلية التجريبية فقط بإنشاء الحمولة التي تمثل تكوين الإذن للرمز المميز sas.