Kinetica   C#   API  Version 7.2.3.1
Public Member Functions | Public Attributes | Protected Member Functions | Properties | List of all members
KineticaAdo.KineticaConnection Class Reference

Inherits DbConnection.

Public Member Functions

 KineticaConnection ()
 
 KineticaConnection (string connectionString)
 
override void ChangeDatabase (string databaseName)
 
void SetSchema (string schemaName)
 Sets the current schema (equivalent to SET SCHEMA command). More...
 
void SetUser (string username)
 Sets the impersonated user context (equivalent to SET USER command). More...
 
void ExecuteAsUser (string username)
 Executes as a specific user, pushing current context to stack. More...
 
void RevertUser ()
 Reverts to previous user context from ExecuteAsUser. More...
 
override void Close ()
 
override void Open ()
 
override async Task OpenAsync (CancellationToken cancellationToken)
 
long FlushBatch ()
 Flushes all pending batch inserts to the database. More...
 
async Task< long > FlushBatchAsync (CancellationToken cancellationToken=default)
 Flushes all pending batch inserts to the database asynchronously. More...
 
override DataTable GetSchema ()
 
override DataTable GetSchema (string collectionName)
 
override DataTable GetSchema (string collectionName, string?[]? restrictionValues)
 

Public Attributes

override string Database => _database
 
override string DataSource => _connectionStringBuilder?.Server ?? string.Empty
 
override string ServerVersion => "7.2"
 
override ConnectionState State => _state
 
string? ImpersonatedUser => _currentImpersonatedUser
 Gets the current impersonated user, if any. More...
 
int PendingBatchCount => _batchManager?.GetTotalPendingCount() ?? 0
 Gets the number of records currently pending in the batch buffer. More...
 

Protected Member Functions

override DbTransaction BeginDbTransaction (IsolationLevel isolationLevel)
 
override DbCommand CreateDbCommand ()
 
override void Dispose (bool disposing)
 

Properties

override string???? ConnectionString [get, set]
 
string???? CurrentSchema [get, set]
 Gets or sets the current schema for this session. More...
 
bool BatchInsertMode [get, set]
 Gets or sets whether batch insert mode is enabled. More...
 
int BatchSize [get, set]
 Gets or sets the batch size for batch insert operations. More...
 
bool BatchUpdateOnExistingPk [get, set]
 Gets or sets whether to update existing records with matching primary keys during batch inserts. More...
 

Detailed Description

Definition at line 10 of file KineticaAdo.cs.

Constructor & Destructor Documentation

◆ KineticaConnection() [1/2]

KineticaAdo.KineticaConnection.KineticaConnection ( )
inline

Definition at line 30 of file KineticaAdo.cs.

◆ KineticaConnection() [2/2]

KineticaAdo.KineticaConnection.KineticaConnection ( string  connectionString)
inline

Definition at line 32 of file KineticaAdo.cs.

Member Function Documentation

◆ BeginDbTransaction()

override DbTransaction KineticaAdo.KineticaConnection.BeginDbTransaction ( IsolationLevel  isolationLevel)
inlineprotected

Definition at line 236 of file KineticaAdo.cs.

◆ ChangeDatabase()

override void KineticaAdo.KineticaConnection.ChangeDatabase ( string  databaseName)
inline

Definition at line 74 of file KineticaAdo.cs.

◆ Close()

override void KineticaAdo.KineticaConnection.Close ( )
inline

Definition at line 124 of file KineticaAdo.cs.

◆ CreateDbCommand()

override DbCommand KineticaAdo.KineticaConnection.CreateDbCommand ( )
inlineprotected

Definition at line 241 of file KineticaAdo.cs.

◆ Dispose()

override void KineticaAdo.KineticaConnection.Dispose ( bool  disposing)
inlineprotected

Definition at line 368 of file KineticaAdo.cs.

◆ ExecuteAsUser()

void KineticaAdo.KineticaConnection.ExecuteAsUser ( string  username)
inline

Executes as a specific user, pushing current context to stack.

Use Revert() to return to previous context.

Definition at line 100 of file KineticaAdo.cs.

◆ FlushBatch()

long KineticaAdo.KineticaConnection.FlushBatch ( )
inline

Flushes all pending batch inserts to the database.

Returns
The number of records flushed.

