SharedOptions interface

الحزمة:

@azure/cosmos

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

الخصائص

abortSignal	abortSignal لتمرير إلى كافة طلبات الشبكة الأساسية التي تم إنشاؤها بواسطة استدعاء الأسلوب هذا. راجع https://developer.mozilla.org/en-US/docs/Web/API/AbortController المثال إلغاء طلب قراءة import { CosmosClient } from "@azure/cosmos"; const endpoint = "https://your-account.documents.azure.com"; const key = "<database account masterkey>"; const client = new CosmosClient({ endpoint, key }); const { database } = await client.databases.createIfNotExists({ id: "Test Database" }); const { container } = await database.containers.createIfNotExists({ id: "Test Container" }); const controller = new AbortController(); const results = container.items.query("SELECT * from c", { abortSignal: controller.signal, });
bypassIntegratedCache	تعيين ما إذا كان يجب تجاوز ذاكرة التخزين المؤقت المتكاملة أو تمكينها للطلب في خدمة Azure CosmosDB. القيمة الافتراضية خاطئة. يتم تمكين ذاكرة التخزين المؤقت المتكاملة بشكل افتراضي
consistencyLevel	مستوى التناسق المطلوب من قبل العميل.
disableRUPerMinuteUsage	يتم استخدام DisableRUPerMinuteUsage لتمكين/تعطيل سعة وحدات الطلب (RUs)/دقيقة لخدمة الطلب إذا تم استنفاد وحدات الطلب/الثانية المتوفرة العادية.
excludedLocations	يستبعد منطقة Azure واحدة أو أكثر للعملية. يتم تطبيق هذا الخيار فقط عند تعيين enableEndPointDiscovery إلى true.
initialHeaders	(حالة الاستخدام المتقدمة) العناوين الأولية التي يجب البدء بها عند إرسال الطلبات إلى Cosmos
maxIntegratedCacheStalenessInMs	تعيين قيمة staleness المقترنة بالطلب في خدمة Azure CosmosDB. بالنسبة للطلبات التي يكون فيها <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> أو <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>، تضمن الاستجابات من ذاكرة التخزين المؤقت المتكاملة أن تكون لا تالفة من القيمة المشار إليها بواسطة maxIntegratedCacheStaleness هذا. عند عدم تعيين مستوى التناسق، يتم تجاهل هذه الخاصية. القيمة الافتراضية فارغة ذاكرة التخزين المؤقت Staleness مدعومة بنقاوة بالمللي ثانية. سيتم تجاهل أي شيء أصغر من مللي ثانية.
priorityLevel	مستوى الأولوية (منخفض/مرتفع) لكل طلب. يتم دائما تقييد الطلبات ذات الأولوية المنخفضة قبل أي طلبات ذات أولوية عالية. القيمة الافتراضية خالية. تكون جميع الطلبات ذات أولوية عالية بشكل افتراضي
sessionToken	تمكين/تعطيل الحصول على الإحصائيات ذات الصلة بالحصة النسبية لحاوية المستندات لطلبات قراءة حاوية المستند.
throughputBucket	دلو الإنتاجية لطلب. القيمة الافتراضية خالية. في هذه الحالة، يمكن للطلب استخدام 100% من معدل نقل القسم. لمزيد من المعلومات، تفضل بزيارة [مستودع إنتاجية Cosmos DB](https://aka.ms/cosmsodb-bucketing).

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

abortSignal

abortSignal لتمرير إلى كافة طلبات الشبكة الأساسية التي تم إنشاؤها بواسطة استدعاء الأسلوب هذا. راجع https://developer.mozilla.org/en-US/docs/Web/API/AbortController

المثال

إلغاء طلب قراءة

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const { database } = await client.databases.createIfNotExists({ id: "Test Database" });

const { container } = await database.containers.createIfNotExists({ id: "Test Container" });

const controller = new AbortController();
const results = container.items.query("SELECT * from c", {
  abortSignal: controller.signal,
});

abortSignal?: AbortSignal

قيمة الخاصية

AbortSignal

bypassIntegratedCache

تعيين ما إذا كان يجب تجاوز ذاكرة التخزين المؤقت المتكاملة أو تمكينها للطلب في خدمة Azure CosmosDB.

القيمة الافتراضية خاطئة. يتم تمكين ذاكرة التخزين المؤقت المتكاملة بشكل افتراضي

bypassIntegratedCache?: boolean

قيمة الخاصية

boolean

consistencyLevel

مستوى التناسق المطلوب من قبل العميل.

consistencyLevel?: string

قيمة الخاصية

string

disableRUPerMinuteUsage

يتم استخدام DisableRUPerMinuteUsage لتمكين/تعطيل سعة وحدات الطلب (RUs)/دقيقة لخدمة الطلب إذا تم استنفاد وحدات الطلب/الثانية المتوفرة العادية.

disableRUPerMinuteUsage?: boolean

قيمة الخاصية

boolean

excludedLocations

يستبعد منطقة Azure واحدة أو أكثر للعملية.

يتم تطبيق هذا الخيار فقط عند تعيين enableEndPointDiscovery إلى true.

excludedLocations?: string[]

قيمة الخاصية

string[]

initialHeaders

(حالة الاستخدام المتقدمة) العناوين الأولية التي يجب البدء بها عند إرسال الطلبات إلى Cosmos

initialHeaders?: CosmosHeaders

قيمة الخاصية

CosmosHeaders

maxIntegratedCacheStalenessInMs

تعيين قيمة staleness المقترنة بالطلب في خدمة Azure CosmosDB. بالنسبة للطلبات التي يكون فيها <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> أو <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>، تضمن الاستجابات من ذاكرة التخزين المؤقت المتكاملة أن تكون لا تالفة من القيمة المشار إليها بواسطة maxIntegratedCacheStaleness هذا. عند عدم تعيين مستوى التناسق، يتم تجاهل هذه الخاصية.

القيمة الافتراضية فارغة

ذاكرة التخزين المؤقت Staleness مدعومة بنقاوة بالمللي ثانية. سيتم تجاهل أي شيء أصغر من مللي ثانية.

maxIntegratedCacheStalenessInMs?: number

قيمة الخاصية

number

priorityLevel

مستوى الأولوية (منخفض/مرتفع) لكل طلب. يتم دائما تقييد الطلبات ذات الأولوية المنخفضة قبل أي طلبات ذات أولوية عالية.

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

priorityLevel?: PriorityLevel

قيمة الخاصية

PriorityLevel

sessionToken

تمكين/تعطيل الحصول على الإحصائيات ذات الصلة بالحصة النسبية لحاوية المستندات لطلبات قراءة حاوية المستند.

sessionToken?: string

قيمة الخاصية

string

throughputBucket

دلو الإنتاجية لطلب.

القيمة الافتراضية خالية. في هذه الحالة، يمكن للطلب استخدام 100% من معدل نقل القسم.

لمزيد من المعلومات، تفضل بزيارة [مستودع إنتاجية Cosmos DB](https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

قيمة الخاصية

number