Top Description Methods
org.jooq

public non-sealed Interface Index

extends TableElement
Known Direct Implementers
org.jooq.impl.IndexImpl
Imports
java.util.List, org.jooq.impl.DSL, .QOM, org.jetbrains.annotations.NotNull, .Nullable, .ApiStatus.Experimental

A DDL index definition.

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

Author
Lukas Eder

Method Summary

Modifier and TypeMethod and Description
public @Nullable Table<?>
$table()

Experimental query object model accessor method, see also QOM.

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

The sort field expressions on which this index is defined.

public @Nullable Table<?>
getTable()

The table on which this index is defined.

public boolean
getUnique()

Whether this is a UNIQUE index.

public @Nullable Condition
getWhere()

Deprecated as a consequence of Condition being deprecated.
The condition of a filtered / partial index, or null, if this is an ordinary index.

Method Detail

$tableback to summary
public @Nullable Table<?> $table()

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

Annotations
@Experimental
@Nullable
getFieldsback to summary
public @NotNull List<SortField<?>> getFields()

The sort field expressions on which this index is defined.

Annotations
@NotNull
getTableback to summary
public @Nullable Table<?> getTable()

The table on which this index is defined.

Annotations
@Nullable
getUniqueback to summary
public boolean getUnique()

Whether this is a UNIQUE index.

getWhereback to summary
public @Nullable Condition getWhere()

Deprecated

as a consequence of Condition being deprecated. See corresponding docs for further information.

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

Annotations
@Nullable