All Classes and Interfaces

Class	Description
AbstractArgumentFactory<T>	An ArgumentFactory base class for arguments of type T.
AbstractJdbiExecutor
AbstractSeparatorCharColumnNameMatcher
AccessibleObjectStrategy
Alpha	Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release.
Argument	Represents an argument to a prepared statement.
ArgumentFactory	Inspect a value with optional static type information and produce an Argument that binds the value to a prepared statement.
ArgumentFactory.Preparable	ArgumentFactory extension interface that allows preparing arguments for efficient batch binding.
Arguments	A registry for ArgumentFactory instances.
Batch	Represents a group of non-prepared statements to be sent to the RDMBS in one "request".
BatchResultBearing	Extends the ResultBearing class to provide access to the per-batch row modification counts.
BatchResultIterable<T>	Extend the ResultIterable for batch operations.
BeanMapper<T>	A row mapper which maps the columns in a statement into a JavaBean.
BeanPropertyArguments	Deprecated. this should never have been public API
Beta	Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release.
Binding	Represents the arguments bound to a particular statement.
BuiltInArgumentFactory	Deprecated. will be replaced by a plugin
BuiltInCollectorFactory	Deprecated. will be replaced by plugin
BuiltInMapperFactory	Deprecated. will be replaced by an opt-out plugin to give the core no hardwired behavior
CachingSqlParser
Call	Used for invoking stored procedures.
CallableStatementMapper	Map an OUT parameter in a callable statement to a result type.
CaseInsensitiveColumnNameMatcher	Matches column names with identical java names, ignoring case.
CaseStrategy	Strategies for comparing case sensitive strings.
CharacterStreamArgument	Bind a Reader as a character stream parameter.
CharSequenceArgumentFactory	An ArgumentFactory for arguments that implement CharSequence.
ClasspathSqlLocator	Locates SQL in .sql files on the classpath.
Cleanable	Cleans up some JDBC resource e.g.
CloseException	Thrown when an exception occurs while attempting to close a database resource.
CMTTransactionHandler	Handler designed to behave properly in a J2EE CMT environment.
Codec<T>	A Codec provides a convenient way for a bidirectional mapping of an attribute to a database column.
CodecFactory	CodecFactory provides column mappers and arguments for bidirectional mapping types to database columns.
CodecFactory.Builder	Fluent Builder for CodecFactory.
CollectorFactory	Factory for building Collectors to assemble containers of elements.
ColonPrefixSqlParser	SQL parser which recognizes named parameter tokens of the form :tokenName
ColumnMapper<T>	Maps result set columns to objects.
ColumnMapperFactory	Factory interface used to produce column mappers.
ColumnMappers	Configuration registry for ColumnMapperFactory instances.
ColumnName	Specify the mapping name for a property or parameter explicitly.
ColumnNameMatcher	Strategy for matching SQL column names to Java property, field, or parameter names.
ConfigCustomizer	Customizes a given ConfigRegistry.
ConfigCustomizerFactory	Factory interface to create collections of ConfigCustomizer instances.
ConfigRegistry	A registry of JdbiConfig instances by type.
Configurable<This>	A type with access to access and modify arbitrary Jdbi configuration.
ConfiguringPlugin<C extends JdbiConfig<C>>
ConnectionException
ConnectionFactory	Supplies Connection instances to a created Handle and allows custom close handling.
ConstructorMapper<T>	A row mapper which maps the fields in a result set into a constructor.
DatabaseValue	Map a value from the database column directly onto an enum value.
DefaultStatementBuilder	A StatementBuilder which will always create a new PreparedStatement.
DefinedAttributeTemplateEngine	Template engine which replaces angle-bracketed tokens like <name> with the string value of the named attribute.
DelegatingTransactionHandler	Simple delegating subclass that just invokes its delegate.
DirectArgumentFactory
ElementTypeNotFoundException	Thrown when Jdbi tries to build a Collector, but cannot determine the element type intended for it.
EmptyHandling	describes what should be done if the value passed to SqlStatement.bindList(java.lang.String, java.lang.Object...) is null or empty
EnumByName	Specifies that an Enum value should be bound or mapped as its Enum.name().
EnumByNameMapperFactory	Deprecated. Use getConfig(Enums.class).setEnumStrategy(BY_NAME) instead.
EnumByOrdinal	Specifies that an Enum value should be bound or mapped as its Enum.ordinal().
EnumByOrdinalMapperFactory	Deprecated. Use getConfig(Enums.class).setEnumStrategy(BY_ORDINAL) instead.
EnumMapper<E extends Enum<E>>	Column mapper for Java enum types.
Enums	Configuration for behavior related to Enums.
EnumStrategy
ExtensionCallback<R,E,X extends Exception>	Callback for use with Jdbi.withExtension(java.lang.Class<E>, org.jdbi.v3.core.extension.ExtensionCallback<R, E, X>).
ExtensionConfigurer	Configures ConfigRegistry instances.
ExtensionConsumer<E,X extends Exception>	Callback for use with Jdbi.withExtension(java.lang.Class<E>, org.jdbi.v3.core.extension.ExtensionCallback<R, E, X>).
ExtensionContext	Accepted by a handle when executing extension code.
ExtensionFactory	Factory interface used to produce Jdbi extension objects.
ExtensionFactory.FactoryFlag	Flags that the factory can return to control aspects of the extension framework.
ExtensionHandler	Provides functionality for a single method on an extension object.
ExtensionHandlerCustomizationOrder	Determines the order in which extension method decorators are invoked.
ExtensionHandlerCustomizer	Supports customization of an extension handler.
ExtensionHandlerFactory	A factory to create ExtensionHandler instances.
ExtensionMetadata	Metadata that was detected when analyzing an extension class before attaching.
ExtensionMetadata.Builder	Builder class for the ExtensionMetadata object.
ExtensionMethod	Holder for a Class and a Method that together define which extension method was invoked.
Extensions	Configuration class for defining Jdbi extensions via ExtensionFactory instances.
FieldMapper<T>	A row mapper which maps the columns in a statement into an object, using reflection to set fields on the object.
GenericMapMapperFactory	Factory for a RowMapper that can map resultset rows to column name/generic value Maps.
GenericType<T>
GenericTypes	Utilities for working with generic types.
GetObjectColumnMapperFactory	Factory that uses ResultSet.getObject(int, Class) to fetch values.
H2DatabasePlugin	Configure vendor supported types for the H2 Java database implementation
Handle	This represents a connection to the database system.
HandleCallback<T,X extends Exception>	Callback that accepts a Handle that remains open for the duration of the callback invocation.
HandleConsumer<X extends Exception>	Callback that accepts a Handle and returns no result.
HandleListener	Allows listening to events on the Handle lifecycle.
Handler
Handles	Configuration class for handles.
HandleSupplier	A handle supplier for extension implementors.
HashPrefixSqlParser	SQL parser which recognizes named parameter tokens of the form #tokenName.
InputStreamArgument	Bind an input stream as either an ASCII (discouraged) or binary stream.
IteratorCallback<T,R,X extends Exception>	Callback for use with ResultIterable.withIterator(IteratorCallback)
IteratorConsumer<T,X extends Exception>	Callback for use with ResultIterable.useIterator(IteratorConsumer)
JavaTimeZoneIdArgumentFactory
Jdbi	Main entry point; configurable wrapper around a JDBC DataSource.
JdbiCache<K,V>	A generic cache implementation for JDBI internal use.
JdbiCacheBuilder	Builder class for JdbiCache implementations.
JdbiCacheLoader<K,V>	Creates a new value for a JdbiCache.
JdbiCacheStats	Simple statistics about a JdbiCache instance.
JdbiCollectors	Registry of collector factories.
JdbiConfig<This extends JdbiConfig<This>>	Interface for classes that hold configuration.
JdbiConstructor	Indicate to ConstructorMapper and other reflective mappers how to construct an instance.
JdbiConstructors	Utilities for JdbiConstructor annotation.
JdbiException	Base unchecked exception for exceptions thrown from jdbi.
JdbiExecutor
JdbiFreeBuilders	Configures support for an FreeBuilder generated Builder) value type.
JdbiImmutables	Configures support for an Immutables generated Immutable or Modifiable value type.
JdbiInterceptionChain<T>	An instance of an interception chain.
JdbiInterceptionChainHolder<S,T>	An interception chain holder to manage transformation operations.
JdbiInterceptor<S,T>	Generic interface to allow transformation operation interception.
JdbiPlugin	A plugin is given an opportunity to customize instances of various Jdbi types before they are returned from their factories.
JdbiPlugin.Singleton	Abstract base class for single-install JdbiPlugins.
JdbiProperty	Configure reflective bean and pojo property attributes.
JoinRow	Holder for a single joined row.
JoinRowMapper	A RowMapper implementation to easily compose existing RowMappers.
LinkedHashMapRowReducer<K,V>	A row reducer that uses LinkedHashMap (which preserves insertion order) as a result container, and returns map.values().stream() as the final result.
LocalTransactionHandler	This TransactionHandler uses local JDBC transactions demarcated explicitly on the handle and passed through to be handled directly on the JDBC Connection instance.
MapArguments	Deprecated. use SqlStatement.bindMap(Map) instead
MapCollectors
MapEntryConfig<This>
MapEntryMapper<K,V>	Maps rows to Map.Entry<K, V>, provided there are mappers registered for types K and V.
MapEntryMappers	Configuration class for MapEntryMapper.
MapMapper	Yo dawg, I heard you like maps, so I made you a mapper that maps rows into Map<String,Object>.
MapMappers
Mappers	Configuration class for obtaining row or column mappers.
MappingException	Thrown when a mapper fails to map the row to a result type.
MessageFormatTemplateEngine	Deprecated. MessageFormat formats integers with decimal separators, e.g.
MetaData	Access to Database Metadata.
MetaData.MetaDataResultSetProvider
MetaData.MetaDataValueProvider<T>
NamedArgumentFinder	Returns an Argument based on a name.
Nested	Signals that the annotated element is a nested mapped type.
NoResultsException	Thrown when no results were found in a context that requires at least one.
NoSuchCollectorException	Thrown when Jdbi tries to produce a result Collector but doesn't have a factory to produce it with.
NoSuchExtensionException	Thrown when no ExtensionFactory accepts a given extension type.
NoSuchMapperException	Thrown when you attempt to map a type that Jdbi doesn't have a registered mapper factory for.
NoTemplateEngine	A TemplateEngine that does not do any templating but returns SQL verbatim.
NullArgument	A typed SQL null argument.
NVarchar	Argument qualifier annotation, indicating that the annotated String element should be bound as an NVARCHAR instead of a VARCHAR.
ObjectArgument	An Argument which uses setObject to support vendor specific types.
ObjectArgumentFactory	Argument factory that matches a specified type and binds it as an ObjectArgument.
ObjectFieldArguments	Deprecated. this functionality will remain supported, but this class should not be API
ObjectMethodArguments	Deprecated. this functionality will remain supported, but this class should not be API
OptionalCollectors	Factory methods for collectors of optional types.
OutParameters	Represents output from a Call (CallableStatement).
ParsedParameters	The parsed parameters from an SQL statement.
ParsedSql	The SQL and parameters parsed from an SQL statement.
ParsedSql.Builder	Fluent builder for ParsedSql instances.
PreparedBatch	Represents a prepared batch statement.
PropagateNull	Signals that the annotated property signals the presence of the mapped type: reflective mappers should map a null bean if this property is null, rather than a present bean with a null property value.
QualifiedArgumentFactory	Inspect a value with optional static qualified type information and produce an Argument that binds the value to a prepared statement.
QualifiedArgumentFactory.Preparable	QualifiedArgumentFactory extension interface that allows preparing arguments for efficient batch binding.
QualifiedColumnMapperFactory	Factory interface used to produce column mappers.
QualifiedType<T>	A Type qualified by a set of qualifier annotations.
Qualifier	Annotation used to identify type qualifying annotations.
Qualifiers	Utility class for type qualifiers supported by Jdbi core.
Query	Statement providing convenience result handling for SQL queries.
ReflectionMappers	Configuration class for reflective mappers.
ReflectionMapperUtil	Utilities for reflective mappers.
ResultBearing	Provides access to the contents of a ResultSet by mapping to Java types.
ResultIterable<T>	An Iterable of values, usually mapped from a ResultSet.
ResultIterable.ResultIteratorDelegate<T,R>	An implementation of ResultIterator that delegates calls to the iterator provided in the constructor.
ResultIterator<T>	Represents a forward-only iterator over a result set, which will lazily iterate the results.
ResultProducer<R>	Produces a result from an executed PreparedStatement.
ResultProducers	Commonly used ResultProducer implementations.
ResultProducers.ResultSetCreator
ResultSetAccumulator<T>	A ResultSetAccumulator repeatedly combines rows from the given ResultSet to produce a single result.
ResultSetException	Wraps exceptions thrown while traversing the JDBC result set.
ResultSetScanner<T>	Scan over rows of result sets, mapping and collecting the rows to a result type.
RollbackOnlyTransactionHandler	A transaction handler that always calls DelegatingTransactionHandler.rollback(org.jdbi.v3.core.Handle) instead of RollbackOnlyTransactionHandler.commit(org.jdbi.v3.core.Handle).
RowMapper<T>	Maps result set rows to objects.
RowMapperFactory	Factory interface used to produce row mappers.
RowMappers	Configuration registry for RowMapperFactory instances.
RowReducer<C,R>	Reduces row data from a ResultSet into a stream of result elements.
RowView	A RowView is an accessor for ResultSet that uses RowMapper or ColumnMapper to extract values.
RowViewMapper<T>	Higher level cousin of RowMapper that operates over RowViews rather than the bare ResultSet.
Script	Represents a number of SQL statements delimited by semicolon which will be executed in order in a batch statement.
SerializableTransactionRunner	A TransactionHandler that automatically retries transactions that fail due to serialization failures, which can generally be resolved by automatically retrying the transaction.
SerializableTransactionRunner.Configuration	Configuration for serializable transaction runner.
SetObjectArgumentFactory	Factory that uses PreparedStatement.setObject(int, Object, int) to bind values.
SimpleExtensionConfigurer	Configurer base class that applies the same configuration changes independent whether an annotation is placed on the type or a method.
SingleColumnMapper<T>	Adapts a ColumnMapper into a RowMapper by mapping a single column.
Slf4JSqlLogger	Simple SqlLogger that emits some diagnostic information about Jdbi usage.
SnakeCaseColumnNameMatcher	Matches snake case column names to java camel case names, ignoring case.
Sql	An immutable sql statement string created from multiple tokens in order to write inline sql statements in an easy-to-read fashion spread out over multiple lines of code.
SqlArrayArgumentFactory	Bind a Java array or Collection to a SQL array using the SqlArrayTypeFactory for the given type information.
SqlArrayArgumentStrategy	Strategies used to bind SQL array arguments to a PreparedStatement.
SqlArrayMapperFactory	Maps SQL array columns into Java arrays or other Java container types.
SqlArrayType<T>	Strategy for converting elements of array-like arguments into SQL array elements.
SqlArrayTypeFactory	Factory interface to produce SqlArrayType instances.
SqlArrayTypes	Configuration class for SQL array binding and mapping.
SqlLogger	SqlLoggers receive query data before and after a query is executed, and after an exception is thrown by a bad query.
SqlParser	Parses the named parameters out of an SQL statement, and returns the ParsedSql containing the JDBC-ready SQL statement, along with the type of parameters used (named or positional), the number, and the parameter name for each position (if applicable).
SqlStatement<This extends SqlStatement<This>>	This class provides the common functions between Query and Update.
SqlStatements	Configuration holder for SqlStatements.
StatementBuilder	Used to convert translated SQL into a prepared statement.
StatementBuilderFactory	Used to specify how prepared statements are built.
StatementContext	The statement context provides access to statement-local configuration.
StatementContextListener	Listener interface for the StatementContext.
StatementCustomizer	Allows tweaking of statement behaviour.
StatementCustomizers	Some simple StatementCustomizers you might find handy.
StatementException	Superclass for exceptions thrown while trying to execute a statement.
StatementExceptions	Configuration for StatementException and subclasses behavior.
StatementExceptions.MessageRendering	Control exception message generation.
StreamCallback<T,R,X extends Exception>	Callback for use with ResultIterable.withStream(StreamCallback)
StreamConsumer<T,X extends Exception>	Callback for use with ResultIterable.useStream(StreamConsumer)
TemplateEngine	Renders an SQL statement from a template.
TemplateEngine.Parsing
TimingCollector	Deprecated. Use SqlLogger instead.
TransactionException	Thrown when there's a problem manipulating the transaction isolation level.
TransactionHandler	Interface which defines callbacks to be used when transaction methods are called on a handle.
TransactionIsolationLevel	Supported transaction isolation levels.
UnableToCreateExtensionException	Marks that a specific extension could not be created.
UnableToCreateStatementException	Thrown when Jdbi couldn't create a statement.
UnableToExecuteStatementException	Thrown when statement execution fails.
UnableToManipulateTransactionIsolationLevelException	Thrown when Jdbi isn't able to change the transaction isolation level.
UnableToProduceResultException	Wraps exceptions thrown while producing Java result types.
UnableToRestoreAutoCommitStateException	Thrown after a transaction finishes if we can't reset its isolation level.
UnableToRetrieveMetaDataException	Thrown when Jdbi couldn't retrieve metadata from the connection.
Update	Used for INSERT, UPDATE, and DELETE statements
UseExtensionConfigurer	Meta-Annotation used to identify annotations that modify configuration in the context of an extension object or method.
UseExtensionHandler	Meta-Annotation used to map a method to an extension handler.
UseExtensionHandlerCustomizer	Meta-Annotation used to identify extension method decorating annotations.