Annotation Interface PrimaryKeyColumn


@Documented @Retention(RUNTIME) @Target({ANNOTATION_TYPE,FIELD,METHOD}) 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:
  • Element Details

    • value

      @AliasFor(attribute="name") String value
      The name of the column in the table.
      Default:
      ""
    • name

      @AliasFor(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

      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 boolean forceQuote
      Deprecated.
      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