• 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 CqlParameter

    Represents a Cql parameter.

    Inheritance
    System.Object
    System.MarshalByRefObject
    System.Data.Common.DbParameter
    CqlParameter
    Implements
    System.Data.IDbDataParameter
    System.Data.IDataParameter
    Inherited Members
    System.Data.Common.DbParameter.Precision
    System.Data.Common.DbParameter.Scale
    System.Data.Common.DbParameter.System.Data.IDbDataParameter.Precision
    System.Data.Common.DbParameter.System.Data.IDbDataParameter.Scale
    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: Dse.Data
    Assembly: Dse.dll
    Syntax
    public class CqlParameter : DbParameter, IDbDataParameter, IDataParameter

    Constructors

    CqlParameter()

    Initializes a new instance of the CqlParameter class.

    Declaration
    public CqlParameter()

    CqlParameter(String)

    Initializes a new instance of the CqlParameter class.

    Declaration
    public CqlParameter(string name)
    Parameters
    Type Name Description
    System.String name

    The name.

    CqlParameter(String, Object)

    Initializes a new instance of the CqlParameter class. The type of the parameter will be guessed from the value.

    Declaration
    public CqlParameter(string name, object value)
    Parameters
    Type Name Description
    System.String name

    The name.

    System.Object value

    The value.

    Properties

    DbType

    Gets or sets the System.Data.DbType of the parameter.

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

    Direction

    Gets or sets a value indicating whether the parameter is input-only, output-only, bidirectional, or a stored procedure return value parameter.

    Declaration
    public override ParameterDirection Direction { get; set; }
    Property Value
    Type Description
    System.Data.ParameterDirection

    One of the System.Data.ParameterDirection values. The default is Input.

    Overrides
    System.Data.Common.DbParameter.Direction
    Exceptions
    Type Condition
    System.NotSupportedException

    Cql only supports input parameters

    IsNullable

    Gets a value indicating whether the parameter accepts null values.

    Declaration
    public override bool IsNullable { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if null values are accepted; otherwise, false. The default is false.

    Overrides
    System.Data.Common.DbParameter.IsNullable

    ParameterName

    Gets or sets the name of the System.Data.IDataParameter.

    Declaration
    public override string ParameterName { get; set; }
    Property Value
    Type Description
    System.String

    The name of the System.Data.IDataParameter. The default is an empty string.

    Overrides
    System.Data.Common.DbParameter.ParameterName

    Size

    The size of the parameter.

    Declaration
    public override int Size { get; set; }
    Property Value
    Type Description
    System.Int32

    Always returns 0.

    Overrides
    System.Data.Common.DbParameter.Size

    SourceColumn

    Gets or sets the name of the source column that is mapped to the System.Data.DataSet and used for loading or returning the System.Data.IDataParameter.Value.

    Declaration
    public override string SourceColumn { get; set; }
    Property Value
    Type Description
    System.String

    The name of the source column that is mapped to the System.Data.DataSet. The default is an empty string.

    Overrides
    System.Data.Common.DbParameter.SourceColumn

    SourceColumnNullMapping

    Sets or gets a value which indicates whether the source column is nullable. This allows System.Data.Common.DbCommandBuilder to correctly generate Update statements for nullable columns.

    Declaration
    public override bool SourceColumnNullMapping { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the source column is nullable; false if it is not.

    Overrides
    System.Data.Common.DbParameter.SourceColumnNullMapping

    SourceVersion

    Gets or sets the System.Data.DataRowVersion to use when loading System.Data.IDataParameter.Value.

    Declaration
    public override DataRowVersion SourceVersion { get; set; }
    Property Value
    Type Description
    System.Data.DataRowVersion

    One of the System.Data.DataRowVersion values. The default is Current.

    Overrides
    System.Data.Common.DbParameter.SourceVersion

    Value

    Gets or sets the value of the parameter. If no type information was provided earlier, the type of the parameter will be guessed from the value's type.

    Declaration
    public override object Value { get; set; }
    Property Value
    Type Description
    System.Object

    An System.Object that is the value of the parameter. The default value is null.

    Overrides
    System.Data.Common.DbParameter.Value

    Methods

    ResetDbType()

    Resets the DbType property to its original settings.

    Declaration
    public override void ResetDbType()
    Overrides
    System.Data.Common.DbParameter.ResetDbType()

    Implements

    System.Data.IDbDataParameter
    System.Data.IDataParameter
    Back to top © DataStax, All rights reserved.