Kinetica.Options Class Reference

Connection Options More...

Properties
string	Username = string.Empty [get, set]
	Optional: User Name for Kinetica security More...
string	Password = string.Empty [get, set]
	Optional: Password for user More...
string	OauthToken = string.Empty [get, set]
	Optional: OauthToken for user More...
bool	UseSnappy = false [get, set]
	Use Snappy compression for requests More...
int	ThreadCount = 1 [get, set]
	Thread Count More...
bool	DisableFailover = false [get, set]
	Whether to disable failover upon failures More...
bool	DisableAutoDiscovery = false [get, set]
	Whether to disable automatic discovery of clusters and worker ranks More...
HAFailoverOrder	HAFailoverOrder = HAFailoverOrder.Random [get, set]
	Order in which to failover to backup clusters More...
int	Timeout = 0 [get, set]
	Request timeout in milliseconds (0 = infinite) More...
int	HostManagerPort = HAFailoverManager.DefaultHostManagerPort [get, set]
	Host manager port number More...
string?	HostnameRegex = null [get, set]
	Optional: Regex pattern to filter URLs by hostname/IP More...
string	PrimaryUrl = string.Empty [get, set]
	URL of the primary cluster in the HA environment More...
int	InitialConnectionAttemptTimeout = 0 [get, set]
	Initial connection attempt timeout in milliseconds. More...
int	ServerConnectionTimeout = 60000 [get, set]
	Server connection timeout in milliseconds. More...
TimeSpan	PooledConnectionLifetime = TimeSpan.FromMinutes(2) [get, set]
	Maximum lifetime of pooled HTTP connections. More...
TimeSpan	PooledConnectionIdleTimeout = TimeSpan.FromMinutes(2) [get, set]
	Idle timeout for pooled HTTP connections. More...

Detailed Description

Connection Options

Definition at line 49 of file Kinetica.cs.

Property Documentation

DisableAutoDiscovery

bool Kinetica.Options.DisableAutoDiscovery = false

getset

Whether to disable automatic discovery of clusters and worker ranks

Definition at line 84 of file Kinetica.cs.

DisableFailover

bool Kinetica.Options.DisableFailover = false

getset

Whether to disable failover upon failures

Definition at line 79 of file Kinetica.cs.

HAFailoverOrder

HAFailoverOrder Kinetica.Options.HAFailoverOrder = HAFailoverOrder.Random

getset

Order in which to failover to backup clusters

Definition at line 89 of file Kinetica.cs.

HostManagerPort

int Kinetica.Options.HostManagerPort = HAFailoverManager.DefaultHostManagerPort

getset

Host manager port number

Definition at line 99 of file Kinetica.cs.

HostnameRegex

string? Kinetica.Options.HostnameRegex = null

getset

Optional: Regex pattern to filter URLs by hostname/IP

Definition at line 104 of file Kinetica.cs.

InitialConnectionAttemptTimeout

int Kinetica.Options.InitialConnectionAttemptTimeout = 0

getset

Initial connection attempt timeout in milliseconds.

If the initial connection fails, the client will retry with exponential backoff until this timeout is reached. Default: 0 (no retry, fail immediately)

Definition at line 117 of file Kinetica.cs.

OauthToken

string Kinetica.Options.OauthToken = string.Empty

getset

Optional: OauthToken for user

Definition at line 64 of file Kinetica.cs.

Password

string Kinetica.Options.Password = string.Empty

getset

Optional: Password for user

Definition at line 59 of file Kinetica.cs.

PooledConnectionIdleTimeout

TimeSpan Kinetica.Options.PooledConnectionIdleTimeout = TimeSpan.FromMinutes(2)

getset

Idle timeout for pooled HTTP connections.

Default: 2 minutes.

Definition at line 135 of file Kinetica.cs.

PooledConnectionLifetime

TimeSpan Kinetica.Options.PooledConnectionLifetime = TimeSpan.FromMinutes(2)

getset

Maximum lifetime of pooled HTTP connections.

Lower values improve DNS refresh frequency but increase connection churn. Default: 2 minutes.

Definition at line 130 of file Kinetica.cs.

PrimaryUrl

string Kinetica.Options.PrimaryUrl = string.Empty

getset

URL of the primary cluster in the HA environment

Definition at line 109 of file Kinetica.cs.

ServerConnectionTimeout

int Kinetica.Options.ServerConnectionTimeout = 60000

getset

Server connection timeout in milliseconds.

Used for individual connection attempts during initialization. Default: 60000 (60 seconds)

Definition at line 124 of file Kinetica.cs.

ThreadCount

int Kinetica.Options.ThreadCount = 1

getset

Thread Count

Definition at line 74 of file Kinetica.cs.

Timeout

int Kinetica.Options.Timeout = 0

getset

Request timeout in milliseconds (0 = infinite)

Definition at line 94 of file Kinetica.cs.

Username

string Kinetica.Options.Username = string.Empty

getset

Optional: User Name for Kinetica security

Definition at line 54 of file Kinetica.cs.

UseSnappy

bool Kinetica.Options.UseSnappy = false

getset

Use Snappy compression for requests

Definition at line 69 of file Kinetica.cs.

---

The documentation for this class was generated from the following file:

• Kinetica/Kinetica.cs