Top Description Methods
org.jooq

public Interface AlterIndexStep

Known Direct Subinterfaces
org.jooq.AlterIndexOnStep
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 AlterIndexFinalStep
renameTo(String renameTo)

Deprecated as a consequence of AlterIndexFinalStep being deprecated.
Add the RENAME TO clause to the ALTER INDEX statement.
public @NotNull AlterIndexFinalStep
renameTo(Name renameTo)

Deprecated as a consequence of AlterIndexFinalStep being deprecated.
Add the RENAME TO clause to the ALTER INDEX statement.
public @NotNull AlterIndexFinalStep
renameTo(Index renameTo)

Deprecated as a consequence of AlterIndexFinalStep being deprecated.
Add the RENAME TO clause to the ALTER INDEX statement.

Method Detail

renameToback to summary
public @NotNull AlterIndexFinalStep renameTo(String renameTo)

Deprecated

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

Add the RENAME TO clause to the ALTER INDEX statement.

Note that in some databases, including MySQL and SQL Server, the index namespace is tied to a table, not a schema. In those databases, it is recommended to call DSLContext#alterTable(String) with AlterTableStep#renameIndex(String) instead.

Annotations
@Support:DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES
@NotNull
@CheckReturnValue
renameToback to summary
public @NotNull AlterIndexFinalStep renameTo(Name renameTo)

Deprecated

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

Add the RENAME TO clause to the ALTER INDEX statement.

Note that in some databases, including MySQL and SQL Server, the index namespace is tied to a table, not a schema. In those databases, it is recommended to call DSLContext#alterTable(String) with AlterTableStep#renameIndex(String) instead.

Annotations
@Support:DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES
@NotNull
@CheckReturnValue
renameToback to summary
public @NotNull AlterIndexFinalStep renameTo(Index renameTo)

Deprecated

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

Add the RENAME TO clause to the ALTER INDEX statement.

Note that in some databases, including MySQL and SQL Server, the index namespace is tied to a table, not a schema. In those databases, it is recommended to call DSLContext#alterTable(String) with AlterTableStep#renameIndex(String) instead.

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