Definition at line 325 of file KineticaAdo.cs.

◆ FlushBatchAsync()

async Task<long> KineticaAdo.KineticaConnection.FlushBatchAsync ( CancellationToken  cancellationToken = default)
inline

Flushes all pending batch inserts to the database asynchronously.

Parameters
cancellationTokenCancellation token.
Returns
The number of records flushed.

Definition at line 339 of file KineticaAdo.cs.

◆ GetSchema() [1/3]

override DataTable KineticaAdo.KineticaConnection.GetSchema ( )
inline

Definition at line 352 of file KineticaAdo.cs.

◆ GetSchema() [2/3]

override DataTable KineticaAdo.KineticaConnection.GetSchema ( string  collectionName)
inline

Definition at line 357 of file KineticaAdo.cs.

◆ GetSchema() [3/3]

override DataTable KineticaAdo.KineticaConnection.GetSchema ( string  collectionName,
string?? []  restrictionValues 
)
inline

Definition at line 362 of file KineticaAdo.cs.

◆ Open()

override void KineticaAdo.KineticaConnection.Open ( )
inline

Definition at line 153 of file KineticaAdo.cs.

◆ OpenAsync()

override async Task KineticaAdo.KineticaConnection.OpenAsync ( CancellationToken  cancellationToken)
inline

Definition at line 162 of file KineticaAdo.cs.

◆ RevertUser()

void KineticaAdo.KineticaConnection.RevertUser ( )
inline

Reverts to previous user context from ExecuteAsUser.

Definition at line 112 of file KineticaAdo.cs.

◆ SetSchema()

void KineticaAdo.KineticaConnection.SetSchema ( string  schemaName)
inline

Sets the current schema (equivalent to SET SCHEMA command).

Definition at line 82 of file KineticaAdo.cs.

◆ SetUser()

void KineticaAdo.KineticaConnection.SetUser ( string  username)
inline

Sets the impersonated user context (equivalent to SET USER command).

Requires appropriate permissions.

Definition at line 91 of file KineticaAdo.cs.

Member Data Documentation

◆ Database

override string KineticaAdo.KineticaConnection.Database => _database

Definition at line 54 of file KineticaAdo.cs.

◆ DataSource

override string KineticaAdo.KineticaConnection.DataSource => _connectionStringBuilder?.Server ?? string.Empty

Definition at line 55 of file KineticaAdo.cs.

◆ ImpersonatedUser

string? KineticaAdo.KineticaConnection.ImpersonatedUser => _currentImpersonatedUser

Gets the current impersonated user, if any.

Definition at line 72 of file KineticaAdo.cs.

◆ PendingBatchCount

int KineticaAdo.KineticaConnection.PendingBatchCount => _batchManager?.GetTotalPendingCount() ?? 0

Gets the number of records currently pending in the batch buffer.

Definition at line 319 of file KineticaAdo.cs.

◆ ServerVersion

override string KineticaAdo.KineticaConnection.ServerVersion => "7.2"

Definition at line 56 of file KineticaAdo.cs.

◆ State

override ConnectionState KineticaAdo.KineticaConnection.State => _state

Definition at line 57 of file KineticaAdo.cs.

Property Documentation

◆ BatchInsertMode

bool KineticaAdo.KineticaConnection.BatchInsertMode
getset

Gets or sets whether batch insert mode is enabled.

When enabled, INSERT statements are buffered and sent in batches for improved performance.

Definition at line 271 of file KineticaAdo.cs.

◆ BatchSize

int KineticaAdo.KineticaConnection.BatchSize
getset

Gets or sets the batch size for batch insert operations.

Definition at line 297 of file KineticaAdo.cs.

◆ BatchUpdateOnExistingPk

bool KineticaAdo.KineticaConnection.BatchUpdateOnExistingPk
getset

Gets or sets whether to update existing records with matching primary keys during batch inserts.

Definition at line 306 of file KineticaAdo.cs.

◆ ConnectionString

override string???? KineticaAdo.KineticaConnection.ConnectionString
getset

Definition at line 39 of file KineticaAdo.cs.

◆ CurrentSchema

string???? KineticaAdo.KineticaConnection.CurrentSchema
getset

Gets or sets the current schema for this session.

Can be set via SET SCHEMA command or programmatically.

Definition at line 64 of file KineticaAdo.cs.

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