• DataStax C# Driver for Apache Cassandra API Documentation

    Show / Hide Table of Contents
    • Cassandra
      • AggregateMetadata
      • AlreadyExistsException
      • AtomicMonotonicTimestampGenerator
      • AtomicMonotonicWinApiTimestampGenerator
      • AuthenticationException
      • BatchStatement
      • BatchType
      • BigIntegerTypeAdapter
      • BoundStatement
      • Builder
      • BusyPoolException
      • CassandraConnectionStringBuilder
      • ClientOptions
      • Cluster
      • ColumnDesc
      • ColumnTypeCode
      • CompressionType
      • Configuration
      • ConsistencyLevel
      • ConstantReconnectionPolicy
      • ConstantSpeculativeExecutionPolicy
      • CqlColumn
      • CustomColumnInfo
      • DataCollectionMetadata
      • DataCollectionMetadata.SortOrder
      • DCAwareRoundRobinPolicy
      • DecimalTypeAdapter
      • DefaultLoadBalancingPolicy
      • DefaultRetryPolicy
      • Diagnostics
      • DowngradingConsistencyRetryPolicy
      • DriverException
      • DriverInternalError
      • Duration
      • DynamicCompositeTypeAdapter
      • EC2MultiRegionTranslator
      • ExecutionException
      • ExecutionInfo
      • ExponentialReconnectionPolicy
      • Extensions
      • FallthroughRetryPolicy
      • FixedReconnectionPolicy
      • FunctionFailureException
      • FunctionMetadata
      • Host
      • HostDistance
      • HostsEventArgs
      • HostsEventArgs.Kind
      • HostsEventHandler
      • IAddressTranslator
      • IAuthenticator
      • IAuthProvider
      • IAuthProviderNamed
      • ICluster
      • IColumnInfo
      • IdempotenceAwareRetryPolicy
      • IExecutionProfile
      • IExecutionProfileBuilder
      • IExecutionProfileOptions
      • IExtendedRetryPolicy
      • IFrameCompressor
      • IInitializer
      • ILoadBalancingPolicy
      • IndexMetadata
      • IndexMetadata.IndexKind
      • InitFatalErrorException
      • InvalidConfigurationInQueryException
      • InvalidQueryException
      • InvalidTypeException
      • IReconnectionPolicy
      • IReconnectionSchedule
      • IRetryPolicy
      • IsBootstrappingException
      • ISession
      • ISessionState
      • ISpeculativeExecutionPlan
      • ISpeculativeExecutionPolicy
      • IStatement
      • ITimestampGenerator
      • ITypeAdapter
      • KeyspaceMetadata
      • KeyType
      • ListColumnInfo
      • LocalDate
      • LocalTime
      • Logger
      • LoggingRetryPolicy
      • MapColumnInfo
      • MaterializedViewMetadata
      • Metadata
      • MetadataSyncOptions
      • MetricsExtensions
      • MonitorReportingOptions
      • NoHostAvailableException
      • NoneAuthProvider
      • NoSpeculativeExecutionPolicy
      • NullTypeAdapter
      • OperationTimedOutException
      • OverloadedException
      • PlainTextAuthProvider
      • Policies
      • PoolingOptions
      • PreparedQueryNotFoundException
      • PreparedStatement
      • PreparedStatementIdMismatchException
      • ProtocolErrorException
      • ProtocolOptions
      • ProtocolVersion
      • QueryExecutionException
      • QueryOptions
      • QueryProtocolOptions
      • QueryProtocolOptions.QueryFlags
      • QueryTimeoutException
      • QueryTrace
      • QueryTrace.Event
      • QueryValidationException
      • ReadFailureException
      • ReadTimeoutException
      • RegularStatement
      • ReplicationStrategies
      • RequestInvalidException
      • RetryDecision
      • RetryDecision.RetryDecisionType
      • RetryLoadBalancingPolicy
      • RetryLoadBalancingPolicyEventArgs
      • RoundRobinPolicy
      • RoutingKey
      • Row
      • RowSet
      • RowSetMetadata
      • SchemaChangedEventArgs
      • SchemaChangedEventArgs.Kind
      • SchemaChangedEventHandler
      • ServerErrorException
      • Session
      • SetColumnInfo
      • SimpleStatement
      • SocketOptions
      • SSLOptions
      • Statement
      • SyntaxError
      • TableColumn
      • TableMetadata
      • TableOptions
      • TimeUuid
      • TokenAwarePolicy
      • ToManyConnectionsPerHost
      • TraceRetrievalException
      • TruncateException
      • TupleColumnInfo
      • TypeAdapters
      • UdtColumnInfo
      • UdtMap
      • UdtMap<T>
      • UdtMappingDefinitions
      • UnauthorizedException
      • UnavailableException
      • Unset
      • WriteFailureException
      • WriteTimeoutException
    • Cassandra.AppMetrics
      • DriverAppMetricsOptions
    • Cassandra.AppMetrics.MetricTypes
      • IAppMetricsCounter
      • IAppMetricsGauge
      • IAppMetricsMeter
      • IAppMetricsMetric
      • IAppMetricsTimer
    • Cassandra.AppMetrics.MetricValues
      • IAppMetricsHistogramValue
      • IAppMetricsMeterValue
      • IAppMetricsMetricWithValue<T>
      • IAppMetricsTimerValue
    • Cassandra.Data
      • CqlBatchTransaction
      • CqlCommand
      • CqlConnection
      • CqlDataAdapter
      • CqlParameter
      • CqlParameterCollection
      • CqlProviderFactory
      • CqlReader
    • Cassandra.Data.Linq
      • AllowFilteringAttribute
      • Batch
      • ClusteringKeyAttribute
      • ColumnAttribute
      • CompactStorageAttribute
      • CounterAttribute
      • CqlArgumentException
      • CqlCommand
      • CqlConditionalCommand<TEntity>
      • CqlDelete
      • CqlFunction
      • CqlInsert<TEntity>
      • CqlLinqNotSupportedException
      • CqlOperator
      • CqlQuery<TEntity>
      • CqlQueryBase<TEntity>
      • CqlQueryExtensions
      • CqlQuerySingleElement<TEntity>
      • CqlScalar<TEntity>
      • CqlToken
      • CqlUpdate
      • IgnoreAttribute
      • ITable
      • PartitionKeyAttribute
      • SecondaryIndexAttribute
      • SessionExtensions
      • StaticColumnAttribute
      • Table<TEntity>
      • TableAttribute
      • TableType
    • Cassandra.DataStax.Auth
      • DseGssapiAuthProvider
      • DsePlainTextAuthProvider
    • Cassandra.DataStax.Auth.Sspi
      • SspiException
    • Cassandra.DataStax.Graph
      • Edge
      • Element
      • GraphNode
      • GraphOptions
      • GraphResultSet
      • GraphStatement
      • IEdge
      • IElement
      • IGraphNode
      • IGraphStatement
      • IPath
      • IProperty
      • IVertex
      • IVertexProperty
      • Path
      • SimpleGraphStatement
      • Vertex
    • Cassandra.DataStax.Search
      • DateRange
      • DateRangeBound
      • DateRangePrecision
    • Cassandra.Geometry
      • GeometryBase
      • LineString
      • Point
      • Polygon
    • Cassandra.Mapping
      • AppliedInfo<T>
      • ColumnMap
      • Cql
      • CqlQueryOptions
      • IColumnDefinition
      • ICqlBatch
      • ICqlQueryAsyncClient
      • ICqlQueryClient
      • ICqlWriteAsyncClient
      • ICqlWriteClient
      • IMapper
      • IPage<T>
      • ITypeDefinition
      • Map<TPoco>
      • Mapper
      • MappingConfiguration
      • Mappings
      • PrimaryKeyAttribute
      • SortOrder
      • TableNameAttribute
    • Cassandra.Mapping.Attributes
      • ClusteringKeyAttribute
      • ColumnAttribute
      • CounterAttribute
      • FrozenAttribute
      • FrozenKeyAttribute
      • FrozenValueAttribute
      • IgnoreAttribute
      • PartitionKeyAttribute
      • SecondaryIndexAttribute
      • StaticColumnAttribute
      • TableAttribute
    • Cassandra.Mapping.TypeConversion
      • DefaultTypeConverter
      • EnumStringMapper<T>
      • NullableEnumStringMapper<T>
      • TypeConverter
    • Cassandra.Mapping.Utils
      • MemberInfoExtensions
    • Cassandra.Metrics
      • DriverMetricsOptions
      • IDriverMetrics
      • IMetric
      • IMetricsRegistry<TMetric>
      • NodeMetric
      • NodeMetric.Counters
      • NodeMetric.Gauges
      • NodeMetric.Meters
      • NodeMetric.Timers
      • SessionMetric
      • SessionMetric.Counters
      • SessionMetric.Gauges
      • SessionMetric.Meters
      • SessionMetric.Timers
    • Cassandra.Metrics.Abstractions
      • IDriverCounter
      • IDriverGauge
      • IDriverMeter
      • IDriverMetric
      • IDriverMetricsProvider
      • IDriverTimer
    • Cassandra.Serialization
      • CustomTypeSerializer<T>
      • TypeSerializer
      • TypeSerializer<T>
      • TypeSerializerDefinitions
      • UdtSerializer
    • Cassandra.Serialization.Primitive
      • DecimalSerializer

    Class CqlReader

    Reads a forward-only stream of rows from Cassandra.

    Inheritance
    System.Object
    System.MarshalByRefObject
    System.Data.Common.DbDataReader
    CqlReader
    Implements
    System.Collections.IEnumerable
    System.Data.IDataReader
    System.Data.IDataRecord
    System.IDisposable
    Inherited Members
    System.Data.Common.DbDataReader.Dispose(System.Boolean)
    System.Data.Common.DbDataReader.GetDbDataReader(System.Int32)
    System.Data.Common.DbDataReader.GetFieldValue<T>(System.Int32)
    System.Data.Common.DbDataReader.GetFieldValueAsync<T>(System.Int32)
    System.Data.Common.DbDataReader.GetFieldValueAsync<T>(System.Int32, System.Threading.CancellationToken)
    System.Data.Common.DbDataReader.GetStream(System.Int32)
    System.Data.Common.DbDataReader.GetTextReader(System.Int32)
    System.Data.Common.DbDataReader.IsDBNullAsync(System.Int32)
    System.Data.Common.DbDataReader.IsDBNullAsync(System.Int32, System.Threading.CancellationToken)
    System.Data.Common.DbDataReader.NextResultAsync()
    System.Data.Common.DbDataReader.NextResultAsync(System.Threading.CancellationToken)
    System.Data.Common.DbDataReader.ReadAsync()
    System.Data.Common.DbDataReader.ReadAsync(System.Threading.CancellationToken)
    System.Data.Common.DbDataReader.System.Data.IDataRecord.GetData(System.Int32)
    System.Data.Common.DbDataReader.VisibleFieldCount
    System.MarshalByRefObject.GetLifetimeService()
    System.MarshalByRefObject.InitializeLifetimeService()
    System.MarshalByRefObject.MemberwiseClone(System.Boolean)
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Cassandra.Data
    Assembly: Cassandra.dll
    Syntax
    public class CqlReader : DbDataReader, IEnumerable, IDataReader, IDataRecord, IDisposable

    Properties

    Depth

    Declaration
    public override int Depth { get; }
    Property Value
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbDataReader.Depth

    FieldCount

    Declaration
    public override int FieldCount { get; }
    Property Value
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbDataReader.FieldCount

    HasRows

    Declaration
    public override bool HasRows { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbDataReader.HasRows

    IsClosed

    Declaration
    public override bool IsClosed { get; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbDataReader.IsClosed

    Item[Int32]

    Declaration
    public override object this[int ordinal] { get; }
    Parameters
    Type Name Description
    System.Int32 ordinal
    Property Value
    Type Description
    System.Object
    Overrides
    System.Data.Common.DbDataReader.Item[System.Int32]

    Item[String]

    Declaration
    public override object this[string name] { get; }
    Parameters
    Type Name Description
    System.String name
    Property Value
    Type Description
    System.Object
    Overrides
    System.Data.Common.DbDataReader.Item[System.String]

    RecordsAffected

    Declaration
    public override int RecordsAffected { get; }
    Property Value
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbDataReader.RecordsAffected

    Methods

    Close()

    Declaration
    public override void Close()
    Overrides
    System.Data.Common.DbDataReader.Close()

    GetBoolean(Int32)

    Declaration
    public override bool GetBoolean(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbDataReader.GetBoolean(System.Int32)

    GetByte(Int32)

    Declaration
    public override byte GetByte(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Byte
    Overrides
    System.Data.Common.DbDataReader.GetByte(System.Int32)

    GetBytes(Int32, Int64, Byte[], Int32, Int32)

    Declaration
    public override long GetBytes(int ordinal, long dataOffset, byte[] buffer, int bufferOffset, int length)
    Parameters
    Type Name Description
    System.Int32 ordinal
    System.Int64 dataOffset
    System.Byte[] buffer
    System.Int32 bufferOffset
    System.Int32 length
    Returns
    Type Description
    System.Int64
    Overrides
    System.Data.Common.DbDataReader.GetBytes(System.Int32, System.Int64, System.Byte[], System.Int32, System.Int32)

    GetChar(Int32)

    Declaration
    public override char GetChar(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Char
    Overrides
    System.Data.Common.DbDataReader.GetChar(System.Int32)

    GetChars(Int32, Int64, Char[], Int32, Int32)

    Declaration
    public override long GetChars(int ordinal, long dataOffset, char[] buffer, int bufferOffset, int length)
    Parameters
    Type Name Description
    System.Int32 ordinal
    System.Int64 dataOffset
    System.Char[] buffer
    System.Int32 bufferOffset
    System.Int32 length
    Returns
    Type Description
    System.Int64
    Overrides
    System.Data.Common.DbDataReader.GetChars(System.Int32, System.Int64, System.Char[], System.Int32, System.Int32)

    GetDataTypeName(Int32)

    Declaration
    public override string GetDataTypeName(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.String
    Overrides
    System.Data.Common.DbDataReader.GetDataTypeName(System.Int32)

    GetDateTime(Int32)

    Declaration
    public override DateTime GetDateTime(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.DateTime
    Overrides
    System.Data.Common.DbDataReader.GetDateTime(System.Int32)

    GetDecimal(Int32)

    Declaration
    public override decimal GetDecimal(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Decimal
    Overrides
    System.Data.Common.DbDataReader.GetDecimal(System.Int32)

    GetDouble(Int32)

    Declaration
    public override double GetDouble(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Double
    Overrides
    System.Data.Common.DbDataReader.GetDouble(System.Int32)

    GetEnumerator()

    Declaration
    public override IEnumerator GetEnumerator()
    Returns
    Type Description
    System.Collections.IEnumerator
    Overrides
    System.Data.Common.DbDataReader.GetEnumerator()

    GetFieldType(Int32)

    Declaration
    public override Type GetFieldType(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Type
    Overrides
    System.Data.Common.DbDataReader.GetFieldType(System.Int32)

    GetFloat(Int32)

    Declaration
    public override float GetFloat(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Single
    Overrides
    System.Data.Common.DbDataReader.GetFloat(System.Int32)

    GetGuid(Int32)

    Declaration
    public override Guid GetGuid(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Guid
    Overrides
    System.Data.Common.DbDataReader.GetGuid(System.Int32)

    GetInt16(Int32)

    Declaration
    public override short GetInt16(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Int16
    Overrides
    System.Data.Common.DbDataReader.GetInt16(System.Int32)

    GetInt32(Int32)

    Declaration
    public override int GetInt32(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbDataReader.GetInt32(System.Int32)

    GetInt64(Int32)

    Declaration
    public override long GetInt64(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Int64
    Overrides
    System.Data.Common.DbDataReader.GetInt64(System.Int32)

    GetName(Int32)

    Declaration
    public override string GetName(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.String
    Overrides
    System.Data.Common.DbDataReader.GetName(System.Int32)

    GetOrdinal(String)

    Declaration
    public override int GetOrdinal(string name)
    Parameters
    Type Name Description
    System.String name
    Returns
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbDataReader.GetOrdinal(System.String)

    GetSchemaTable()

    Declaration
    public override DataTable GetSchemaTable()
    Returns
    Type Description
    System.Data.DataTable
    Overrides
    System.Data.Common.DbDataReader.GetSchemaTable()

    GetString(Int32)

    Declaration
    public override string GetString(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.String
    Overrides
    System.Data.Common.DbDataReader.GetString(System.Int32)

    GetValue(Int32)

    Declaration
    public override object GetValue(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Object
    Overrides
    System.Data.Common.DbDataReader.GetValue(System.Int32)

    GetValues(Object[])

    Declaration
    public override int GetValues(object[] values)
    Parameters
    Type Name Description
    System.Object[] values
    Returns
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbDataReader.GetValues(System.Object[])

    IsDBNull(Int32)

    Declaration
    public override bool IsDBNull(int ordinal)
    Parameters
    Type Name Description
    System.Int32 ordinal
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbDataReader.IsDBNull(System.Int32)

    NextResult()

    Declaration
    public override bool NextResult()
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbDataReader.NextResult()

    Read()

    Declaration
    public override bool Read()
    Returns
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbDataReader.Read()

    Implements

    System.Collections.IEnumerable
    System.Data.IDataReader
    System.Data.IDataRecord
    System.IDisposable
    Back to top © DataStax, All rights reserved.