Module org.jooq

Package org.jooq

Interface CreateIndexIncludeStep

All Superinterfaces:

Attachable, AttachableQueryPart, CreateIndexFinalStep, CreateIndexWhereStep, DDLQuery, Flow.Publisher<Integer>, Publisher<Integer>, org.reactivestreams.Publisher<Integer>, Query, QueryPart, RowCountQuery, Serializable, Statement

public interface CreateIndexIncludeStep
extends CreateIndexWhereStep

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 CreateIndexWhereStep	include(String... include)	Add the INCLUDE clause to the CREATE INDEX statement.
@NotNull CreateIndexWhereStep	include(Collection<? extends Field<?>> include)	Add the INCLUDE clause to the CREATE INDEX statement.
@NotNull CreateIndexWhereStep	include(Field<?>... include)	Add the INCLUDE clause to the CREATE INDEX statement.
@NotNull CreateIndexWhereStep	include(Name... include)	Add the INCLUDE clause to the CREATE INDEX statement.

Methods inherited from interface org.jooq.Attachable

attach, configuration, detach

Methods inherited from interface org.jooq.AttachableQueryPart

getBindValues, getParam, getParams, getSQL, getSQL

Methods inherited from interface org.jooq.CreateIndexWhereStep

excludeNullKeys, where, where, where, where, where, where, where, where

Methods inherited from interface org.jooq.Publisher

subscribe

Methods inherited from interface org.reactivestreams.Publisher

subscribe

Methods inherited from interface org.jooq.Query

bind, bind, cancel, execute, executeAsync, executeAsync, isExecutable, keepStatement, poolable, queryTimeout

Methods inherited from interface org.jooq.QueryPart

$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Method Details

include

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

Add the INCLUDE clause to the CREATE INDEX statement.

If this is not supported by any given database, then the included columns will simply be put in the index as ordinary columns, making the index a composite index.

include

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

Add the INCLUDE clause to the CREATE INDEX statement.

If this is not supported by any given database, then the included columns will simply be put in the index as ordinary columns, making the index a composite index.

include

@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,IGNITE,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull
@CheckReturnValue
@NotNull CreateIndexWhereStep include(Field<?>... include)

Add the INCLUDE clause to the CREATE INDEX statement.

If this is not supported by any given database, then the included columns will simply be put in the index as ordinary columns, making the index a composite index.

include

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

Add the INCLUDE clause to the CREATE INDEX statement.

If this is not supported by any given database, then the included columns will simply be put in the index as ordinary columns, making the index a composite index.