Module org.jooq

Package org.jooq

Interface BindingScope

All Superinterfaces:

Scope

All Known Subinterfaces:

BindingGetResultSetContext<U>, BindingGetSQLInputContext<U>, BindingGetStatementContext<U>, BindingRegisterContext<U>, BindingSetSQLOutputContext<U>, BindingSetStatementContext<U>, BindingSQLContext<U>

public interface BindingScope
extends Scope

A Scope that lives in the context of a data type Binding operation.

Known subtypes of various binding operations

The various Binding operations and their corresponding BindingScope subtypes include:

• Binding.sql(BindingSQLContext) with BindingSQLContext to generate the SQL string for a bind value.
• Binding.set(BindingSetStatementContext) with BindingSetStatementContext to set the bind value to the JDBC PreparedStatement.
• Binding.set(BindingSetSQLOutputContext) with BindingSetSQLOutputContext to write the bind value to a JDBC SQLOutput (used for UDT).
• Binding.register(BindingRegisterContext) with BindingRegisterContext to register a procedural OUT parameter on a JDBC CallableStatement.
• Binding.get(BindingGetResultSetContext) with BindingGetResultSetContext to read a result value from a JDBC ResultSet.
• Binding.get(BindingGetSQLInputContext) with BindingGetSQLInputContext to read a result value from a JDBC SQLInput (used for UDT).
• Binding.get(BindingGetStatementContext) with BindingGetStatementContext to read a procedural OUT argument from a JDBC CallableStatement.

Lifecycle

The various Binding operations are very short lived operations and thus this scope is also very short lived, although some implementations (e.g. BindingGetResultSetContext) may be cached for the duration of an ExecuteScope for performance reasons.

The Scope.data() map is that of the parent scope, which is:

• The Context for BindingSQLContext
• The ExecuteScope for all the others

This allows for interacting with the rendering lifecycle or the execution lifecycle from within a custom data type Binding.

Interactions with other Scope types

Most but not all BindingScope types are also ExecuteScope. Specifically, the BindingSQLContext type isn't an ExecuteScope because it can also be used in non-execution use-cases, such as DSLContext.render(QueryPart), where a bind value needs to render its SQL to the output SQL string, without the SQL string ever being executed.

Author:

Lukas Eder

Method Summary

Methods inherited from interface org.jooq.Scope

configuration, creationTime, data, data, data, dialect, dsl, family, settings