ConnectionPolicy interface
يمثل نهج الاتصال المقترن ب CosmosClient في خدمة قاعدة بيانات Azure Cosmos DB.
الخصائص
| connection |
تحديد الوضع الذي يجب الاتصال ب Cosmos باستخدامه. (حاليا يدعم خيار البوابة فقط) |
| enable |
وضع علامة لتمكين/تعطيل تحديث الخلفية لنقاط النهاية. الإعدادات الافتراضية إلى true.
سيظل اكتشاف نقطة النهاية باستخدام |
| enable |
وضع علامة لتمكين/تعطيل إعادة التوجيه التلقائي للطلبات استنادا إلى عمليات القراءة/الكتابة. الافتراضي صواب. مطلوب لاستدعاء client.dispose() عند تعيين هذا إلى true بعد تدمير CosmosClient داخل عملية أخرى أو في المستعرض. |
| enable |
ضع علامة على تمكين/تعطيل قاطع الدائرة على مستوى القسم (PPCB). الإعدادات الافتراضية إلى false.
ملاحظة: يتطلب |
| enable |
ضع علامة على تمكين/تعطيل تجاوز الفشل على مستوى القسم (PPAF). الإعدادات الافتراضية إلى true.
تجاوز الفشل تلقائيا إلى الأقسام الأخرى المتوفرة عندما يصبح القسم غير متوفر.
عند التمكين، سيتم أيضا تعيين enablePartitionLevelCircuitBreaker إلى true.
ملاحظة: يتطلب التمكين الديناميكي كلاهما |
| endpoint |
المعدل بالمللي ثانية حيث سيقوم العميل بتحديث قائمة نقاط النهاية في الخلفية |
| preferred |
قائمة مناطق Azure التي سيتم استخدامها كمواقع مفضلة لطلبات القراءة. |
| request |
طلب مهلة (وقت انتظار الاستجابة من نظير الشبكة). ممثل بالمللي ثانية. |
| retry |
كائن RetryOptions الذي يعرف العديد من الخصائص القابلة للتكوين المستخدمة أثناء إعادة المحاولة. |
| use |
العلامة التي تمكن عمليات الكتابة على أي مواقع (مناطق) لحسابات قاعدة البيانات المنسوخة جغرافيا في خدمة Azure Cosmos DB.
الافتراضي هو |
تفاصيل الخاصية
connectionMode
تحديد الوضع الذي يجب الاتصال ب Cosmos باستخدامه. (حاليا يدعم خيار البوابة فقط)
connectionMode?: Gateway
قيمة الخاصية
enableBackgroundEndpointRefreshing
وضع علامة لتمكين/تعطيل تحديث الخلفية لنقاط النهاية. الإعدادات الافتراضية إلى true.
سيظل اكتشاف نقطة النهاية باستخدام enableEndpointsDiscovery يعمل مع الطلبات الفاشلة.
enableBackgroundEndpointRefreshing?: boolean
قيمة الخاصية
boolean
enableEndpointDiscovery
وضع علامة لتمكين/تعطيل إعادة التوجيه التلقائي للطلبات استنادا إلى عمليات القراءة/الكتابة. الافتراضي صواب. مطلوب لاستدعاء client.dispose() عند تعيين هذا إلى true بعد تدمير CosmosClient داخل عملية أخرى أو في المستعرض.
enableEndpointDiscovery?: boolean
قيمة الخاصية
boolean
enablePartitionLevelCircuitBreaker
ضع علامة على تمكين/تعطيل قاطع الدائرة على مستوى القسم (PPCB). الإعدادات الافتراضية إلى false.
ملاحظة: يتطلب enableEndpointDiscovery أن يكون true. إذا تم تعطيل اكتشاف نقطة النهاية، فلن يكون لهذا الإعداد أي تأثير.
enablePartitionLevelCircuitBreaker?: boolean
قيمة الخاصية
boolean
enablePartitionLevelFailover
ضع علامة على تمكين/تعطيل تجاوز الفشل على مستوى القسم (PPAF). الإعدادات الافتراضية إلى true.
تجاوز الفشل تلقائيا إلى الأقسام الأخرى المتوفرة عندما يصبح القسم غير متوفر.
عند التمكين، سيتم أيضا تعيين enablePartitionLevelCircuitBreaker إلى true.
ملاحظة: يتطلب التمكين الديناميكي كلاهما enableEndpointDiscovery وأن enableBackgroundEndpointRefreshing يكون true. إذا تم تعطيل اكتشاف نقطة النهاية، فلن يكون لهذا الإعداد أي تأثير.
enablePartitionLevelFailover?: boolean
قيمة الخاصية
boolean
endpointRefreshRateInMs
المعدل بالمللي ثانية حيث سيقوم العميل بتحديث قائمة نقاط النهاية في الخلفية
endpointRefreshRateInMs?: number
قيمة الخاصية
number
preferredLocations
قائمة مناطق Azure التي سيتم استخدامها كمواقع مفضلة لطلبات القراءة.
preferredLocations?: string[]
قيمة الخاصية
string[]
requestTimeout
طلب مهلة (وقت انتظار الاستجابة من نظير الشبكة). ممثل بالمللي ثانية.
requestTimeout?: number
قيمة الخاصية
number
retryOptions
كائن RetryOptions الذي يعرف العديد من الخصائص القابلة للتكوين المستخدمة أثناء إعادة المحاولة.
retryOptions?: RetryOptions
قيمة الخاصية
useMultipleWriteLocations
العلامة التي تمكن عمليات الكتابة على أي مواقع (مناطق) لحسابات قاعدة البيانات المنسوخة جغرافيا في خدمة Azure Cosmos DB.
الافتراضي هو true.
useMultipleWriteLocations?: boolean
قيمة الخاصية
boolean