jOOQ 3.18.7 · org.jooq.Routine

A routine is a callable object in your RDBMS.

Callable objects are mainly stored procedures and stored functions. The distinction between those two object types is very subtle and not well defined across various RDBMS. In general, this can be said:

Procedures:

Are called as callable statements
Have no return value
Support OUT parameters

Functions

Can be used in SQL statements
Have a return value
Don't support OUT parameters

But there are exceptions to these rules:

DB2, H2, and HSQLDB don't allow for JDBC escape syntax when calling functions. Functions must be used in a SELECT statement
H2 only knows functions (without OUT parameters)
Oracle functions may have OUT parameters
Oracle knows functions that mustn't be used in SQL statements
Oracle parameters can have default values (to support this, jOOQ renders PL/SQL instead of the JDBC escape syntax)
Postgres only knows functions (with all features combined)
The Sybase JDBC driver doesn't handle null values correctly when using the JDBC escape syntax on functions
etc...

Hence, with #852, jOOQ 1.6.8, the distinction between procedures and functions becomes obsolete. All stored routines are simply referred to as "Routine".

Instances of this type cannot be created directly. They are available from generated code.

Method Summary

Modifier and Type	Method and Description
public int	execute(Configuration configuration) Execute the stored object using a `Configuration` object
public int	execute() Execute the stored object on an underlying connection
public <Z> Z	Returns: The routine's OUT value for an OUT parameter. get(Parameter<Z> parameter)
public @NotNull List<Parameter<?>>	Returns: The list of in parameters getInParameters() A list of IN parameters passed to the stored procedure as argument.
public <Z> Z	Returns: The routine's IN value for an IN parameter. getInValue(Parameter<Z> parameter)
public @NotNull List<Parameter<?>>	Returns: The list of out parameters getOutParameters() A list of OUT parameters passed to the stored procedure as argument.
public @NotNull List<Parameter<?>>	Returns: A list of parameters passed to the stored object as argument getParameters()
public @NotNull Results	Returns: The routine's results (if available) getResults()
public @Nullable Parameter<T>	Returns: The return parameter or `null` if this routine doesn't have a return value. getReturnParameter() The parameter representing this routine's `getReturnValue()`
public T	Returns: The routine's return value (if it is a function) getReturnValue()
public <Z> Z	Returns: The routine's OUT value for an OUT parameter. getValue(Parameter<Z> parameter)
public <Z> void	set(Parameter<Z> parameter, Z value) Set the routine's IN value for an IN parameter.
public <Z> void	setValue(Parameter<Z> parameter, Z value) Set the routine's IN value for an IN parameter.

Inherited from org.jooq.Attachable:: attach configuration detach
Inherited from org.jooq.Qualified:: $schema getCatalog getSchema

Method Detail

execute back to summary

execute	back to summary
public int execute(Configuration configuration) throws DataAccessException Execute the stored object using a `Configuration` object Annotations @Blocking Exceptions DataAccessException: if something went wrong executing the query

public int execute(Configuration configuration) throws DataAccessException

Execute the stored object using a Configuration object

Annotations

@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

execute	back to summary
public int execute() throws DataAccessException Execute the stored object on an underlying connection Annotations @Blocking Exceptions DataAccessException: if something went wrong executing the query

execute

back to summary

public int execute() throws DataAccessException

Execute the stored object on an underlying connection

Annotations

@Blocking

Exceptions

DataAccessException:: if something went wrong executing the query

get	back to summary
public <Z> Z get(Parameter<Z> parameter) Returns:Z The routine's OUT value for an OUT parameter.

getInParameters back to summary

getInParameters	back to summary
public @NotNull List<Parameter<?>> getInParameters() A list of IN parameters passed to the stored procedure as argument. This list contains all parameters that are either IN or INOUT in their respective order of appearance in `getParameters()`. Returns:@NotNull List<Parameter<?>> The list of in parameters Annotations @NotNull See Also `getParameters()`

public @NotNull List<Parameter<?>> getInParameters()

A list of IN parameters passed to the stored procedure as argument. This list contains all parameters that are either IN or INOUT in their respective order of appearance in getParameters().

Returns:@NotNull List<Parameter<?>>

The list of in parameters

Annotations

@NotNull

See Also

getParameters()

getInValue	back to summary
public <Z> Z getInValue(Parameter<Z> parameter) Returns:Z The routine's IN value for an IN parameter.

getOutParameters back to summary

getOutParameters	back to summary
public @NotNull List<Parameter<?>> getOutParameters() A list of OUT parameters passed to the stored procedure as argument. This list contains all parameters that are either OUT or INOUT in their respective order of appearance in `getParameters()`. Returns:@NotNull List<Parameter<?>> The list of out parameters Annotations @NotNull See Also `getParameters()`

public @NotNull List<Parameter<?>> getOutParameters()

A list of OUT parameters passed to the stored procedure as argument. This list contains all parameters that are either OUT or INOUT in their respective order of appearance in getParameters().

Returns:@NotNull List<Parameter<?>>

The list of out parameters

Annotations

@NotNull

See Also

getParameters()

getParameters	back to summary
public @NotNull List<Parameter<?>> getParameters() Returns:@NotNull List<Parameter<?>> A list of parameters passed to the stored object as argument Annotations @NotNull

getResults	back to summary
public @NotNull Results getResults() Returns:@NotNull Results The routine's results (if available) Annotations @NotNull

getReturnParameter back to summary

getReturnParameter	back to summary
public @Nullable Parameter<T> getReturnParameter() The parameter representing this routine's `getReturnValue()` Returns:@Nullable Parameter<T> The return parameter or `null` if this routine doesn't have a return value. Annotations @Nullable See Also `getParameters()`

public @Nullable Parameter<T> getReturnParameter()

The parameter representing this routine's getReturnValue()

Returns:@Nullable Parameter<T>

The return parameter or null if this routine doesn't have a return value.

Annotations

@Nullable

See Also

getParameters()

getReturnValue	back to summary
public T getReturnValue() Returns:T The routine's return value (if it is a function) Annotations @Nullable

getValue	back to summary
public <Z> Z getValue(Parameter<Z> parameter) Returns:Z The routine's OUT value for an OUT parameter.

set	back to summary
public <Z> void set(Parameter<Z> parameter, Z value) Set the routine's IN value for an IN parameter.

setValue	back to summary
public <Z> void setValue(Parameter<Z> parameter, Z value) Set the routine's IN value for an IN parameter.

public Interface Routine<T>

Method Summary

Method Detail