Package org.jdbi.v3.sqlobject.customizer

package org.jdbi.v3.sqlobject.customizer

The sqlobject.customizer package provides annotations that customize the execution of a statement. The most common utility is binding parameters with @Bind but there are also miscellaneous JDBC options supported here such as timeouts and fetch size.

Related Packages

Package	Description
org.jdbi.v3.sqlobject	SQL Objects
org.jdbi.v3.sqlobject.config	The sqlobject.config package defines configuration annotations that modify the Jdbi configuration used as the context for executing SqlObject methods, such as registering handled types.
org.jdbi.v3.sqlobject.locator	sqlobject.locator inspects the declared SqlObject and determines the statement text to pass off to core.locator for final resolution of the statement text.
org.jdbi.v3.sqlobject.statement	The sqlobject.statement annotations declare the type of statement that a SqlObject method should create, such as a @SqlQuery to return rows or a @SqlUpdate to modify rows and return the modification count.
org.jdbi.v3.sqlobject.transaction	sqlobject.transaction annotations declaratively create transactions wrapping a SqlObject method.

Class	Description
AllowUnusedBindings	Suppresses error when bindings are created but never used in the query.
Bind	Binds the annotated argument as a named parameter, and as a positional parameter.
BindBean	Binds the properties of a JavaBean to a SQL statement.
BindBeanList	Binds each property for each value in the annotated Iterable or array/varargs argument, and defines a named attribute as a comma-separated list of each bound parameter name.
BindFields	Binds the properties and public fields of an object to a SQL statement.
BindList	Binds each value in the annotated Iterable or array/varargs argument, and defines a named attribute as a comma-separated list of each bound parameter name.
BindList.EmptyHandling	describes what needs to be done if the passed argument is null or empty
BindMap	Binds the entries of a Map<String, Object> to a SQL statement.
BindMethods
BindMethodsList	Binds each method for each value in the annotated Iterable or array/varargs argument, and defines a named attribute as a comma-separated list of each bound method name.
BindPojo	Binds the properties of an object to a SQL statement.
Define	Defines a named attribute as the argument passed to the annotated parameter.
DefineList	Defines a named attribute as a comma-separated String from the elements of the annotated array or List argument.
DefineNamedBindings	Defines all bound arguments that don't already have a definition.
Definition	Annotate a SqlObject type, method, or field as @Definition in order to define an attribute for all SqlObject methods in the same type.
Definitions
FetchSize	Specify batch size to fetch resulting rows in.
MaxRows	Used to specify the maximum number of rows to return on a result set.
OutParameter	Declare a named out parameter on an @SqlCall annotated method.
OutParameterList
QueryTimeOut	Specify the query timeout in seconds.
SqlStatementCustomizer	Used with SqlStatementCustomizerFactory to customize sql statements via annotations.
SqlStatementCustomizerFactory	Interface used in conjunction with SqlStatementCustomizingAnnotation to generate SqlStatementCustomizer instances.
SqlStatementCustomizingAnnotation	Annotation used to build customizing annotations.
SqlStatementParameterCustomizer	Customize a SqlStatement according to the value of an annotated parameter.
Timestamped	Binds the named parameter :now or a custom named parameter with the current DateTime as an OffsetDateTime.
TimestampedConfig	Configuration for Timestamped.