ConnectionPolicy interface
Reprezentuje zasady połączenia skojarzone z obiektem CosmosClient w usłudze bazy danych Azure Cosmos DB.
Właściwości
connection |
Określa tryb nawiązywania połączenia z usługą Cosmos za pomocą polecenia . (Obecnie obsługuje tylko opcję bramy) |
enable |
Flaga włączania/wyłączania odświeżania w tle punktów końcowych. Wartość domyślna to false.
Odnajdywanie punktów końcowych przy użyciu |
enable |
Flaga umożliwiająca włączanie/wyłączanie automatycznego przekierowywania żądań na podstawie operacji odczytu/zapisu. Wartość domyślna true. Wymagane do wywołania metody client.dispose() w przypadku ustawienia wartości true po usunięciu elementu CosmosClient wewnątrz innego procesu lub w przeglądarce. |
endpoint |
Częstotliwość w milisekundach, w których klient odświeży listę punktów końcowych w tle |
preferred |
Lista regionów świadczenia usługi Azure, które mają być używane jako preferowane lokalizacje dla żądań odczytu. |
request |
Limit czasu żądania (czas oczekiwania na odpowiedź z elementu równorzędnego sieci). Reprezentowane w milisekundach. |
retry |
RetryOptions obiekt, który definiuje kilka konfigurowalnych właściwości używanych podczas ponawiania próby. |
use |
Flaga umożliwiająca zapisywanie w dowolnych lokalizacjach (regionach) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB.
Wartość domyślna to |
Szczegóły właściwości
connectionMode
Określa tryb nawiązywania połączenia z usługą Cosmos za pomocą polecenia . (Obecnie obsługuje tylko opcję bramy)
connectionMode?: Gateway
Wartość właściwości
enableBackgroundEndpointRefreshing
Flaga włączania/wyłączania odświeżania w tle punktów końcowych. Wartość domyślna to false.
Odnajdywanie punktów końcowych przy użyciu enableEndpointsDiscovery
polecenia będzie nadal działać w przypadku żądań, które zakończyły się niepowodzeniem.
enableBackgroundEndpointRefreshing?: boolean
Wartość właściwości
boolean
enableEndpointDiscovery
Flaga umożliwiająca włączanie/wyłączanie automatycznego przekierowywania żądań na podstawie operacji odczytu/zapisu. Wartość domyślna true. Wymagane do wywołania metody client.dispose() w przypadku ustawienia wartości true po usunięciu elementu CosmosClient wewnątrz innego procesu lub w przeglądarce.
enableEndpointDiscovery?: boolean
Wartość właściwości
boolean
endpointRefreshRateInMs
Częstotliwość w milisekundach, w których klient odświeży listę punktów końcowych w tle
endpointRefreshRateInMs?: number
Wartość właściwości
number
preferredLocations
Lista regionów świadczenia usługi Azure, które mają być używane jako preferowane lokalizacje dla żądań odczytu.
preferredLocations?: string[]
Wartość właściwości
string[]
requestTimeout
Limit czasu żądania (czas oczekiwania na odpowiedź z elementu równorzędnego sieci). Reprezentowane w milisekundach.
requestTimeout?: number
Wartość właściwości
number
retryOptions
RetryOptions obiekt, który definiuje kilka konfigurowalnych właściwości używanych podczas ponawiania próby.
retryOptions?: RetryOptions
Wartość właściwości
useMultipleWriteLocations
Flaga umożliwiająca zapisywanie w dowolnych lokalizacjach (regionach) dla kont baz danych replikowanych geograficznie w usłudze Azure Cosmos DB.
Wartość domyślna to false
.
useMultipleWriteLocations?: boolean
Wartość właściwości
boolean