Kinetica   C#   API  Version 7.2.3.1
Classes | Public Member Functions | Properties | List of all members
KineticaAdo.KineticaConnectionStringBuilder Class Reference

Provides a comprehensive connection string builder with JDBC-compatible properties. More...

Classes

class  PropertyKeys
 

Public Member Functions

 KineticaConnectionStringBuilder ()
 
 KineticaConnectionStringBuilder (string connectionString)
 

Properties

string Server [get, set]
 Gets or sets the server URL (e.g., "http://localhost:9191"). More...
 
string PrimaryUrl [get, set]
 Gets or sets the primary URL for HA configurations. More...
 
string Username [get, set]
 Gets or sets the username for authentication. More...
 
string Password [get, set]
 Gets or sets the password for authentication. More...
 
string OAuthToken [get, set]
 Gets or sets the OAuth token for authentication. More...
 
string?? Database [get, set]
 Gets or sets the database name. More...
 
string?? Schema [get, set]
 Gets or sets the default schema. More...
 
string?? ImpersonateUser [get, set]
 Gets or sets the user to impersonate. More...
 
int Timeout [get, set]
 Gets or sets the query timeout in minutes. More...
 
int ConnectionTimeout [get, set]
 Gets or sets the connection timeout in seconds. More...
 
int InitialConnectionTimeout [get, set]
 Gets or sets the initial connection timeout in seconds. More...
 
int ServerConnectionTimeout [get, set]
 Gets or sets the server connection timeout in seconds. More...
 
bool BypassSslCertCheck [get, set]
 Gets or sets whether to bypass SSL certificate validation. More...
 
string?? SslCaCertPath [get, set]
 Gets or sets the path to the SSL CA certificate. More...
 
string?? SslCertPassword [get, set]
 Gets or sets the SSL certificate password. More...
 
bool SslAllowHostMismatch [get, set]
 Gets or sets whether to allow SSL host mismatch. More...
 
bool DisableAutoDiscovery [get, set]
 Gets or sets whether to disable auto-discovery of cluster nodes. More...
 
bool DisableFailover [get, set]
 Gets or sets whether to disable automatic failover. More...
 
string?? FailoverOrder [get, set]
 Gets or sets the HA failover order. More...
 
int FailbackPollInterval [get, set]
 Gets or sets the failback poll interval in seconds. More...
 
bool DisableSnappy [get, set]
 Gets or sets whether to disable Snappy compression. More...
 
bool CostBasedOptimization [get, set]
 Gets or sets whether cost-based optimization is enabled. More...
 
bool DistributedJoins [get, set]
 Gets or sets whether distributed joins are enabled. More...
 
bool ParallelExecution [get, set]
 Gets or sets whether parallel execution is enabled. More...
 
bool PlanCache [get, set]
 Gets or sets whether plan caching is enabled. More...
 
bool ResultsCaching [get, set]
 Gets or sets whether results caching is enabled. More...
 
bool RuleBasedOptimizations [get, set]
 Gets or sets whether rule-based optimizations are enabled. More...
 
bool SsqOptimizations [get, set]
 Gets or sets whether SSQ optimizations are enabled. More...
 
bool UseApproxCountDistinct [get, set]
 Gets or sets whether to use approximate count distinct. More...
 
bool ReadOnly [get, set]
 Gets or sets whether the connection is read-only. More...
 
int Ttl [get, set]
 Gets or sets the time-to-live in minutes for query results. More...
 
int PagingTableTtl [get, set]
 Gets or sets the TTL for paging tables in minutes. More...
 
int Limit [get, set]
 Gets or sets the result row limit. More...
 
int RowsPerFetch [get, set]
 Gets or sets the number of rows per fetch. More...
 
int FetchSize [get, set]
 Gets or sets the default fetch size for paged result sets. More...
 
bool UseKeyLookup [get, set]
 Gets or sets whether to use key lookup optimization. More...
 
int RowsPerInsertion [get, set]
 Gets or sets the number of rows per insertion batch. More...
 
bool DisableMultiheadInsert [get, set]
 Gets or sets whether to disable multi-head insert. More...
 
bool IgnoreExistingPk [get, set]
 Gets or sets whether to ignore existing primary keys on insert. More...
 
