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
object
ColumnMap
Implements
Inherited Members
Namespace: Cassandra.Mapping
Assembly: Cassandra.dll
Syntax
public class ColumnMap : IColumnDefinition

Constructors

ColumnMap(MemberInfo, Type, bool)

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
MemberInfo memberInfo
Type memberInfoType
bool 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
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
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

Implements