ConnectionPolicy interface

Pacchetto:

@azure/cosmos

Rappresenta i criteri di connessione associati a cosmosClient nel servizio di database Azure Cosmos DB.

Proprietà

connectionMode	Determina la modalità con cui connettersi a Cosmos. (Attualmente supporta solo l'opzione Gateway)
enableBackgroundEndpointRefreshing	Flag per abilitare/disabilitare l'aggiornamento in background degli endpoint. il valore predefinito è true. L'individuazione degli endpoint tramite enableEndpointsDiscovery funzionerà comunque per le richieste non riuscite.
enableEndpointDiscovery	Flag per abilitare/disabilitare il reindirizzamento automatico delle richieste in base alle operazioni di lettura/scrittura. Impostazione predefinita: true. Obbligatorio per chiamare client.dispose() quando questa proprietà è impostata su true dopo aver distrutto CosmosClient all'interno di un altro processo o nel browser.
enablePartitionLevelCircuitBreaker	Flag per abilitare/disabilitare l'interruttore automatico a livello di partizione (PPCB). Il valore predefinito è falso. Nota: Richiede enableEndpointDiscovery l'essere true. Se l'individuazione degli endpoint è disabilitata, questa impostazione non ha alcun effetto.
enablePartitionLevelFailover	Flag per abilitare/disabilitare il failover a livello di partizione (PPAF). il valore predefinito è true. Esegue automaticamente il failover su altre partizioni disponibili quando una partizione diventa non disponibile. Se abilitato, anche enablePartitionLevelCircuitBreaker verrà impostato su true. Nota: l'abilitazione dinamica richiede che sia enableEndpointDiscoveryenableBackgroundEndpointRefreshingtrue. Se l'individuazione degli endpoint è disabilitata, questa impostazione non ha alcun effetto.
endpointRefreshRateInMs	Frequenza in millisecondi in cui il client aggiornerà l'elenco degli endpoint in background
preferredLocations	Elenco delle aree di Azure da usare come località preferite per le richieste di lettura.
requestTimeout	Timeout della richiesta (tempo di attesa della risposta dal peer di rete). Rappresentato in millisecondi.
retryOptions	Oggetto RetryOptions che definisce diverse proprietà configurabili usate durante i tentativi.
useMultipleWriteLocations	Flag che abilita le scritture in qualsiasi posizione (area) per gli account di database con replica geografica nel servizio Azure Cosmos DB. Il valore predefinito è true.

Dettagli proprietà

connectionMode

Determina la modalità con cui connettersi a Cosmos. (Attualmente supporta solo l'opzione Gateway)

connectionMode?: Gateway

Valore della proprietà

Gateway

enableBackgroundEndpointRefreshing

Flag per abilitare/disabilitare l'aggiornamento in background degli endpoint. il valore predefinito è true. L'individuazione degli endpoint tramite enableEndpointsDiscovery funzionerà comunque per le richieste non riuscite.

enableBackgroundEndpointRefreshing?: boolean

Valore della proprietà

boolean

enableEndpointDiscovery

Flag per abilitare/disabilitare il reindirizzamento automatico delle richieste in base alle operazioni di lettura/scrittura. Impostazione predefinita: true. Obbligatorio per chiamare client.dispose() quando questa proprietà è impostata su true dopo aver distrutto CosmosClient all'interno di un altro processo o nel browser.

enableEndpointDiscovery?: boolean

Valore della proprietà

boolean

enablePartitionLevelCircuitBreaker

Flag per abilitare/disabilitare l'interruttore automatico a livello di partizione (PPCB). Il valore predefinito è falso. Nota: Richiede enableEndpointDiscovery l'essere true. Se l'individuazione degli endpoint è disabilitata, questa impostazione non ha alcun effetto.

enablePartitionLevelCircuitBreaker?: boolean

Valore della proprietà

boolean

enablePartitionLevelFailover

Flag per abilitare/disabilitare il failover a livello di partizione (PPAF). il valore predefinito è true. Esegue automaticamente il failover su altre partizioni disponibili quando una partizione diventa non disponibile. Se abilitato, anche enablePartitionLevelCircuitBreaker verrà impostato su true. Nota: l'abilitazione dinamica richiede che sia enableEndpointDiscoveryenableBackgroundEndpointRefreshingtrue. Se l'individuazione degli endpoint è disabilitata, questa impostazione non ha alcun effetto.

enablePartitionLevelFailover?: boolean

Valore della proprietà

boolean

endpointRefreshRateInMs

Frequenza in millisecondi in cui il client aggiornerà l'elenco degli endpoint in background

endpointRefreshRateInMs?: number

Valore della proprietà

number

preferredLocations

Elenco delle aree di Azure da usare come località preferite per le richieste di lettura.

preferredLocations?: string[]

Valore della proprietà

string[]

requestTimeout

Timeout della richiesta (tempo di attesa della risposta dal peer di rete). Rappresentato in millisecondi.

requestTimeout?: number

Valore della proprietà

number

retryOptions

Oggetto RetryOptions che definisce diverse proprietà configurabili usate durante i tentativi.

retryOptions?: RetryOptions

Valore della proprietà

RetryOptions

useMultipleWriteLocations

Flag che abilita le scritture in qualsiasi posizione (area) per gli account di database con replica geografica nel servizio Azure Cosmos DB. Il valore predefinito è true.

useMultipleWriteLocations?: boolean

Valore della proprietà

boolean