org.springframework.data.cassandra.mapping

Annotation Type PrimaryKeyColumn

@Retention(value=RUNTIME)
 @Target(value={FIELD,METHOD,ANNOTATION_TYPE})
public @interface PrimaryKeyColumn

Identifies the annotated field of a composite primary key class as a primary key field that is either a partition or cluster key field.

Author:

Matthew T. Adams

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	ordinal The order of this column relative to other primary key columns.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	forceQuote Whether to cause the column name to be force-quoted.
String	name The name of the column in the table.
Ordering	ordering The cluster ordering of this column if type() is PrimaryKeyType.CLUSTERED, otherwise ignored.
PrimaryKeyType	type The type of this key column.

Element Detail

ordinal

public abstract int ordinal

The order of this column relative to other primary key columns.

name

public abstract String name

The name of the column in the table.

Default:

""

type

public abstract PrimaryKeyType type

The type of this key column. Default is PrimaryKeyType.CLUSTERED.

Default:

org.springframework.cassandra.core.PrimaryKeyType.CLUSTERED

ordering

public abstract Ordering ordering

The cluster ordering of this column if type() is PrimaryKeyType.CLUSTERED, otherwise ignored. Default is Ordering.ASCENDING.

Default:

org.springframework.cassandra.core.Ordering.ASCENDING

forceQuote

public abstract boolean forceQuote

Whether to cause the column name to be force-quoted.

Default:

false