jOOQ 3.18.7 · org.jooq.CreateIndexIncludeStep

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 and Description
public @NotNull CreateIndexWhereStep	include(String... include) Deprecated as a consequence of `CreateIndexWhereStep` being deprecated. Add the `INCLUDE` clause to the `CREATE INDEX` statement.
public @NotNull CreateIndexWhereStep	include(Name... include) Deprecated as a consequence of `CreateIndexWhereStep` being deprecated. Add the `INCLUDE` clause to the `CREATE INDEX` statement.
public @NotNull CreateIndexWhereStep	include(Field<?>... include) Deprecated as a consequence of `Field` and `CreateIndexWhereStep` being deprecated. Add the `INCLUDE` clause to the `CREATE INDEX` statement.
public @NotNull CreateIndexWhereStep	include(Collection<? extends Field<?>> include) Deprecated as a consequence of `CreateIndexWhereStep` being deprecated. Add the `INCLUDE` clause to the `CREATE INDEX` statement.

Inherited from org.jooq.CreateIndexWhereStep:: excludeNullKeys where where where where where where where where

Method Detail

include back to summary

include	back to summary
public @NotNull CreateIndexWhereStep include(String... include) Deprecated as a consequence of `CreateIndexWhereStep` being deprecated. See corresponding docs for further information. 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. Annotations @Support @NotNull @CheckReturnValue

public @NotNull CreateIndexWhereStep include(String... include)

Deprecated

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

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.

Annotations

@Support
@NotNull
@CheckReturnValue

include back to summary

include	back to summary
public @NotNull CreateIndexWhereStep include(Name... include) Deprecated as a consequence of `CreateIndexWhereStep` being deprecated. See corresponding docs for further information. 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. Annotations @Support @NotNull @CheckReturnValue

public @NotNull CreateIndexWhereStep include(Name... include)

Deprecated

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

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.

Annotations

@Support
@NotNull
@CheckReturnValue

include back to summary

include	back to summary
public @NotNull CreateIndexWhereStep include(Field<?>... include) Deprecated as a consequence of `Field` and `CreateIndexWhereStep` being deprecated. See corresponding docs for further information. 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. Annotations @Support @NotNull @CheckReturnValue

public @NotNull CreateIndexWhereStep include(Field<?>... include)

Deprecated

as a consequence of Field and CreateIndexWhereStep being deprecated. See corresponding docs for further information.

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.

Annotations

@Support
@NotNull
@CheckReturnValue

include back to summary

include	back to summary
public @NotNull CreateIndexWhereStep include(Collection<? extends Field<?>> include) Deprecated as a consequence of `CreateIndexWhereStep` being deprecated. See corresponding docs for further information. 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. Annotations @Support @NotNull @CheckReturnValue

public @NotNull CreateIndexWhereStep include(Collection<? extends Field<?>> include)

Deprecated

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

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.

Annotations

@Support
@NotNull
@CheckReturnValue

public Interface CreateIndexIncludeStep

Referencing XYZ*Step types directly from client code

Method Summary

Method Detail

Referencing `XYZ*Step` types directly from client code