sirius.db.mixing.annotations

Annotation Type Index

@Retention(value=RUNTIME)
 @Target(value=TYPE)
 @Repeatable(value=Indices.class)
public @interface Index

Defines an additional index on an SQLEntity.

The index will be picked up and created by Schema.computeRequiredSchemaChanges()

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String[]	columns Contains the columns being indexed.
String	name Contains the name of the index.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	columnSettings
boolean	unique Determines if the index implies an unique constraint on the combination of the given columns.

Element Detail

name

public abstract String name

Contains the name of the index.

Returns:

the name of the index

columns

public abstract String[] columns

Contains the columns being indexed.

Returns:

the columns which make up the index

columnSettings

public abstract String[] columnSettings

Default:

{}

unique

public abstract boolean unique

Determines if the index implies an unique constraint on the combination of the given columns.

Returns:

true if an unique constraint is implied, false otherwise

Default:

false