• DataStax C# Driver for Apache Cassandra API Documentation
Search Results for

    Show / Hide Table of Contents
    • Cassandra
      • AesColumnEncryptionPolicy
      • AesColumnEncryptionPolicy.AesKeyAndIV
      • AggregateMetadata
      • AlreadyExistsException
      • AtomicMonotonicTimestampGenerator
      • AtomicMonotonicWinApiTimestampGenerator
      • AuthenticationException
      • BaseColumnEncryptionPolicy<TKey>
      • BaseColumnEncryptionPolicy<TKey>.ColMetadataKey
      • BatchStatement
      • BatchType
      • BigIntegerTypeAdapter
      • BoundStatement
      • Builder
      • BusyPoolException
      • CassandraConnectionStringBuilder
      • ClientOptions
      • Cluster
      • ColumnDesc
      • ColumnEncryptionInvalidTypeError
      • ColumnEncryptionMetadata
      • ColumnTypeCode
      • CompressionType
      • Configuration
      • ConsistencyLevel
      • ConstantReconnectionPolicy
      • ConstantSpeculativeExecutionPolicy
      • CqlColumn
      • CustomColumnInfo
      • DataCollectionMetadata
      • DataCollectionMetadata.SortOrder
      • DCAwareRoundRobinPolicy
      • DecimalTypeAdapter
      • DefaultLoadBalancingPolicy
      • DefaultRetryPolicy
      • Diagnostics
      • DowngradingConsistencyRetryPolicy
      • DriverException
      • DriverInternalError
      • Duration
      • DynamicCompositeTypeAdapter
      • EC2MultiRegionTranslator
      • EncryptedValue
      • ExecutionException
      • ExecutionInfo
      • ExponentialReconnectionPolicy
      • Extensions
      • FallthroughRetryPolicy
      • FixedReconnectionPolicy
      • FunctionFailureException
      • FunctionMetadata
      • GraphProtocol
      • Host
      • HostDistance
      • HostsEventArgs
      • HostsEventArgs.Kind
      • HostsEventHandler
      • IAddressTranslator
      • IAuthenticator
      • IAuthProvider
      • IAuthProviderNamed
      • ICluster
      • IColumnEncryptionPolicy
      • 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
      • Direction
      • Edge
      • Element
      • ElementMap
      • EnumWrapper
      • FluentGraphStatement
      • GraphNode
      • GraphOptions
      • GraphResultSet
      • GraphStatement
      • IEdge
      • IElement
      • IGraphNode
      • IGraphStatement
      • IPath
      • IProperty
      • IPropertyWithElement
      • IVertex
      • IVertexProperty
      • Path
      • SimpleGraphStatement
      • TEnum
      • Traverser
      • Vertex
    • Cassandra.DataStax.Graph.Internal
      • IGraphSONDeserializer
      • IGraphSONReader
      • IGraphSONSerializer
      • IGraphSONWriter
    • 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 CqlParameterCollection

    Represents a collection of CqlParameters.

    Inheritance
    object
    MarshalByRefObject
    DbParameterCollection
    CqlParameterCollection
    Implements
    IDataParameterCollection
    IList
    ICollection
    IEnumerable
    Inherited Members
    DbParameterCollection.this[int]
    DbParameterCollection.this[string]
    MarshalByRefObject.GetLifetimeService()
    MarshalByRefObject.InitializeLifetimeService()
    MarshalByRefObject.MemberwiseClone(bool)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Cassandra.Data
    Assembly: Cassandra.dll
    Syntax
    public class CqlParameterCollection : DbParameterCollection, IDataParameterCollection, IList, ICollection, IEnumerable

    Properties

    Count

    Specifies the number of items in the collection.

    Declaration
    public override int Count { get; }
    Property Value
    Type Description
    int

    The number of items in the collection.

    Overrides
    System.Data.Common.DbParameterCollection.Count

    IsFixedSize

    Specifies whether the collection is a fixed size.

    Declaration
    public override bool IsFixedSize { get; }
    Property Value
    Type Description
    bool

    true if the collection is a fixed size; otherwise false.

    Overrides
    System.Data.Common.DbParameterCollection.IsFixedSize

    IsReadOnly

    Specifies whether the collection is read-only.

    Declaration
    public override bool IsReadOnly { get; }
    Property Value
    Type Description
    bool

    true if the collection is read-only; otherwise false.

    Overrides
    System.Data.Common.DbParameterCollection.IsReadOnly

    IsSynchronized

    Specifies whether the collection is synchronized.

    Declaration
    public override bool IsSynchronized { get; }
    Property Value
    Type Description
    bool

    true if the collection is synchronized; otherwise false.

    Overrides
    System.Data.Common.DbParameterCollection.IsSynchronized

    SyncRoot

    Specifies the object to be used to synchronize access to the collection.

    Declaration
    public override object SyncRoot { get; }
    Property Value
    Type Description
    object

    A object to be used to synchronize access to the System.Data.Common.DbParameterCollection.

    Overrides
    System.Data.Common.DbParameterCollection.SyncRoot

    Methods

    Add(CqlParameter)

    Adds the specified parameter.

    Declaration
    public int Add(CqlParameter parameter)
    Parameters
    Type Name Description
    CqlParameter parameter

    The parameter.

    Returns
    Type Description
    int

    Add(object)

    Adds the specified System.Data.Common.DbParameter object to the System.Data.Common.DbParameterCollection.

    Declaration
    public override int Add(object value)
    Parameters
    Type Name Description
    object value

    The System.Data.Common.DbParameter.Value of the System.Data.Common.DbParameter to add to the collection.

    Returns
    Type Description
    int

    The index of the System.Data.Common.DbParameter object in the collection.

    Overrides
    System.Data.Common.DbParameterCollection.Add(object)

    Add(string, object)

    Adds a new parameter with the specified name and value. The name will be parsed to extract table and keyspace information (if any). The parameter type will be guessed from the object value.

    Declaration
    public CqlParameter Add(string name, object value)
    Parameters
    Type Name Description
    string name

    The name.

    object value

    The value.

    Returns
    Type Description
    CqlParameter

    The created CqlParameter.

    AddRange(Array)

    Adds an array of items with the specified values to the System.Data.Common.DbParameterCollection.

    Declaration
    public override void AddRange(Array values)
    Parameters
    Type Name Description
    Array values

    An array of values of type System.Data.Common.DbParameter to add to the collection.

    Overrides
    System.Data.Common.DbParameterCollection.AddRange(System.Array)

    Clear()

    Removes all System.Data.Common.DbParameter values from the System.Data.Common.DbParameterCollection.

    Declaration
    public override void Clear()
    Overrides
    System.Data.Common.DbParameterCollection.Clear()

    Contains(object)

    Indicates whether a System.Data.Common.DbParameter with the specified System.Data.Common.DbParameter.Value is contained in the collection.

    Declaration
    public override bool Contains(object value)
    Parameters
    Type Name Description
    object value

    The System.Data.Common.DbParameter.Value of the System.Data.Common.DbParameter to look for in the collection.

    Returns
    Type Description
    bool

    true if the System.Data.Common.DbParameter is in the collection; otherwise false.

    Overrides
    System.Data.Common.DbParameterCollection.Contains(object)

    Contains(string)

    Indicates whether a System.Data.Common.DbParameter with the specified name exists in the collection.

    Declaration
    public override bool Contains(string value)
    Parameters
    Type Name Description
    string value

    The name of the System.Data.Common.DbParameter to look for in the collection.

    Returns
    Type Description
    bool

    true if the System.Data.Common.DbParameter is in the collection; otherwise false.

    Overrides
    System.Data.Common.DbParameterCollection.Contains(string)

    CopyTo(Array, int)

    Copies an array of items to the collection starting at the specified index.

    Declaration
    public override void CopyTo(Array array, int index)
    Parameters
    Type Name Description
    Array array

    The array of items to copy to the collection.

    int index

    The index in the collection to copy the items.

    Overrides
    System.Data.Common.DbParameterCollection.CopyTo(System.Array, int)

    GetEnumerator()

    Exposes the System.Collections.IEnumerable.GetEnumerator method, which supports a simple iteration over a collection by a .NET Framework data provider.

    Declaration
    public override IEnumerator GetEnumerator()
    Returns
    Type Description
    IEnumerator

    An System.Collections.IEnumerator that can be used to iterate through the collection.

    Overrides
    System.Data.Common.DbParameterCollection.GetEnumerator()

    GetParameter(int)

    Returns the System.Data.Common.DbParameter object at the specified index in the collection.

    Declaration
    protected override DbParameter GetParameter(int index)
    Parameters
    Type Name Description
    int index

    The index of the System.Data.Common.DbParameterin the collection.

    Returns
    Type Description
    DbParameter

    The System.Data.Common.DbParameter object at the specified index in the collection.

    Overrides
    System.Data.Common.DbParameterCollection.GetParameter(int)

    GetParameter(string)

    Returns System.Data.Common.DbParameter the object with the specified name.

    Declaration
    protected override DbParameter GetParameter(string parameterName)
    Parameters
    Type Name Description
    string parameterName

    The name of the System.Data.Common.DbParameter in the collection.

    Returns
    Type Description
    DbParameter

    The System.Data.Common.DbParameter the object with the specified name.

    Overrides
    System.Data.Common.DbParameterCollection.GetParameter(string)

    IndexOf(object)

    Returns the index of the specified System.Data.Common.DbParameter object.

    Declaration
    public override int IndexOf(object value)
    Parameters
    Type Name Description
    object value

    The System.Data.Common.DbParameter object in the collection.

    Returns
    Type Description
    int

    The index of the specified System.Data.Common.DbParameter object.

    Overrides
    System.Data.Common.DbParameterCollection.IndexOf(object)

    IndexOf(string)

    Returns the index of the System.Data.Common.DbParameter object with the specified name.

    Declaration
    public override int IndexOf(string parameterName)
    Parameters
    Type Name Description
    string parameterName
    Returns
    Type Description
    int The name of the System.Data.Common.DbParameter object in the collection. The index of the System.Data.Common.DbParameter object with the specified name.
    Overrides
    System.Data.Common.DbParameterCollection.IndexOf(string)

    Insert(int, object)

    Inserts the specified index of the System.Data.Common.DbParameter object with the specified name into the collection at the specified index.

    Declaration
    public override void Insert(int index, object value)
    Parameters
    Type Name Description
    int index

    The index at which to insert the System.Data.Common.DbParameter object.

    object value

    The System.Data.Common.DbParameter object to insert into the collection.

    Overrides
    System.Data.Common.DbParameterCollection.Insert(int, object)

    Remove(object)

    Removes the specified System.Data.Common.DbParameter object from the collection.

    Declaration
    public override void Remove(object value)
    Parameters
    Type Name Description
    object value

    The System.Data.Common.DbParameter object to remove.

    Overrides
    System.Data.Common.DbParameterCollection.Remove(object)

    RemoveAt(int)

    Removes the System.Data.Common.DbParameter object at the specified from the collection.

    Declaration
    public override void RemoveAt(int index)
    Parameters
    Type Name Description
    int index

    The index where the System.Data.Common.DbParameter object is located.

    Overrides
    System.Data.Common.DbParameterCollection.RemoveAt(int)

    RemoveAt(string)

    Removes the System.Data.Common.DbParameter object with the specified name from the collection.

    Declaration
    public override void RemoveAt(string parameterName)
    Parameters
    Type Name Description
    string parameterName

    The name of the System.Data.Common.DbParameter object to remove.

    Overrides
    System.Data.Common.DbParameterCollection.RemoveAt(string)

    SetParameter(int, DbParameter)

    Sets the System.Data.Common.DbParameter object at the specified index to a new value.

    Declaration
    protected override void SetParameter(int index, DbParameter value)
    Parameters
    Type Name Description
    int index

    The index where the System.Data.Common.DbParameter objectis located.

    DbParameter value

    The new System.Data.Common.DbParameter value.

    Overrides
    System.Data.Common.DbParameterCollection.SetParameter(int, System.Data.Common.DbParameter)

    SetParameter(string, DbParameter)

    Sets the System.Data.Common.DbParameter object with the specified name to a new value.

    Declaration
    protected override void SetParameter(string parameterName, DbParameter value)
    Parameters
    Type Name Description
    string parameterName

    The name of the System.Data.Common.DbParameter object in the collection.

    DbParameter value

    The new System.Data.Common.DbParameter value.

    Overrides
    System.Data.Common.DbParameterCollection.SetParameter(string, System.Data.Common.DbParameter)

    Implements

    System.Data.IDataParameterCollection
    System.Collections.IList
    System.Collections.ICollection
    System.Collections.IEnumerable
    Back to top © DataStax, All rights reserved.