bool TruncateStrings [get, set]
 Gets or sets whether to truncate strings that exceed column length. More...
 
bool UpdateOnExistingPk [get, set]
 Gets or sets whether to update on existing primary key. More...
 
string?? ErrorMode [get, set]
 Gets or sets the error mode for insertions. More...
 
string?? Replication [get, set]
 Gets or sets the replication mode. More...
 
bool NoSync [get, set]
 Gets or sets whether to disable sync mode. More...
 
string FileReadDelimiter [get, set]
 Gets or sets the file read delimiter. More...
 
bool FileReadHasHeader [get, set]
 Gets or sets whether the file has a header row. More...
 
string FileReadNullString [get, set]
 Gets or sets the null string representation in files. More...
 
string FileReadEscapeChar [get, set]
 Gets or sets the file escape character. More...
 

Detailed Description

Provides a comprehensive connection string builder with JDBC-compatible properties.

Supports all connection options from the Java JDBC driver.

Definition at line 1523 of file KineticaAdo.cs.

Constructor & Destructor Documentation

◆ KineticaConnectionStringBuilder() [1/2]

KineticaAdo.KineticaConnectionStringBuilder.KineticaConnectionStringBuilder ( )
inline

Definition at line 1618 of file KineticaAdo.cs.

◆ KineticaConnectionStringBuilder() [2/2]

KineticaAdo.KineticaConnectionStringBuilder.KineticaConnectionStringBuilder ( string  connectionString)
inline

Definition at line 1620 of file KineticaAdo.cs.

Property Documentation

◆ BypassSslCertCheck

bool KineticaAdo.KineticaConnectionStringBuilder.BypassSslCertCheck
getset

Gets or sets whether to bypass SSL certificate validation.

Definition at line 1752 of file KineticaAdo.cs.

◆ ConnectionTimeout

int KineticaAdo.KineticaConnectionStringBuilder.ConnectionTimeout
getset

Gets or sets the connection timeout in seconds.

Definition at line 1721 of file KineticaAdo.cs.

◆ CostBasedOptimization

bool KineticaAdo.KineticaConnectionStringBuilder.CostBasedOptimization
getset

Gets or sets whether cost-based optimization is enabled.

Default: true.

Definition at line 1841 of file KineticaAdo.cs.

◆ Database

string?? KineticaAdo.KineticaConnectionStringBuilder.Database
getset

Gets or sets the database name.

Aliases: Database, Initial Catalog

Definition at line 1681 of file KineticaAdo.cs.

◆ DisableAutoDiscovery

bool KineticaAdo.KineticaConnectionStringBuilder.DisableAutoDiscovery
getset

Gets or sets whether to disable auto-discovery of cluster nodes.

Definition at line 1792 of file KineticaAdo.cs.

◆ DisableFailover

bool KineticaAdo.KineticaConnectionStringBuilder.DisableFailover
getset

Gets or sets whether to disable automatic failover.

Definition at line 1801 of file KineticaAdo.cs.

◆ DisableMultiheadInsert

bool KineticaAdo.KineticaConnectionStringBuilder.DisableMultiheadInsert
getset

Gets or sets whether to disable multi-head insert.

Definition at line 1995 of file KineticaAdo.cs.

◆ DisableSnappy

bool KineticaAdo.KineticaConnectionStringBuilder.DisableSnappy
getset

Gets or sets whether to disable Snappy compression.

Definition at line 1828 of file KineticaAdo.cs.

◆ DistributedJoins

bool KineticaAdo.KineticaConnectionStringBuilder.DistributedJoins
getset

Gets or sets whether distributed joins are enabled.

Default: true.

Definition at line 1850 of file KineticaAdo.cs.

◆ ErrorMode

string?? KineticaAdo.KineticaConnectionStringBuilder.ErrorMode
getset

Gets or sets the error mode for insertions.

Definition at line 2031 of file KineticaAdo.cs.

◆ FailbackPollInterval

int KineticaAdo.KineticaConnectionStringBuilder.FailbackPollInterval
getset

Gets or sets the failback poll interval in seconds.

-1 means no limit.

Definition at line 1819 of file KineticaAdo.cs.

◆ FailoverOrder

string?? KineticaAdo.KineticaConnectionStringBuilder.FailoverOrder
getset

Gets or sets the HA failover order.

