net.akaish.kitty.orm.annotations.column.constraints

Annotation Type PRIMARY_KEY

@Retention(value=RUNTIME)
 @Target(value=FIELD)
 @Inherited
public @interface PRIMARY_KEY

Annotation for PRIMARY KEY column constraint.

How to set synthetic primary key here, through field types and affinities:

If you want to use this field as primary key associated, use TypeAffinities.INTEGER as affinity in KITTY_COLUMN.columnAffinity() without autoincrement() flag and without AscDesc.DESCENDING as value for orderAscDesc(), cause:
1) there some issues with aliasing primary key with oid if key type is not integer, however other integer types such as INT and BIGINT not presented in this code, they can be presented in future ( Other integer type names like "INT" or "BIGINT" or "SHORT INTEGER" or "UNSIGNED INTEGER" causes the primary key column to behave as an ordinary table column with integer affinity and a unique tableIndex, not as an alias for the rowid.)
2) CREATE TABLE t(x INTEGER PRIMARY KEY DESCENDING, y, z) doesn't result in "x" being an alias for the rowid
3) the main purpose of using AUTOINCREMENT attribute is to prevent SQLite to reuse value that has not been used or from the previously deleted row. In case if integer primary key is associated with oid (row id) it would be just overkill.
So, use for synthetic primary key something like "x INTEGER NOT NULL PRIMARY KEY"
You can achieve this in two different ways:
1) In KITTY_COLUMN set KITTY_COLUMN.isIPK() to true and KITTY_COLUMN.columnAffinity() to TypeAffinities.INTEGER or
2) Set in KITTY_COLUMN @link KITTY_COLUMN#columnAffinity()} to TypeAffinities.INTEGER and annotate model's field with PRIMARY_KEY without setting autoincrement() and orderAscDesc() to value AscDesc.DESCENDING. Also do not forget to annotate field with NOT_NULL (SQLite supports NULL values for IPK but they not supported by KittyORM). Created by akaish on 30.04.2018.

Author:

akaish (Denis Bogomolov)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	autoincrement AUTOINCREMENT keyword flag, if false than it would be skipped at column PK constraint generation Default value is false
ConflictClauses	onConflictAction Action that should be performed on conflict, if default value set than it would be skipped at column PK constraint generation Default value is ConflictClauses.CONFLICT_CLAUSE_NOT_SET
AscDesc	orderAscDesc Order (ASC\DESC), if default value set than it would be skipped at column PK constraint generation Default value is AscDesc.NOT_SET_SKIP_OR_DEFAULT

Element Detail

orderAscDesc

public abstract AscDesc orderAscDesc

Order (ASC\DESC), if default value set than it would be skipped at column PK constraint generation
Default value is AscDesc.NOT_SET_SKIP_OR_DEFAULT

Returns:

Default:

net.akaish.kitty.orm.enums.AscDesc.NOT_SET_SKIP_OR_DEFAULT

autoincrement

public abstract boolean autoincrement

AUTOINCREMENT keyword flag, if false than it would be skipped at column PK constraint generation
Default value is false

Returns:

Default:

false

onConflictAction

public abstract ConflictClauses onConflictAction

Action that should be performed on conflict, if default value set than it would be skipped at column PK constraint generation
Default value is ConflictClauses.CONFLICT_CLAUSE_NOT_SET

Returns:

Default:

net.akaish.kitty.orm.enums.ConflictClauses.CONFLICT_CLAUSE_NOT_SET