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

A paging data reader that fetches records in batches for large result sets. More...

Inherits DbDataReader.

Public Member Functions

 KineticaPagingDataReader (Kinetica client, string sql, int fetchSize, CommandBehavior behavior, CancellationToken cancellationToken=default)
 
override bool Read ()
 
override async Task< bool > ReadAsync (CancellationToken cancellationToken)
 
override bool NextResult ()
 
override void Close ()
 
override DataTable GetSchemaTable ()
 
override bool GetBoolean (int ordinal)
 
override byte GetByte (int ordinal)
 
override char GetChar (int ordinal)
 
override DateTime GetDateTime (int ordinal)
 
override decimal GetDecimal (int ordinal)
 
override double GetDouble (int ordinal)
 
override float GetFloat (int ordinal)
 
override Guid GetGuid (int ordinal)
 
override short GetInt16 (int ordinal)
 
override int GetInt32 (int ordinal)
 
override long GetInt64 (int ordinal)
 
override string GetString (int ordinal)
 
override long GetBytes (int ordinal, long dataOffset, byte[]? buffer, int bufferOffset, int length)
 
override long GetChars (int ordinal, long dataOffset, char[]? buffer, int bufferOffset, int length)
 
override string GetDataTypeName (int ordinal)
 
override Type GetFieldType (int ordinal)
 
override string GetName (int ordinal)
 
override int GetOrdinal (string name)
 
override object GetValue (int ordinal)
 
override int GetValues (object[] values)
 
override bool IsDBNull (int ordinal)
 
override IEnumerator< IDataRecord > GetEnumerator ()
 

Public Attributes

override bool HasRows => _totalRecordCount > 0
 
override bool IsClosed => _closed
 
override int RecordsAffected => (int)_totalRecordCount
 
override int FieldCount => _columnNames?.Count ?? 0
 
override object this[int ordinal] => GetValue(ordinal)
 
override object this[string name] => GetValue(GetOrdinal(name))
 
override int Depth => 0
 
long TotalRowsRead => _totalRowsRead
 Gets the total number of records read so far. More...
 
long TotalRecordCount => _totalRecordCount
 Gets the total number of records in the result set. More...
 

Detailed Description

A paging data reader that fetches records in batches for large result sets.

Similar to JDBC's forward-only result set with fetch size.

Definition at line 1158 of file KineticaAdo.cs.

Constructor & Destructor Documentation

◆ KineticaPagingDataReader()

KineticaAdo.KineticaPagingDataReader.KineticaPagingDataReader ( Kinetica  client,
string  sql,
int  fetchSize,
CommandBehavior  behavior,
CancellationToken  cancellationToken = default 
)
inline

Definition at line 1176 of file KineticaAdo.cs.

Member Function Documentation

◆ Close()

override void KineticaAdo.KineticaPagingDataReader.Close ( )
inline

Definition at line 1352 of file KineticaAdo.cs.

◆ GetBoolean()

override bool KineticaAdo.KineticaPagingDataReader.GetBoolean ( int  ordinal)

◆ GetByte()

override byte KineticaAdo.KineticaPagingDataReader.GetByte ( int  ordinal)

◆ GetBytes()

override long KineticaAdo.KineticaPagingDataReader.GetBytes ( int  ordinal,
long  dataOffset,
byte? []  buffer,
int  bufferOffset,
int  length 
)
inline

Definition at line 1395 of file KineticaAdo.cs.

◆ GetChar()

override char KineticaAdo.KineticaPagingDataReader.GetChar ( int  ordinal)

◆ GetChars()

override long KineticaAdo.KineticaPagingDataReader.GetChars ( int  ordinal,
long  dataOffset,
char? []  buffer,
int  bufferOffset,
int  length 
)
inline

Definition at line 1409 of file KineticaAdo.cs.

◆ GetDataTypeName()

override string KineticaAdo.KineticaPagingDataReader.GetDataTypeName ( int  ordinal)
inline

Definition at line 1421 of file KineticaAdo.cs.

◆ GetDateTime()

override DateTime KineticaAdo.KineticaPagingDataReader.GetDateTime ( int  ordinal)

◆ GetDecimal()

override decimal KineticaAdo.KineticaPagingDataReader.GetDecimal ( int  ordinal)

◆ GetDouble()

override double KineticaAdo.KineticaPagingDataReader.GetDouble ( int  ordinal)

◆ GetEnumerator()

