Module org.jooq

Package org.jooq

Interface AlterIndexOnStep

All Superinterfaces:

AlterIndexStep

public interface AlterIndexOnStep
extends 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 AlterIndexStep	on(String on)	Add the ON clause to the ALTER INDEX statement.
@NotNull AlterIndexStep	on(Name on)	Add the ON clause to the ALTER INDEX statement.
@NotNull AlterIndexStep	on(Table<?> on)	Add the ON clause to the ALTER INDEX statement.

Methods inherited from interface org.jooq.AlterIndexStep

renameTo, renameTo, renameTo

Method Details

on

@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull
@CheckReturnValue
@NotNull AlterIndexStep on(@Name
 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.

on

@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull
@CheckReturnValue
@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.

on

@Support({ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,DB2,DERBY,H2,HANA,HSQLDB,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLSERVER2016})
@NotNull
@CheckReturnValue
@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.