• DataStax Enterprise C# Driver API Documentation

    Show / Hide Table of Contents
    • Dse
      • 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
      • DefaultRetryPolicy
      • Diagnostics
      • DowngradingConsistencyRetryPolicy
      • DriverException
      • DriverInternalError
      • DseCluster
      • DseClusterBuilder
      • DseConfiguration
      • DseLoadBalancingPolicy
      • Duration
      • DynamicCompositeTypeAdapter
      • EC2MultiRegionTranslator
      • ExecutionException
      • ExecutionInfo
      • ExponentialReconnectionPolicy
      • Extensions
      • FallthroughRetryPolicy
      • FixedReconnectionPolicy
      • FunctionFailureException
      • FunctionMetadata
      • Host
      • HostDistance
      • HostsEventArgs
      • HostsEventArgs.Kind
      • HostsEventHandler
      • IAddressTranslator
      • IAuthenticator
      • IAuthProvider
      • IAuthProviderNamed
      • ICluster
      • IColumnInfo
      • IdempotenceAwareRetryPolicy
      • IDseCluster
      • IDseSession
      • IExecutionProfile
      • IExecutionProfileBuilder
      • IExecutionProfileOptions
      • IExtendedRetryPolicy
      • IFrameCompressor
      • IInitializer
      • ILoadBalancingPolicy
      • IndexMetadata
      • IndexMetadata.IndexKind
      • 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
    • Dse.AppMetrics
      • DriverAppMetricsOptions
    • Dse.AppMetrics.MetricTypes
      • IAppMetricsCounter
      • IAppMetricsGauge
      • IAppMetricsMeter
      • IAppMetricsMetric
      • IAppMetricsTimer
    • Dse.AppMetrics.MetricValues
      • IAppMetricsHistogramValue
      • IAppMetricsMeterValue
      • IAppMetricsMetricWithValue<T>
      • IAppMetricsTimerValue
    • Dse.Auth
      • DseGssapiAuthProvider
      • DsePlainTextAuthProvider
    • Dse.Auth.Sspi
      • SspiException
    • Dse.Data
      • CqlBatchTransaction
      • CqlCommand
      • CqlConnection
      • CqlDataAdapter
      • CqlParameter
      • CqlParameterCollection
      • CqlProviderFactory
      • CqlReader
    • Dse.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
    • Dse.Geometry
      • GeometryBase
      • LineString
      • Point
      • Polygon
    • Dse.Graph
      • Edge
      • Element
      • GraphNode
      • GraphOptions
      • GraphResultSet
      • GraphStatement
      • IEdge
      • IElement
      • IGraphNode
      • IGraphStatement
      • IPath
      • IProperty
      • IVertex
      • IVertexProperty
      • Path
      • SimpleGraphStatement
      • Vertex
    • Dse.Mapping
      • AppliedInfo<T>
      • ColumnMap
      • Cql
      • CqlQueryOptions
      • IColumnDefinition
      • ICqlBatch
      • ICqlQueryAsyncClient
      • ICqlQueryClient
      • ICqlWriteAsyncClient
      • ICqlWriteClient
      • IMapper
      • IPage<T>
      • ITypeDefinition
      • Map<TPoco>
      • Mapper
      • MappingConfiguration
      • Mappings
      • SortOrder
    • Dse.Mapping.Attributes
      • ClusteringKeyAttribute
      • ColumnAttribute
      • CounterAttribute
      • FrozenAttribute
      • FrozenKeyAttribute
      • FrozenValueAttribute
      • IgnoreAttribute
      • PartitionKeyAttribute
      • SecondaryIndexAttribute
      • StaticColumnAttribute
      • TableAttribute
    • Dse.Mapping.TypeConversion
      • DefaultTypeConverter
      • EnumStringMapper<T>
      • NullableEnumStringMapper<T>
      • TypeConverter
    • Dse.Mapping.Utils
      • MemberInfoExtensions
    • Dse.Metrics
      • DriverMetricsOptions
      • IDriverMetrics
      • IMetric
      • IMetricsRegistry<TMetric>
      • NodeMetric
      • NodeMetric.Counters
      • NodeMetric.Gauges
      • NodeMetric.Meters
      • NodeMetric.Timers
      • SessionMetric
      • SessionMetric.Counters
      • SessionMetric.Gauges
      • SessionMetric.Meters
      • SessionMetric.Timers
    • Dse.Metrics.Abstractions
      • IDriverCounter
      • IDriverGauge
      • IDriverMeter
      • IDriverMetric
      • IDriverMetricsProvider
      • IDriverTimer
    • Dse.Search
      • DateRange
      • DateRangeBound
      • DateRangePrecision
    • Dse.Serialization
      • CustomTypeSerializer<T>
      • TypeSerializer
      • TypeSerializer<T>
      • TypeSerializerDefinitions
      • UdtSerializer

    Class CqlCommand

    Represents an CQL statement to execute against Cassandra

    Inheritance
    System.Object
    System.MarshalByRefObject
    System.ComponentModel.Component
    System.Data.Common.DbCommand
    CqlCommand
    Implements
    System.ComponentModel.IComponent
    System.Data.IDbCommand
    System.IDisposable
    Inherited Members
    System.Data.Common.DbCommand.CreateParameter()
    System.Data.Common.DbCommand.ExecuteDbDataReaderAsync(System.Data.CommandBehavior, System.Threading.CancellationToken)
    System.Data.Common.DbCommand.ExecuteNonQueryAsync()
    System.Data.Common.DbCommand.ExecuteNonQueryAsync(System.Threading.CancellationToken)
    System.Data.Common.DbCommand.ExecuteReader()
    System.Data.Common.DbCommand.ExecuteReader(System.Data.CommandBehavior)
    System.Data.Common.DbCommand.ExecuteReaderAsync()
    System.Data.Common.DbCommand.ExecuteReaderAsync(System.Data.CommandBehavior)
    System.Data.Common.DbCommand.ExecuteReaderAsync(System.Data.CommandBehavior, System.Threading.CancellationToken)
    System.Data.Common.DbCommand.ExecuteReaderAsync(System.Threading.CancellationToken)
    System.Data.Common.DbCommand.ExecuteScalarAsync()
    System.Data.Common.DbCommand.ExecuteScalarAsync(System.Threading.CancellationToken)
    System.Data.Common.DbCommand.System.Data.IDbCommand.CreateParameter()
    System.Data.Common.DbCommand.System.Data.IDbCommand.ExecuteReader()
    System.Data.Common.DbCommand.System.Data.IDbCommand.ExecuteReader(System.Data.CommandBehavior)
    System.Data.Common.DbCommand.Connection
    System.Data.Common.DbCommand.System.Data.IDbCommand.Connection
    System.Data.Common.DbCommand.System.Data.IDbCommand.Parameters
    System.Data.Common.DbCommand.System.Data.IDbCommand.Transaction
    System.Data.Common.DbCommand.Transaction
    System.ComponentModel.Component.Dispose()
    System.ComponentModel.Component.Dispose(System.Boolean)
    System.ComponentModel.Component.GetService(System.Type)
    System.ComponentModel.Component.ToString()
    System.ComponentModel.Component.CanRaiseEvents
    System.ComponentModel.Component.Container
    System.ComponentModel.Component.DesignMode
    System.ComponentModel.Component.Events
    System.ComponentModel.Component.Site
    System.ComponentModel.Component.Disposed
    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)
    Namespace: Dse.Data
    Assembly: Dse.dll
    Syntax
    public sealed class CqlCommand : DbCommand, IComponent, IDbCommand, IDisposable

    Properties

    CommandText

    Declaration
    public override string CommandText { get; set; }
    Property Value
    Type Description
    System.String
    Overrides
    System.Data.Common.DbCommand.CommandText

    CommandTimeout

    Declaration
    public override int CommandTimeout { get; set; }
    Property Value
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbCommand.CommandTimeout

    CommandType

    Declaration
    public override CommandType CommandType { get; set; }
    Property Value
    Type Description
    System.Data.CommandType
    Overrides
    System.Data.Common.DbCommand.CommandType

    ConsistencyLevel

    Gets or sets the ConsistencyLevel when executing the current CqlCommand.

    Declaration
    public ConsistencyLevel ConsistencyLevel { get; set; }
    Property Value
    Type Description
    ConsistencyLevel

    DbConnection

    Declaration
    protected override DbConnection DbConnection { get; set; }
    Property Value
    Type Description
    System.Data.Common.DbConnection
    Overrides
    System.Data.Common.DbCommand.DbConnection

    DbParameterCollection

    Declaration
    protected override DbParameterCollection DbParameterCollection { get; }
    Property Value
    Type Description
    System.Data.Common.DbParameterCollection
    Overrides
    System.Data.Common.DbCommand.DbParameterCollection

    DbTransaction

    Declaration
    protected override DbTransaction DbTransaction { get; set; }
    Property Value
    Type Description
    System.Data.Common.DbTransaction
    Overrides
    System.Data.Common.DbCommand.DbTransaction

    DesignTimeVisible

    Declaration
    public override bool DesignTimeVisible { get; set; }
    Property Value
    Type Description
    System.Boolean
    Overrides
    System.Data.Common.DbCommand.DesignTimeVisible

    IsPrepared

    Gets whether this command has been prepared.

    Declaration
    public bool IsPrepared { get; }
    Property Value
    Type Description
    System.Boolean

    Parameters

    Gets the CqlParameters.

    Declaration
    public CqlParameterCollection Parameters { get; }
    Property Value
    Type Description
    CqlParameterCollection

    UpdatedRowSource

    Declaration
    public override UpdateRowSource UpdatedRowSource { get; set; }
    Property Value
    Type Description
    System.Data.UpdateRowSource
    Overrides
    System.Data.Common.DbCommand.UpdatedRowSource

    Methods

    Cancel()

    Declaration
    public override void Cancel()
    Overrides
    System.Data.Common.DbCommand.Cancel()

    CreateDbParameter()

    Declaration
    protected override DbParameter CreateDbParameter()
    Returns
    Type Description
    System.Data.Common.DbParameter
    Overrides
    System.Data.Common.DbCommand.CreateDbParameter()

    ExecuteDbDataReader(CommandBehavior)

    Declaration
    protected override DbDataReader ExecuteDbDataReader(CommandBehavior behavior)
    Parameters
    Type Name Description
    System.Data.CommandBehavior behavior
    Returns
    Type Description
    System.Data.Common.DbDataReader
    Overrides
    System.Data.Common.DbCommand.ExecuteDbDataReader(System.Data.CommandBehavior)

    ExecuteNonQuery()

    Declaration
    public override int ExecuteNonQuery()
    Returns
    Type Description
    System.Int32
    Overrides
    System.Data.Common.DbCommand.ExecuteNonQuery()

    ExecuteScalar()

    Declaration
    public override object ExecuteScalar()
    Returns
    Type Description
    System.Object
    Overrides
    System.Data.Common.DbCommand.ExecuteScalar()

    Prepare()

    Declaration
    public override void Prepare()
    Overrides
    System.Data.Common.DbCommand.Prepare()

    Implements

    System.ComponentModel.IComponent
    System.Data.IDbCommand
    System.IDisposable
    Back to top © DataStax, All rights reserved.