أمثلة Azure Cosmos DB.NET v 3 SDK (Microsoft.Azure.Cosmos) لواجهة برمجة تطبيقات SQL

ينطبق على: واجهة برمجة تطبيقات SQL

يتضمن مستودع azure-cosmos-dotnet-v3 GitHub أحدث نماذج حلول Microsoft .NET. يمكنك استخدام هذه الحلول لتنفيذ CRUD (إنشاء وقراءة وتحديث وحذف) والعمليات الشائعة الأخرى على موارد Azure Cosmos DB.

إذا كنت على دراية بالإصدار السابق من .NET SDK، فقد تكون معتادًا على مجموعة المصطلحات والمستندات. نظرًا لأن Azure Cosmos DB يدعم العديد من نماذج واجهة برمجة التطبيقات، فإن الإصدار 3.0 من .NET SDK يستخدم المصطلحات العامة الحاوية والعنصر. يمكن أن تكون الحاوية عبارة عن مجموعة أو رسم بياني أو جدول. يمكن للعنصر أن يكون مستندًا أو حافة/رأسًا أو صفًا، وهو المحتوى الموجود داخل الحاوية. توفر هذه المقالة:

  • روابط إلى المهام في كل من ملفات مثال المشروع C#‎.
  • روابط إلى المحتوى المرجعي API ذات الصلة.

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

ملاحظة

العينات قائمة بذاتها ويتم إعدادها وتنظيفها ذاتيًا. كل تكرار فواتير اشتراكك لمدة ساعة واحدة من الاستخدام في مستوى الأداء الحاوية الخاصة بك.

أمثلة قاعدة البيانات

يوضح أسلوب RunDatabaseDemo لنموذج مشروع DatabaseManagement طريقة تنفيذ المهام التالية. للتعرف على قواعد بيانات Azure Cosmos DB قبل تشغيل العينات التالية، راجع العمل مع قواعد البيانات والحاويات والعناصر.

المهمة مرجع واجهة برمجة التطبيقات‬
إنشاء قاعدة بيانات CosmosClient.CreateDatabaseIfNotExistsAsync
قراءة قاعدة بيانات تبعًا للمعرّف ID Database.ReadAsync
قراءة كافة قواعد البيانات في حساب CosmosClient.GetDatabaseQueryIterator
حذف قاعدة بيانات Database.DeleteAsync

أمثلة الحاوية

يوضح أسلوب RunContainerDemo من مشروع ContainerManagement النموذجي كيفية القيام بالمهام التالية. للتعرف على حاويات Azure Cosmos DB قبل تشغيل العينات التالية، راجع العمل مع قواعد البيانات والحاويات والعناصر.

المهمة مرجع واجهة برمجة التطبيقات‬
إنشاء حاوية Database.CreateContainerIfNotExistsAsync
إنشاء حاوية بسياسة الفهرس المخصص Database.CreateContainerIfNotExistsAsync
تغيير الأداء المكوّن للحاوية Container.ReplaceThroughputAsync
الحصول على حاوية تبعًا للمعرّف ID Container.ReadContainerAsync
قراءة كافة الحاويات في قاعدة بيانات Database.GetContainerQueryIterator
حذف حاوية Container.DeleteContainerAsync

أمثلة على الأصناف

يوضح أسلوب RunItemsDemo من مشروع ItemManagement النموذجي كيفية القيام بالمهام التالية. للتعرف على عناصر Azure Cosmos DB قبل تشغيل العينات التالية، راجع العمل مع قواعد البيانات والحاويات والعناصر.

المهمة مرجع واجهة برمجة التطبيقات‬
إنشاء عنصر Container.CreateItemAsync
قراءة العنصر تبعًا للمعرّف ID container.ReadItemAsync
الاستعلام عن العناصر container.GetItemQueryIterator
استبدال عنصر container.ReplaceItemAsync
رفع عنصر container.UpsertItemAsync
حذف عنصر container.DeleteItemAsync
استبدال عنصر بتحقق ETag الشرطي RequestOptions.IfMatchEtag
تحديث جزئي (تصحيح) لعنصر حاوية .PatchItemAsync

فهرسة الأمثلة

يوضح أسلوب RunIndexDemoلنموذج مشروع IndexManagementطريقة تنفيذ المهام التالية. للتعرّف على الفهرسة في Azure Cosmos DB قبل تشغيل النماذج التالية، راجع سياسات الفهرس، وأنواع الفهرس، ومسارات الفهرس.

المهمة مرجع واجهة برمجة التطبيقات‬
استبعاد عنصر من الفهرس IndexingDirective.Exclude
استخدام الفهرسة البطيئة IndexingPolicy.IndexingMode
استبعاد مسارات لعناصر محددة من الفهرس IndexingPolicy.ExcludedPaths

أمثلة الاستعلام

يوضح أسلوب RunDemoAsync لنموذج مشروع Queries طريقة تنفيذ المهام التالية باستخدام قواعد لغة استعلام SQL، ومقدم LINQ مع الاستعلام، و Lambda. للتعرّف على مرجع استعلام SQL في خدمة Azure Cosmos DB قبل تشغيل النماذج التالية، راجع نماذج استعلامات SQL لخدمة Azure Cosmos DB.

المهمة مرجع واجهة برمجة التطبيقات‬
عناصر الاستعلام من قسم واحد container.GetItemQueryIterator
عناصر الاستعلام من أقسام متعددة container.GetItemQueryIterator
الاستعلام باستخدام عبارة SQL container.GetItemQueryIterator

أمثلة لموجز التغييرات

يوضح أسلوب RunBasicChangeFeed من مشروع ChangeFeed النموذجي كيفية القيام بالمهام التالية. وللتعرّف على موجز التغييرات في خدمة Azure Cosmos DB قبل تشغيل النماذج التالية، راجع قراءة موجز التغييرات في Azure Cosmos DB ومعالج موجز التغيير.

المهمة مرجع واجهة برمجة التطبيقات‬
وظائف موجز التغييرات الأساسية Container.GetChangeFeedProcessorBuilder
قراءة موجز التغييرات من وقت محدد Container.GetChangeFeedProcessorBuilder
قراءة موجز التغييرات من البداية ChangeFeedProcessorBuilder.WithStartTime(DateTime)
الترحيل من معالج خلاصة التغيير لتغيير التغذية في v 3 SDK Container.GetChangeFeedProcessorBuilder

أمثلة برمجة من جانب الخادم

يوضح أسلوب RunDemoAsync لنموذج مشروع ServerSideScripts طريقة تنفيذ المهام التالية. للتعرّف على البرمجة من جانب الخادم في خدمة Azure Cosmos DB قبل تشغيل النماذج التالية، راجعالإجراءات المخزّنة والمشغّلات والوظائف المعرّفة بواسطة المستخدم.

المهمة مرجع واجهة برمجة التطبيقات‬
إنشاء إجراء مخزّن Scripts.CreateStoredProcedureAsync
قم بتنفيذ إجراء مخزن Scripts.ExecuteStoredProcedureAsync
حذف إجراء مخزّن Scripts.DeleteStoredProcedureAsync

تسلسل مخصص

يعرض مشروع عينة SystemTextJson كيفية استخدام مسلسل مخصص عند تهيئة عنصر CosmosClient جديد. تتضمن العينة أيضًا فئة CosmosSerializer مخصصة، والتي تستخدم System.Text.Json للتسلسل وإزالة التسلسل.

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

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