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

    A class for defining how a property or field on a POCO is mapped to a column via a fluent-style interface.

    Inheritance
    System.Object
    ColumnMap
    Implements
    IColumnDefinition
    Inherited Members
    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.Mapping
    Assembly: Dse.dll
    Syntax
    public class ColumnMap : IColumnDefinition

    Constructors

    ColumnMap(MemberInfo, Type, Boolean)

    Creates a new ColumnMap for the property/field specified by the MemberInfo.

    Declaration
    public ColumnMap(MemberInfo memberInfo, Type memberInfoType, bool isExplicitlyDefined)
    Parameters
    Type Name Description
    System.Reflection.MemberInfo memberInfo
    System.Type memberInfoType
    System.Boolean isExplicitlyDefined

    Methods

    AsCounter()

    Tells the mapper that this is a counter column

    Declaration
    public ColumnMap AsCounter()
    Returns
    Type Description
    ColumnMap

    AsFrozen()

    Tells the mapper that the column type is frozen. Only valid for collections, tuples, and user-defined types. For example: frozen<address>

    Declaration
    public ColumnMap AsFrozen()
    Returns
    Type Description
    ColumnMap

    AsStatic()

    Tells the mapper that this is a static column

    Declaration
    public ColumnMap AsStatic()
    Returns
    Type Description
    ColumnMap

    Ignore()

    Tells the mapper to ignore this property/field when mapping.

    Declaration
    public ColumnMap Ignore()
    Returns
    Type Description
    ColumnMap

    WithDbType(Type)

    Tells the mapper to convert the data in the property or field to the Type specified when doing an INSERT or UPDATE (i.e. the column type in Cassandra). (NOTE: This does NOT affect the Type when fetching/SELECTing data from the database.)

    Declaration
    public ColumnMap WithDbType(Type type)
    Parameters
    Type Name Description
    System.Type type
    Returns
    Type Description
    ColumnMap

    WithDbType<T>()

    Tells the mapper to convert the data in the property or field to Type T when doing an INSERT or UPDATE (i.e. the column type in Cassandra). (NOTE: This does NOT affect the Type when fetching/SELECTing data from the database.)

    Declaration
    public ColumnMap WithDbType<T>()
    Returns
    Type Description
    ColumnMap
    Type Parameters
    Name Description
    T

    WithFrozenKey()

    Tells the mapper that the key of the column type is frozen. Only valid for maps and sets, for example: map<frozen<tuple<text, text>>, uuid> .

    Declaration
    public ColumnMap WithFrozenKey()
    Returns
    Type Description
    ColumnMap

    WithFrozenValue()

    Tells the mapper that the value of the column type is frozen. Only valid for maps and lists, for example: map<uuid, frozen<tuple<text, text>>> .

    Declaration
    public ColumnMap WithFrozenValue()
    Returns
    Type Description
    ColumnMap

    WithName(String)

    Tells the mapper to use the column name specified when mapping the property/field.

    Declaration
    public ColumnMap WithName(string columnName)
    Parameters
    Type Name Description
    System.String columnName
    Returns
    Type Description
    ColumnMap

    WithSecondaryIndex()

    Tells the mapper that this column is defined also as a secondary index

    Declaration
    public ColumnMap WithSecondaryIndex()
    Returns
    Type Description
    ColumnMap

    Explicit Interface Implementations

    IColumnDefinition.ColumnName

    Declaration
    string IColumnDefinition.ColumnName { get; }
    Returns
    Type Description
    System.String

    IColumnDefinition.ColumnType

    Declaration
    Type IColumnDefinition.ColumnType { get; }
    Returns
    Type Description
    System.Type

    IColumnDefinition.HasFrozenKey

    Declaration
    bool IColumnDefinition.HasFrozenKey { get; }
    Returns
    Type Description
    System.Boolean

    IColumnDefinition.HasFrozenValue

    Declaration
    bool IColumnDefinition.HasFrozenValue { get; }
    Returns
    Type Description
    System.Boolean

    IColumnDefinition.Ignore

    Declaration
    bool IColumnDefinition.Ignore { get; }
    Returns
    Type Description
    System.Boolean

    IColumnDefinition.IsCounter

    Declaration
    bool IColumnDefinition.IsCounter { get; }
    Returns
    Type Description
    System.Boolean

    IColumnDefinition.IsExplicitlyDefined

    Declaration
    bool IColumnDefinition.IsExplicitlyDefined { get; }
    Returns
    Type Description
    System.Boolean

    IColumnDefinition.IsFrozen

    Declaration
    bool IColumnDefinition.IsFrozen { get; }
    Returns
    Type Description
    System.Boolean

    IColumnDefinition.IsStatic

    Declaration
    bool IColumnDefinition.IsStatic { get; }
    Returns
    Type Description
    System.Boolean

    IColumnDefinition.MemberInfo

    Declaration
    MemberInfo IColumnDefinition.MemberInfo { get; }
    Returns
    Type Description
    System.Reflection.MemberInfo

    IColumnDefinition.MemberInfoType

    Declaration
    Type IColumnDefinition.MemberInfoType { get; }
    Returns
    Type Description
    System.Type

    IColumnDefinition.SecondaryIndex

    Declaration
    bool IColumnDefinition.SecondaryIndex { get; }
    Returns
    Type Description
    System.Boolean

    Implements

    IColumnDefinition
    Back to top © DataStax, All rights reserved.