Module org.jooq

Package org.jooq

Interface AlterIndexStep

All Known Subinterfaces:

AlterIndexOnStep

public interface AlterIndexStep

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:

• They're operating on mutable implementations (as of jOOQ 3.x)
• They're less composable and not easy to get right when dynamic SQL gets complex
• They're less readable
• They might have binary incompatible changes between minor releases

Method Summary

Modifier and Type	Method	Description
@NotNull AlterIndexFinalStep	renameTo(String renameTo)	Add the RENAME TO clause to the ALTER INDEX statement.
@NotNull AlterIndexFinalStep	renameTo(Index renameTo)	Add the RENAME TO clause to the ALTER INDEX statement.
@NotNull AlterIndexFinalStep	renameTo(Name renameTo)	Add the RENAME TO clause to the ALTER INDEX statement.

Method Details

renameTo

@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull
@CheckReturnValue
@NotNull AlterIndexFinalStep renameTo(@Name
 String renameTo)

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.

renameTo

@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull
@CheckReturnValue
@NotNull AlterIndexFinalStep renameTo(Name renameTo)

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.

renameTo

@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull
@CheckReturnValue
@NotNull AlterIndexFinalStep renameTo(Index renameTo)

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.