jdbi3 documentation 3.31.0 API
Packages
Package
Description
The 'core' package hosts the top level interface into jdbi core.
The
argument classes translate Java types into JDBC parameters.
The
array package binds Java arrays and collections to SQL arrays, and
handles mapping array result types back to Java arrays and collections.
The
collector package reduces the mapped rows of the result set
into a Stream Collector to produce the final aggregated result.
The
config classes define a configuration registry starting from
each Jdbi instance.
The
extension classes allow you to extend Jdbi's
functionality by declaring interface types that may attach to Handle
instances.
The
generic package holds utility methods and helper
types for reflectively working with Java generic types.
The
h2 package adds vendor support for the H2 embeddable pure Java database implementation.Utility classes used internally by Jdbi.
locator instances inspect text given to Jdbi and
provide lookup of the actual SQL to execute.mappers take the JDBC ResultSet and produce Java results.mapper.reflect provides RowMappers that reflectively
construct result types using techniques like constructor injection
or JavaBeans setters.result provides the streaming interface that reads rows from JDBC
and drives the mapper and collector processes to
produce results.
The
spi package includes entrypoints to extending Jdbi
instances with your own custom functionality.
The
statement package provides most of the Fluent API
to drive statement execution.
The
transaction package implements the strategy
Jdbi uses to open and close transactions.freemarker provides advanced string template processing.guava provides extra types that are commonly needed beyond built
in JDK types.Google Guice integration.Internal classes for the Guice integration, do not use directly outside Jdbi.
joda-time provides improved date and time types to pre-Java 8 applications.
The
jpa plugin provides minimal support for discovering JPA
annotations like Column.
The
postgres plugin provides improved support for
java.time, hstore, uuid, and enum
types when configured with a recent Postgres database server.
The
sqlite plugin provides improved support for
java.net.URL.SQL Objects
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.
The
sqlobject.customizer package provides annotations
that customize the execution of a statement.sqlobject.locator inspects the declared SqlObject and determines
the statement text to pass off to core.locator for final
resolution of the statement text.
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.sqlobject.transaction annotations declaratively create transactions
wrapping a SqlObject method.stringtemplate4 provides advanced string template processing
that Jdbi can drive with the statement's bound parameters
and context to drive statement generation that may need to bind
variable number of parameters or other advanced use cases.JUnit 4 testing support.
JUnit 5 testing support.
vavr is a functional programming library for the JVM.