Top Description Methods
org.jooq

public Interface AlterIndexOnStep

extends AlterIndexStep
Known Direct Implementers
org.jooq.impl.AlterIndexImpl
Annotations
@SuppressWarnings:unused
Static Imports
org.jooq.SQLDialect.*, org.jooq.impl.DSL.*
A step in the construction of the ALTER INDEX statement.

Referencing XYZ*Step types directly from client code

It is usually not recommended to reference any XYZ*Step types directly from client code, or assign them to local variables. When writing dynamic SQL, creating a statement's components dynamically, and passing them to the DSL API statically is usually a better choice. See the manual's section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.

Drawbacks of referencing the XYZ*Step types directly:

Method Summary

Modifier and TypeMethod and Description
public @NotNull AlterIndexStep
on(String on)

Add the ON clause to the ALTER INDEX statement.

public @NotNull AlterIndexStep
on(Name on)

Add the ON clause to the ALTER INDEX statement.

public @NotNull AlterIndexStep
on(Table<?> on)

Add the ON clause to the ALTER INDEX statement.

Inherited from org.jooq.AlterIndexStep:
renameTorenameTorenameTo

Method Detail

onback to summary
public @NotNull AlterIndexStep on(String on)

Add the ON clause to the ALTER INDEX statement.

SQLDialect#MYSQL, SQLDialect#MARIADB, and SQLDialect#SQLSERVER use table-scoped index names, not schema-scoped names. This means that in these databases, the ON clause is mandatory in order to unambiguously identify an index. In all other databases, the ON clause will simply be ignored for compatibility reasons.

Annotations
@Support:DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES
@NotNull
@CheckReturnValue
onback to summary
public @NotNull AlterIndexStep on(Name on)

Add the ON clause to the ALTER INDEX statement.

SQLDialect#MYSQL, SQLDialect#MARIADB, and SQLDialect#SQLSERVER use table-scoped index names, not schema-scoped names. This means that in these databases, the ON clause is mandatory in order to unambiguously identify an index. In all other databases, the ON clause will simply be ignored for compatibility reasons.

Annotations
@Support:DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES
@NotNull
@CheckReturnValue
onback to summary
public @NotNull AlterIndexStep on(Table<?> on)

Add the ON clause to the ALTER INDEX statement.

SQLDialect#MYSQL, SQLDialect#MARIADB, and SQLDialect#SQLSERVER use table-scoped index names, not schema-scoped names. This means that in these databases, the ON clause is mandatory in order to unambiguously identify an index. In all other databases, the ON clause will simply be ignored for compatibility reasons.

Annotations
@Support:DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES
@NotNull
@CheckReturnValue