jOOQ 3.18.7 · org.jooq.AttachableQueryPart

Method Summary

Modifier and Type	Method and Description
public @NotNull List<Object>	getBindValues() Retrieve the bind values that will be bound by this Query.
public @Nullable Param<?>	getParam(String name) Deprecated as a consequence of `Param` being deprecated. Get a named parameter from the `Query`, provided its name.
public @NotNull Map<String, Param<?>>	getParams() Get a `Map` of named parameters.
public @NotNull String	getSQL() Retrieve the SQL code rendered by this Query.
public @NotNull String	Returns: The generated SQL getSQL(ParamType How to render parameters. This overrides values in `Settings#getStatementType()` paramType) Retrieve the SQL code rendered by this Query.

Inherited from org.jooq.Attachable:: attach configuration detach
Inherited from org.jooq.QueryPart:: equals hashCode toString

Method Detail

getBindValues back to summary

getBindValues	back to summary
public @NotNull List<Object> getBindValues() Retrieve the bind values that will be bound by this Query. Unlike `getParams()`, which returns also inlined parameters, this returns only actual bind values that will render an actual bind value as a question mark `"?"` Annotations @NotNull See Also `DSLContext#extractBindValues(QueryPart)`

public @NotNull List<Object> getBindValues()

Retrieve the bind values that will be bound by this Query.

Unlike getParams(), which returns also inlined parameters, this returns only actual bind values that will render an actual bind value as a question mark "?"

Annotations

@NotNull

getParam back to summary

getParam	back to summary
public @Nullable Param<?> getParam(String name) Deprecated as a consequence of `Param` being deprecated. See corresponding docs for further information. Get a named parameter from the `Query`, provided its name. Bind values created with `DSL#val(Object)` will have their bind index as name. Annotations @Nullable See Also `Param`, `DSL#param(String, Object)`, `DSLContext#extractParam(QueryPart, String)`

public @Nullable Param<?> getParam(String name)

Deprecated

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

Get a named parameter from the Query, provided its name.

Bind values created with DSL#val(Object) will have their bind index as name.

Annotations

@Nullable

getParams back to summary

getParams	back to summary
public @NotNull Map<String, Param<?>> getParams() Get a `Map` of named parameters. The `Map` itself cannot be modified, but the `Param` elements allow for modifying bind values on an existing `Query`. Bind values created with `DSL#val(Object)` will have their bind index as name. Annotations @NotNull See Also `Param`, `DSL#param(String, Object)`, `DSLContext#extractParams(QueryPart)`

public @NotNull Map<String, Param<?>> getParams()

Get a Map of named parameters. The Map itself cannot be modified, but the Param elements allow for modifying bind values on an existing Query.

Bind values created with DSL#val(Object) will have their bind index as name.

Annotations

@NotNull

getSQL back to summary

public @NotNull String getSQL()

Retrieve the SQL code rendered by this Query.

Use this method, when you want to use jOOQ for object oriented query creation, but execute the query with some other technology, such as

JDBC
Spring Templates
JPA native queries
etc...

Note, this is the same as calling getSQL(ParamType). The parameter will depend on your DSLContext's Settings:

`StatementType`	boolean parameter	effect
`StatementType#PREPARED_STATEMENT`	`false` (default)	This will render bind variables to be used with a JDBC `PreparedStatement`. You can extract bind values from this `Query` using `getBindValues()`
`StatementType#STATIC_STATEMENT`	`true`	This will inline all bind variables in a statement to be used with a JDBC `Statement`

[#1520] Note that the query actually being executed might not contain any bind variables, in case the number of bind variables exceeds your SQL dialect's maximum number of supported bind variables. This is not reflected by this method, which will only use the Settings to decide whether to render bind values.

Annotations

@NotNull

See Also

getSQL(ParamType)

getSQL back to summary

getSQL	back to summary
public @NotNull String getSQL(ParamType paramType) Retrieve the SQL code rendered by this Query. [#1520] Note that the query actually being executed might not contain any bind variables, in case the number of bind variables exceeds your SQL dialect's maximum number of supported bind variables. This is not reflected by this method, which will only use `paramType` argument to decide whether to render bind values. See `getSQL()` for more details. Parameters paramType:ParamType How to render parameters. This overrides values in `Settings#getStatementType()` Returns:@NotNull String The generated SQL Annotations @NotNull

public @NotNull String getSQL(ParamType paramType)

Retrieve the SQL code rendered by this Query.

[#1520] Note that the query actually being executed might not contain any bind variables, in case the number of bind variables exceeds your SQL dialect's maximum number of supported bind variables. This is not reflected by this method, which will only use paramType argument to decide whether to render bind values.

See getSQL() for more details.

Parameters

paramType:ParamType: How to render parameters. This overrides values in Settings#getStatementType()

Returns:@NotNull String

The generated SQL

Annotations

@NotNull

public Interface AttachableQueryPart

Method Summary

Method Detail