Definition at line 1810 of file KineticaAdo.cs.

◆ FetchSize

int KineticaAdo.KineticaConnectionStringBuilder.FetchSize
getset

Gets or sets the default fetch size for paged result sets.

When set to a positive value, SELECT queries will use paging to fetch results. 0 (default) means fetch all results at once.

Definition at line 1964 of file KineticaAdo.cs.

◆ FileReadDelimiter

string KineticaAdo.KineticaConnectionStringBuilder.FileReadDelimiter
getset

Gets or sets the file read delimiter.

Default: ",".

Definition at line 2062 of file KineticaAdo.cs.

◆ FileReadEscapeChar

string KineticaAdo.KineticaConnectionStringBuilder.FileReadEscapeChar
getset

Gets or sets the file escape character.

Definition at line 2089 of file KineticaAdo.cs.

◆ FileReadHasHeader

bool KineticaAdo.KineticaConnectionStringBuilder.FileReadHasHeader
getset

Gets or sets whether the file has a header row.

Definition at line 2071 of file KineticaAdo.cs.

◆ FileReadNullString

string KineticaAdo.KineticaConnectionStringBuilder.FileReadNullString
getset

Gets or sets the null string representation in files.

Default: "\\N".

Definition at line 2080 of file KineticaAdo.cs.

◆ IgnoreExistingPk

bool KineticaAdo.KineticaConnectionStringBuilder.IgnoreExistingPk
getset

Gets or sets whether to ignore existing primary keys on insert.

Definition at line 2004 of file KineticaAdo.cs.

◆ ImpersonateUser

string?? KineticaAdo.KineticaConnectionStringBuilder.ImpersonateUser
getset

Gets or sets the user to impersonate.

Requires appropriate permissions.

Definition at line 1699 of file KineticaAdo.cs.

◆ InitialConnectionTimeout

int KineticaAdo.KineticaConnectionStringBuilder.InitialConnectionTimeout
getset

Gets or sets the initial connection timeout in seconds.

0 means no limit.

Definition at line 1730 of file KineticaAdo.cs.

◆ Limit

int KineticaAdo.KineticaConnectionStringBuilder.Limit
getset

Gets or sets the result row limit.

-1 means no limit.

Definition at line 1944 of file KineticaAdo.cs.

◆ NoSync

bool KineticaAdo.KineticaConnectionStringBuilder.NoSync
getset

Gets or sets whether to disable sync mode.

Definition at line 2049 of file KineticaAdo.cs.

◆ OAuthToken

string KineticaAdo.KineticaConnectionStringBuilder.OAuthToken
getset

Gets or sets the OAuth token for authentication.

Definition at line 1671 of file KineticaAdo.cs.

◆ PagingTableTtl

int KineticaAdo.KineticaConnectionStringBuilder.PagingTableTtl
getset

Gets or sets the TTL for paging tables in minutes.

Default: 20.

Definition at line 1935 of file KineticaAdo.cs.

◆ ParallelExecution

bool KineticaAdo.KineticaConnectionStringBuilder.ParallelExecution
getset

Gets or sets whether parallel execution is enabled.

Default: true.

Definition at line 1859 of file KineticaAdo.cs.

◆ Password

string KineticaAdo.KineticaConnectionStringBuilder.Password
getset

Gets or sets the password for authentication.

Aliases: Password, PWD

Definition at line 1662 of file KineticaAdo.cs.

◆ PlanCache

bool KineticaAdo.KineticaConnectionStringBuilder.PlanCache
getset

Gets or sets whether plan caching is enabled.

Default: true.

Definition at line 1868 of file KineticaAdo.cs.

◆ PrimaryUrl

string KineticaAdo.KineticaConnectionStringBuilder.PrimaryUrl
getset

Gets or sets the primary URL for HA configurations.

Definition at line 1642 of file KineticaAdo.cs.

◆ ReadOnly

bool KineticaAdo.KineticaConnectionStringBuilder.ReadOnly
getset

Gets or sets whether the connection is read-only.

Definition at line 1917 of file KineticaAdo.cs.

◆ Replication

string?? KineticaAdo.KineticaConnectionStringBuilder.Replication
getset

Gets or sets the replication mode.

Definition at line 2040 of file KineticaAdo.cs.

◆ ResultsCaching

