org.jdbi.v3.core.statement

Class SqlStatements

java.lang.Object

org.jdbi.v3.core.statement.SqlStatements

All Implemented Interfaces:

JdbiConfig<SqlStatements>

public final class SqlStatements
extends Object
implements JdbiConfig<SqlStatements>

Configuration holder for SqlStatements.

Constructor Summary

Constructors

Constructor and Description
SqlStatements()

Method Summary

Modifier and Type	Method and Description
SqlStatements	addCustomizer(StatementCustomizer customizer) Provides a means for custom statement modification.
SqlStatements	createCopy() Returns a copy of this configuration object.
SqlStatements	define(String key, Object value) Define an attribute for StatementContext for statements executed by Jdbi.
SqlStatements	defineMap(Map<String,?> values) Defines attributes for each key/value pair in the Map.
Object	getAttribute(String key) Obtain the value of an attribute
Map<String,Object>	getAttributes() Returns the attributes which will be applied to SQL statements created by Jdbi.
Integer	getQueryTimeout()
SqlLogger	getSqlLogger()
SqlParser	getSqlParser()
TemplateEngine	getTemplateEngine()
boolean	isUnusedBindingAllowed()
SqlStatements	setQueryTimeout(Integer seconds) Jdbi does not implement its own timeout mechanism: it simply calls Statement.setQueryTimeout(int), leaving timeout handling to your jdbc driver.
SqlStatements	setSqlLogger(SqlLogger sqlLogger)
SqlStatements	setSqlParser(SqlParser sqlParser) Sets the SqlParser used to parse parameters in SQL statements executed by Jdbi.
SqlStatements	setTemplateEngine(TemplateEngine templateEngine) Sets the TemplateEngine used to render SQL for all SQL statements executed by Jdbi.
SqlStatements	setUnusedBindingAllowed(boolean allowUnusedBindings) Sets whether or not an exception should be thrown when any arguments are given to a query but not actually used in it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jdbi.v3.core.config.JdbiConfig

setRegistry

Constructor Detail

SqlStatements

public SqlStatements()

Method Detail

addCustomizer

public SqlStatements addCustomizer(StatementCustomizer customizer)

Provides a means for custom statement modification. Common customizations have their own methods, such as Query.setMaxRows(int)

Parameters:

customizer - instance to be used to customize a statement

Returns:

this

createCopy

public SqlStatements createCopy()

Description copied from interface: JdbiConfig

Returns a copy of this configuration object. Changes to the copy should not modify the original, and vice-versa.

Specified by:

createCopy in interface JdbiConfig<SqlStatements>

Returns:

a copy of this configuration object.

define

public SqlStatements define(String key,
                            Object value)

Define an attribute for StatementContext for statements executed by Jdbi.

Parameters:

key - the key for the attribute

value - the value for the attribute

Returns:

this

defineMap

public SqlStatements defineMap(Map<String,?> values)

Defines attributes for each key/value pair in the Map.

Parameters:

values - map of attributes to define.

Returns:

this

getAttribute

public Object getAttribute(String key)

Obtain the value of an attribute

Parameters:

key - the name of the attribute

Returns:

the value of the attribute

getAttributes

public Map<String,Object> getAttributes()

Returns the attributes which will be applied to SQL statements created by Jdbi.

Returns:

the defined attributes.

getQueryTimeout

@Beta
public Integer getQueryTimeout()

getSqlLogger

public SqlLogger getSqlLogger()

getSqlParser

public SqlParser getSqlParser()

getTemplateEngine

public TemplateEngine getTemplateEngine()

Returns:

the template engine which renders the SQL template prior to parsing parameters.

isUnusedBindingAllowed

public boolean isUnusedBindingAllowed()

setQueryTimeout

@Beta
public SqlStatements setQueryTimeout(@Nullable
                                           Integer seconds)

Jdbi does not implement its own timeout mechanism: it simply calls Statement.setQueryTimeout(int), leaving timeout handling to your jdbc driver.

Parameters:

seconds - the time in seconds to wait for a query to complete; 0 to disable the timeout; null to leave it at defaults (i.e. Jdbi will not call setQueryTimeout(int))

Returns:

this

setSqlLogger

public SqlStatements setSqlLogger(SqlLogger sqlLogger)

setSqlParser

public SqlStatements setSqlParser(SqlParser sqlParser)

Sets the SqlParser used to parse parameters in SQL statements executed by Jdbi. The default parses colon-prefixed named parameter tokens, e.g. :name.

Parameters:

sqlParser - the new SQL parser.

Returns:

this

setTemplateEngine

public SqlStatements setTemplateEngine(TemplateEngine templateEngine)

Sets the TemplateEngine used to render SQL for all SQL statements executed by Jdbi. The default engine replaces <name>-style tokens with attributes defined on the statement context.

Parameters:

templateEngine - the new template engine.

Returns:

this

setUnusedBindingAllowed

public SqlStatements setUnusedBindingAllowed(boolean allowUnusedBindings)

Sets whether or not an exception should be thrown when any arguments are given to a query but not actually used in it. Unused bindings tend to be bugs or oversights, but are not always. Defaults to false: unused bindings are not allowed.

Parameters:

allowUnusedBindings - the new setting

Returns:

this

See Also:

Argument