Module spring.data.cassandra

Package org.springframework.data.cassandra.core.mapping

Annotation Interface PrimaryKeyColumn

@Documented
@Retention(RUNTIME)
@Target({ANNOTATION_TYPE,FIELD,METHOD})
@Column
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. Annotated properties must be either reside in a PrimaryKeyClass to be part of the composite key or annotated with Id to identify a single property as primary key column.

Author:

Matthew T. Adams, Mark Paluch

See Also:

• Id
• PrimaryKey
• PrimaryKeyClass

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	forceQuote	Deprecated, for removal: This API element is subject to removal in a future version. since 3.0.
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.
int	ordinal	The order of this column relative to other primary key columns.
PrimaryKeyType	type	The type of this key column.
String	value	The name of the column in the table.

Element Details

value

@AliasFor(annotation=Column.class,
          attribute="value")
String value

The name of the column in the table.

Default:

""

name

@AliasFor(annotation=Column.class,
          attribute="value")
String name

The name of the column in the table.

Default:

""

ordinal

int ordinal

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

Default:

-2147483648

type

PrimaryKeyType type

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

Default:

CLUSTERED

ordering

Ordering ordering

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

Default:

ASCENDING

forceQuote

@Deprecated(forRemoval=true)
@AliasFor(annotation=Column.class,
          attribute="forceQuote")
boolean forceQuote

Deprecated, for removal: This API element is subject to removal in a future version.

since 3.0. The column name gets converted into CqlIdentifier hence it no longer requires an indication whether the name should be quoted.

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

See Also:

• CqlIdentifier.fromInternal(String)

Default:

false