bool KineticaAdo.KineticaConnectionStringBuilder.ResultsCaching
getset

Gets or sets whether results caching is enabled.

Default: true.

Definition at line 1877 of file KineticaAdo.cs.

◆ RowsPerFetch

int KineticaAdo.KineticaConnectionStringBuilder.RowsPerFetch
getset

Gets or sets the number of rows per fetch.

Default: 10000.

Definition at line 1953 of file KineticaAdo.cs.

◆ RowsPerInsertion

int KineticaAdo.KineticaConnectionStringBuilder.RowsPerInsertion
getset

Gets or sets the number of rows per insertion batch.

Default: 10000.

Definition at line 1986 of file KineticaAdo.cs.

◆ RuleBasedOptimizations

bool KineticaAdo.KineticaConnectionStringBuilder.RuleBasedOptimizations
getset

Gets or sets whether rule-based optimizations are enabled.

Default: true.

Definition at line 1886 of file KineticaAdo.cs.

◆ Schema

string?? KineticaAdo.KineticaConnectionStringBuilder.Schema
getset

Gets or sets the default schema.

Definition at line 1690 of file KineticaAdo.cs.

◆ Server

string KineticaAdo.KineticaConnectionStringBuilder.Server
getset

Gets or sets the server URL (e.g., "http://localhost:9191").

Aliases: Server, URL, Host, Data Source

Definition at line 1633 of file KineticaAdo.cs.

◆ ServerConnectionTimeout

int KineticaAdo.KineticaConnectionStringBuilder.ServerConnectionTimeout
getset

Gets or sets the server connection timeout in seconds.

0 means no limit.

Definition at line 1739 of file KineticaAdo.cs.

◆ SslAllowHostMismatch

bool KineticaAdo.KineticaConnectionStringBuilder.SslAllowHostMismatch
getset

Gets or sets whether to allow SSL host mismatch.

Definition at line 1779 of file KineticaAdo.cs.

◆ SslCaCertPath

string?? KineticaAdo.KineticaConnectionStringBuilder.SslCaCertPath
getset

Gets or sets the path to the SSL CA certificate.

Definition at line 1761 of file KineticaAdo.cs.

◆ SslCertPassword

string?? KineticaAdo.KineticaConnectionStringBuilder.SslCertPassword
getset

Gets or sets the SSL certificate password.

Definition at line 1770 of file KineticaAdo.cs.

◆ SsqOptimizations

bool KineticaAdo.KineticaConnectionStringBuilder.SsqOptimizations
getset

Gets or sets whether SSQ optimizations are enabled.

Default: true.

Definition at line 1895 of file KineticaAdo.cs.

◆ Timeout

int KineticaAdo.KineticaConnectionStringBuilder.Timeout
getset

Gets or sets the query timeout in minutes.

-1 means no limit.

Definition at line 1712 of file KineticaAdo.cs.

◆ TruncateStrings

bool KineticaAdo.KineticaConnectionStringBuilder.TruncateStrings
getset

Gets or sets whether to truncate strings that exceed column length.

Definition at line 2013 of file KineticaAdo.cs.

◆ Ttl

int KineticaAdo.KineticaConnectionStringBuilder.Ttl
getset

Gets or sets the time-to-live in minutes for query results.

Default: 20.

Definition at line 1926 of file KineticaAdo.cs.

◆ UpdateOnExistingPk

bool KineticaAdo.KineticaConnectionStringBuilder.UpdateOnExistingPk
getset

Gets or sets whether to update on existing primary key.

Definition at line 2022 of file KineticaAdo.cs.

◆ UseApproxCountDistinct

bool KineticaAdo.KineticaConnectionStringBuilder.UseApproxCountDistinct
getset

Gets or sets whether to use approximate count distinct.

Default: false.

Definition at line 1904 of file KineticaAdo.cs.

◆ UseKeyLookup

bool KineticaAdo.KineticaConnectionStringBuilder.UseKeyLookup
getset

Gets or sets whether to use key lookup optimization.

Definition at line 1973 of file KineticaAdo.cs.

◆ Username

string KineticaAdo.KineticaConnectionStringBuilder.Username
getset

Gets or sets the username for authentication.

Aliases: Username, UID, User ID

Definition at line 1652 of file KineticaAdo.cs.

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