Module org.jooq

Package org.jooq

Interface CreateIndexStep

public interface CreateIndexStep

A step in the construction of the CREATE 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 CreateIndexIncludeStep	on(String table, String... on)	Add the ON clause to the CREATE INDEX statement.
@NotNull CreateIndexIncludeStep	on(String table, Collection<? extends String> on)	Add the ON clause to the CREATE INDEX statement.
@NotNull CreateIndexIncludeStep	on(Name table, Collection<? extends Name> on)	Add the ON clause to the CREATE INDEX statement.
@NotNull CreateIndexIncludeStep	on(Name table, Name... on)	Add the ON clause to the CREATE INDEX statement.
@NotNull CreateIndexIncludeStep	on(Table<?> table, Collection<? extends OrderField<?>> on)	Add the ON clause to the CREATE INDEX statement.
@NotNull CreateIndexIncludeStep	on(Table<?> table, OrderField<?>... on)	Add the ON clause to the CREATE INDEX statement.

Method Details

on

@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,CLICKHOUSE,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull
@CheckReturnValue
@NotNull CreateIndexIncludeStep on(@Name
 String table,
 @Name
 String... on)

Add the ON clause to the CREATE INDEX statement.

on

@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,CLICKHOUSE,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull
@CheckReturnValue
@NotNull CreateIndexIncludeStep on(Name table,
 Name... on)

Add the ON clause to the CREATE INDEX statement.

on

@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,CLICKHOUSE,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull
@CheckReturnValue
@NotNull CreateIndexIncludeStep on(Table<?> table,
 OrderField<?>... on)

Add the ON clause to the CREATE INDEX statement.

on

@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,CLICKHOUSE,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull
@CheckReturnValue
@NotNull CreateIndexIncludeStep on(@Name
 String table,
 Collection<? extends String> on)

Add the ON clause to the CREATE INDEX statement.

on

@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,CLICKHOUSE,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull
@CheckReturnValue
@NotNull CreateIndexIncludeStep on(Name table,
 Collection<? extends Name> on)

Add the ON clause to the CREATE INDEX statement.

on

@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,CLICKHOUSE,COCKROACHDB,CUBRID,DB2,DERBY,DUCKDB,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull
@CheckReturnValue
@NotNull CreateIndexIncludeStep on(Table<?> table,
 Collection<? extends OrderField<?>> on)

Add the ON clause to the CREATE INDEX statement.