Package org.jdbi.v3.core.statement

Interface StatementBuilder

All Known Implementing Classes:

DefaultStatementBuilder

public interface StatementBuilder

Used to convert translated SQL into a prepared statement. The default implementation created by DefaultStatementBuilder.FACTORY creates a new statement on every call. A StatementBuilder is always associated with exactly one Handle instance

See Also:

StatementBuilderFactory

Method Summary

Modifier and Type	Method	Description
default void	close(java.sql.Connection conn)	Is called when the Handle, to which this StatementBuilder is attached to, is closed.
void	close(java.sql.Connection conn, java.lang.String sql, java.sql.Statement stmt)	Called to close an individual statement created from this builder.
java.sql.PreparedStatement	create(java.sql.Connection conn, java.lang.String sql, StatementContext ctx)	Called each time a prepared statement needs to be created.
java.sql.Statement	create(java.sql.Connection conn, StatementContext ctx)	Called each time a statement needs to be created.
java.sql.CallableStatement	createCall(java.sql.Connection conn, java.lang.String sql, StatementContext ctx)	Called each time a Callable statement needs to be created.

Method Detail

create

java.sql.Statement create(java.sql.Connection conn,
                          StatementContext ctx)
                   throws java.sql.SQLException

Called each time a statement needs to be created.

Parameters:

conn - the JDBC Connection the statement is being created for

ctx - Statement context associated with the SqlStatement this is building for

Returns:

a Statement

Throws:

java.sql.SQLException - if anything goes wrong getting the statement

create

java.sql.PreparedStatement create(java.sql.Connection conn,
                                  java.lang.String sql,
                                  StatementContext ctx)
                           throws java.sql.SQLException

Called each time a prepared statement needs to be created.

Parameters:

conn - the JDBC Connection the statement is being created for

sql - the translated SQL which should be prepared

ctx - Statement context associated with the SqlStatement this is building for

Returns:

a PreparedStatement for the given arguments

Throws:

java.sql.SQLException - if anything goes wrong preparing the statement

createCall

java.sql.CallableStatement createCall(java.sql.Connection conn,
                                      java.lang.String sql,
                                      StatementContext ctx)
                               throws java.sql.SQLException

Called each time a Callable statement needs to be created.

Parameters:

conn - the JDBC Connection the statement is being created for

sql - the translated SQL which should be prepared

ctx - Statement context associated with the SqlStatement

Returns:

a CallableStatement for the given arguments

Throws:

java.sql.SQLException - if anything goes wrong preparing the statement

close

void close(java.sql.Connection conn,
           java.lang.String sql,
           java.sql.Statement stmt)
    throws java.sql.SQLException

Called to close an individual statement created from this builder.

Parameters:

conn - the JDBC Connection that this statement was created for.

sql - the translated SQL which was prepared.

stmt - the statement.

Throws:

java.sql.SQLException - if anything goes wrong closing the statement.

close

default void close(java.sql.Connection conn)

Is called when the Handle, to which this StatementBuilder is attached to, is closed.

Parameters:

conn - The connection which can be used to release resources. The Connection is managed by the Handle and must not be closed by the StatementBuilder.