override IEnumerator<IDataRecord> KineticaAdo.KineticaPagingDataReader.GetEnumerator ( )
inline

Definition at line 1509 of file KineticaAdo.cs.

◆ GetFieldType()

override Type KineticaAdo.KineticaPagingDataReader.GetFieldType ( int  ordinal)
inline

Definition at line 1428 of file KineticaAdo.cs.

◆ GetFloat()

override float KineticaAdo.KineticaPagingDataReader.GetFloat ( int  ordinal)

◆ GetGuid()

override Guid KineticaAdo.KineticaPagingDataReader.GetGuid ( int  ordinal)

◆ GetInt16()

override short KineticaAdo.KineticaPagingDataReader.GetInt16 ( int  ordinal)

◆ GetInt32()

override int KineticaAdo.KineticaPagingDataReader.GetInt32 ( int  ordinal)

◆ GetInt64()

override long KineticaAdo.KineticaPagingDataReader.GetInt64 ( int  ordinal)

◆ GetName()

override string KineticaAdo.KineticaPagingDataReader.GetName ( int  ordinal)
inline

Definition at line 1452 of file KineticaAdo.cs.

◆ GetOrdinal()

override int KineticaAdo.KineticaPagingDataReader.GetOrdinal ( string  name)
inline

Definition at line 1459 of file KineticaAdo.cs.

◆ GetSchemaTable()

override DataTable KineticaAdo.KineticaPagingDataReader.GetSchemaTable ( )
inline

Definition at line 1358 of file KineticaAdo.cs.

◆ GetString()

override string KineticaAdo.KineticaPagingDataReader.GetString ( int  ordinal)

◆ GetValue()

override object KineticaAdo.KineticaPagingDataReader.GetValue ( int  ordinal)
inline

Definition at line 1472 of file KineticaAdo.cs.

◆ GetValues()

override int KineticaAdo.KineticaPagingDataReader.GetValues ( object []  values)
inline

Definition at line 1493 of file KineticaAdo.cs.

◆ IsDBNull()

override bool KineticaAdo.KineticaPagingDataReader.IsDBNull ( int  ordinal)
inline

Definition at line 1503 of file KineticaAdo.cs.

◆ NextResult()

override bool KineticaAdo.KineticaPagingDataReader.NextResult ( )

◆ Read()

override bool KineticaAdo.KineticaPagingDataReader.Read ( )
inline

Definition at line 1300 of file KineticaAdo.cs.

◆ ReadAsync()

override async Task<bool> KineticaAdo.KineticaPagingDataReader.ReadAsync ( CancellationToken  cancellationToken)
inline

Definition at line 1325 of file KineticaAdo.cs.

Member Data Documentation

◆ Depth

override int KineticaAdo.KineticaPagingDataReader.Depth => 0

Definition at line 1288 of file KineticaAdo.cs.

◆ FieldCount

override int KineticaAdo.KineticaPagingDataReader.FieldCount => _columnNames?.Count ?? 0

Definition at line 1285 of file KineticaAdo.cs.

◆ HasRows

override bool KineticaAdo.KineticaPagingDataReader.HasRows => _totalRecordCount > 0

Definition at line 1282 of file KineticaAdo.cs.

◆ IsClosed

override bool KineticaAdo.KineticaPagingDataReader.IsClosed => _closed

Definition at line 1283 of file KineticaAdo.cs.

◆ RecordsAffected

override int KineticaAdo.KineticaPagingDataReader.RecordsAffected => (int)_totalRecordCount

Definition at line 1284 of file KineticaAdo.cs.

◆ this[int ordinal]

override object KineticaAdo.KineticaPagingDataReader.this[int ordinal] => GetValue(ordinal)

Definition at line 1286 of file KineticaAdo.cs.

◆ this[string name]

override object KineticaAdo.KineticaPagingDataReader.this[string name] => GetValue(GetOrdinal(name))

Definition at line 1287 of file KineticaAdo.cs.

◆ TotalRecordCount

long KineticaAdo.KineticaPagingDataReader.TotalRecordCount => _totalRecordCount

Gets the total number of records in the result set.

Definition at line 1298 of file KineticaAdo.cs.

◆ TotalRowsRead

long KineticaAdo.KineticaPagingDataReader.TotalRowsRead => _totalRowsRead

Gets the total number of records read so far.

Definition at line 1293 of file KineticaAdo.cs.

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