Uses of Annotation Type
org.jdbi.v3.meta.Beta
Package
Description
The 'core' package hosts the top level interface into jdbi core.
The
argument
classes translate Java types into JDBC parameters.
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.mapper
s take the JDBC ResultSet and produce Java results.
The
statement
package provides most of the Fluent API
to drive statement execution.
The
postgres
plugin provides improved support for
java.time
, hstore
, uuid
, and enum
types when configured with a recent Postgres database server.SQL Objects
The
sqlobject.customizer
package provides annotations
that customize the execution of a statement.-
Uses of Beta in org.jdbi.v3.core
Modifier and TypeClassDescriptionfinal class
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.Modifier and TypeMethodDescriptionHandle.afterCommit
(Runnable afterCommit) Execute an action the next time this Handle commits, unless it is rolled back first.Handle.afterRollback
(Runnable afterRollback) Execute an action the next time this Handle rolls back, unless it is committed first. -
Uses of Beta in org.jdbi.v3.core.annotation
Modifier and TypeClassDescription@interface
Configure reflective bean and pojo mapping to skip a property. -
Uses of Beta in org.jdbi.v3.core.argument
Modifier and TypeInterfaceDescriptionstatic interface
ArgumentFactory extension interface that allows preparing arguments for efficient batch binding.static interface
QualifiedArgumentFactory extension interface that allows preparing arguments for efficient batch binding.class
Factory that usesPreparedStatement.setObject(int, Object, int)
to bind values.Modifier and TypeMethodDescriptiondefault Collection<String>
NamedArgumentFinder.getNames()
Returns the names this named argument finder can find.Arguments.prepareFor
(QualifiedType<?> type) Obtain a prepared argument function for given type in the given context. -
Uses of Beta in org.jdbi.v3.core.config
Modifier and TypeInterfaceDescriptioninterface
JdbiCache<K,
V> Simple cache interface.final class
Hold metadata caches which maps various JVM constants into pre-parsed forms. -
Uses of Beta in org.jdbi.v3.core.enums
-
Uses of Beta in org.jdbi.v3.core.extension
Modifier and TypeMethodDescriptionboolean
Extensions.isAllowProxy()
Returns whether Proxy classes are allowed to be used.void
Extensions.onCreateProxy()
Throw if proxy creation is disallowed.Extensions.setAllowProxy
(boolean allowProxy) Allow usingProxy
to implement extensions. -
Uses of Beta in org.jdbi.v3.core.mapper
Modifier and TypeClassDescriptionenum
Strategies for comparing case sensitive strings.class
Factory for a RowMapper that can map resultset rows to column name/generic valueMap
s.class
Factory that usesResultSet.getObject(int, Class)
to fetch values.class
@interface
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.interface
Modifier and TypeMethodDescriptionMapMappers.getCaseChange()
GenericMapMapperFactory.getMapperForValueType
(Class<T> valueType, ConfigRegistry config) GenericMapMapperFactory.getMapperForValueType
(GenericType<T> valueType, ConfigRegistry config) MapMappers.setCaseChange
(UnaryOperator<String> caseChange) -
Uses of Beta in org.jdbi.v3.core.mapper.freebuilder
Modifier and TypeClassDescriptionclass
Configures support for an FreeBuilder generatedBuilder)
value type. -
Uses of Beta in org.jdbi.v3.core.mapper.immutables
Modifier and TypeClassDescriptionclass
-
Uses of Beta in org.jdbi.v3.core.statement
Modifier and TypeClassDescriptionclass
Configuration forStatementException
and subclasses behavior.static interface
Modifier and TypeMethodDescriptionBinds named parameters from object properties on the argument.Binds named parameters from object properties on the argument.SqlStatement.bindPojo
(Object pojo, GenericType<?> type) Binds named parameters from object properties on the argument.Binds named parameters from object properties on the bean argument, with the given prefix.Binds named parameters from object properties on the bean argument, with the given prefix.SqlStatement.bindPojo
(String prefix, Object pojo, GenericType<?> type) Binds named parameters from object properties on the bean argument, with the given prefix.SqlStatement.defineNamedBindings()
Define all bound arguments that don't already have a definition with a boolean indicating their presence.SqlStatements.getQueryTimeout()
default Optional<Function<StatementContext,
String>> TemplateEngine.parse
(String template, ConfigRegistry config) Parse a SQL template and return a parsed representation ready to apply to a statement.SqlStatements.setQueryTimeout
(Integer seconds) Jdbi does not implement its own timeout mechanism: it simply callsStatement.setQueryTimeout(int)
, leaving timeout handling to your jdbc driver.SqlStatements.setTemplateCache
(com.github.benmanes.caffeine.cache.Caffeine<Object, Object> caffeineSpec) Sets the Caffeine cache used to avoid repeatedly parsing SQL statements.ModifierConstructorDescriptionColonPrefixSqlParser
(com.github.benmanes.caffeine.cache.Caffeine<Object, Object> cache) HashPrefixSqlParser
(com.github.benmanes.caffeine.cache.Caffeine<Object, Object> cache) -
Uses of Beta in org.jdbi.v3.postgres
-
Uses of Beta in org.jdbi.v3.sqlobject
Modifier and TypeClassDescription@interface
Decorate a SqlObject type to instruct thejdbi3-generator
annotation processor to create a compiled implementation.Modifier and TypeMethodDescriptiondefault void
Handler.warm
(ConfigRegistry config) Called after the method handler is constructed to pre-initialize any important configuration data structures. -
Uses of Beta in org.jdbi.v3.sqlobject.customizer
Modifier and TypeClassDescription@interface
Defines all bound arguments that don't already have a definition.Modifier and TypeMethodDescriptiondefault void
SqlStatementCustomizer.warm
(ConfigRegistry config) Called after the customizer is instantiated but before any statement is available, to pre-initialize any configuration data structures.default void
SqlStatementParameterCustomizer.warm
(ConfigRegistry config) Called after the customizer is instantiated but before any statement is available, to pre-initialize any configuration data structures.