@azure/cosmos package

الفصول

AbortError	يتم طرح هذا الخطأ عند إجهاض عملية غير متزامنة. تحقق من هذا الخطأ عن طريق اختبار name أن خاصية اسم الخطأ تتطابق "AbortError"مع . مثال const controller = new AbortController(); controller.abort(); try { doAsyncWork(controller.signal) } catch (e) { if (e.name === 'AbortError') { // handle abort error here. } }
ChangeFeedIterator	يوفر مكرر لموجز التغيير. استخدم Items.changeFeed() للحصول على مثيل من المكرر.
ChangeFeedIteratorResponse	صفحة استجابة واحدة من موجز تغيير Azure Cosmos DB
ChangeFeedResponse	صفحة استجابة واحدة من موجز تغيير Azure Cosmos DB
ChangeFeedStartFrom	الفئة الأساسية لمكان بدء تشغيل ChangeFeedIterator.
ClientSideMetrics
Conflict	استخدم لقراءة تعارض معين حسب المعرف أو حذفه. راجع التعارضات للاستعلام عن كافة التعارضات أو قراءتها.
ConflictResponse
Conflicts	استخدم للاستعلام عن كافة التعارضات أو قراءتها. راجع التعارض لقراءة تعارض معين حسب المعرف أو حذفه.
Container	عمليات قراءة حاوية معينة موجودة أو استبدالها أو حذفها حسب المعرف. راجع حاويات لإنشاء حاويات جديدة، وقراءة/الاستعلام عن جميع الحاويات؛ استخدم .containers. ملاحظة: تقوم جميع هذه العمليات بإجراء مكالمات مقابل ميزانية ثابتة. يجب عليك تصميم نظامك بحيث يتم تغيير حجم هذه المكالمات بشكل فرعي مع التطبيق الخاص بك. على سبيل المثال، لا تتصل container(id).read() قبل كل استدعاء واحد item.read() ، للتأكد من وجود الحاوية؛ قم بذلك مرة واحدة عند بدء تشغيل التطبيق.
ContainerResponse	كائن الاستجابة لعمليات الحاوية
Containers	عمليات إنشاء حاويات جديدة، وقراءة/الاستعلام عن جميع الحاويات راجع الحاوية لقراءة حاوية موجودة أو استبدالها أو حذفها؛ استخدم .container(id). ملاحظة: تقوم جميع هذه العمليات بإجراء مكالمات مقابل ميزانية ثابتة. يجب عليك تصميم نظامك بحيث يتم تغيير حجم هذه المكالمات بشكل فرعي مع التطبيق الخاص بك. على سبيل المثال، لا تتصل containers.readAll() قبل كل استدعاء واحد item.read() ، للتأكد من وجود الحاوية؛ قم بذلك مرة واحدة عند بدء تشغيل التطبيق.
CosmosClient	يوفر تمثيلا منطقيا من جانب العميل لحساب قاعدة بيانات Azure Cosmos DB. يستخدم هذا العميل لتكوين الطلبات وتنفيذها في خدمة قاعدة بيانات Azure Cosmos DB. مثال إنشاء مثيل لعميل وإنشاء قاعدة بيانات جديدة const client = new CosmosClient({endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}}); await client.databases.create({id: "<datbase name here>"}); مثال إنشاء مثيل لعميل باستخدام نهج الاتصال المخصص const connectionPolicy = new ConnectionPolicy(); connectionPolicy.RequestTimeout = 10000; const client = new CosmosClient({ endpoint: "<URL HERE>", auth: {masterKey: "<KEY HERE>"}, connectionPolicy });
CosmosDiagnostics	هذا نوع تشخيص Cosmos يحتوي على معلومات تشخيصية تم جمعها أثناء عمليات العميل. اي. Item.read(), Container.create(). لديها ثلاثة أعضاء - clientSideRequestStatistics يحتوي العضو على معلومات تشخيصية مجمعة، بما في ذلك - عمليات البحث عن بيانات التعريف. هنا تعتبر جميع طلبات الخادم، بصرف النظر عن المورد المقصود النهائي استدعاءات بيانات التعريف. أي بالنسبة إلى item.read(id)، إذا قام العميل بإجراء استدعاء الخادم لاكتشاف نقاط النهاية، فسيتم اعتباره استدعاء بيانات التعريف. المحاولات نقاط النهاية التي تم الاتصال بها. طلب، إحصائيات حمولة الاستجابة. gatewayStatistics - المعلومات المقابلة للعملية الرئيسية. على سبيل المثال أثناء Item.read()، قد يقوم العميل بالعديد من العمليات، مثل البحث عن بيانات التعريف وما إلى ذلك، ولكن gatewayStatistics تمثل معلومات التشخيص لعملية القراءة الفعلية. diagnosticNode - هي شجرة مثل البنية التي تلتقط معلومات التشخيص التفصيلية. بشكل افتراضي، يتم تعطيله، ويهدف إلى استخدامه فقط لتصحيح الأخطاء في البيئات غير الإنتاجية. يتم التحكم في نوع التفاصيل التي تم التقاطها في diagnosticNode بواسطة CosmosDbDiagnosticLevel. CosmosDbDiagnosticLevel.info - هي القيمة الافتراضية. في هذا المستوى يتم تسجيل clientSideRequestStatistics فقط. مخصص لبيئات الإنتاج. CosmosDbDiagnosticLevel.debug - يلتقط diagnosticNode و clientConfig. لا يتم التقاط أي حمولات طلب واستجابة. لا يقصد استخدامه في بيئة الإنتاج. CosmosDbDiagnosticLevel.debug-unsafe - بالإضافة إلى البيانات التي تم التقاطها في CosmosDbDiagnosticLevel.debug، يلتقط أيضا حمولات الطلب والاستجابة. لا يقصد استخدامه في بيئة الإنتاج. clientConfig - يلتقط المعلومات المتعلقة بكيفية تكوين العميل أثناء التهيئة.
Database	عمليات لقراءة قاعدة بيانات موجودة أو حذفها. راجع قواعد البيانات لإنشاء قواعد بيانات جديدة، وقراءة/الاستعلام عن جميع قواعد البيانات؛ استخدم client.databases. ملاحظة: تقوم جميع هذه العمليات بإجراء مكالمات مقابل ميزانية ثابتة. يجب عليك تصميم نظامك بحيث يتم تغيير حجم هذه المكالمات بشكل فرعي مع التطبيق الخاص بك. على سبيل المثال، لا تتصل database.read() قبل كل استدعاء واحد item.read() ، للتأكد من وجود قاعدة البيانات؛ قم بذلك مرة واحدة عند بدء تشغيل التطبيق.
DatabaseAccount	يمثل DatabaseAccount في خدمة قاعدة بيانات Azure Cosmos DB.
DatabaseResponse	كائن الاستجابة لعمليات قاعدة البيانات
Databases	عمليات إنشاء قواعد بيانات جديدة، وقراءة/الاستعلام عن جميع قواعد البيانات راجع قاعدة البيانات لقراءة قاعدة بيانات موجودة أو حذفها؛ استخدم client.database(id). ملاحظة: تقوم جميع هذه العمليات بإجراء مكالمات مقابل ميزانية ثابتة. يجب عليك تصميم نظامك بحيث يتم تغيير حجم هذه المكالمات بشكل فرعي مع التطبيق الخاص بك. على سبيل المثال، لا تتصل databases.readAll() قبل كل استدعاء واحد item.read() ، للتأكد من وجود قاعدة البيانات؛ قم بذلك مرة واحدة عند بدء تشغيل التطبيق.
ErrorResponse
FeedRange	تحديد نطاق موجز لملف التغيير.
FeedResponse
Item	يستخدم لتنفيذ عمليات على عنصر معين. راجع العناصر الخاصة بالعملية على جميع العناصر؛ راجع container.items.
ItemResponse
Items	عمليات إنشاء عناصر جديدة وقراءة/الاستعلام عن كافة العناصر راجع العنصر لقراءة حاوية موجودة أو استبدالها أو حذفها؛ استخدم .item(id).
Offer	استخدم لقراءة عرض موجود حسب المعرف أو استبداله. راجع العروض للاستعلام عن جميع العروض أو قراءتها.
OfferResponse
Offers	يستخدم للاستعلام عن جميع العروض أو قراءتها. راجع عرض لقراءة عرض موجود حسب المعرف أو استبداله.
PartitionKeyBuilder	فئة المنشئ لبناء PartitionKey.
Permission	استخدم لقراءة إذن معين أو استبداله أو حذفه حسب المعرف. راجع الأذونات لإنشاء كافة الأذونات أو إصدارها أو الاستعلام أو قراءتها.
PermissionResponse
Permissions	استخدم لإنشاء جميع الأذونات واستبدالها والاستعلام فيها وقراءتها. راجع إذن قراءة إذن معين أو استبداله أو حذفه حسب المعرف.
QueryIterator	يمثل كائن QueryIterator، وهو تنفيذ للموجز أو استجابة الاستعلام التي تمكن من اجتياز الاستجابة والتكرار عبر الاستجابة في خدمة قاعدة بيانات Azure Cosmos DB.
QueryMetrics
QueryPreparationTimes
ResourceResponse
RestError	نوع خطأ مخصص لطلبات البنية الأساسية لبرنامج ربط العمليات التجارية الفاشلة.
RuntimeExecutionTimes
SasTokenProperties
Scripts
StoredProcedure	عمليات قراءة إجراء مخزن موجود أو استبداله أو حذفه أو تنفيذه حسب المعرف. لعمليات إنشاء الإجراءات المخزنة أو قراءتها أو الاستعلام فيها،
StoredProcedureResponse
StoredProcedures	عمليات إنشاء كافة الإجراءات المخزنة أو رفعها أو قراءتها/الاستعلام فيها. بالنسبة للعمليات لقراءة إجراء مخزن موجود أو استبداله أو حذفه أو تنفيذه حسب المعرف، راجع container.storedProcedure().
TimeoutError
Trigger	عمليات لقراءة مشغل أو استبداله أو حذفه. استخدم container.triggers لإنشاء الكل أو رفعه أو الاستعلام أو قراءته.
TriggerResponse
Triggers	عمليات إنشاء جميع المشغلات وتكبيرها والاستعلام عليها وقراءتها. استخدم container.triggers لقراءة مشغل أو استبداله أو حذفه.
User	يستخدم لقراءة المستخدمين واستبدالهم وحذفهم. بالإضافة إلى ذلك، يمكنك الوصول إلى أذونات مستخدم معين عبر user.permission و user.permissions. راجع المستخدمين لإنشاء الكل أو رفعه أو الاستعلام أو قراءته.
UserDefinedFunction	يستخدم لقراءة أو استبدال أو حذف دالة محددة من قبل المستخدم المعرف. راجع UserDefinedFunction لإنشاء، upsert، الاستعلام، قراءة كافة الوظائف المعرفة من قبل المستخدم.
UserDefinedFunctionResponse
UserDefinedFunctions	يستخدم لإنشاء أو upsert أو الاستعلام أو قراءة كافة الوظائف المعرفة من قبل المستخدم. راجع UserDefinedFunction لقراءة دالة محددة معرفة من قبل المستخدم أو استبدالها أو حذفها بواسطة المعرف.
UserResponse
Users	يستخدم لإنشاء جميع المستخدمين و upsert والاستعلام وقراءتها. راجع المستخدم لقراءة مستخدم معين أو استبداله أو حذفه بواسطة المعرف.

الواجهات

@azure/cosmos.Index

Agent
BulkOptions	عنصر الخيارات المستخدم لتعديل التنفيذ المجمع. continueOnError (القيمة الافتراضية: false) - يستمر التنفيذ المجمع عند فشل عملية ** ملاحظة هذا سيتم افتراضيا إلى TRUE في الإصدار 4.0
ChangeFeedIteratorOptions	تحديد خيارات لموجز التغيير إذا لم يتم تعيين أي من هذه الخيارات، فسيبدأ في قراءة التغييرات من الآن للحاوية بأكملها.
ChangeFeedOptions	تحديد خيارات لموجز التغيير تتحكم بعض هذه الخيارات في مكان ومتى تبدأ القراءة من موجز التغيير. ترتيب الأسبقية هو: استمرار startTime startFromBeginning إذا لم يتم تعيين أي من هذه الخيارات، فسيبدأ في قراءة التغييرات من المكالمة الأولى ChangeFeedIterator.fetchNext() .
ChangeFeedPullModelIterator	استخدم Items.getChangeFeedIterator() لإرجاع مكرر يمكنه التكرار على جميع التغييرات لمفتاح قسم أو نطاق موجز أو حاوية بأكملها.
ConflictDefinition
ConflictResolutionPolicy	يمثل تكوين نهج حل التعارض لتحديد كيفية حل التعارضات في حالة ما إذا كانت عمليات الكتابة من مناطق مختلفة تؤدي إلى تعارضات في المستندات في المجموعة في خدمة Azure Cosmos DB.
ConnectionPolicy	يمثل نهج الاتصال المقترن ب CosmosClient في خدمة قاعدة بيانات Azure Cosmos DB.
ContainerDefinition
ContainerRequest
CosmosClientOptions
CosmosHeaders
CreateOperationInput
DatabaseDefinition
DatabaseRequest
DeleteOperationInput
DiagnosticNode	يمثل شجرة مثل البنية، لالتقاط معلومات التشخيص.
ErrorBody
FailedRequestAttemptDiagnostic	يلتقط هذا النوع معلومات التشخيص المتعلقة بطلب فاشل لواجهة برمجة تطبيقات الخادم.
FeedOptions	خيارات الموجز وأساليب الاستعلام.
GroupByAliasToAggregateType
IndexedPath
IndexingPolicy
ItemDefinition	العناصر في Cosmos DB هي ببساطة كائنات JSON. تسمح معظم عمليات Item بتوفير النوع الخاص بك الذي يوسع ItemDefinition البسيط جدا. لا يمكنك استخدام أي مفاتيح محجوزة. يمكنك مشاهدة قائمة المفاتيح المحجوزة في <xref:ItemBody>
JSONArray
JSONObject
Location	تستخدم لتحديد المواقع المتوفرة، القراءة هي الفهرس 1 والكتابة هي الفهرس 0.
MetadataLookUpDiagnostic	يحتوي هذا النوع على معلومات تشخيصية تتعلق بطلب بيانات تعريف واحدة إلى الخادم.
OfferDefinition
OperationBase
OperationResponse
PartitionKeyDefinition
PartitionKeyRangePropertiesNames
PatchOperationInput
PermissionBody
PermissionDefinition
ReadOperationInput
ReplaceOperationInput
RequestOptions	الخيارات التي يمكن تحديدها لإصدار مطلوب لخوادم Azure Cosmos DB.=
Resource
RetryOptions	يمثل نهج إعادة المحاولة المحملة بالطلبات المقيدة في خدمة قاعدة بيانات Azure Cosmos DB.
SharedOptions	الخيارات التي يمكن تحديدها لإصدار مطلوب لخوادم Azure Cosmos DB.=
SpatialIndex
SqlParameter	يمثل معلمة في استعلام SQL معلمات، محدد في SqlQuerySpec
SqlQuerySpec	يمثل استعلام SQL في خدمة Azure Cosmos DB. يجب تحديد معلمات الاستعلامات ذات المدخلات للحماية من حقن SQL. مثال استعلام SQL ذات معلمات const query: SqlQuerySpec = { query: "SELECT * FROM Families f where f.lastName = @lastName", parameters: [ {name: "@lastName", value: "Wakefield"} ] };
StoredProcedureDefinition
TriggerDefinition
UniqueKey	واجهة لمفتاح فريد واحد تم تمريره كجزء من UniqueKeyPolicy
UniqueKeyPolicy	واجهة لإعداد مفاتيح فريدة على إنشاء الحاوية
UpsertOperationInput
UserDefinedFunctionDefinition
UserDefinition

النوع أسماء مستعارة

AggregateType
BulkOperationResponse
BulkPatchOperation
ClientConfigDiagnostic	يحتوي هذا النوع على معلومات تتعلق بتهيئة CosmosClient
ClientSideRequestStatistics	هذا نوع مجموعة لجميع معلومات التشخيص من جانب العميل.
CreateOperation
DeleteOperation
ExistingKeyOperation
GatewayStatistics
GroupByExpressions
JSONValue
MetadataLookUpDiagnostics	يحتوي هذا النوع على معلومات تشخيصية تتعلق بجميع طلبات بيانات التعريف إلى الخادم أثناء عملية عميل CosmosDB.
NonePartitionKeyType	يمثل الكائن الذي تم إرجاعه قيمة مفتاح القسم التي تسمح بإنشاء العناصر والوصول إليها دون قيمة لمفتاح القسم
NullPartitionKeyType	يمثل الكائن الذي تم إرجاعه قيمة مفتاح القسم التي تسمح بإنشاء العناصر والوصول إليها بقيمة خالية لمفتاح القسم.
Operation
OperationInput
OperationWithItem
PartitionKey	PartitionKey للحاوية.
PatchOperation
PatchRequestBody
PrimitivePartitionKeyValue	قيمة مفتاح القسم البدائي.
ReadOperation
RemoveOperation
ReplaceOperation
RetryDiagnostics	يلتقط هذا النوع معلومات التشخيص المتعلقة بمحاولة إعادة المحاولة أثناء عملية عميل CosmosDB.
TokenProvider
UpsertOperation

التعدادات

ConflictResolutionMode
ConnectionMode	تحديد سلوك الاتصال ل CosmosClient. ملاحظة، نحن ندعم حاليا وضع البوابة فقط.
ConsistencyLevel	يمثل مستويات التناسق المدعومة لعمليات عميل Azure Cosmos DB. يجب أن يتطابق ConsistencyLevel المطلوب أو يكون أضعف من ذلك المقدم لحساب قاعدة البيانات. مستويات التناسق. مستويات التناسق حسب ترتيب القوة هي Strong و BoundedStaleness و Session و Consistent Prefix و Eventual. راجع https://aka.ms/cosmos-consistency للحصول على وثائق أكثر تفصيلا حول مستويات التناسق.
CosmosDbDiagnosticLevel	مستوى تشخيص Cosmos DB
DataType	يحدد نوع البيانات الهدف لمواصفات مسار الفهرس في خدمة Azure Cosmos DB.
GeospatialType
IndexKind	تحديد أنواع الفهرس المدعومة.
IndexingMode	تحديد أوضاع الفهرسة المدعومة.
MetadataLookUpType	هذا تعداد لنوع عمليات البحث عن بيانات التعريف الممكنة.
PartitionKeyDefinitionVersion	إصدار تعريف PartitionKey
PartitionKeyKind	نوع PartitionKey أي التجزئة، MultiHash
PermissionMode	تعداد لقيم وضع الأذونات.
PriorityLevel	يمثل مستوى الأولوية المرتبط بكل طلبات عميل Azure Cosmos DB. يتم تقييد طلبات الأولوية المنخفضة دائما قبل أي طلبات ذات أولوية عالية. بشكل افتراضي، تعتبر جميع الطلبات طلبات ذات أولوية عالية. راجع https://aka.ms/CosmosDB/PriorityBasedExecution للحصول على وثائق أكثر تفصيلا حول التقييد المستند إلى الأولوية.
SpatialType
TriggerOperation	تعداد لقيم عملية المشغل. يحدد العمليات التي يجب تنفيذ المشغل عليها.
TriggerType	تعداد لقيم نوع المشغل. يحدد نوع المشغل.
UserDefinedFunctionType	تعداد لقيم نوع udf. يحدد أنواع الدالات المعرفة من قبل المستخدم.

الوظائف

createAuthorizationSasToken(string, SasTokenProperties)

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

تفاصيل الوظيفة

createAuthorizationSasToken(string, SasTokenProperties)

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

function createAuthorizationSasToken(masterKey: string, sasTokenProperties: SasTokenProperties): Promise<string>

المعلمات

masterKey

string

sasTokenProperties

SasTokenProperties

المرتجعات

Promise<string>