FeedOptions interface
خيارات الموجز وأساليب الاستعلام.
- يمتد
الخصائص
| access |
الشروط المقترنة بالطلب. |
| allow |
صالح فقط للطلب غير المتدفق حسب الاستعلام. الافتراضي: خطأ؛ عند التعيين إلى true، فإنه يسمح للاستعلامات بتجاوز السلوك الافتراضي الذي يحظر الاستعلامات غير المتلقين للمعلومات دون عبارات أعلى أو حد. |
| buffer |
تمكين التخزين المؤقت للعناصر الإضافية أثناء الاستعلامات. الافتراضي: خطأ سيؤدي ذلك إلى تخزين صفحة إضافية مؤقتا في كل مرة (مضروبة في maxDegreeOfParallelism) من الخادم في الخلفية.
يؤدي هذا إلى تحسين زمن الانتقال عن طريق جلب الصفحات قبل أن يحتاجها العميل. إذا كنت تستنزف جميع النتائج من الخادم، مثل |
| continuation | رمز مميز مبهم لمتابعة التعداد. الافتراضي: غير معرف |
| continuation |
رمز مميز مبهم لمتابعة التعداد. الافتراضي: غير معرف |
| continuation |
يحد من حجم رمز المتابعة المميز في الاستجابة. الافتراضي: غير معرف تحتوي الرموز المميزة للمتابعة على بيانات اختيارية يمكن إزالتها من التسلسل قبل كتابتها إلى عنوان. بشكل افتراضي، نقوم بالحد الأقصى هذا إلى 1 كيلوبايت لتجنب الرؤوس الطويلة (Node.js لها حد حجم رأس عام). قد يقوم المستخدم بتعيين هذا الحقل للسماح برؤوس أطول، مما يساعد الواجهة الخلفية على تحسين تنفيذ الاستعلام." |
| disable |
الافتراضي: خطأ. إذا تم تعيينه إلى true، فإنه يعطل تحسين خطة استعلام البحث المختلط. يتم تمكين هذا التحسين بشكل افتراضي ويستخدم لتحسين أداء طلبات البحث المختلطة. |
| disable |
تعطيل ميزة الاستعلام nonStreamingOrderBy في ميزات الاستعلام المدعومة. الافتراضي: خطأ. قم بتعيين إلى صحيح لتجنب الخطأ من بوابة قديمة لا تدعم هذه الميزة. |
| enable |
يتحكم في سلوك تنفيذ الاستعلام.
الافتراضي: خطأ. إذا تم تعيينه إلى false، فسيعيد الاستعلام المحاولة حتى تصبح النتائج جاهزة ويتم |
| enable |
السماح بالمسح الضوئي على الاستعلامات التي لا يمكن تقديمها كفهرسة تم تعطيلها على المسارات المطلوبة. الافتراضي: خطأ بشكل عام، من الأفضل تجنب استخدام هذا الإعداد. عمليات الفحص مكلفة نسبيا وتستغرق وقتا طويلا للخدمة. |
| force |
يفرض هذا الإعداد على الاستعلام استخدام خطة استعلام. الافتراضي: خطأ ملاحظة: سيؤدي ذلك إلى تعطيل دعم الرمز المميز للمتابعة، حتى لاستعلامات القسم الفردي. بالنسبة للاستعلامات مثل التجميعات ومعظم استعلامات الأقسام المتقاطعة، يحدث هذا على أي حال. ومع ذلك، نظرا لأن المكتبة لا تعرف نوع الاستعلام حتى نسترجع الاستجابة الأولى، لا يمكن أن يحدث بعض التحسين حتى وقت لاحق. إذا تم تمكين هذا الإعداد، فرض خطة الاستعلام للاستعلام، والتي ستحفظ بعض طلبات الشبكة وتضمن حدوث التوازي. مفيد عندما تعرف أنك تقوم بالاستعلامات المشتركة أو التجميعية. |
| max |
الحد الأقصى لعدد العمليات المتزامنة التي تقوم بتشغيل جانب العميل أثناء تنفيذ الاستعلام المتوازي في خدمة قاعدة بيانات Azure Cosmos DB. تجعل القيم السالبة النظام يقرر تلقائيا عدد العمليات المتزامنة التي سيتم تشغيلها. الافتراضي: 0 (بدون توازي) |
| max |
الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد. الافتراضي: غير معرف (سيقوم الخادم بتعريف البيانات الأساسية) يمكن أن يؤدي انتهاء الصلاحية بهذه القيمة عادة إلى أكبر تغييرات في الأداء للاستعلام. كلما كان عدد العناصر أصغر، كلما تم تسليم النتيجة الأولى بشكل أسرع (لغير التجميعات). بالنسبة للمبالغ الأكبر، سيستغرق الأمر وقتا أطول لخدمة الطلب، ولكن عادة ما تحصل على معدل نقل أفضل للاستعلامات الكبيرة (أي إذا كنت بحاجة إلى 1000 عنصر قبل أن تتمكن من القيام بأي إجراءات أخرى، قم بتعيين |
| partition |
يقيد الاستعلام بمفتاح قسم معين. الافتراضي: غير معرف يمكن إنجاز تحديد نطاق استعلام إلى قسم واحد بطريقتين:
الأول مفيد عندما يكون نص الاستعلام خارج نطاق سيطرتك ولكنك لا تزال ترغب في تقييده إلى قسم واحد. مثال: استعلام محدد من قبل المستخدم. |
| populate |
تمكين إرجاع مقاييس الفهرس في رؤوس الاستجابة. الافتراضي: خطأ |
| populate |
تمكين إرجاع مقاييس الاستعلام في عناوين الاستجابة. الافتراضي: خطأ يستخدم لتصحيح أخطاء الاستعلامات البطيئة أو المكلفة. يزيد أيضا حجم الاستجابة وإذا كنت تستخدم الحد الأقصى لحجم الرأس المنخفض في Node.js، يمكنك مواجهة المشكلات بشكل أسرع. |
| use |
ملاحظة: ضع في اعتبارك استخدام changeFeed بدلا من ذلك. يشير إلى طلب موجز التغيير. يجب تعيين إلى "موجز تزايدي"، أو حذفه بخلاف ذلك. الافتراضي: خطأ |
| vector |
يحدد الحد الأقصى المخصص لحجم المخزن المؤقت لتخزين النتائج النهائية للاستعلامات nonStreamingOrderBy. يتم تجاهل هذه القيمة إذا كان الاستعلام يتضمن عبارات top/offset+limit. |
الخصائص الموروثة
| abort |
abortSignal لتمرير إلى كافة طلبات الشبكة الأساسية التي تم إنشاؤها بواسطة استدعاء الأسلوب هذا. راجع https://developer.mozilla.org/en-US/docs/Web/API/AbortController المثال إلغاء طلب قراءة
|
| bypass |
تعيين ما إذا كان يجب تجاوز ذاكرة التخزين المؤقت المتكاملة أو تمكينها للطلب في خدمة Azure CosmosDB. القيمة الافتراضية خاطئة. يتم تمكين ذاكرة التخزين المؤقت المتكاملة بشكل افتراضي |
| consistency |
مستوى التناسق المطلوب من قبل العميل. |
| disable |
يتم استخدام DisableRUPerMinuteUsage لتمكين/تعطيل سعة وحدات الطلب (RUs)/دقيقة لخدمة الطلب إذا تم استنفاد وحدات الطلب/الثانية المتوفرة العادية. |
| excluded |
يستبعد منطقة Azure واحدة أو أكثر للعملية. يتم تطبيق هذا الخيار فقط عند تعيين enableEndPointDiscovery إلى true. |
| initial |
(حالة الاستخدام المتقدمة) العناوين الأولية التي يجب البدء بها عند إرسال الطلبات إلى Cosmos |
| max |
تعيين قيمة staleness المقترنة بالطلب في خدمة Azure CosmosDB. بالنسبة للطلبات التي يكون فيها <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> أو <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>، تضمن الاستجابات من ذاكرة التخزين المؤقت المتكاملة أن تكون لا تالفة من القيمة المشار إليها بواسطة maxIntegratedCacheStaleness هذا. عند عدم تعيين مستوى التناسق، يتم تجاهل هذه الخاصية. القيمة الافتراضية فارغة ذاكرة التخزين المؤقت Staleness مدعومة بنقاوة بالمللي ثانية. سيتم تجاهل أي شيء أصغر من مللي ثانية. |
| priority |
مستوى الأولوية (منخفض/مرتفع) لكل طلب. يتم دائما تقييد الطلبات ذات الأولوية المنخفضة قبل أي طلبات ذات أولوية عالية. القيمة الافتراضية خالية. تكون جميع الطلبات ذات أولوية عالية بشكل افتراضي |
| session |
تمكين/تعطيل الحصول على الإحصائيات ذات الصلة بالحصة النسبية لحاوية المستندات لطلبات قراءة حاوية المستند. |
| throughput |
دلو الإنتاجية لطلب. القيمة الافتراضية خالية. في هذه الحالة، يمكن للطلب استخدام 100% من معدل نقل القسم. لمزيد من المعلومات، تفضل بزيارة [مستودع إنتاجية Cosmos DB](https://aka.ms/cosmsodb-bucketing). |
تفاصيل الخاصية
accessCondition
الشروط المقترنة بالطلب.
accessCondition?: { condition: string, type: string }
قيمة الخاصية
{ condition: string, type: string }
allowUnboundedNonStreamingQueries
صالح فقط للطلب غير المتدفق حسب الاستعلام. الافتراضي: خطأ؛ عند التعيين إلى true، فإنه يسمح للاستعلامات بتجاوز السلوك الافتراضي الذي يحظر الاستعلامات غير المتلقين للمعلومات دون عبارات أعلى أو حد.
allowUnboundedNonStreamingQueries?: boolean
قيمة الخاصية
boolean
bufferItems
تمكين التخزين المؤقت للعناصر الإضافية أثناء الاستعلامات. الافتراضي: خطأ
سيؤدي ذلك إلى تخزين صفحة إضافية مؤقتا في كل مرة (مضروبة في maxDegreeOfParallelism) من الخادم في الخلفية.
يؤدي هذا إلى تحسين زمن الانتقال عن طريق جلب الصفحات قبل أن يحتاجها العميل. إذا كنت تستنزف جميع النتائج من الخادم، مثل .fetchAll، يجب عليك عادة تمكين هذا. إذا كنت تقوم بإحضار صفحة واحدة فقط في كل مرة عبر رمز المتابعة المميز، يجب تجنب ذلك. إذا كنت تستنزف أكثر من صفحة واحدة، ولكن ليس مجموعة النتائج بأكملها، فقد يساعد ذلك في تحسين زمن الانتقال، ولكنه سيزيد من إجمالي مقدار استخدام RU/s لخدمة الاستعلام بأكمله (حيث سيتم جلب بعض الصفحات أكثر من مرة).
bufferItems?: boolean
قيمة الخاصية
boolean
continuation
تحذير
واجهة برمجة التطبيقات هذه مهملة الآن.
Use continuationToken instead.
رمز مميز مبهم لمتابعة التعداد. الافتراضي: غير معرف
continuation?: string
قيمة الخاصية
string
continuationToken
رمز مميز مبهم لمتابعة التعداد. الافتراضي: غير معرف
continuationToken?: string
قيمة الخاصية
string
continuationTokenLimitInKB
يحد من حجم رمز المتابعة المميز في الاستجابة. الافتراضي: غير معرف
تحتوي الرموز المميزة للمتابعة على بيانات اختيارية يمكن إزالتها من التسلسل قبل كتابتها إلى عنوان. بشكل افتراضي، نقوم بالحد الأقصى هذا إلى 1 كيلوبايت لتجنب الرؤوس الطويلة (Node.js لها حد حجم رأس عام). قد يقوم المستخدم بتعيين هذا الحقل للسماح برؤوس أطول، مما يساعد الواجهة الخلفية على تحسين تنفيذ الاستعلام."
continuationTokenLimitInKB?: number
قيمة الخاصية
number
disableHybridSearchQueryPlanOptimization
الافتراضي: خطأ. إذا تم تعيينه إلى true، فإنه يعطل تحسين خطة استعلام البحث المختلط. يتم تمكين هذا التحسين بشكل افتراضي ويستخدم لتحسين أداء طلبات البحث المختلطة.
disableHybridSearchQueryPlanOptimization?: boolean
قيمة الخاصية
boolean
disableNonStreamingOrderByQuery
تعطيل ميزة الاستعلام nonStreamingOrderBy في ميزات الاستعلام المدعومة. الافتراضي: خطأ. قم بتعيين إلى صحيح لتجنب الخطأ من بوابة قديمة لا تدعم هذه الميزة.
disableNonStreamingOrderByQuery?: boolean
قيمة الخاصية
boolean
enableQueryControl
يتحكم في سلوك تنفيذ الاستعلام.
الافتراضي: خطأ. إذا تم تعيينه إلى false، فسيعيد الاستعلام المحاولة حتى تصبح النتائج جاهزة ويتم maxItemCount الوصول إليها، الأمر الذي قد يستغرق بعض الوقت للأقسام الكبيرة التي تحتوي على بيانات صغيرة نسبيا.
إذا تم تعيينه إلى true، فيقوم بفحص الأقسام حتى maxDegreeOfParallelism، ويضيف نتائج إلى المخزن المؤقت ويرجع ما هو متاح. إذا لم تكن النتائج جاهزة، فإنها ترجع استجابة فارغة.
enableQueryControl?: boolean
قيمة الخاصية
boolean
enableScanInQuery
السماح بالمسح الضوئي على الاستعلامات التي لا يمكن تقديمها كفهرسة تم تعطيلها على المسارات المطلوبة. الافتراضي: خطأ
بشكل عام، من الأفضل تجنب استخدام هذا الإعداد. عمليات الفحص مكلفة نسبيا وتستغرق وقتا طويلا للخدمة.
enableScanInQuery?: boolean
قيمة الخاصية
boolean
forceQueryPlan
يفرض هذا الإعداد على الاستعلام استخدام خطة استعلام. الافتراضي: خطأ
ملاحظة: سيؤدي ذلك إلى تعطيل دعم الرمز المميز للمتابعة، حتى لاستعلامات القسم الفردي.
بالنسبة للاستعلامات مثل التجميعات ومعظم استعلامات الأقسام المتقاطعة، يحدث هذا على أي حال. ومع ذلك، نظرا لأن المكتبة لا تعرف نوع الاستعلام حتى نسترجع الاستجابة الأولى، لا يمكن أن يحدث بعض التحسين حتى وقت لاحق.
إذا تم تمكين هذا الإعداد، فرض خطة الاستعلام للاستعلام، والتي ستحفظ بعض طلبات الشبكة وتضمن حدوث التوازي. مفيد عندما تعرف أنك تقوم بالاستعلامات المشتركة أو التجميعية.
forceQueryPlan?: boolean
قيمة الخاصية
boolean
maxDegreeOfParallelism
الحد الأقصى لعدد العمليات المتزامنة التي تقوم بتشغيل جانب العميل أثناء تنفيذ الاستعلام المتوازي في خدمة قاعدة بيانات Azure Cosmos DB. تجعل القيم السالبة النظام يقرر تلقائيا عدد العمليات المتزامنة التي سيتم تشغيلها. الافتراضي: 0 (بدون توازي)
maxDegreeOfParallelism?: number
قيمة الخاصية
number
maxItemCount
الحد الأقصى لعدد العناصر التي سيتم إرجاعها في عملية التعداد. الافتراضي: غير معرف (سيقوم الخادم بتعريف البيانات الأساسية)
يمكن أن يؤدي انتهاء الصلاحية بهذه القيمة عادة إلى أكبر تغييرات في الأداء للاستعلام.
كلما كان عدد العناصر أصغر، كلما تم تسليم النتيجة الأولى بشكل أسرع (لغير التجميعات). بالنسبة للمبالغ الأكبر، سيستغرق الأمر وقتا أطول لخدمة الطلب، ولكن عادة ما تحصل على معدل نقل أفضل للاستعلامات الكبيرة (أي إذا كنت بحاجة إلى 1000 عنصر قبل أن تتمكن من القيام بأي إجراءات أخرى، قم بتعيين maxItemCount إلى 1000. إذا كان بإمكانك البدء في العمل بعد أول 100، فقم بتعيين maxItemCount إلى 100.)
maxItemCount?: number
قيمة الخاصية
number
partitionKey
يقيد الاستعلام بمفتاح قسم معين. الافتراضي: غير معرف
يمكن إنجاز تحديد نطاق استعلام إلى قسم واحد بطريقتين:
container.items.query('SELECT * from c', { partitionKey: "foo" }).toArray()
container.items.query('SELECT * from c WHERE c.yourPartitionKey = "foo"').toArray()
الأول مفيد عندما يكون نص الاستعلام خارج نطاق سيطرتك ولكنك لا تزال ترغب في تقييده إلى قسم واحد. مثال: استعلام محدد من قبل المستخدم.
partitionKey?: PartitionKey
قيمة الخاصية
populateIndexMetrics
تمكين إرجاع مقاييس الفهرس في رؤوس الاستجابة. الافتراضي: خطأ
populateIndexMetrics?: boolean
قيمة الخاصية
boolean
populateQueryMetrics
تمكين إرجاع مقاييس الاستعلام في عناوين الاستجابة. الافتراضي: خطأ
يستخدم لتصحيح أخطاء الاستعلامات البطيئة أو المكلفة. يزيد أيضا حجم الاستجابة وإذا كنت تستخدم الحد الأقصى لحجم الرأس المنخفض في Node.js، يمكنك مواجهة المشكلات بشكل أسرع.
populateQueryMetrics?: boolean
قيمة الخاصية
boolean
useIncrementalFeed
ملاحظة: ضع في اعتبارك استخدام changeFeed بدلا من ذلك.
يشير إلى طلب موجز التغيير. يجب تعيين إلى "موجز تزايدي"، أو حذفه بخلاف ذلك. الافتراضي: خطأ
useIncrementalFeed?: boolean
قيمة الخاصية
boolean
vectorSearchBufferSize
يحدد الحد الأقصى المخصص لحجم المخزن المؤقت لتخزين النتائج النهائية للاستعلامات nonStreamingOrderBy. يتم تجاهل هذه القيمة إذا كان الاستعلام يتضمن عبارات top/offset+limit.
vectorSearchBufferSize?: number
قيمة الخاصية
number
تفاصيل الخاصية الموروثة
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
موروث منSharedOptions.abortSignal
bypassIntegratedCache
تعيين ما إذا كان يجب تجاوز ذاكرة التخزين المؤقت المتكاملة أو تمكينها للطلب في خدمة Azure CosmosDB.
القيمة الافتراضية خاطئة. يتم تمكين ذاكرة التخزين المؤقت المتكاملة بشكل افتراضي
bypassIntegratedCache?: boolean
قيمة الخاصية
boolean
consistencyLevel
مستوى التناسق المطلوب من قبل العميل.
consistencyLevel?: string
قيمة الخاصية
string
موروثة منSharedOptions.consistencyLevel
disableRUPerMinuteUsage
يتم استخدام DisableRUPerMinuteUsage لتمكين/تعطيل سعة وحدات الطلب (RUs)/دقيقة لخدمة الطلب إذا تم استنفاد وحدات الطلب/الثانية المتوفرة العادية.
disableRUPerMinuteUsage?: boolean
قيمة الخاصية
boolean
excludedLocations
يستبعد منطقة Azure واحدة أو أكثر للعملية.
يتم تطبيق هذا الخيار فقط عند تعيين enableEndPointDiscovery إلى true.
excludedLocations?: string[]
قيمة الخاصية
string[]
موروثة منSharedOptions.excludedLocations
initialHeaders
(حالة الاستخدام المتقدمة) العناوين الأولية التي يجب البدء بها عند إرسال الطلبات إلى Cosmos
initialHeaders?: CosmosHeaders
قيمة الخاصية
موروث منSharedOptions.initialHeaders
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
قيمة الخاصية
موروث منSharedOptions.priorityLevel
sessionToken
تمكين/تعطيل الحصول على الإحصائيات ذات الصلة بالحصة النسبية لحاوية المستندات لطلبات قراءة حاوية المستند.
sessionToken?: string
قيمة الخاصية
string
موروث منSharedOptions.sessionToken
throughputBucket
دلو الإنتاجية لطلب.
القيمة الافتراضية خالية. في هذه الحالة، يمكن للطلب استخدام 100% من معدل نقل القسم.
لمزيد من المعلومات، تفضل بزيارة [مستودع إنتاجية Cosmos DB](https://aka.ms/cosmsodb-bucketing).throughputBucket?: number
قيمة الخاصية
number
موروثة منSharedOptions.throughputBucket