Module org.jooq

Package org.jooq

Interface Index

All Superinterfaces:

Named, QueryPart, Serializable

public interface Index
extends Named

A DDL index definition.

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

Author:

Lukas Eder

Method Summary

Modifier and Type	Method	Description
@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 org.jooq.Named

getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

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.