ConnectionPolicy interface

Pakiet:

@azure/cosmos

Reprezentuje zasady połączenia skojarzone z obiektem CosmosClient w usłudze bazy danych Azure Cosmos DB.

Właściwości

connectionMode	Określa tryb nawiązywania połączenia z usługą Cosmos. (Obecnie obsługuje tylko opcję bramy)
enableBackgroundEndpointRefreshing	Flaga włączania/wyłączania odświeżania w tle punktów końcowych. Domyślnie ustawione na true. Odnajdywanie punktów końcowych przy użyciu enableEndpointsDiscovery nadal będzie działać w przypadku żądań, które zakończyły się niepowodzeniem.
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 elementu client.dispose() po ustawieniu wartości true po zniszczeniu elementu CosmosClient wewnątrz innego procesu lub w przeglądarce.
enablePartitionLevelCircuitBreaker	Flaga włączania/wyłączania wyłącznika obwodu na poziomie partycji (PPCB). Wartość domyślna to fałsz. Uwaga: Wymaga enableEndpointDiscovery , aby być true. Jeśli odnajdywanie punktów końcowych jest wyłączone, to ustawienie nie ma żadnego wpływu.
enablePartitionLevelFailover	Flaga umożliwiająca włączanie/wyłączanie trybu failover na poziomie partycji (PPAF). Domyślnie ustawione na true. Automatycznie przełącza się w tryb failover na inne dostępne partycje, gdy partycja staje się niedostępna. Po włączeniu enablePartitionLevelCircuitBreaker zostanie również ustawiona na true. Uwaga: Włączenie dynamiczne wymaga zarówno , jak enableEndpointDiscovery i enableBackgroundEndpointRefreshing .true Jeśli odnajdywanie punktów końcowych jest wyłączone, to ustawienie nie ma żadnego wpływu.
endpointRefreshRateInMs	Częstotliwość w milisekundach, w których klient odświeży listę punktów końcowych w tle
preferredLocations	Lista regionów świadczenia usługi Azure, które mają być używane jako preferowane lokalizacje dla żądań odczytu.
requestTimeout	Limit czasu żądania (czas oczekiwania na odpowiedź z elementu równorzędnego sieci). Reprezentowane w milisekundach.
retryOptions	RetryOptions obiekt, który definiuje kilka konfigurowalnych właściwości używanych podczas ponawiania próby.
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 true.

Szczegóły właściwości

connectionMode

Określa tryb nawiązywania połączenia z usługą Cosmos. (Obecnie obsługuje tylko opcję bramy)

connectionMode?: Gateway

Wartość właściwości

Gateway

enableBackgroundEndpointRefreshing

Flaga włączania/wyłączania odświeżania w tle punktów końcowych. Domyślnie ustawione na true. Odnajdywanie punktów końcowych przy użyciu enableEndpointsDiscovery nadal będzie 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 elementu client.dispose() po ustawieniu wartości true po zniszczeniu elementu CosmosClient wewnątrz innego procesu lub w przeglądarce.

enableEndpointDiscovery?: boolean

Wartość właściwości

boolean

enablePartitionLevelCircuitBreaker

Flaga włączania/wyłączania wyłącznika obwodu na poziomie partycji (PPCB). Wartość domyślna to fałsz. Uwaga: Wymaga enableEndpointDiscovery , aby być true. Jeśli odnajdywanie punktów końcowych jest wyłączone, to ustawienie nie ma żadnego wpływu.

enablePartitionLevelCircuitBreaker?: boolean

Wartość właściwości

boolean

enablePartitionLevelFailover

Flaga umożliwiająca włączanie/wyłączanie trybu failover na poziomie partycji (PPAF). Domyślnie ustawione na true. Automatycznie przełącza się w tryb failover na inne dostępne partycje, gdy partycja staje się niedostępna. Po włączeniu enablePartitionLevelCircuitBreaker zostanie również ustawiona na true. Uwaga: Włączenie dynamiczne wymaga zarówno , jak enableEndpointDiscovery i enableBackgroundEndpointRefreshing .true Jeśli odnajdywanie punktów końcowych jest wyłączone, to ustawienie nie ma żadnego wpływu.

enablePartitionLevelFailover?: 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

RetryOptions

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 true.

useMultipleWriteLocations?: boolean

Wartość właściwości

boolean