Interface Index

All Superinterfaces:

Named, QueryPart, Serializable, TableElement

public interface Index
extends TableElement

A DDL index definition.

Instances can be created using DSL.index(Name) and overloads.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@Nullable Table<?>	$table()	Experimental query object model accessor method, see also QOM.
@NotNull List<SortField<?>>	getFields()	The sort field expressions on which this index is defined.
@Nullable Table<?>	getTable()	The table on which this index is defined.
boolean	getUnique()	Whether this is a UNIQUE index.
@Nullable Condition	getWhere()	The condition of a filtered / partial index, or null, if this is an ordinary index.

Methods inherited from interface Named

$name, getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Methods inherited from interface QueryPart

$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Method Details

getTable

@Nullable
@Nullable Table<?> getTable()

The table on which this index is defined.

getFields

@NotNull
@NotNull List<SortField<?>> getFields()

The sort field expressions on which this index is defined.

getWhere

@Nullable
@Nullable Condition getWhere()

The condition of a filtered / partial index, or null, if this is an ordinary index.

getUnique

boolean getUnique()

Whether this is a UNIQUE index.

$table

@Experimental
@Nullable
@Nullable Table<?> $table()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.