Index

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractArgumentFactory<T> - Class in org.jdbi.v3.core.argument

An ArgumentFactory base class for arguments of type T.

AbstractJdbiConfigurationModule - Class in org.jdbi.v3.guice

Base module class for element configuration modules.

AbstractJdbiConfigurationModule() - Constructor for class org.jdbi.v3.guice.AbstractJdbiConfigurationModule

Creates an element configuration module.

AbstractJdbiConfigurationModule(Class<? extends Annotation>) - Constructor for class org.jdbi.v3.guice.AbstractJdbiConfigurationModule

Creates an element configuration module with a custom annotation.

AbstractJdbiDefinitionModule - Class in org.jdbi.v3.guice

Base module class to define Jdbi instances.

AbstractJdbiDefinitionModule(Annotation) - Constructor for class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Create a Jdbi definition module.

AbstractJdbiDefinitionModule(Annotation, Class<? extends Annotation>) - Constructor for class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Create a Jdbi definition module with a custom annotation for element configuration.

AbstractJdbiDefinitionModule(Class<? extends Annotation>) - Constructor for class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Create a Jdbi definition module.

AbstractJdbiDefinitionModule(Class<? extends Annotation>, Class<? extends Annotation>) - Constructor for class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Create a Jdbi definition module with a custom annotation for element configuration.

AbstractJdbiExecutor - Class in org.jdbi.v3.core.async

AbstractJdbiExecutor() - Constructor for class org.jdbi.v3.core.async.AbstractJdbiExecutor

AbstractSeparatorCharColumnNameMatcher - Class in org.jdbi.v3.core.mapper.reflect

accepts(Class<?>) - Method in interface org.jdbi.v3.core.extension.ExtensionFactory

Returns true if the factory can process the given extension type.

accepts(Class<?>) - Method in class org.jdbi.v3.sqlobject.SqlObjectFactory

accepts(Class<?>, Method) - Method in interface org.jdbi.v3.core.extension.ExtensionHandlerFactory

Determines whether the factory can create an ExtensionHandler for combination of extension type and method.

accepts(Class<?>, Method) - Method in interface org.jdbi.v3.sqlobject.HandlerFactory

Deprecated.

accepts(Type) - Method in class org.jdbi.v3.core.collector.BuiltInCollectorFactory

Deprecated.

accepts(Type) - Method in interface org.jdbi.v3.core.collector.CollectorFactory

Accept a Type as a collector.

AccessibleObjectStrategy - Enum in org.jdbi.v3.core.mapper.reflect

accumulate(C, RowView) - Method in interface org.jdbi.v3.core.result.RowReducer

Accumulate data from the current row into the result container.

adapt(ConfigRegistry, ArgumentFactory) - Static method in interface org.jdbi.v3.core.argument.QualifiedArgumentFactory

Adapts an ArgumentFactory into a QualifiedArgumentFactory.

adapt(ConfigRegistry, ArgumentFactory.Preparable) - Static method in interface org.jdbi.v3.core.argument.QualifiedArgumentFactory

Adapts an ArgumentFactory.Preparable into a QualifiedArgumentFactory.Preparable.

adapt(ConfigRegistry, ArgumentFactory.Preparable) - Static method in interface org.jdbi.v3.core.argument.QualifiedArgumentFactory.Preparable

Adapts an ArgumentFactory.Preparable into a QualifiedArgumentFactory.Preparable The returned factory only matches qualified types with zero qualifiers.

adapt(ColumnMapperFactory) - Static method in interface org.jdbi.v3.core.mapper.QualifiedColumnMapperFactory

Adapts a ColumnMapperFactory into a QualifiedColumnMapperFactory.

add() - Method in class org.jdbi.v3.core.statement.PreparedBatch

Add the current binding as a saved batch and clear the binding.

add(Object...) - Method in class org.jdbi.v3.core.statement.PreparedBatch

Bind arguments positionally, add the binding as a saved batch, and then clear the current binding.

add(String) - Method in class org.jdbi.v3.core.statement.Batch

Add a statement to the batch

add(Map<String, ?>) - Method in class org.jdbi.v3.core.statement.PreparedBatch

Bind arguments from a Map, add the binding as a saved batch, then clear the current binding.

addCleanable(Cleanable) - Method in class org.jdbi.v3.core.Handle

Registers a Cleanable to be invoked when the handle is closed.

addCleanable(Cleanable) - Method in class org.jdbi.v3.core.statement.StatementContext

Registers a Cleanable to be invoked when the statement context is closed.

addCodec(Type, Codec<?>) - Method in class org.jdbi.v3.core.codec.CodecFactory.Builder

Add a codec for a Type.

addCodec(GenericType<?>, Codec<?>) - Method in class org.jdbi.v3.core.codec.CodecFactory.Builder

Add a codec for a GenericType.

addCodec(QualifiedType<?>, Codec<?>) - Method in class org.jdbi.v3.core.codec.CodecFactory.Builder

Add a codec for a QualifiedType.

addConfigCustomizerFactory(ConfigCustomizerFactory) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Adds an ConfigCustomizerFactory that will be used to find configuration customizers when the ExtensionMetadata.Builder.build()} method is called.

addContextListener(StatementContextListener) - Method in class org.jdbi.v3.core.statement.SqlStatements

addCustomizer(StatementCustomizer) - Method in interface org.jdbi.v3.core.config.Configurable

addCustomizer(StatementCustomizer) - Method in class org.jdbi.v3.core.statement.SqlStatements

Provides a means for custom statement modification.

addExtensionHandlerCustomizer(ExtensionHandlerCustomizer) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Adds an ExtensionHandlerCustomizer that will be used to customize extension handlers when the ExtensionMetadata.Builder.build()} method is called.

addExtensionHandlerFactory(ExtensionHandlerFactory) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Adds an ExtensionHandlerFactory that will be used to find extension handlers when the ExtensionMetadata.Builder.build()} method is called.

addFirst(JdbiInterceptor<S, T>) - Method in class org.jdbi.v3.core.interceptor.JdbiInterceptionChainHolder

Registers a new interceptor at the beginning of the chain.

addHandleListener(HandleListener) - Method in class org.jdbi.v3.core.Handle

Add a specific HandleListener which is called for specific events for this Handle.

addInstanceConfigCustomizer(ConfigCustomizer) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Add an instance specific configuration customizer.

addLast(JdbiInterceptor<S, T>) - Method in class org.jdbi.v3.core.interceptor.JdbiInterceptionChainHolder

Registers a new interceptor at the end of the chain.

addListener(HandleListener) - Method in class org.jdbi.v3.core.Handles

Add a HandleListener which is called for specific events.

addMethodConfigCustomizer(Method, ConfigCustomizer) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Add a method specific configuration customizer.

addMethodHandler(Method, ExtensionHandler) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Adds a new extension handler for a method.

addNamed(String, Object) - Method in class org.jdbi.v3.core.statement.Binding

Bind a named parameter for the given name.

addNamed(String, Object, QualifiedType<?>) - Method in class org.jdbi.v3.core.statement.Binding

Bind a named parameter for the given name.

addNamed(String, Argument) - Method in class org.jdbi.v3.core.statement.Binding

Bind a named parameter for the given name.

addNamedArgumentFinder(NamedArgumentFinder) - Method in class org.jdbi.v3.core.statement.Binding

Bind a named argument finder.

addPositional(int, Object) - Method in class org.jdbi.v3.core.statement.Binding

Bind a positional parameter at the given index (0-based).

addPositional(int, Object, QualifiedType<?>) - Method in class org.jdbi.v3.core.statement.Binding

Bind a positional parameter at the given index (0-based).

addPositional(int, Argument) - Method in class org.jdbi.v3.core.statement.Binding

Bind a positional parameter at the given index (0-based).

addPropertyNamePrefix(String, String) - Static method in class org.jdbi.v3.core.mapper.reflect.ReflectionMapperUtil

Add a prefix separated with '.' to a java bean property name.

after() - Method in class org.jdbi.v3.testing.JdbiRule

afterAll(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

afterAll(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiPostgresExtension

afterCommit(Runnable) - Method in class org.jdbi.v3.core.Handle

Execute an action the next time this Handle commits, unless it is rolled back first.

afterEach(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

afterEach(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiPostgresExtension

afterExecution(PreparedStatement, StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementCustomizer

This will be invoked after execution of the prepared statement, but before any results are accessed.

afterPropertiesSet() - Method in class org.jdbi.v3.spring5.JdbiFactoryBean

Verifies that a dataSource has been set

afterRollback(Runnable) - Method in class org.jdbi.v3.core.Handle

Execute an action the next time this Handle rolls back, unless it is committed first.

allowNoResults(boolean) - Method in class org.jdbi.v3.core.result.ResultProducers

Normally a query that doesn't return a result set throws an exception.

AllowUnusedBindings - Annotation Type in org.jdbi.v3.sqlobject.customizer

Suppresses error when bindings are created but never used in the query.

Alpha - Annotation Type in org.jdbi.v3.meta

Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release.

AnnotationSqlLocator - Class in org.jdbi.v3.sqlobject.locator

Locates SQL on the SQL method annotations like @SqlQuery("foo").

AnnotationSqlLocator() - Constructor for class org.jdbi.v3.sqlobject.locator.AnnotationSqlLocator

anyColumnsStartWithPrefix(Collection<String>, String, List<ColumnNameMatcher>) - Static method in class org.jdbi.v3.core.mapper.reflect.ReflectionMapperUtil

Returns whether any of the given column names begin with the given prefix, according to the list of column name matchers.

append(String) - Method in class org.jdbi.v3.core.statement.ParsedSql.Builder

Appends the given SQL fragment to the SQL string.

appendNamedParameter(String) - Method in class org.jdbi.v3.core.statement.ParsedSql.Builder

Records a named parameter with the given name, and appends a ? to the SQL string.

appendPositionalParameter() - Method in class org.jdbi.v3.core.statement.ParsedSql.Builder

Records a positional parameters, and appends a ? to the SQL string.

apply(int, PreparedStatement, StatementContext) - Method in interface org.jdbi.v3.core.argument.Argument

Apply the argument to the given prepared statement.

apply(int, PreparedStatement, StatementContext) - Method in class org.jdbi.v3.core.argument.CharacterStreamArgument

apply(int, PreparedStatement, StatementContext) - Method in class org.jdbi.v3.core.argument.InputStreamArgument

apply(int, PreparedStatement, StatementContext) - Method in class org.jdbi.v3.core.argument.NullArgument

apply(int, PreparedStatement, StatementContext) - Method in class org.jdbi.v3.core.argument.ObjectArgument

apply(SqlStatement<?>) - Method in interface org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizer

Invoked to customize the sql statement

apply(SqlStatement<?>, Object) - Method in interface org.jdbi.v3.sqlobject.customizer.SqlStatementParameterCustomizer

Applies the customization to the SQL statement using the argument passed to the method.

apply(StatementException) - Method in enum org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

apply(T, ResultSet, StatementContext) - Method in interface org.jdbi.v3.core.result.ResultSetAccumulator

Extract a single row from the result set, and combine it with the accumulator to produce a result.

applyDecorators(Handler, Class<?>, Method) - Method in class org.jdbi.v3.sqlobject.HandlerDecorators

Deprecated.

Applies all registered decorators to the given handler

Argument - Interface in org.jdbi.v3.core.argument

Represents an argument to a prepared statement.

ArgumentFactory - Interface in org.jdbi.v3.core.argument

Inspect a value with optional static type information and produce an Argument that binds the value to a prepared statement.

ArgumentFactory.Preparable - Interface in org.jdbi.v3.core.argument

ArgumentFactory extension interface that allows preparing arguments for efficient batch binding.

Arguments - Class in org.jdbi.v3.core.argument

A registry for ArgumentFactory instances.

Arguments(ConfigRegistry) - Constructor for class org.jdbi.v3.core.argument.Arguments

arrayType(Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Returns the element type for an Array Type.

asCallback() - Method in interface org.jdbi.v3.core.HandleConsumer

asCallback() - Method in interface org.jdbi.v3.sqlobject.transaction.TransactionalConsumer

attach(Class<E>, HandleSupplier) - Method in interface org.jdbi.v3.core.extension.ExtensionFactory

Attaches an extension type.

attach(Class<T>) - Method in class org.jdbi.v3.core.Handle

Create a Jdbi extension object of the specified type bound to this handle.

attach(Class<T>) - Method in class org.jdbi.v3.testing.JdbiRule

Attach an extension (such as a SqlObject) to the managed handle.

attach(Class<T>) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Convenience method to attach an extension (such as a SqlObject) to the shared handle.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.Batch

Registers with the handle for cleaning when the handle is closed.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.Call

Registers with the handle for cleaning when the handle is closed.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.MetaData

Registers with the handle for cleaning when the handle is closed.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.PreparedBatch

Registers with the handle for cleaning when the handle is closed.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.Query

Registers with the handle for cleaning when the handle is closed.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.Script

Registers with the handle for cleaning when the handle is closed.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.SqlStatement

Registers with the handle for cleaning when the handle is closed.

attachToHandleForCleanup() - Method in class org.jdbi.v3.core.statement.Update

Registers with the handle for cleaning when the handle is closed.

B

Batch - Class in org.jdbi.v3.core.statement

Represents a group of non-prepared statements to be sent to the RDMBS in one "request".

Batch(Handle) - Constructor for class org.jdbi.v3.core.statement.Batch

BatchChunkSize - Annotation Type in org.jdbi.v3.sqlobject.statement

Used to control the batch chunk size for sql batch operations.

BatchResultBearing - Class in org.jdbi.v3.core.result

Extends the ResultBearing class to provide access to the per-batch row modification counts.

BatchResultBearing(ResultBearing, Supplier<int[]>) - Constructor for class org.jdbi.v3.core.result.BatchResultBearing

BatchResultIterable<T> - Interface in org.jdbi.v3.core.result

Extend the ResultIterable for batch operations.

BeanMapper<T> - Class in org.jdbi.v3.core.mapper.reflect

A row mapper which maps the columns in a statement into a JavaBean.

BeanPropertyArguments - Class in org.jdbi.v3.core.argument

Deprecated.

this should never have been public API

BeanPropertyArguments(String, Object) - Constructor for class org.jdbi.v3.core.argument.BeanPropertyArguments

Deprecated.

BeanPropertyArguments(String, Object, ConfigRegistry) - Constructor for class org.jdbi.v3.core.argument.BeanPropertyArguments

Deprecated.

before() - Method in class org.jdbi.v3.testing.JdbiRule

before() - Static method in class org.jdbi.v3.testing.Migration

Create new Migration.

beforeAll(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

beforeAll(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiPostgresExtension

beforeBinding(PreparedStatement, StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementCustomizer

Invoked prior to applying bound parameters to the PreparedStatement.

beforeEach(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

beforeEach(ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiPostgresExtension

beforeExecution(PreparedStatement, StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementCustomizer

Make the changes you need to inside this method.

beforeTemplating(PreparedStatement, StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementCustomizer

Invoked prior to using the TemplateEngine to render sql from definitions.

begin() - Method in class org.jdbi.v3.core.Handle

Start a transaction.

begin() - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Begins a transaction.

begin(Handle) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

Called when a transaction is started

begin(Handle) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

begin(Handle) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

begin(Handle) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Begin a transaction.

Beta - Annotation Type in org.jdbi.v3.meta

Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release.

between(char, char) - Static method in class org.jdbi.v3.commonstext.StringSubstitutorTemplateEngine

between(char, char, char) - Static method in class org.jdbi.v3.commonstext.StringSubstitutorTemplateEngine

between(String, String) - Static method in class org.jdbi.v3.commonstext.StringSubstitutorTemplateEngine

between(String, String, char) - Static method in class org.jdbi.v3.commonstext.StringSubstitutorTemplateEngine

bind() - Element in annotation type org.jdbi.v3.core.annotation.JdbiProperty

Returns true if the property is bound as an argument.

bind(int, boolean) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, byte) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, byte[]) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, char) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, double) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, float) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, long) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, short) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Reader, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Boolean) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Byte) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Character) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Double) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Float) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Integer) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Long) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Short) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, String) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, BigDecimal) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, URI) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, URL) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Blob) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Clob) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Date) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Time) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Timestamp) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Date) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, UUID) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bind(int, Argument) - Method in class org.jdbi.v3.core.statement.SqlStatement

Used if you need to have some exotic parameter bound.

bind(String, boolean) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, byte) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, byte[]) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, char) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, double) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, float) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, long) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, short) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Reader, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Boolean) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Byte) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Character) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Double) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Float) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Integer) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Long) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Short) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, String) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, BigDecimal) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, URI) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, URL) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Blob) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Clob) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Date) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Time) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Timestamp) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Date) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, UUID) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bind(String, Argument) - Method in class org.jdbi.v3.core.statement.SqlStatement

Used if you need to have some exotic parameter bound.

Bind - Annotation Type in org.jdbi.v3.sqlobject.customizer

Binds the annotated argument as a named parameter, and as a positional parameter.

bindArray(int, Type, Iterable<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an Iterable as a SQL array.

bindArray(int, Type, Object...) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a Java array as a SQL array, casting each element to a new type.

bindArray(int, Type, Iterator<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an Iterator as a SQL array.

bindArray(int, T...) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a Java array as a SQL array.

bindArray(String, Type, Iterable<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an Iterable as a SQL array.

bindArray(String, Type, Object...) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a Java array as a SQL array, casting each element to a new type.

bindArray(String, Type, Iterator<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an Iterator as a SQL array.

bindArray(String, T...) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a Java array as a SQL array.

bindArrayType(Class<?>) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a SQL array type.

bindASCIIStream(int, InputStream, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bindASCIIStream(String, InputStream, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bindBean(Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from JavaBean properties on the argument.

bindBean(String, Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from JavaBean properties on the bean argument, with the given prefix.

BindBean - Annotation Type in org.jdbi.v3.sqlobject.customizer

Binds the properties of a JavaBean to a SQL statement.

bindBeanList(String, List<?>, List<String>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a parameter for each value in the given list * number of property names, and defines an attribute as the comma-separated list of parameter references (using colon prefix).

BindBeanList - Annotation Type in org.jdbi.v3.sqlobject.customizer

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.

bindBinaryStream(int, InputStream, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument positionally

bindBinaryStream(String, InputStream, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument by name

bindBySqlType(int, Object, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a value using a specific type from java.sql.Types via PreparedStatement#setObject(int, Object, int)

bindBySqlType(String, Object, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a value using a specific type from java.sql.Types via PreparedStatement#setObject(int, Object, int)

bindByType(int, Object, Type) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument dynamically by the type passed in.

bindByType(int, Object, GenericType<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument dynamically by the generic type passed in.

bindByType(int, Object, QualifiedType<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument dynamically by the qualified type passed in.

bindByType(String, Object, Type) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument dynamically by the type passed in.

bindByType(String, Object, GenericType<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument dynamically by the generic type passed in.

bindByType(String, Object, QualifiedType<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind an argument dynamically by the type passed in.

bindCodec(Type) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a Codec using a Type.

bindCodec(GenericType<?>) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a Codec using a GenericType.

bindCodec(QualifiedType<?>) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a Codec using a QualifiedType.

bindColumnMapper() - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a ColumnMapper.

bindColumnMapper(Type) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a ColumnMapper using a Type.

bindColumnMapper(GenericType<?>) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a ColumnMapper using a GenericType.

bindColumnMapper(QualifiedType<?>) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a ColumnMapper using a QualifiedType.

bindCustomizer() - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a GuiceJdbiCustomizer.

bindFields(Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds public fields of the specified object as arguments for the query.

bindFields(String, Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds public fields of the specified object as arguments for the query.

BindFields - Annotation Type in org.jdbi.v3.sqlobject.customizer

Binds the properties and public fields of an object to a SQL statement.

binding() - Static method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

Binding - Class in org.jdbi.v3.core.statement

Represents the arguments bound to a particular statement.

BindJpa - Annotation Type in org.jdbi.v3.jpa

Bind a class based on the subset of JPA annotations we understand.

bindList(String, Iterable<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

see SqlStatement.bindList(BiConsumer, String, List)

bindList(String, Object...) - Method in class org.jdbi.v3.core.statement.SqlStatement

see SqlStatement.bindList(BiConsumer, String, List)

bindList(String, Iterator<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

see SqlStatement.bindList(BiConsumer, String, List)

bindList(BiConsumer<SqlStatement, String>, String, Iterable<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

see SqlStatement.bindList(BiConsumer, String, List)

bindList(BiConsumer<SqlStatement, String>, String, Object...) - Method in class org.jdbi.v3.core.statement.SqlStatement

see SqlStatement.bindList(BiConsumer, String, List)

bindList(BiConsumer<SqlStatement, String>, String, Iterator<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

see SqlStatement.bindList(BiConsumer, String, List)

bindList(BiConsumer<SqlStatement, String>, String, List<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a parameter for each value in the given list, and defines an attribute as the comma-separated list of parameter references (using colon prefix).

BindList - Annotation Type in org.jdbi.v3.sqlobject.customizer

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 - Enum in org.jdbi.v3.sqlobject.customizer

describes what needs to be done if the passed argument is null or empty

bindMap(Map<String, ?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from a map of String to Object instances

BindMap - Annotation Type in org.jdbi.v3.sqlobject.customizer

Binds the entries of a Map<String, Object> to a SQL statement.

bindMethods(Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds methods with no parameters on the argument.

bindMethods(String, Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds methods with no parameters on the argument, with the given prefix.

BindMethods - Annotation Type in org.jdbi.v3.sqlobject.customizer

bindMethodsList(String, Iterable<?>, List<String>) - Method in class org.jdbi.v3.core.statement.SqlStatement

For each value given, create a tuple by invoking each given method in order, and bind the tuple into a VALUES (...) format insert clause.

BindMethodsList - Annotation Type in org.jdbi.v3.sqlobject.customizer

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.

bindNamedArgumentFinder(NamedArgumentFinder) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds a new NamedArgumentFinder.

bindNull(int, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind NULL to be set for a given argument.

bindNull(String, int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind NULL to be set for a given argument.

bindNVarchar(int, String) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a String argument positionally, as NVARCHAR type.

bindNVarchar(String, String) - Method in class org.jdbi.v3.core.statement.SqlStatement

Bind a String argument by name, as NVARCHAR type.

BindParameterCustomizerFactory - Class in org.jdbi.v3.sqlobject.statement

Standard implementation of ParameterCustomizerFactory that delegates to BindFactory.createForParameter(Annotation, Class, Method, Parameter, int, Type) passing null for Annotation parameter.

BindParameterCustomizerFactory() - Constructor for class org.jdbi.v3.sqlobject.statement.BindParameterCustomizerFactory

bindPlugin() - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a JdbiPlugin.

bindPojo(Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from object properties on the argument.

bindPojo(Object, Type) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from object properties on the argument.

bindPojo(Object, GenericType<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from object properties on the argument.

bindPojo(String, Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from object properties on the bean argument, with the given prefix.

bindPojo(String, Object, Type) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from object properties on the bean argument, with the given prefix.

bindPojo(String, Object, GenericType<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Binds named parameters from object properties on the bean argument, with the given prefix.

BindPojo - Annotation Type in org.jdbi.v3.sqlobject.customizer

Binds the properties of an object to a SQL statement.

bindRowMapper() - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a RowMapper.

bindRowMapper(Type) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a RowMapper using a Type.

bindRowMapper(GenericType<?>) - Method in interface org.jdbi.v3.guice.JdbiBinder

Creates a new binding for a RowMapper using a GenericType.

BLANK - Enum constant in enum org.jdbi.v3.core.statement.EmptyHandling

Render nothing in the query.

box(Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Perform boxing conversion on a Type, if it is a primitive type.

build() - Method in class org.jdbi.v3.cache.caffeine.CaffeineCacheBuilder

build() - Method in class org.jdbi.v3.cache.noop.NoopCacheBuilder

build() - Method in interface org.jdbi.v3.core.cache.JdbiCacheBuilder

Creates an cache instance from the values in the builder.

build() - Method in class org.jdbi.v3.core.codec.CodecFactory.Builder

build() - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Creates a new ExtensionMetadata object.

build() - Method in class org.jdbi.v3.core.statement.ParsedSql.Builder

Returns the finalized ParsedSql object.

build(Type) - Method in class org.jdbi.v3.core.collector.BuiltInCollectorFactory

Deprecated.

build(Type) - Method in interface org.jdbi.v3.core.collector.CollectorFactory

Creates a collector for a given container type.

build(Type, Object, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.AbstractArgumentFactory

build(Type, Object, ConfigRegistry) - Method in interface org.jdbi.v3.core.argument.ArgumentFactory

Returns an Argument for the given value if the factory supports it; empty otherwise.

build(Type, Object, ConfigRegistry) - Method in interface org.jdbi.v3.core.argument.ArgumentFactory.Preparable

build(Type, Object, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.BuiltInArgumentFactory

Deprecated.

build(Type, Object, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.DirectArgumentFactory

build(Type, Object, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.ObjectArgumentFactory

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.array.SqlArrayMapperFactory

build(Type, ConfigRegistry) - Method in interface org.jdbi.v3.core.array.SqlArrayTypeFactory

Returns an SqlArrayType for the given elementType if this factory supports it; empty otherwise.

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.BuiltInMapperFactory

Deprecated.

build(Type, ConfigRegistry) - Method in interface org.jdbi.v3.core.mapper.ColumnMapperFactory

Supplies a column mapper which will map columns to type if the factory supports it; empty otherwise.

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.EnumByNameMapperFactory

Deprecated.

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.EnumByOrdinalMapperFactory

Deprecated.

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.GenericMapMapperFactory

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.GetObjectColumnMapperFactory

build(Type, ConfigRegistry) - Method in interface org.jdbi.v3.core.mapper.RowMapperFactory

Supplies a row mapper which will map result set rows to type if the factory supports it; empty otherwise.

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.jpa.JpaMapperFactory

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.postgres.DurationColumnMapperFactory

build(Type, ConfigRegistry) - Method in class org.jdbi.v3.postgres.PeriodColumnMapperFactory

build(Duration, ConfigRegistry) - Method in class org.jdbi.v3.postgres.DurationArgumentFactory

build(Period, ConfigRegistry) - Method in class org.jdbi.v3.postgres.PeriodArgumentFactory

build(QualifiedType<?>, Object, ConfigRegistry) - Method in interface org.jdbi.v3.core.argument.QualifiedArgumentFactory

Returns an Argument for the given value if the factory supports it; empty otherwise.

build(QualifiedType<?>, Object, ConfigRegistry) - Method in class org.jdbi.v3.core.codec.CodecFactory

build(QualifiedType<?>, ConfigRegistry) - Method in class org.jdbi.v3.core.codec.CodecFactory

build(QualifiedType<?>, ConfigRegistry) - Method in interface org.jdbi.v3.core.mapper.QualifiedColumnMapperFactory

Supplies a column mapper which will map columns to type if the factory supports it; empty otherwise.

builder() - Static method in class org.jdbi.v3.cache.noop.NoopCache

Returns a new JdbiCacheBuilder which can be used to construct the internal caches.

builder() - Static method in class org.jdbi.v3.core.codec.CodecFactory

Returns a builder for fluent API.

builder() - Static method in class org.jdbi.v3.core.statement.ParsedSql

Creates a new ParsedSql builder.

builder() - Static method in class org.jdbi.v3.guava.codec.TypeResolvingCodecFactory

Returns a builder for fluent API.

builder(Class<?>) - Static method in class org.jdbi.v3.core.extension.ExtensionMetadata

Returns a new ExtensionMetadata.Builder instance.

Builder(Function<Map<QualifiedType<?>, Codec<?>>, CodecFactory>) - Constructor for class org.jdbi.v3.core.codec.CodecFactory.Builder

buildExtensionMetadata(ExtensionMetadata.Builder) - Method in interface org.jdbi.v3.core.extension.ExtensionFactory

Receives the ExtensionMetadata.Builder when the ExtensionMetadata object for this extension is created.

buildExtensionMetadata(ExtensionMetadata.Builder) - Method in class org.jdbi.v3.sqlobject.SqlObjectFactory

buildHandler(Class<?>, Method) - Method in interface org.jdbi.v3.sqlobject.HandlerFactory

Deprecated.

Returns a Handler instance for executing the given SQL Object method.

buildWithLoader(JdbiCacheLoader<K, V>) - Method in class org.jdbi.v3.cache.caffeine.CaffeineCacheBuilder

buildWithLoader(JdbiCacheLoader<K, V>) - Method in class org.jdbi.v3.cache.noop.NoopCacheBuilder

buildWithLoader(JdbiCacheLoader<K, V>) - Method in interface org.jdbi.v3.core.cache.JdbiCacheBuilder

Creates an cache instance from the values in the builder and a supplied cache loader.

BuiltInArgumentFactory - Class in org.jdbi.v3.core.argument

Deprecated.

will be replaced by a plugin

BuiltInArgumentFactory() - Constructor for class org.jdbi.v3.core.argument.BuiltInArgumentFactory

Deprecated.

BuiltInCollectorFactory - Class in org.jdbi.v3.core.collector

Deprecated.

will be replaced by plugin

BuiltInCollectorFactory() - Constructor for class org.jdbi.v3.core.collector.BuiltInCollectorFactory

Deprecated.

BuiltInMapperFactory - Class in org.jdbi.v3.core.mapper

Deprecated.

will be replaced by an opt-out plugin to give the core no hardwired behavior

BuiltInMapperFactory() - Constructor for class org.jdbi.v3.core.mapper.BuiltInMapperFactory

Deprecated.

BY_NAME - Enum constant in enum org.jdbi.v3.core.enums.EnumStrategy

BY_ORDINAL - Enum constant in enum org.jdbi.v3.core.enums.EnumStrategy

byName(Class<E>) - Static method in class org.jdbi.v3.core.mapper.EnumMapper

Map database string values to enum names.

byOrdinal(Class<E>) - Static method in class org.jdbi.v3.core.mapper.EnumMapper

Map database integer values to enum ordinal values.

C

cacheSize() - Method in interface org.jdbi.v3.core.cache.JdbiCacheStats

Returns the current size of the cache.

cacheStats() - Method in class org.jdbi.v3.core.statement.CachingSqlParser

Returns cache statistics for the internal sql parser cache.

cacheStats() - Method in class org.jdbi.v3.core.statement.SqlStatements

Returns cache statistics for the internal template cache.

CachingSqlParser - Class in org.jdbi.v3.core.statement

CaffeineCache<K,V> - Class in org.jdbi.v3.cache.caffeine

Cache implementation using the caffeine cache library.

CaffeineCacheBuilder - Class in org.jdbi.v3.cache.caffeine

Cache builder using the caffeine caching library.

CaffeineCacheBuilder(Caffeine<Object, Object>) - Constructor for class org.jdbi.v3.cache.caffeine.CaffeineCacheBuilder

Wraps an existing Caffeine object for Jdbi internal use.

CaffeineCachePlugin - Class in org.jdbi.v3.cache.caffeine

Installing this plugin restores the up-to 3.36.0 behavior of using the Caffeine cache library for SQL statements and the colon prefix parser.

CaffeineCachePlugin() - Constructor for class org.jdbi.v3.cache.caffeine.CaffeineCachePlugin

CaffeineLoadingCache<K,V> - Class in org.jdbi.v3.cache.caffeine

Cache implementation using the caffeine cache library.

call(Runnable) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.ExtensionHandlerInvoker

Invoke a runnable in the extension context.

call(Callable<?>) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.ExtensionHandlerInvoker

Invoke a callable in the extension context.

Call - Class in org.jdbi.v3.core.statement

Used for invoking stored procedures.

Call(Handle, CharSequence) - Constructor for class org.jdbi.v3.core.statement.Call

Call(Handle, String) - Constructor for class org.jdbi.v3.core.statement.Call

Backwards compatible constructor that takes an explicit string argument.

CallableStatementMapper - Interface in org.jdbi.v3.core.statement

Map an OUT parameter in a callable statement to a result type.

CaseInsensitiveColumnNameMatcher - Class in org.jdbi.v3.core.mapper.reflect

Matches column names with identical java names, ignoring case.

CaseInsensitiveColumnNameMatcher() - Constructor for class org.jdbi.v3.core.mapper.reflect.CaseInsensitiveColumnNameMatcher

CaseStrategy - Enum in org.jdbi.v3.core.mapper

Strategies for comparing case sensitive strings.

CharacterStreamArgument - Class in org.jdbi.v3.core.argument

Bind a Reader as a character stream parameter.

CharacterStreamArgument(Reader, int) - Constructor for class org.jdbi.v3.core.argument.CharacterStreamArgument

charAt(int) - Method in class org.jdbi.v3.core.Sql

CharSequenceArgumentFactory - Class in org.jdbi.v3.core.argument

An ArgumentFactory for arguments that implement CharSequence.

CharSequenceArgumentFactory() - Constructor for class org.jdbi.v3.core.argument.CharSequenceArgumentFactory

checkPropagateNullAnnotation(Field) - Static method in class org.jdbi.v3.core.mapper.reflect.FieldMapper

ClasspathSqlLocator - Class in org.jdbi.v3.core.locator

Locates SQL in .sql files on the classpath.

clean() - Method in class org.jdbi.v3.core.Handle

Release any database resource that may be held by the handle.

Cleanable - Interface in org.jdbi.v3.core.statement

Cleans up some JDBC resource e.g.

cleanableAdded(StatementContext, Cleanable) - Method in interface org.jdbi.v3.core.statement.StatementContextListener

A Cleanable object was added to this context for cleanup when the context is cleaned.

cleanableRemoved(StatementContext, Cleanable) - Method in interface org.jdbi.v3.core.statement.StatementContextListener

A Cleanable object was removed from the context.

cleanAfter() - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Deprecated.

The default changed to true so this call actually does nothing.

cleanAfter() - Method in class org.jdbi.v3.testing.Migration

Will drop all objects in the configured schemas after tests using Flyway.

cleanAfter(boolean) - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Drop all objects in the configured schemas using Flyway after the test finishes.

cleanAfter(boolean) - Method in class org.jdbi.v3.testing.Migration

Controls whether to drop all objects in the configured schemas after running the tests using Flyway.

cleanup(DataSource, Handle) - Method in interface org.jdbi.v3.testing.junit5.JdbiExtensionInitializer

Run cleanup code after a test.

cleanup(DataSource, Handle) - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

cleanupHandleCommit() - Method in class org.jdbi.v3.core.statement.SqlStatement

Transfer ownership of the handle to the statement: when the statement is closed, commit the handle's transaction (if one exists) and close the handle.

cleanupHandleRollback() - Method in class org.jdbi.v3.core.statement.SqlStatement

When the statement is closed, roll it back then close the owning Handle.

clear() - Method in class org.jdbi.v3.core.statement.Binding

Remove all bindings from this Binding.

close() - Method in interface org.jdbi.v3.core.extension.HandleSupplier

close() - Method in class org.jdbi.v3.core.Handle

Closes the handle, its connection, and any other database resources it is holding.

close() - Method in class org.jdbi.v3.core.result.ResultIterable.ResultIteratorDelegate

close() - Method in interface org.jdbi.v3.core.result.ResultIterator

Close the underlying result set.

close() - Method in class org.jdbi.v3.core.statement.Batch

close() - Method in class org.jdbi.v3.core.statement.Call

close() - Method in class org.jdbi.v3.core.statement.MetaData

close() - Method in class org.jdbi.v3.core.statement.PreparedBatch

close() - Method in class org.jdbi.v3.core.statement.Query

close() - Method in class org.jdbi.v3.core.statement.Script

close() - Method in class org.jdbi.v3.core.statement.SqlStatement

close() - Method in class org.jdbi.v3.core.statement.Update

close() - Method in interface org.jdbi.v3.core.statement.Cleanable

close() - Method in class org.jdbi.v3.core.statement.StatementContext

close(Connection) - Method in interface org.jdbi.v3.core.statement.StatementBuilder

Is called when the Handle, to which this StatementBuilder is attached to, is closed.

close(Connection, String, Statement) - Method in class org.jdbi.v3.core.statement.DefaultStatementBuilder

Called to close an individual prepared statement created from this builder.

close(Connection, String, Statement) - Method in interface org.jdbi.v3.core.statement.StatementBuilder

Called to close an individual statement created from this builder.

closeAndSuppress(Throwable) - Method in interface org.jdbi.v3.core.statement.Cleanable

Cleans the underlying resource and appends possible exceptions to the given Throwable.

closeConnection(Connection) - Method in interface org.jdbi.v3.core.ConnectionFactory

Closes a connection.

closeConnection(Connection) - Method in class org.jdbi.v3.spring5.SpringConnectionFactory

CloseException - Exception Class in org.jdbi.v3.core

Thrown when an exception occurs while attempting to close a database resource.

CloseException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.CloseException

closeIfNeeded(Handle) - Static method in class org.jdbi.v3.spring5.JdbiUtil

Close a handle if it is not transactionally bound, otherwise no-op

CMTTransactionHandler - Class in org.jdbi.v3.core.transaction

Handler designed to behave properly in a J2EE CMT environment.

CMTTransactionHandler() - Constructor for class org.jdbi.v3.core.transaction.CMTTransactionHandler

Codec<T> - Interface in org.jdbi.v3.core.codec

A Codec provides a convenient way for a bidirectional mapping of an attribute to a database column.

CodecFactory - Class in org.jdbi.v3.core.codec

CodecFactory provides column mappers and arguments for bidirectional mapping types to database columns.

CodecFactory(Map<QualifiedType<?>, Codec<?>>) - Constructor for class org.jdbi.v3.core.codec.CodecFactory

Create a new CodecFactory.

CodecFactory.Builder - Class in org.jdbi.v3.core.codec

Fluent Builder for CodecFactory.

collect(long, StatementContext) - Method in interface org.jdbi.v3.core.statement.TimingCollector

Deprecated.

Use SqlLogger.logAfterExecution(org.jdbi.v3.core.statement.StatementContext) instead.

collect(Collector<? super T, ?, R>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Collect the results into a container specified by a collector.

collectInto(Class<R>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

collectInto(Class<R>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Collect the results into a container of the given type.

collectInto(Type) - Method in class org.jdbi.v3.core.result.BatchResultBearing

collectInto(Type) - Method in interface org.jdbi.v3.core.result.ResultBearing

Collect the results into a container of the given type.

collectInto(Type) - Method in interface org.jdbi.v3.core.result.ResultIterable

Collect the results into a container type.

collectInto(GenericType<R>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

collectInto(GenericType<R>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Collect the results into a container of the given generic type.

collectInto(GenericType<R>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Collect the results into a collection type.

collectIntoList() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns results in a List.

collectIntoSet() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns results in a Set.

collectorFactory(Type, Collector<?, ?, ?>) - Static method in interface org.jdbi.v3.core.collector.CollectorFactory

Creates a CollectorFactory from a container type and a collector.

collectorFactory(GenericType<?>, Collector<?, ?, ?>) - Static method in interface org.jdbi.v3.core.collector.CollectorFactory

Creates a CollectorFactory from a parameterized container type and a collector.

CollectorFactory - Interface in org.jdbi.v3.core.collector

Factory for building Collectors to assemble containers of elements.

collectRows(Collector<RowView, A, R>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

collectRows(Collector<RowView, A, R>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Collect the results using the given collector.

collectToMap(Function<? super T, ? extends K>, Function<? super T, ? extends V>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Collect the results into a Map, using the given functions to compute keys and values.

ColonPrefixSqlParser - Class in org.jdbi.v3.core.statement

SQL parser which recognizes named parameter tokens of the form :tokenName

ColonPrefixSqlParser() - Constructor for class org.jdbi.v3.core.statement.ColonPrefixSqlParser

ColonPrefixSqlParser(JdbiCacheBuilder) - Constructor for class org.jdbi.v3.core.statement.ColonPrefixSqlParser

ColumnMapper<T> - Interface in org.jdbi.v3.core.mapper

Maps result set columns to objects.

ColumnMapperFactory - Interface in org.jdbi.v3.core.mapper

Factory interface used to produce column mappers.

ColumnMappers - Class in org.jdbi.v3.core.mapper

Configuration registry for ColumnMapperFactory instances.

ColumnMappers() - Constructor for class org.jdbi.v3.core.mapper.ColumnMappers

ColumnName - Annotation Type in org.jdbi.v3.core.mapper.reflect

Specify the mapping name for a property or parameter explicitly.

ColumnNameMatcher - Interface in org.jdbi.v3.core.mapper.reflect

Strategy for matching SQL column names to Java property, field, or parameter names.

columnNameMatches(String, String) - Method in class org.jdbi.v3.core.mapper.reflect.AbstractSeparatorCharColumnNameMatcher

columnNameMatches(String, String) - Method in class org.jdbi.v3.core.mapper.reflect.CaseInsensitiveColumnNameMatcher

columnNameMatches(String, String) - Method in interface org.jdbi.v3.core.mapper.reflect.ColumnNameMatcher

Returns whether the column name fits the given Java identifier name.

columnNameStartsWith(String, String) - Method in class org.jdbi.v3.core.mapper.reflect.AbstractSeparatorCharColumnNameMatcher

columnNameStartsWith(String, String) - Method in class org.jdbi.v3.core.mapper.reflect.CaseInsensitiveColumnNameMatcher

columnNameStartsWith(String, String) - Method in interface org.jdbi.v3.core.mapper.reflect.ColumnNameMatcher

Return whether the column name starts with the given prefix, according to the matching strategy of this ColumnNameMatcher.

commit() - Method in class org.jdbi.v3.core.Handle

Commit a transaction.

commit() - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Commits the open transaction.

commit(Handle) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

Called when a transaction is committed

commit(Handle) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

commit(Handle) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

commit(Handle) - Method in class org.jdbi.v3.core.transaction.RollbackOnlyTransactionHandler

commit(Handle) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Commit the transaction.

concurrentUpdatable() - Method in class org.jdbi.v3.core.statement.Query

Specify that the result set should be concurrent updatable.

ConfigCustomizer - Interface in org.jdbi.v3.core.config

Customizes a given ConfigRegistry.

ConfigCustomizerFactory - Interface in org.jdbi.v3.core.extension

Factory interface to create collections of ConfigCustomizer instances.

ConfigRegistry - Class in org.jdbi.v3.core.config

A registry of JdbiConfig instances by type.

ConfigRegistry() - Constructor for class org.jdbi.v3.core.config.ConfigRegistry

Creates a new config registry.

Configurable<This> - Interface in org.jdbi.v3.core.config

A type with access to access and modify arbitrary Jdbi configuration.

Configuration() - Constructor for class org.jdbi.v3.core.transaction.SerializableTransactionRunner.Configuration

configure(Class<C>, Consumer<C>) - Method in interface org.jdbi.v3.core.config.Configurable

Passes the configuration object of the given type to the configurer, then returns this object.

configure(ConfigRegistry, Annotation, Class<?>) - Method in class org.jdbi.v3.core.extension.SimpleExtensionConfigurer

Updates configuration for the given annotation on an extension type.

configureForMethod(ConfigRegistry, Annotation, Class<?>, Method) - Method in interface org.jdbi.v3.core.extension.ExtensionConfigurer

Configures the config for the given annotation on a extension type method.

configureForMethod(ConfigRegistry, Annotation, Class<?>, Method) - Method in class org.jdbi.v3.core.extension.SimpleExtensionConfigurer

configureForType(ConfigRegistry, Annotation, Class<?>) - Method in interface org.jdbi.v3.core.extension.ExtensionConfigurer

Updates configuration for the given annotation on an extension type.

configureForType(ConfigRegistry, Annotation, Class<?>) - Method in class org.jdbi.v3.core.extension.SimpleExtensionConfigurer

configureJdbi() - Method in class org.jdbi.v3.guice.AbstractJdbiConfigurationModule

Override this method to create bindings that will be used in Jdbi definition modules.

configureJdbi() - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Override this method to configure all aspects of a Jdbi instance.

Configurer - Interface in org.jdbi.v3.sqlobject.config

Deprecated.

Use ExtensionConfigurer directly.

ConfiguringAnnotation - Annotation Type in org.jdbi.v3.sqlobject.config

Deprecated.

Use UseExtensionConfigurer.

ConfiguringPlugin<C> - Class in org.jdbi.v3.core.config

ConnectionException - Exception Class in org.jdbi.v3.core

ConnectionException(Throwable) - Constructor for exception class org.jdbi.v3.core.ConnectionException

ConnectionFactory - Interface in org.jdbi.v3.core

Supplies Connection instances to a created Handle and allows custom close handling.

ConstructorMapper<T> - Class in org.jdbi.v3.core.mapper.reflect

A row mapper which maps the fields in a result set into a constructor.

container() - Method in interface org.jdbi.v3.core.result.LinkedHashMapRowReducer

container() - Method in interface org.jdbi.v3.core.result.RowReducer

Returns a new, empty result container.

contextCleaned(StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementContextListener

A StatementContext object was cleaned.

contextCreated(StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementContextListener

A new StatementContext is created.

convertArrayElement(T) - Method in interface org.jdbi.v3.core.array.SqlArrayType

Returns an equivalent value in a type supported by the JDBC vendor.

convertKeys() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindMap

Whether to automatically convert map keys to strings.

create() - Static method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Return a new ClasspathSqlLocator that returns SQL without modifying it.

create(Class<?>) - Static method in class org.jdbi.v3.core.argument.ObjectArgumentFactory

Match the given type and bind as an object without SQL type information.

create(Class<?>, Integer) - Static method in class org.jdbi.v3.core.argument.ObjectArgumentFactory

Match the given type and bind as an object with the given SQL type information

create(String) - Static method in class org.jdbi.v3.core.Jdbi

Creates a new Jdbi instance from a database URL.

create(String, String, String) - Static method in class org.jdbi.v3.core.Jdbi

Creates a new Jdbi instance from a database URL.

create(String, Properties) - Static method in class org.jdbi.v3.core.Jdbi

Creates a new Jdbi instance from a database URL.

create(Connection) - Static method in class org.jdbi.v3.core.Jdbi

Creates a new Jdbi object from a Connection.

create(Connection, String, StatementContext) - Method in class org.jdbi.v3.core.statement.DefaultStatementBuilder

Create a new DefaultStatementBuilder which will always create a new PreparedStatement from the Connection

create(Connection, String, StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementBuilder

Called each time a prepared statement needs to be created.

create(Connection, StatementContext) - Method in class org.jdbi.v3.core.statement.DefaultStatementBuilder

create(Connection, StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementBuilder

Called each time a statement needs to be created.

create(DataSource) - Static method in class org.jdbi.v3.core.Jdbi

Creates a new Jdbi object from a DataSource.

create(K) - Method in interface org.jdbi.v3.core.cache.JdbiCacheLoader

Create a new value for caching from a cache key.

create(ConnectionFactory) - Static method in class org.jdbi.v3.core.Jdbi

Factory used to allow for obtaining a Connection in a customized manner.

create(Jdbi, Executor) - Static method in interface org.jdbi.v3.core.async.JdbiExecutor

Create a JdbiExecutor.

createBatch() - Method in class org.jdbi.v3.core.Handle

Create a non-prepared (no bound parameters, but different SQL) batch statement.

createCall(CharSequence) - Method in class org.jdbi.v3.core.Handle

Create a call to a stored procedure.

createCall(String) - Method in class org.jdbi.v3.core.Handle

Create a call to a stored procedure.

createCall(Connection, String, StatementContext) - Method in class org.jdbi.v3.core.statement.DefaultStatementBuilder

Called each time a Callable statement needs to be created

createCall(Connection, String, StatementContext) - Method in interface org.jdbi.v3.core.statement.StatementBuilder

Called each time a Callable statement needs to be created.

createCopy() - Method in class org.jdbi.v3.core.argument.Arguments

createCopy() - Method in class org.jdbi.v3.core.array.SqlArrayTypes

createCopy() - Method in class org.jdbi.v3.core.collector.JdbiCollectors

createCopy() - Method in class org.jdbi.v3.core.config.ConfigRegistry

Returns a copy of this config registry.

createCopy() - Method in interface org.jdbi.v3.core.config.JdbiConfig

Returns a copy of this configuration object.

createCopy() - Method in class org.jdbi.v3.core.enums.Enums

createCopy() - Method in class org.jdbi.v3.core.extension.Extensions

createCopy() - Method in class org.jdbi.v3.core.Handles

createCopy() - Method in class org.jdbi.v3.core.mapper.ColumnMappers

createCopy() - Method in class org.jdbi.v3.core.mapper.freebuilder.JdbiFreeBuilders

createCopy() - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

createCopy() - Method in class org.jdbi.v3.core.mapper.MapEntryMappers

createCopy() - Method in class org.jdbi.v3.core.mapper.MapMappers

createCopy() - Method in class org.jdbi.v3.core.mapper.Mappers

createCopy() - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

createCopy() - Method in class org.jdbi.v3.core.mapper.RowMappers

createCopy() - Method in class org.jdbi.v3.core.qualifier.Qualifiers

createCopy() - Method in class org.jdbi.v3.core.result.ResultProducers

createCopy() - Method in class org.jdbi.v3.core.statement.SqlStatements

createCopy() - Method in class org.jdbi.v3.core.statement.StatementExceptions

createCopy() - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner.Configuration

createCopy() - Method in class org.jdbi.v3.freemarker.FreemarkerConfig

createCopy() - Method in class org.jdbi.v3.gson2.Gson2Config

createCopy() - Method in class org.jdbi.v3.jackson2.Jackson2Config

createCopy() - Method in class org.jdbi.v3.json.JsonConfig

createCopy() - Method in class org.jdbi.v3.moshi.MoshiConfig

createCopy() - Method in class org.jdbi.v3.postgres.PostgresTypes

createCopy() - Method in class org.jdbi.v3.sqlobject.customizer.TimestampedConfig

createCopy() - Method in class org.jdbi.v3.sqlobject.HandlerDecorators

Deprecated.

createCopy() - Method in class org.jdbi.v3.sqlobject.Handlers

Deprecated.

createCopy() - Method in class org.jdbi.v3.sqlobject.SqlObjects

createCopy() - Method in class org.jdbi.v3.stringtemplate4.StringTemplates

createCopy() - Method in class org.jdbi.v3.vavr.TupleMappers

createExtensionHandler(Class<?>, Method) - Method in interface org.jdbi.v3.core.extension.ExtensionHandlerFactory

Returns an ExtensionHandler instance for a extension type and method combination.

createExtensionHandler(Class<?>, Method) - Method in interface org.jdbi.v3.sqlobject.HandlerFactory

Deprecated.

createExtensionHandlerInvoker(E, Method, HandleSupplier, ConfigRegistry) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata

Creates an ExtensionMetadata.ExtensionHandlerInvoker instance for a specific method.

createForMethod(Annotation, Class<?>, Method) - Method in interface org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizerFactory

Used to create customizers for annotations on methods.

createForMethod(Method) - Static method in interface org.jdbi.v3.core.extension.ExtensionHandler

Create an extension handler and bind it to a method that will be called on the target object when invoked.

createForMethodHandle(MethodHandle) - Static method in interface org.jdbi.v3.core.extension.ExtensionHandler

Create an extension handler and bind it to a MethodHandle instance.

createForParameter(Annotation, Class<?>, Method, Parameter, int, Type) - Method in interface org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizerFactory

Used to create customizers for annotations on parameters

createForParameter(Class<?>, Method, Parameter, int, Type) - Method in class org.jdbi.v3.sqlobject.statement.BindParameterCustomizerFactory

createForParameter(Class<?>, Method, Parameter, int, Type) - Method in interface org.jdbi.v3.sqlobject.statement.ParameterCustomizerFactory

Creates parameter customizer used to bind sql statement parameters when parameter is not explicitly annotated

createForSpecialMethod(Method) - Static method in interface org.jdbi.v3.core.extension.ExtensionHandler

Create an extension handler and bind it to a special method that will be called on the target object when invoked.

createForType(Annotation, Class<?>) - Method in interface org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizerFactory

Used to create customizers for annotations on sql object interfaces

createInstanceConfiguration(ConfigRegistry) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata

Create an instance specific configuration based on all instance customizers.

createKey(TypeLiteral<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Creates a Key object for a TypeLiteral that uses the annotation or annotation class used to construct this module.

createKey(Class<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Creates a Key object for a class that uses the annotation or annotation class used to construct this module.

createLob() - Method in interface org.jdbi.v3.postgres.PgLobApi

createLocator() - Method in class org.jdbi.v3.freemarker.FreemarkerConfig

createMethodConfiguration(Method, ConfigRegistry) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata

Create an method specific configuration based on all method customizers.

createQuery(CharSequence) - Method in class org.jdbi.v3.core.Handle

Return a Query instance that executes a statement with bound parameters and maps the result set into Java types.

createQuery(String) - Method in class org.jdbi.v3.core.Handle

Return a Query instance that executes a statement with bound parameters and maps the result set into Java types.

createResultBearing(Supplier<PreparedStatement>, ResultProducers.ResultSetCreator, StatementContext) - Static method in class org.jdbi.v3.core.result.ResultProducers

Create a ResultBearing instance backed by a ResultSet.

createResultSet(Statement) - Method in interface org.jdbi.v3.core.result.ResultProducers.ResultSetCreator

Use the supplied statement to create a ResultSet.

createScript(CharSequence) - Method in class org.jdbi.v3.core.Handle

Creates a Script from the given SQL script.

createScript(String) - Method in class org.jdbi.v3.core.Handle

Create an Insert or Update statement which returns the number of rows modified.

CreateSqlObject - Annotation Type in org.jdbi.v3.sqlobject

Use this annotation on a sql object method to create a new sql object with the same underlying handle as the sql object the method is invoked on.

createStatementBuilder(Connection) - Method in interface org.jdbi.v3.core.statement.StatementBuilderFactory

Creates a new StatementBuilder from a Connection object.

createUpdate(CharSequence) - Method in class org.jdbi.v3.core.Handle

Create an Insert or Update statement which returns the number of rows modified.

createUpdate(String) - Method in class org.jdbi.v3.core.Handle

Create an Insert or Update statement which returns the number of rows modified.

customize(Consumer<EmbeddedPostgres.Builder>) - Method in class org.jdbi.v3.testing.junit5.JdbiOtjPostgresExtension

Deprecated.

customize(ConfigRegistry) - Method in interface org.jdbi.v3.core.config.ConfigCustomizer

Manipulates the ConfigRegistry object.

customize(ExtensionHandler, Class<?>, Method) - Method in interface org.jdbi.v3.core.extension.ExtensionHandlerCustomizer

Customize an extension handler.

customize(ExtensionHandler, Class<?>, Method) - Method in interface org.jdbi.v3.sqlobject.HandlerDecorator

Deprecated.

customize(Jdbi) - Method in interface org.jdbi.v3.guice.GuiceJdbiCustomizer

Customize the Jdbi instance passed in.

customizeConnection(Connection) - Method in interface org.jdbi.v3.core.spi.JdbiPlugin

Configure customizations for a newly acquired Connection.

customizeHandle(Handle) - Method in interface org.jdbi.v3.core.spi.JdbiPlugin

Configure customizations for a new Handle instance.

customizeHandle(Handle) - Method in class org.jdbi.v3.postgres.PostgresPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.cache.caffeine.CaffeineCachePlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.cache.noop.NoopCachePlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.core.config.ConfiguringPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.core.h2.H2DatabasePlugin

customizeJdbi(Jdbi) - Method in interface org.jdbi.v3.core.spi.JdbiPlugin

Configure customizations global to any object managed by this Jdbi.

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.gson2.Gson2Plugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.guava.GuavaPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.jackson2.Jackson2Plugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.jodatime2.JodaTimePlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.jpa.JpaPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.json.JsonPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.moshi.MoshiPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.postgis.PostgisPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.postgres.PostgresPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.sqlite3.SQLitePlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.sqlobject.SqlObjectPlugin

customizeJdbi(Jdbi) - Method in class org.jdbi.v3.vavr.VavrPlugin

D

DatabaseValue - Annotation Type in org.jdbi.v3.core.enums

Map a value from the database column directly onto an enum value.

DateTimeArgumentFactory - Class in org.jdbi.v3.jodatime2

Bind a DateTime as a Timestamp.

DateTimeArgumentFactory() - Constructor for class org.jdbi.v3.jodatime2.DateTimeArgumentFactory

DateTimeMapper - Class in org.jdbi.v3.jodatime2

Map a Timestamp to a DateTime.

DateTimeMapper() - Constructor for class org.jdbi.v3.jodatime2.DateTimeMapper

decorate(HandleCallback<R, X>) - Method in interface org.jdbi.v3.core.HandleCallbackDecorator

Decorate the given HandleCallback instance.

decorateHandler(Handler, Class<?>, Method) - Method in interface org.jdbi.v3.sqlobject.HandlerDecorator

Deprecated.

Decorates the Handler to add or substitute behavior on the given SQL Object method.

DecoratorOrder - Annotation Type in org.jdbi.v3.sqlobject

Deprecated.

Use UseExtensionHandlerCustomizer to mark annotations and ExtensionHandlerCustomizationOrder instead.

Default Methods - Search tag in package org.jdbi.v3.sqlobject

Section

DefaultStatementBuilder - Class in org.jdbi.v3.core.statement

A StatementBuilder which will always create a new PreparedStatement.

DefaultStatementBuilder() - Constructor for class org.jdbi.v3.core.statement.DefaultStatementBuilder

define(String, Object) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(SqlStatements.class).define(key, value)

define(String, Object) - Method in class org.jdbi.v3.core.statement.SqlStatements

Define an attribute for StatementContext for statements executed by Jdbi.

define(String, Object) - Method in class org.jdbi.v3.core.statement.StatementContext

Define an attribute for in this context.

define(SqlStatement, String) - Method in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Deprecated.

legacy internal API

Define - Annotation Type in org.jdbi.v3.sqlobject.customizer

Defines a named attribute as the argument passed to the annotated parameter.

DEFINE_NULL - Enum constant in enum org.jdbi.v3.core.statement.EmptyHandling

Define a null value, leaving the result up to the TemplateEngine to decide.

DefinedAttributeTemplateEngine - Class in org.jdbi.v3.core.statement

Template engine which replaces angle-bracketed tokens like <name> with the string value of the named attribute.

DefinedAttributeTemplateEngine() - Constructor for class org.jdbi.v3.core.statement.DefinedAttributeTemplateEngine

defineList(String, Object...) - Method in class org.jdbi.v3.core.statement.SqlStatement

Define an attribute as the comma-separated String from the elements of the values argument.

defineList(String, List<?>) - Method in class org.jdbi.v3.core.statement.SqlStatement

Define an attribute as the comma-separated String from the elements of the values argument.

DefineList - Annotation Type in org.jdbi.v3.sqlobject.customizer

Defines a named attribute as a comma-separated String from the elements of the annotated array or List argument.

defineMap(Map<String, ?>) - Method in class org.jdbi.v3.core.statement.SqlStatements

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

defineNamedBindings() - Method in class org.jdbi.v3.core.statement.SqlStatement

Define all bound arguments that don't already have a definition with a boolean indicating their presence.

DefineNamedBindings - Annotation Type in org.jdbi.v3.sqlobject.customizer

Defines all bound arguments that don't already have a definition.

DelegatingTransactionHandler - Class in org.jdbi.v3.core.transaction

Simple delegating subclass that just invokes its delegate.

DelegatingTransactionHandler(TransactionHandler) - Constructor for class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

deleteLob(long) - Method in interface org.jdbi.v3.postgres.PgLobApi

DETAIL - Enum constant in enum org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

Include all detail.

DirectArgumentFactory - Class in org.jdbi.v3.core.argument

DirectArgumentFactory() - Constructor for class org.jdbi.v3.core.argument.DirectArgumentFactory

disableAccessibleObjectStrategy() - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Set the strategy Jdbi uses for Java accessibility rules to a no-op.

DO_NOT_MAKE_ACCESSIBLE - Enum constant in enum org.jdbi.v3.core.mapper.reflect.AccessibleObjectStrategy

Do not make non-public methods and constructors accessible.

DONT_USE_PROXY - Enum constant in enum org.jdbi.v3.core.extension.ExtensionFactory.FactoryFlag

Do not wrap the backing object methods into ExtensionHandler instances and return a Proxy instance but return it as is.

DurationArgumentFactory - Class in org.jdbi.v3.postgres

Postgres version of argument factory for Duration.

DurationArgumentFactory() - Constructor for class org.jdbi.v3.postgres.DurationArgumentFactory

DurationColumnMapperFactory - Class in org.jdbi.v3.postgres

A column mapper which maps Postgres's PGInterval type to Java's Duration.

DurationColumnMapperFactory() - Constructor for class org.jdbi.v3.postgres.DurationColumnMapperFactory

E

elementType(Type) - Method in class org.jdbi.v3.core.collector.BuiltInCollectorFactory

Deprecated.

elementType(Type) - Method in interface org.jdbi.v3.core.collector.CollectorFactory

Returns the element type for a given container type.

ElementTypeNotFoundException - Exception Class in org.jdbi.v3.core.collector

Thrown when Jdbi tries to build a Collector, but cannot determine the element type intended for it.

ElementTypeNotFoundException(String) - Constructor for exception class org.jdbi.v3.core.collector.ElementTypeNotFoundException

ElementTypeNotFoundException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.collector.ElementTypeNotFoundException

ElementTypeNotFoundException(Throwable) - Constructor for exception class org.jdbi.v3.core.collector.ElementTypeNotFoundException

embeddedPostgres() - Static method in class org.jdbi.v3.testing.JdbiRule

Create a JdbiRule with an embedded PostgreSQL instance.

embeddedPostgres(Consumer<EmbeddedPostgres.Builder>) - Static method in class org.jdbi.v3.testing.JdbiRule

Create a JdbiRule with an embedded PostgreSQL instance.

EmptyHandling - Enum in org.jdbi.v3.core.statement

describes what should be done if the value passed to SqlStatement.bindList(java.lang.String, java.lang.Object...) is null or empty

enableLeakChecker(boolean) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Enable tracking of cleanable resources and handles when running tests.

EncodedJson - Annotation Type in org.jdbi.v3.json

Type qualifying annotation for pre-encoded json data.

EntityMemberAccessException - Exception Class in org.jdbi.v3.jpa

Thrown when a JPA getter or setter fails.

EntityMemberAccessException(String) - Constructor for exception class org.jdbi.v3.jpa.EntityMemberAccessException

EntityMemberAccessException(String, Throwable) - Constructor for exception class org.jdbi.v3.jpa.EntityMemberAccessException

EntityMemberAccessException(Throwable) - Constructor for exception class org.jdbi.v3.jpa.EntityMemberAccessException

EnumByName - Annotation Type in org.jdbi.v3.core.enums

Specifies that an Enum value should be bound or mapped as its Enum.name().

EnumByNameMapperFactory - Class in org.jdbi.v3.core.mapper

Deprecated.

Use getConfig(Enums.class).setEnumStrategy(BY_NAME) instead.

EnumByNameMapperFactory() - Constructor for class org.jdbi.v3.core.mapper.EnumByNameMapperFactory

Deprecated.

EnumByOrdinal - Annotation Type in org.jdbi.v3.core.enums

Specifies that an Enum value should be bound or mapped as its Enum.ordinal().

EnumByOrdinalMapperFactory - Class in org.jdbi.v3.core.mapper

Deprecated.

Use getConfig(Enums.class).setEnumStrategy(BY_ORDINAL) instead.

EnumByOrdinalMapperFactory() - Constructor for class org.jdbi.v3.core.mapper.EnumByOrdinalMapperFactory

Deprecated.

EnumMapper<E> - Class in org.jdbi.v3.core.mapper

Column mapper for Java enum types.

Enums - Class in org.jdbi.v3.core.enums

Configuration for behavior related to Enums.

Enums() - Constructor for class org.jdbi.v3.core.enums.Enums

EnumStrategy - Enum in org.jdbi.v3.core.enums

equals(Object) - Method in class org.jdbi.v3.core.Handle

equals(Object) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

equals(Object) - Method in class org.jdbi.v3.core.spi.JdbiPlugin.Singleton

equals(Object) - Method in class org.jdbi.v3.core.Sql

equals(Object) - Method in class org.jdbi.v3.core.statement.Batch

equals(Object) - Method in class org.jdbi.v3.core.statement.Call

equals(Object) - Method in class org.jdbi.v3.core.statement.MetaData

equals(Object) - Method in class org.jdbi.v3.core.statement.PreparedBatch

equals(Object) - Method in class org.jdbi.v3.core.statement.Query

equals(Object) - Method in class org.jdbi.v3.core.statement.Script

equals(Object) - Method in class org.jdbi.v3.core.statement.SqlStatement

equals(Object) - Method in class org.jdbi.v3.core.statement.Update

equals(Object) - Method in class org.jdbi.v3.core.statement.ParsedParameters

equals(Object) - Method in class org.jdbi.v3.core.statement.ParsedSql

equals(Object) - Method in class org.jdbi.v3.core.statement.StatementContext

EQUALS_HANDLER - Static variable in interface org.jdbi.v3.core.extension.ExtensionHandler

Implementation for the Object.equals(Object) method.

escape() - Element in annotation type org.jdbi.v3.commonstext.UseStringSubstitutorTemplateEngine

execute() - Method in class org.jdbi.v3.core.statement.Batch

Execute the batch and return the number of rows affected for each batch part.

execute() - Method in class org.jdbi.v3.core.statement.MetaData

execute() - Method in class org.jdbi.v3.core.statement.PreparedBatch

Execute the batch and return the number of rows affected for each batch part.

execute() - Method in class org.jdbi.v3.core.statement.Script

Execute this script in a batch statement

execute() - Method in class org.jdbi.v3.core.statement.Update

Executes the statement, returning the update count.

execute(CharSequence, Object...) - Method in class org.jdbi.v3.core.Handle

Execute a SQL statement, and return the number of rows affected by the statement.

execute(String, Object...) - Method in class org.jdbi.v3.core.Handle

Execute a SQL statement, and return the number of rows affected by the statement.

execute(ResultProducer<R>) - Method in class org.jdbi.v3.core.statement.PreparedBatch

Executes the batch, returning the result obtained from the given ResultProducer.

execute(ResultProducer<R>) - Method in class org.jdbi.v3.core.statement.Query

Executes the query, returning the result obtained from the given ResultProducer.

execute(ResultProducer<R>) - Method in class org.jdbi.v3.core.statement.Update

Executes the update, returning the result obtained from the given ResultProducer.

executeAndGetModCount() - Method in class org.jdbi.v3.core.statement.PreparedBatch

Execute the batch and return the mod counts as in execute, but as a Jdbi result iterator instead of an array.

executeAndReturnGeneratedKeys(String...) - Method in class org.jdbi.v3.core.statement.PreparedBatch

Deprecated.

Use PreparedBatch.executePreparedBatch(String...) which has the same functionality but also returns the per-batch modified row counts.

executeAndReturnGeneratedKeys(String...) - Method in class org.jdbi.v3.core.statement.Update

Execute the statement and returns any auto-generated keys.

executeAsSeparateStatements() - Method in class org.jdbi.v3.core.statement.Script

Execute this script as a set of separate statements

executePreparedBatch(String...) - Method in class org.jdbi.v3.core.statement.PreparedBatch

Execute the batch and give access to any generated keys returned by the operation.

exposeBinding(TypeLiteral<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Exposes a binding that is in module scope (without annotations) and binds it using either the annotation or annotation class and then exposes it outside the module.

exposeBinding(Class<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Exposes a binding that is in module scope (without annotations) and binds it using either the annotation or annotation class and then exposes it outside the module.

EXTENSION_ID - Static variable in class org.jdbi.v3.sqlobject.SqlObjectFactory

ExtensionCallback<R,E,X> - Interface in org.jdbi.v3.core.extension

Callback for use with Jdbi.withExtension(java.lang.Class<E>, org.jdbi.v3.core.extension.ExtensionCallback<R, E, X>).

ExtensionConfigurer - Interface in org.jdbi.v3.core.extension

Configures ConfigRegistry instances.

ExtensionConsumer<E,X> - Interface in org.jdbi.v3.core.extension

Callback for use with Jdbi.withExtension(java.lang.Class<E>, org.jdbi.v3.core.extension.ExtensionCallback<R, E, X>).

ExtensionContext - Class in org.jdbi.v3.core.extension

Accepted by a handle when executing extension code.

ExtensionContext(ConfigRegistry, ExtensionMethod) - Constructor for class org.jdbi.v3.core.extension.ExtensionContext

ExtensionFactory - Interface in org.jdbi.v3.core.extension

Factory interface used to produce Jdbi extension objects.

ExtensionFactory.FactoryFlag - Enum in org.jdbi.v3.core.extension

Flags that the factory can return to control aspects of the extension framework.

ExtensionHandler - Interface in org.jdbi.v3.core.extension

Provides functionality for a single method on an extension object.

ExtensionHandlerCustomizationOrder - Annotation Type in org.jdbi.v3.core.extension.annotation

Determines the order in which extension method decorators are invoked.

ExtensionHandlerCustomizer - Interface in org.jdbi.v3.core.extension

Supports customization of an extension handler.

ExtensionHandlerFactory - Interface in org.jdbi.v3.core.extension

A factory to create ExtensionHandler instances.

ExtensionMetadata - Class in org.jdbi.v3.core.extension

Metadata that was detected when analyzing an extension class before attaching.

ExtensionMetadata.Builder - Class in org.jdbi.v3.core.extension

Builder class for the ExtensionMetadata object.

ExtensionMetadata.ExtensionHandlerInvoker - Class in org.jdbi.v3.core.extension

Wraps all config customizers and the handler for a specific method execution.

ExtensionMethod - Class in org.jdbi.v3.core.extension

Holder for a Class and a Method that together define which extension method was invoked.

ExtensionMethod(Class<?>, Method) - Constructor for class org.jdbi.v3.core.extension.ExtensionMethod

Creates a new extension method.

Extensions - Class in org.jdbi.v3.core.extension

Configuration class for defining Jdbi extensions via ExtensionFactory instances.

Extensions() - Constructor for class org.jdbi.v3.core.extension.Extensions

Creates a new instance.

extensionType() - Method in class org.jdbi.v3.core.extension.ExtensionMetadata

externalPostgres(String, Integer, String, String, String) - Static method in class org.jdbi.v3.testing.JdbiRule

Create a JdbiRule using an external PostgreSQL instance.

externalPostgres(String, Integer, String, String, String) - Static method in class org.jdbi.v3.testing.junit5.JdbiExtension

Creates an extension that uses an external (outside the scope of an unit test class) postgres database.

F

factory() - Static method in class org.jdbi.v3.guava.GuavaArguments

Returns an ArgumentFactory which understands Guava types.

factory() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a CollectorFactory which knows how to create all supported Guava types.

factory(Class<?>) - Static method in class org.jdbi.v3.core.mapper.reflect.BeanMapper

Returns a mapper factory that maps to the given bean class

factory(Class<?>) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Use the only declared constructor to map a class.

factory(Class<?>) - Static method in class org.jdbi.v3.core.mapper.reflect.FieldMapper

Returns a mapper factory that maps to the given bean class

factory(Class<?>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.BeanMapper

Returns a mapper factory that maps to the given bean class

factory(Class<?>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Use the only declared constructor to map a class.

factory(Class<?>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.FieldMapper

Returns a mapper factory that maps to the given bean class

factory(Constructor<?>) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Use a Constructor<T> to map its declaring type.

factory(Constructor<?>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Use a Constructor<T> to map its declaring type.

FACTORY - Static variable in class org.jdbi.v3.core.statement.DefaultStatementBuilder

failFast() - Method in class org.jdbi.v3.core.extension.Extensions

Fail fast if any method in an Extension object is misconfigured and can not be warmed.

fetchSize(int) - Static method in class org.jdbi.v3.core.statement.StatementCustomizers

Set the number of rows to fetch from the database in a single batch.

FetchSize - Annotation Type in org.jdbi.v3.sqlobject.customizer

Specify batch size to fetch resulting rows in.

FieldMapper<T> - Class in org.jdbi.v3.core.mapper.reflect

A row mapper which maps the columns in a statement into an object, using reflection to set fields on the object.

filter(Predicate<? super T>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Convenience method to filter the ResultIterable by applying the specified Predicate.
This method has the look and feel of Stream.filter(Predicate) without making use of streams.

find(String, StatementContext) - Method in class org.jdbi.v3.core.argument.MapArguments

Deprecated.

find(String, StatementContext) - Method in interface org.jdbi.v3.core.argument.NamedArgumentFinder

findArgumentFor(Type, Object) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain an argument for given value in this context

findArgumentFor(QualifiedType<?>, Object) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain an argument for given value in this context

findCollectorFor(Type) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a collector for the given type.

findColumnIndex(String, List<String>, List<ColumnNameMatcher>, Supplier<String>) - Static method in class org.jdbi.v3.core.mapper.reflect.ReflectionMapperUtil

Attempts to find the index of a specified column's mapped parameter in a list of column names

findColumnMapperFor(Class<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a column mapper for the given type in this context.

findColumnMapperFor(Type) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a column mapper for the given type in this context.

findColumnMapperFor(GenericType<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a column mapper for the given type in this context.

findColumnMapperFor(QualifiedType<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a column mapper for the given qualified type in this context.

findConstructorFor(Class<T>) - Static method in class org.jdbi.v3.core.mapper.reflect.JdbiConstructors

Find an invokable constructor.

findElementTypeFor(Type) - Method in class org.jdbi.v3.core.collector.JdbiCollectors

Returns the element type for the given container type.

findElementTypeFor(Type) - Method in class org.jdbi.v3.core.statement.StatementContext

Returns the element type for the given container type.

findFactory(Class<? extends ExtensionFactory>) - Method in class org.jdbi.v3.core.extension.Extensions

Find the registered factory of the given type.

findFirst() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns the first row in the result set, if present.

findFor(Class<?>, Method) - Method in class org.jdbi.v3.sqlobject.Handlers

Deprecated.

findFor(Class<E>, HandleSupplier) - Method in class org.jdbi.v3.core.extension.Extensions

Create an extension instance if a factory accepts the extension type.

findFor(Class<T>) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Obtain a column mapper for the given type.

findFor(Class<T>) - Method in class org.jdbi.v3.core.mapper.Mappers

Obtain a mapper for the given type.

findFor(Class<T>) - Method in class org.jdbi.v3.core.mapper.RowMappers

Obtain a row mapper for the given type in the given context.

findFor(AnnotatedElement...) - Method in class org.jdbi.v3.core.qualifier.Qualifiers

Returns the set of qualifying annotations on the given elements.

findFor(Type) - Method in class org.jdbi.v3.core.array.SqlArrayTypes

Obtain an SqlArrayType for the given array element type in the given context

findFor(Type) - Method in class org.jdbi.v3.core.collector.JdbiCollectors

Obtain a collector for the given type.

findFor(Type) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Obtain a column mapper for the given type.

findFor(Type) - Method in class org.jdbi.v3.core.mapper.Mappers

Obtain a mapper for the given type.

findFor(Type) - Method in class org.jdbi.v3.core.mapper.RowMappers

Obtain a row mapper for the given type in the given context.

findFor(Type, Object) - Method in class org.jdbi.v3.core.argument.Arguments

Obtain an argument for given value in the given context

findFor(GenericType<T>) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Obtain a column mapper for the given type.

findFor(GenericType<T>) - Method in class org.jdbi.v3.core.mapper.Mappers

Obtain a mapper for the given type.

findFor(GenericType<T>) - Method in class org.jdbi.v3.core.mapper.RowMappers

Obtain a row mapper for the given type in the given context.

findFor(QualifiedType<?>, Object) - Method in class org.jdbi.v3.core.argument.Arguments

Obtain an argument for given value in the given context.

findFor(QualifiedType<T>) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Obtain a column mapper for the given qualified type.

findFor(QualifiedType<T>) - Method in class org.jdbi.v3.core.mapper.Mappers

Obtain a mapper for the given qualified type.

findForName(String, StatementContext) - Method in class org.jdbi.v3.core.statement.Binding

Deprecated.

don't inspect a Binding: keep your own state!

findForPosition(int) - Method in class org.jdbi.v3.core.statement.Binding

Deprecated.

don't inspect a Binding: keep your own state!

findGenericParameter(Type, Class<?>) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Same as GenericTypes.findGenericParameter(Type, Class, int) with n = 0.

findGenericParameter(Type, Class<?>, int) - Static method in class org.jdbi.v3.core.generic.GenericTypes

For the given type which extends parameterizedSupertype, returns the nth generic parameter for the parameterized supertype, if concretely expressed.

findMapperFor(Class<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a mapper for the given type in this context.

findMapperFor(Type) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a mapper for the given type in this context.

findMapperFor(GenericType<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a mapper for the given type in this context.

findMapperFor(QualifiedType<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a mapper for the given qualified type in this context.

findMetadata(Class<?>, ExtensionFactory) - Method in class org.jdbi.v3.core.extension.Extensions

Retrieves all extension metadata for a specific extension type.

findOne() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns the only row in the result set, if any.

findOnly() - Method in interface org.jdbi.v3.core.result.ResultIterable

Deprecated.

use ResultIterable.one() or ResultIterable.findOne() instead.

findRowMapperFor(Class<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a row mapper for the given type in this context.

findRowMapperFor(Type) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a row mapper for the given type in this context.

findRowMapperFor(GenericType<T>) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain a row mapper for the given type in this context.

findSqlArrayTypeFor(Type) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain an SqlArrayType for the given array element type in this context

findSqlOnClasspath(Class<?>, String) - Static method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Deprecated.

ClasspathSqlLocator.create() an instance instead of using static methods

findSqlOnClasspath(String) - Static method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Deprecated.

ClasspathSqlLocator.create() an instance instead of using static methods

findStringTemplate(Class<?>, String) - Static method in class org.jdbi.v3.stringtemplate4.StringTemplateSqlLocator

Locates SQL for the given type and name.

findStringTemplate(ClassLoader, String, String) - Static method in class org.jdbi.v3.stringtemplate4.StringTemplateSqlLocator

Locates SQL for the given type and name.

findStringTemplate(String, String) - Static method in class org.jdbi.v3.stringtemplate4.StringTemplateSqlLocator

Locates SQL for the given type and name.

findStringTemplateGroup(Class<?>) - Static method in class org.jdbi.v3.stringtemplate4.StringTemplateSqlLocator

Loads the StringTemplateGroup for the given type.

findStringTemplateGroup(ClassLoader, String) - Static method in class org.jdbi.v3.stringtemplate4.StringTemplateSqlLocator

Loads the StringTemplateGroup from the given path on the classpath.

findStringTemplateGroup(String) - Static method in class org.jdbi.v3.stringtemplate4.StringTemplateSqlLocator

Loads the StringTemplateGroup from the given path on the classpath.

findTemplate(Configuration, Class<?>, String) - Static method in class org.jdbi.v3.freemarker.FreemarkerSqlLocator

findTemplate(Class<?>, String) - Static method in class org.jdbi.v3.freemarker.FreemarkerSqlLocator

Deprecated.

this static method does not respect configuration, use FreemarkerConfig.createLocator()

first() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns the first row in the result set.

flatMapType(Function<Type, Optional<Type>>) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Apply the provided mapping function to the type, and if non-empty is returned, return an Optional<QualifiedType<?>> with the returned type, and the same qualifiers as this instance.

flywayMigration() - Static method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Returns an instance of JdbiFlywayMigration which can be configured and used as a JdbiExtensionInitializer.

FORCE_MAKE_ACCESSIBLE - Enum constant in enum org.jdbi.v3.core.mapper.reflect.AccessibleObjectStrategy

Force non-public methods and constructors to be accessible.

forClasses(Class<?>...) - Static method in class org.jdbi.v3.core.mapper.GetObjectColumnMapperFactory

Creates a ColumnMapperFactory that accepts multiple types and maps them by calling ResultSet.getObject(int, Class).

forClasses(Map<Class<?>, Integer>) - Static method in class org.jdbi.v3.core.argument.SetObjectArgumentFactory

Creates a new ArgumentFactory that maps objects to Types values.

forClasses(Set<Class<?>>) - Static method in class org.jdbi.v3.core.mapper.GetObjectColumnMapperFactory

Creates a ColumnMapperFactory that accepts multiple types and maps them by calling ResultSet.getObject(int, Class).

forConfig(ConfigRegistry) - Static method in class org.jdbi.v3.core.extension.ExtensionContext

Create an extension context for a configuration only.

forEach(Consumer<? super T>) - Method in interface org.jdbi.v3.core.result.ResultIterable

forEachRemaining(Consumer<? super T>) - Method in interface org.jdbi.v3.core.result.ResultIterator

forEachWithCount(Consumer<? super T>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Performs the specified action on each remaining element and returns the iteration i.e.

forExtensionMethod(Class<?>, Method) - Method in interface org.jdbi.v3.core.extension.ConfigCustomizerFactory

Creates a collection of ConfigCustomizer instances for an extension type method.

forExtensionMethod(ConfigRegistry, Class<?>, Method) - Static method in class org.jdbi.v3.core.extension.ExtensionContext

forExtensionType(Class<?>) - Method in interface org.jdbi.v3.core.extension.ConfigCustomizerFactory

Creates a collection of ConfigCustomizer instances for an extension type.

forSingleCodec(QualifiedType<?>, Codec<?>) - Static method in class org.jdbi.v3.core.codec.CodecFactory

forSingleCodec(QualifiedType<?>, Codec<?>) - Static method in class org.jdbi.v3.guava.codec.TypeResolvingCodecFactory

forTestcontainerClass(Class<? extends JdbcDatabaseContainer>) - Static method in class org.jdbi.v3.testing.junit5.tc.TestcontainersDatabaseInformation

Returns a TestcontainersDatabaseInformation instance for a given container instance class.

forType(Type, ConfigRegistry) - Method in interface org.jdbi.v3.json.JsonMapper

forTypes(Type...) - Static method in class org.jdbi.v3.core.mapper.JoinRowMapper

Create a JoinRowMapper that maps each of the given types and returns a JoinRow with the resulting values.

FreemarkerConfig - Class in org.jdbi.v3.freemarker

FreemarkerConfig() - Constructor for class org.jdbi.v3.freemarker.FreemarkerConfig

FreemarkerEngine - Class in org.jdbi.v3.freemarker

Rewrites a Freemarker template, using the attributes on the StatementContext as template parameters.

FreemarkerEngine() - Constructor for class org.jdbi.v3.freemarker.FreemarkerEngine

Deprecated.

use FreemarkerEngine.instance() for a shared engine instead

FreemarkerSqlLocator - Class in org.jdbi.v3.freemarker

Locates SQL in .sql.ftl Freemarker files on the classpath.

fromJson(Type, String, ConfigRegistry) - Method in interface org.jdbi.v3.json.JsonMapper

Deprecated.

fromJson(String, ConfigRegistry) - Method in interface org.jdbi.v3.json.JsonMapper.TypedJsonMapper

G

GENERATE_SQL_OBJECT_ANNOTATION_NAME - Static variable in class org.jdbi.v3.generator.GenerateSqlObjectProcessor

GenerateSqlObject - Annotation Type in org.jdbi.v3.sqlobject

Decorate a SqlObject type to instruct the jdbi3-generator annotation processor to create a compiled implementation.

GenerateSqlObjectProcessor - Class in org.jdbi.v3.generator

GenerateSqlObjectProcessor() - Constructor for class org.jdbi.v3.generator.GenerateSqlObjectProcessor

GenericMapMapperFactory - Class in org.jdbi.v3.core.mapper

Factory for a RowMapper that can map resultset rows to column name/generic value Maps.

GenericMapMapperFactory() - Constructor for class org.jdbi.v3.core.mapper.GenericMapMapperFactory

GenericType<T> - Class in org.jdbi.v3.core.generic

GenericTypes - Class in org.jdbi.v3.core.generic

Utilities for working with generic types.

get(Class<C>) - Method in class org.jdbi.v3.core.config.ConfigRegistry

Returns this registry's instance of the given config class.

get(Class<T>) - Method in class org.jdbi.v3.core.mapper.JoinRow

Return the value mapped for a given class.

get(Type) - Method in class org.jdbi.v3.core.mapper.JoinRow

Return the value mapped for a given type.

get(K) - Method in class org.jdbi.v3.cache.caffeine.CaffeineCache

get(K) - Method in class org.jdbi.v3.cache.caffeine.CaffeineLoadingCache

get(K) - Method in class org.jdbi.v3.cache.noop.NoopCache

get(K) - Method in interface org.jdbi.v3.core.cache.JdbiCache

Returns the cached value for a key.

getArgumentFunction() - Method in interface org.jdbi.v3.core.codec.Codec

Returns a Function that creates an Argument to map an attribute value onto the database column.

getArgumentFunction(ConfigRegistry) - Method in interface org.jdbi.v3.core.codec.Codec

Returns a Function that creates an Argument to map an attribute value onto the database column.

getArgumentStrategy() - Method in class org.jdbi.v3.core.array.SqlArrayTypes

Returns the strategy used to bind array-type arguments to SQL statements.

getArrayElementClass() - Method in interface org.jdbi.v3.core.array.SqlArrayType

Returns the element class that is used to create the backing array.

getAttribute(String) - Method in class org.jdbi.v3.core.statement.SqlStatements

Obtain the value of an attribute

getAttribute(String) - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain the value of an attribute

getAttributes() - Method in class org.jdbi.v3.core.statement.SqlStatements

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

getAttributes() - Method in class org.jdbi.v3.core.statement.StatementContext

Returns the attributes applied in this context.

getBinding() - Method in class org.jdbi.v3.core.statement.StatementContext

Returns the statement binding.

getBytes(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getBytes(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getCaseChange() - Method in class org.jdbi.v3.core.mapper.MapMappers

Case change strategy for the database column names.

getCaseChange() - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Case change strategy for the database column names.

getCleanableFor(Connection) - Method in interface org.jdbi.v3.core.ConnectionFactory

Returns a Cleanable that will close the connection and release all necessary resources.

getCoalesceNullPrimitivesToDefaults() - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Returns true if database null values should be transformed to the default value for primitives.

getColumn(int) - Method in class org.jdbi.v3.vavr.TupleMappers

Returns the name for a column.

getColumn(int, Class<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a column mapper to extract a type from the current ResultSet row.

getColumn(int, Type) - Method in class org.jdbi.v3.core.result.RowView

Use a column mapper to extract a type from the current ResultSet row.

getColumn(int, GenericType<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a column mapper to extract a type from the current ResultSet row.

getColumn(int, QualifiedType<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a qualified column mapper to extract a type from the current ResultSet row.

getColumn(String, Class<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a column mapper to extract a type from the current ResultSet row.

getColumn(String, Type) - Method in class org.jdbi.v3.core.result.RowView

Use a column mapper to extract a type from the current ResultSet row.

getColumn(String, GenericType<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a column mapper to extract a type from the current ResultSet row.

getColumn(String, QualifiedType<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a qualified column mapper to extract a type from the current ResultSet row.

getColumnMapper() - Method in interface org.jdbi.v3.core.codec.Codec

Returns a ColumnMapper that creates an attribute value from a database column.

getColumnMapper(ConfigRegistry) - Method in interface org.jdbi.v3.core.codec.Codec

Returns a ColumnMapper that creates an attribute value from a database column.

getColumnNameMatchers() - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Returns the registered column name mappers.

getColumnNames(ResultSet) - Static method in class org.jdbi.v3.core.mapper.reflect.ReflectionMapperUtil

Deprecated.

Use ReflectionMapperUtil.getColumnNames(ResultSet, UnaryOperator) and CaseStrategy to control name capitalization

getColumnNames(ResultSet, UnaryOperator<String>) - Static method in class org.jdbi.v3.core.mapper.reflect.ReflectionMapperUtil

Returns the name of all the columns present in the specified ResultSet.

getCompletionMoment() - Method in class org.jdbi.v3.core.statement.StatementContext

If query execution was successful, returns the query execution end as an Instant.

getConfig() - Method in interface org.jdbi.v3.core.config.Configurable

Returns the configuration registry associated with this object.

getConfig() - Method in class org.jdbi.v3.core.extension.ExtensionContext

getConfig() - Method in interface org.jdbi.v3.core.extension.HandleSupplier

Returns the current Jdbi config.

getConfig() - Method in class org.jdbi.v3.core.Handle

The current configuration object associated with this handle.

getConfig() - Method in class org.jdbi.v3.core.Jdbi

getConfig() - Method in class org.jdbi.v3.core.statement.Batch

getConfig() - Method in class org.jdbi.v3.core.statement.Call

getConfig() - Method in class org.jdbi.v3.core.statement.MetaData

getConfig() - Method in class org.jdbi.v3.core.statement.PreparedBatch

getConfig() - Method in class org.jdbi.v3.core.statement.Query

getConfig() - Method in class org.jdbi.v3.core.statement.Script

getConfig() - Method in class org.jdbi.v3.core.statement.SqlStatement

getConfig() - Method in class org.jdbi.v3.core.statement.Update

getConfig() - Method in class org.jdbi.v3.core.statement.StatementContext

Returns the ConfigRegistry.

getConfig(Class<C>) - Method in interface org.jdbi.v3.core.config.Configurable

Gets the configuration object of the given type, associated with this object.

getConfig(Class<C>) - Method in class org.jdbi.v3.core.statement.StatementContext

Gets the configuration object of the given type, associated with this context.

getConfigCustomizerFactories(ConfigRegistry) - Method in interface org.jdbi.v3.core.extension.ExtensionFactory

Returns a collection of ConfigCustomizerFactory objects.

getConfigCustomizerFactories(ConfigRegistry) - Method in class org.jdbi.v3.sqlobject.SqlObjectFactory

getConnection() - Method in class org.jdbi.v3.core.Handle

Get the JDBC Connection this Handle uses.

getConnection() - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain the JDBC connection being used for this statement

getContext() - Method in class org.jdbi.v3.core.result.ResultIterable.ResultIteratorDelegate

getContext() - Method in interface org.jdbi.v3.core.result.ResultIterator

Returns the current StatementContext.

getContext() - Method in class org.jdbi.v3.core.statement.Batch

Returns the statement context associated with this statement.

getContext() - Method in class org.jdbi.v3.core.statement.Call

Returns the statement context associated with this statement.

getContext() - Method in class org.jdbi.v3.core.statement.MetaData

Returns the statement context associated with this statement.

getContext() - Method in class org.jdbi.v3.core.statement.PreparedBatch

Returns the statement context associated with this statement.

getContext() - Method in class org.jdbi.v3.core.statement.Query

Returns the statement context associated with this statement.

getContext() - Method in class org.jdbi.v3.core.statement.Script

Returns the statement context associated with this statement.

getContext() - Method in class org.jdbi.v3.core.statement.SqlStatement

Returns the statement context associated with this statement.

getContext() - Method in class org.jdbi.v3.core.statement.Update

Returns the statement context associated with this statement.

getCoreImpl() - Method in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

getDate(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getDate(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getDefaultColumnMapper() - Static method in interface org.jdbi.v3.core.mapper.ColumnMapper

getDefaultParameterCustomizerFactory() - Method in class org.jdbi.v3.sqlobject.SqlObjects

Returns the configured ParameterCustomizerFactory used to bind sql statement parameters when parameter is not explicitly annotated.

getDefaultStrategy() - Method in class org.jdbi.v3.core.enums.Enums

Returns the default strategy to use for mapping and binding enums, in the absence of a EnumByName or EnumByOrdinal qualifying annotation.

getDeserializationView() - Method in class org.jdbi.v3.jackson2.Jackson2Config

Returns the current @JsonView used for deserialization.

getDouble(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getDouble(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getElapsedTime(ChronoUnit) - Method in class org.jdbi.v3.core.statement.StatementContext

Convenience method to measure elapsed time between start of query execution and completion or exception as appropriate.

getErasedType(Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Returns the erased class for the given type.

getExceptionMoment() - Method in class org.jdbi.v3.core.statement.StatementContext

If query execution failed, returns the query execution end as an Instant.

getExecutionMoment() - Method in class org.jdbi.v3.core.statement.StatementContext

Returns the query execution start as an Instant.

getExtensionHandlerCustomizers(ConfigRegistry) - Method in interface org.jdbi.v3.core.extension.ExtensionFactory

Returns a collection of ExtensionHandlerCustomizer objects.

getExtensionHandlerCustomizers(ConfigRegistry) - Method in class org.jdbi.v3.sqlobject.SqlObjectFactory

getExtensionHandlerFactories(ConfigRegistry) - Method in interface org.jdbi.v3.core.extension.ExtensionFactory

Returns a collection of ExtensionHandlerFactory objects.

getExtensionHandlerFactories(ConfigRegistry) - Method in class org.jdbi.v3.sqlobject.SqlObjectFactory

getExtensionMethod() - Method in class org.jdbi.v3.core.extension.ExtensionContext

getExtensionMethod() - Method in class org.jdbi.v3.core.Handle

Returns the extension method currently bound to the handle's context.

getExtensionMethod() - Method in class org.jdbi.v3.core.statement.StatementContext

getExtensionMethods() - Method in class org.jdbi.v3.core.extension.ExtensionMetadata

Returns a set of all Methods that have ExtensionHandler objects associated with them.

getExtensionType() - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.Builder

Returns the extension type from the builder.

getFactories() - Method in class org.jdbi.v3.core.argument.Arguments

getFactoryFlags() - Method in interface org.jdbi.v3.core.extension.ExtensionFactory

Returns a set of ExtensionFactory.FactoryFlags that describe the extension factory.

getFloat(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getFloat(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getFreemarkerConfiguration() - Method in class org.jdbi.v3.freemarker.FreemarkerConfig

GetGeneratedKeys - Annotation Type in org.jdbi.v3.sqlobject.statement

getGeneratedKeysColumnNames() - Method in class org.jdbi.v3.core.statement.StatementContext

Returns the generated key column names or empty if none were generated.

getGson() - Method in class org.jdbi.v3.gson2.Gson2Config

Returns the Gson object used for json conversion.

getHandle() - Method in interface org.jdbi.v3.core.extension.HandleSupplier

Returns a handle, possibly creating it lazily.

getHandle() - Method in class org.jdbi.v3.core.statement.Batch

getHandle() - Method in class org.jdbi.v3.core.statement.Call

getHandle() - Method in class org.jdbi.v3.core.statement.MetaData

getHandle() - Method in class org.jdbi.v3.core.statement.PreparedBatch

getHandle() - Method in class org.jdbi.v3.core.statement.Query

getHandle() - Method in class org.jdbi.v3.core.statement.Script

getHandle() - Method in class org.jdbi.v3.core.statement.SqlStatement

getHandle() - Method in class org.jdbi.v3.core.statement.Update

getHandle() - Method in interface org.jdbi.v3.sqlobject.SqlObject

Returns the handle used in the current sql object context.

getHandle() - Method in class org.jdbi.v3.testing.JdbiRule

Get the single Handle instance opened for the duration of this test case.

getHandle(Jdbi) - Static method in class org.jdbi.v3.spring5.JdbiUtil

Obtain a Handle instance, either the transactionally bound one if we are in a transaction, or a new one otherwise.

getHandleCallbackDecorator() - Method in class org.jdbi.v3.core.Jdbi

Returns the HandleCallbackDecorator.

getInferenceInterceptors() - Method in class org.jdbi.v3.core.array.SqlArrayTypes

Returns the JdbiInterceptionChainHolder for the SqlArrayType inference.

getInferenceInterceptors() - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Returns the JdbiInterceptionChainHolder for the ColumnMapper inference.

getInferenceInterceptors() - Method in class org.jdbi.v3.core.mapper.RowMappers

Returns the JdbiInterceptionChainHolder for the RowMapper inference.

getInt(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getInt(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getJdbi() - Method in interface org.jdbi.v3.core.extension.HandleSupplier

Returns the owning Jdbi instance.

getJdbi() - Method in class org.jdbi.v3.core.Handle

Returns the Jdbi object used to create this handle.

getJdbi() - Method in class org.jdbi.v3.testing.JdbiRule

Get Jdbi, in case you want to open additional handles to the same data source.

getJdbi() - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Returns a Jdbi instance linked to the data source used by this extension.

getJsonMapper() - Method in class org.jdbi.v3.json.JsonConfig

getKeyColumn() - Method in interface org.jdbi.v3.core.mapper.MapEntryConfig

getKeyColumn() - Method in class org.jdbi.v3.core.mapper.MapEntryMappers

getKeyColumn() - Method in class org.jdbi.v3.vavr.TupleMappers

getLengthLimit() - Method in class org.jdbi.v3.core.statement.StatementExceptions

Returns the limit hint to use to shorten strings.

getListeners() - Method in class org.jdbi.v3.core.Handles

Returns the collection of HandleListener objects.

getLobApi() - Method in class org.jdbi.v3.postgres.PostgresTypes

Provide access to Large Object streaming via Postgres specific API.

getLong(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getLong(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getMapper() - Method in class org.jdbi.v3.jackson2.Jackson2Config

Returns the object mapper to use for json conversion.

getMapperForValueType(Class<T>, ConfigRegistry) - Static method in class org.jdbi.v3.core.mapper.GenericMapMapperFactory

Returns a RowMapper for a map with the given value type.

getMapperForValueType(GenericType<T>, ConfigRegistry) - Static method in class org.jdbi.v3.core.mapper.GenericMapMapperFactory

Returns a RowMapper for a map with the given value type.

getMessage() - Method in exception class org.jdbi.v3.core.statement.StatementException

getMessageRendering() - Method in class org.jdbi.v3.core.statement.StatementExceptions

Returns the statement exception message rendering strategy.

getMethod() - Method in class org.jdbi.v3.core.extension.ExtensionMethod

Returns the method invoked.

getMoshi() - Method in class org.jdbi.v3.moshi.MoshiConfig

Returns the Moshi to use for json conversion.

getNames() - Method in class org.jdbi.v3.core.argument.MapArguments

Deprecated.

getNames() - Method in interface org.jdbi.v3.core.argument.NamedArgumentFinder

Returns the names this named argument finder can find.

getNames() - Method in class org.jdbi.v3.core.statement.Binding

Deprecated.

this is expensive to compute, and it's bad practice to inspect a Binding: keep track of your own state!

getObject(int) - Method in class org.jdbi.v3.core.statement.OutParameters

Type-casting convenience method which obtains an object from the results positionally object obtained should have been created with CallableStatementMapper

getObject(int, Class<T>) - Method in class org.jdbi.v3.core.statement.OutParameters

Type-casting convenience method which obtains an object from the map positionally object obtained should have been created with CallableStatementMapper

getObject(String) - Method in class org.jdbi.v3.core.statement.OutParameters

Obtains an object from the map, the object obtained should have been created with CallableStatementMapper

getObject(String, Class<T>) - Method in class org.jdbi.v3.core.statement.OutParameters

Type-casting convenience method which obtains an object from the map, the object obtained should have been created with CallableStatementMapper

GetObjectColumnMapperFactory - Class in org.jdbi.v3.core.mapper

Factory that uses ResultSet.getObject(int, Class) to fetch values.

getObjectType() - Method in class org.jdbi.v3.spring5.JdbiFactoryBean

See FactoryBean.getObjectType()

getParameterCount() - Method in class org.jdbi.v3.core.statement.ParsedParameters

The number of parameters from the SQL statement.

getParameterNames() - Method in class org.jdbi.v3.core.statement.ParsedParameters

The parameter names from the SQL statement.

getParameters() - Method in class org.jdbi.v3.core.statement.ParsedSql

The set of parameters parsed from the input SQL string.

getParsedSql() - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain the parsed SQL statement

getQualifiers() - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Returns a set of qualifying annotations.

getQueryTimeout() - Method in class org.jdbi.v3.core.statement.SqlStatements

getRawSql() - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain the initial sql for the statement used to create the statement

getRenderedSql() - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain the rendered SQL statement

getResource(ClassLoader, String) - Method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Returns resource's contents as a string at the specified path by the specified classloader.

getResource(String) - Method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Returns resource's contents as a string at the specified path.

getResourceOnClasspath(ClassLoader, String) - Static method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Deprecated.

ClasspathSqlLocator.create() an instance instead of using static methods

getResourceOnClasspath(String) - Static method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Deprecated.

ClasspathSqlLocator.create() an instance instead of using static methods

getRow(Class<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a row mapper to extract a type from the current ResultSet row.

getRow(Type) - Method in class org.jdbi.v3.core.result.RowView

Use a row mapper to extract a type from the current ResultSet row.

getRow(GenericType<T>) - Method in class org.jdbi.v3.core.result.RowView

Use a row mapper to extract a type from the current ResultSet row.

getRowSet(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getRowSet(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getSerializationView() - Method in class org.jdbi.v3.jackson2.Jackson2Config

Returns the current @JsonView used for serialization.

getSharedHandle() - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Returns a shared Handle used by the extension.

getShort(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getShort(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getShortMessage() - Method in exception class org.jdbi.v3.core.statement.StatementException

getSql() - Method in class org.jdbi.v3.core.statement.ParsedSql

Returns a SQL string suitable for use with a JDBC PreparedStatement.

getSqlArrayArgumentStrategy() - Method in class org.jdbi.v3.core.statement.StatementContext

Returns the strategy used by this context to bind array-type arguments to SQL statements.

getSqlLocator() - Method in class org.jdbi.v3.sqlobject.SqlObjects

Returns the configured SqlLocator.

getSqlLogger() - Method in class org.jdbi.v3.core.statement.SqlStatements

Returns the current logger.

getSqlParser() - Method in class org.jdbi.v3.core.statement.SqlStatements

getSqlType() - Method in class org.jdbi.v3.core.argument.NullArgument

Returns the Types value that is used.

getStatement() - Method in class org.jdbi.v3.core.statement.StatementContext

Obtain the actual prepared statement being used.

getStatementBuilder() - Method in class org.jdbi.v3.core.Handle

Returns the current StatementBuilder which is used to create new JDBC Statement objects.

getStatementBuilderFactory() - Method in class org.jdbi.v3.core.Jdbi

Returns the current StatementBuilderFactory.

getStatementContext() - Method in exception class org.jdbi.v3.core.statement.StatementException

getStatements() - Method in class org.jdbi.v3.core.statement.Script

Locate the Script and split it into statements.

getStats() - Method in class org.jdbi.v3.cache.caffeine.CaffeineCache

getStats() - Method in class org.jdbi.v3.cache.caffeine.CaffeineLoadingCache

getStats() - Method in class org.jdbi.v3.cache.noop.NoopCache

getStats() - Method in interface org.jdbi.v3.core.cache.JdbiCache

Return implementation specific statistics for the cache object.

getString(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getString(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getSupportedSourceVersion() - Method in class org.jdbi.v3.generator.GenerateSqlObjectProcessor

getTemplateEngine() - Method in class org.jdbi.v3.core.statement.SqlStatements

Returns the TemplateEngine which renders the SQL template.

getter(String, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.ObjectFieldArguments

Deprecated.

getter(String, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.ObjectMethodArguments

Deprecated.

getTimestamp(int) - Method in class org.jdbi.v3.core.statement.OutParameters

getTimestamp(String) - Method in class org.jdbi.v3.core.statement.OutParameters

getTimezone() - Method in class org.jdbi.v3.sqlobject.customizer.TimestampedConfig

Returns the timezone used in the resulting OffsetDateTime.

getTimingCollector() - Method in class org.jdbi.v3.core.statement.SqlStatements

Deprecated.

use SqlStatements.getSqlLogger() instead

getTransactionHandler() - Method in class org.jdbi.v3.core.Jdbi

Returns the TransactionHandler.

getTransactionIsolationLevel() - Method in class org.jdbi.v3.core.Handle

Obtain the current transaction isolation level.

getType() - Method in class org.jdbi.v3.core.extension.ExtensionMethod

Returns the type the method was invoked on.

getType() - Method in class org.jdbi.v3.core.generic.GenericType

getType() - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Returns the qualified type.

getTypeName() - Method in interface org.jdbi.v3.core.array.SqlArrayType

Returns the vendor-specific SQL type name String for the element type T.

getUntypedNullArgument() - Method in class org.jdbi.v3.core.argument.Arguments

Returns the untyped null argument.

getUrl() - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Returns a JDBC url representing the data source used by this extension.

getUrl() - Method in class org.jdbi.v3.testing.junit5.JdbiExternalPostgresExtension

getUrl() - Method in class org.jdbi.v3.testing.junit5.JdbiGenericExtension

getUrl() - Method in class org.jdbi.v3.testing.junit5.JdbiH2Extension

getUrl() - Method in class org.jdbi.v3.testing.junit5.JdbiOtjPostgresExtension

Deprecated.

getUrl() - Method in class org.jdbi.v3.testing.junit5.JdbiPostgresExtension

getUrl() - Method in class org.jdbi.v3.testing.junit5.JdbiSqliteExtension

getUrl() - Method in class org.jdbi.v3.testing.junit5.tc.JdbiTestcontainersExtension

getValueColumn() - Method in interface org.jdbi.v3.core.mapper.MapEntryConfig

getValueColumn() - Method in class org.jdbi.v3.core.mapper.MapEntryMappers

getValueColumn() - Method in class org.jdbi.v3.vavr.TupleMappers

getWithLoader(K, JdbiCacheLoader<K, V>) - Method in class org.jdbi.v3.cache.caffeine.CaffeineCache

getWithLoader(K, JdbiCacheLoader<K, V>) - Method in class org.jdbi.v3.cache.caffeine.CaffeineLoadingCache

getWithLoader(K, JdbiCacheLoader<K, V>) - Method in class org.jdbi.v3.cache.noop.NoopCache

getWithLoader(K, JdbiCacheLoader<K, V>) - Method in interface org.jdbi.v3.core.cache.JdbiCache

Returns a cached value for a key.

Gson2Config - Class in org.jdbi.v3.gson2

Configuration class for Gson 2 integration.

Gson2Config() - Constructor for class org.jdbi.v3.gson2.Gson2Config

Gson2Plugin - Class in org.jdbi.v3.gson2

Gson 2 integration plugin.

Gson2Plugin() - Constructor for class org.jdbi.v3.gson2.Gson2Plugin

GuavaArguments - Class in org.jdbi.v3.guava

Provide ArgumentFactory instances that understand Guava types.

GuavaCollectors - Class in org.jdbi.v3.guava

Provides Collectors for Guava collection types.

GuavaPlugin - Class in org.jdbi.v3.guava

Plugin to enable all Guava functionality.

GuavaPlugin() - Constructor for class org.jdbi.v3.guava.GuavaPlugin

GuiceJdbiCustomizer - Interface in org.jdbi.v3.guice

Allows specific customizations of the Jdbi instance during creation.

H

h2() - Static method in class org.jdbi.v3.testing.JdbiRule

Create a JdbiRule with an in-memory H2 database instance.

h2() - Static method in class org.jdbi.v3.testing.junit5.JdbiExtension

Creates a new extension using the H2 database.

H2DatabasePlugin - Class in org.jdbi.v3.core.h2

Configure vendor supported types for the H2 Java database implementation

H2DatabasePlugin() - Constructor for class org.jdbi.v3.core.h2.H2DatabasePlugin

Handle - Class in org.jdbi.v3.core

This represents a connection to the database system.

HandleCallback<T,X> - Interface in org.jdbi.v3.core

Callback that accepts a Handle that remains open for the duration of the callback invocation.

HandleCallbackDecorator - Interface in org.jdbi.v3.core

Decorates the HandleCallback instance for Jdbi.useHandle(HandleConsumer), Jdbi.withHandle(HandleCallback), Jdbi.inTransaction(HandleCallback) and Jdbi.useTransaction(HandleConsumer).

handleClosed(Handle) - Method in interface org.jdbi.v3.core.HandleListener

A handle was closed.

HandleConsumer<X> - Interface in org.jdbi.v3.core

Callback that accepts a Handle and returns no result.

handleCreated(Handle) - Method in interface org.jdbi.v3.core.HandleListener

A handle was created.

HandleListener - Interface in org.jdbi.v3.core

Allows listening to events on the Handle lifecycle.

Handler - Interface in org.jdbi.v3.sqlobject

Deprecated.

Use ExtensionHandler directly.

HandlerDecorator - Interface in org.jdbi.v3.sqlobject

Deprecated.

Use ExtensionHandlerCustomizer directly.

HandlerDecorators - Class in org.jdbi.v3.sqlobject

Deprecated.

Use ExtensionHandlerCustomizer instances which are returned directly from the ExtensionFactory.getExtensionHandlerCustomizers(ConfigRegistry).

HandlerDecorators() - Constructor for class org.jdbi.v3.sqlobject.HandlerDecorators

Deprecated.

HandlerFactory - Interface in org.jdbi.v3.sqlobject

Deprecated.

Use ExtensionHandlerFactory instances directly.

Handlers - Class in org.jdbi.v3.sqlobject

Deprecated.

Use ExtensionHandlerFactory instances that are returned from the ExtensionFactory.getExtensionHandlerFactories(ConfigRegistry) method.

Handlers() - Constructor for class org.jdbi.v3.sqlobject.Handlers

Deprecated.

Handles - Class in org.jdbi.v3.core

Configuration class for handles.

Handles() - Constructor for class org.jdbi.v3.core.Handles

HandleSupplier - Interface in org.jdbi.v3.core.extension

A handle supplier for extension implementors.

hasExtensionFor(Class<?>) - Method in class org.jdbi.v3.core.extension.Extensions

Returns true if an extension is registered for the given extension type.

hashCode() - Method in class org.jdbi.v3.core.Handle

hashCode() - Method in class org.jdbi.v3.core.qualifier.QualifiedType

hashCode() - Method in class org.jdbi.v3.core.spi.JdbiPlugin.Singleton

hashCode() - Method in class org.jdbi.v3.core.Sql

hashCode() - Method in class org.jdbi.v3.core.statement.Batch

hashCode() - Method in class org.jdbi.v3.core.statement.Call

hashCode() - Method in class org.jdbi.v3.core.statement.MetaData

hashCode() - Method in class org.jdbi.v3.core.statement.PreparedBatch

hashCode() - Method in class org.jdbi.v3.core.statement.Query

hashCode() - Method in class org.jdbi.v3.core.statement.Script

hashCode() - Method in class org.jdbi.v3.core.statement.SqlStatement

hashCode() - Method in class org.jdbi.v3.core.statement.Update

hashCode() - Method in class org.jdbi.v3.core.statement.ParsedParameters

hashCode() - Method in class org.jdbi.v3.core.statement.ParsedSql

hashCode() - Method in class org.jdbi.v3.core.statement.StatementContext

HASHCODE_HANDLER - Static variable in interface org.jdbi.v3.core.extension.ExtensionHandler

Implementation for the Object.hashCode() method.

HashPrefixSqlParser - Class in org.jdbi.v3.core.statement

SQL parser which recognizes named parameter tokens of the form #tokenName.

HashPrefixSqlParser() - Constructor for class org.jdbi.v3.core.statement.HashPrefixSqlParser

HashPrefixSqlParser(JdbiCacheBuilder) - Constructor for class org.jdbi.v3.core.statement.HashPrefixSqlParser

hasNext() - Method in class org.jdbi.v3.core.result.ResultIterable.ResultIteratorDelegate

hasQualifier(Class<? extends Annotation>) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Returns true if this type contains the given qualifier.

HStore - Annotation Type in org.jdbi.v3.postgres

Type qualifying annotation for HSTORE data type.

HStoreArgumentFactory - Class in org.jdbi.v3.postgres

An argument factory which binds Java's Map to Postgres' hstore type.

HStoreArgumentFactory() - Constructor for class org.jdbi.v3.postgres.HStoreArgumentFactory

HStoreColumnMapper - Class in org.jdbi.v3.postgres

A column mapper which maps Postgres' hstore type to Java's Map.

HStoreColumnMapper() - Constructor for class org.jdbi.v3.postgres.HStoreColumnMapper

I

id() - Element in annotation type org.jdbi.v3.core.extension.annotation.UseExtensionHandler

An extension must declare an id and tag all annotations with it.

importBinding(LinkedBindingBuilder<T>, TypeLiteral<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an existing outside binding into the module scope using the specified binder.

importBinding(LinkedBindingBuilder<T>, Class<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an existing outside binding into the module scope using the specified binder.

importBinding(TypeLiteral<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an existing outside binding into the module scope.

importBinding(Class<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an existing outside binding into the module scope.

importBindingLoosely(LinkedBindingBuilder<T>, TypeLiteral<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an outside binding into the module scope if it exists using the binder given.

importBindingLoosely(LinkedBindingBuilder<T>, Class<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an outside binding into the module scope if it exists using the binder given.

importBindingLoosely(TypeLiteral<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an outside binding into the module scope if it exists.

importBindingLoosely(Class<T>) - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Pulls an outside binding into the module scope if it exists.

InetArgumentFactory - Class in org.jdbi.v3.postgres

Postgres version of argument factory for InetAddress.

InetArgumentFactory() - Constructor for class org.jdbi.v3.postgres.InetArgumentFactory

init(ProcessingEnvironment) - Method in class org.jdbi.v3.generator.GenerateSqlObjectProcessor

init(ConfigRegistry) - Method in interface org.jdbi.v3.core.mapper.ColumnMapper

Allows for initialization of the column mapper instance within a ConfigRegistry scope.

init(ConfigRegistry) - Method in interface org.jdbi.v3.core.mapper.RowMapper

Allows for initialization of the row mapper instance within a ConfigRegistry scope.

initialize(DataSource, Handle) - Method in interface org.jdbi.v3.testing.junit5.JdbiExtensionInitializer

Run initialization code before a test.

initialize(DataSource, Handle) - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

InputStreamArgument - Class in org.jdbi.v3.core.argument

Bind an input stream as either an ASCII (discouraged) or binary stream.

InputStreamArgument(InputStream, int, boolean) - Constructor for class org.jdbi.v3.core.argument.InputStreamArgument

installPlugin(JdbiPlugin) - Method in class org.jdbi.v3.core.Jdbi

Install a given JdbiPlugin instance that will configure any provided Handle instances.

installPlugins() - Method in class org.jdbi.v3.core.Jdbi

Use the ServiceLoader API to detect and install plugins automagically.

installPlugins() - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

When creating the Jdbi instance, call the Jdbi.installPlugins() method, which loads all plugins discovered by the ServiceLoader API.

instance() - Static method in class org.jdbi.v3.cache.caffeine.CaffeineCacheBuilder

Returns a new JdbiCacheBuilder which can be used to construct the internal caches.

instance() - Static method in class org.jdbi.v3.freemarker.FreemarkerEngine

instance(TestcontainersDatabaseInformation, JdbcDatabaseContainer<?>) - Static method in class org.jdbi.v3.testing.junit5.tc.JdbiTestcontainersExtension

Create a new JdbiExtension that uses the supplied JdbcDatabaseContainer as database.

instance(JdbcDatabaseContainer<?>) - Static method in class org.jdbi.v3.testing.junit5.tc.JdbiTestcontainersExtension

Create a new JdbiExtension that uses the supplied JdbcDatabaseContainer as database.

INSTANCE - Static variable in class org.jdbi.v3.core.argument.BuiltInArgumentFactory

Deprecated.

intercept(S, JdbiInterceptionChain<T>) - Method in interface org.jdbi.v3.core.interceptor.JdbiInterceptor

Process a given source object.

inTransaction(HandleCallback<R, X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

inTransaction(HandleCallback<R, X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

inTransaction(HandleCallback<R, X>) - Method in class org.jdbi.v3.core.Handle

Executes callback in a transaction, and returns the result of the callback.

inTransaction(HandleCallback<R, X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

inTransaction(Handle, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

inTransaction(Handle, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

inTransaction(Handle, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

inTransaction(Handle, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner

inTransaction(Handle, HandleCallback<R, X>) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Run a transaction.

inTransaction(Handle, TransactionIsolationLevel, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

inTransaction(Handle, TransactionIsolationLevel, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

inTransaction(Handle, TransactionIsolationLevel, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

inTransaction(Handle, TransactionIsolationLevel, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner

inTransaction(Handle, TransactionIsolationLevel, HandleCallback<R, X>) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Run a transaction.

inTransaction(TransactionIsolationLevel, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

inTransaction(TransactionIsolationLevel, HandleCallback<R, X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

inTransaction(TransactionIsolationLevel, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.Handle

Executes callback in a transaction, and returns the result of the callback.

inTransaction(TransactionIsolationLevel, HandleCallback<R, X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

inTransaction(TransactionIsolationLevel, TransactionalCallback<R, This, X>) - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Executes the given callback within a transaction, returning the value returned by the callback.

inTransaction(TransactionalCallback<R, This, X>) - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Executes the given callback within a transaction, returning the value returned by the callback.

inTransaction(T) - Method in interface org.jdbi.v3.sqlobject.transaction.TransactionalCallback

Execute in a transaction.

intValue() - Method in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

invoke() - Method in class org.jdbi.v3.core.statement.Call

Invoke the callable statement.

invoke(Object...) - Method in class org.jdbi.v3.core.extension.ExtensionMetadata.ExtensionHandlerInvoker

Invoke the registered extension handler code in the extension context.

invoke(Object, Object[], HandleSupplier) - Method in interface org.jdbi.v3.sqlobject.Handler

Deprecated.

Executes a SQL Object method, and returns the result.

invoke(Consumer<OutParameters>) - Method in class org.jdbi.v3.core.statement.Call

Invoke the callable statement and process its OutParameters results.

invoke(Function<OutParameters, T>) - Method in class org.jdbi.v3.core.statement.Call

Invoke the callable statement and process its OutParameters results, returning a computed value of type T.

invoke(HandleSupplier, Object, Object...) - Method in interface org.jdbi.v3.core.extension.ExtensionHandler

Gets invoked to return a value for the method that this handler was bound to.

invoke(HandleSupplier, Object, Object...) - Method in interface org.jdbi.v3.sqlobject.Handler

Deprecated.

invokeInContext(ExtensionContext, Callable<V>) - Method in interface org.jdbi.v3.core.extension.HandleSupplier

Bind a new ExtensionContext to the Handle, invoke the given task, then restore the Handle's extension state.

isAllowProxy() - Method in class org.jdbi.v3.core.extension.Extensions

Returns whether Proxy classes are allowed to be used.

isArray(Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Checks whether a given Type is an Array Type.

isAttachAllStatementsForCleanup() - Method in class org.jdbi.v3.core.statement.SqlStatements

If true, all statements created within Jdbi.withHandle(org.jdbi.v3.core.HandleCallback<R, X>), Jdbi.useHandle(org.jdbi.v3.core.HandleConsumer<X>), Jdbi.inTransaction(org.jdbi.v3.core.HandleCallback<R, X>) and Jdbi.useTransaction(org.jdbi.v3.core.HandleConsumer<X>) are attached to the Handle object for cleanup.

isAttachCallbackStatementsForCleanup() - Method in class org.jdbi.v3.core.statement.SqlStatements

If true, statements created within Jdbi.withHandle(org.jdbi.v3.core.HandleCallback<R, X>), Jdbi.useHandle(org.jdbi.v3.core.HandleConsumer<X>), Jdbi.inTransaction(org.jdbi.v3.core.HandleCallback<R, X>) and Jdbi.useTransaction(org.jdbi.v3.core.HandleConsumer<X>) will be attached to the Handle object in the callback for cleanup.

isBindingNullToPrimitivesPermitted() - Method in class org.jdbi.v3.core.argument.Arguments

Returns true if binding null to a variable declared as a primitive type is allowed.

isClean() - Method in class org.jdbi.v3.core.Handle

Returns true if the Handle currently holds no database resources.

isClosed() - Method in class org.jdbi.v3.core.Handle

Returns true if the Handle has been closed.

isConcurrentUpdatable() - Method in class org.jdbi.v3.core.statement.StatementContext

Return if the statement should be concurrent updatable.

isEmpty() - Method in class org.jdbi.v3.core.statement.Binding

Returns whether any bindings exist.

isFailFast() - Method in class org.jdbi.v3.core.extension.Extensions

Returns true if misconfigured extension objects fail fast.

isFailOnMissingAttribute() - Method in class org.jdbi.v3.stringtemplate4.StringTemplates

isForceEndTransactions() - Method in class org.jdbi.v3.core.Handles

Returns whether to enforce transaction termination discipline when a Handle is closed.

isInTransaction() - Method in class org.jdbi.v3.core.Handle

Returns whether the handle is in a transaction.

isInTransaction() - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Returns True if this object is currently in a transaction.

isInTransaction(Handle) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

Called to test if a handle is in a transaction

isInTransaction(Handle) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

isInTransaction(Handle) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

isInTransaction(Handle) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Returns whether a given Handle is in the transaction.

isPositional() - Method in class org.jdbi.v3.core.statement.ParsedParameters

Whether the the SQL statement uses positional parameters.

isPreparedArgumentsEnabled() - Method in class org.jdbi.v3.core.argument.Arguments

Returns true if prepared arguments binding is enabled.

isReadOnly() - Method in class org.jdbi.v3.core.Handle

Whether the connection is in read-only mode.

isReturningGeneratedKeys() - Method in class org.jdbi.v3.core.statement.StatementContext

Whether the statement being generated is expected to return generated keys.

isStrictMatching() - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Returns whether strict column name matching is enabled.

isSuperType(Type, Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Tests whether a given type is a supertype of another type

isUnusedBindingAllowed() - Method in class org.jdbi.v3.core.statement.SqlStatements

iterator() - Method in interface org.jdbi.v3.core.result.ResultIterable

Stream all the rows of the result set out with an Iterator.

IteratorCallback<T,R,X> - Interface in org.jdbi.v3.core.result

Callback for use with ResultIterable.withIterator(IteratorCallback)

IteratorConsumer<T,X> - Interface in org.jdbi.v3.core.result

Callback for use with ResultIterable.useIterator(IteratorConsumer)

J

Jackson2Config - Class in org.jdbi.v3.jackson2

Configuration class for Jackson 2 integration.

Jackson2Config() - Constructor for class org.jdbi.v3.jackson2.Jackson2Config

Jackson2Plugin - Class in org.jdbi.v3.jackson2

Jackson 2 integration plugin.

Jackson2Plugin() - Constructor for class org.jdbi.v3.jackson2.Jackson2Plugin

JavaTimeArgumentFactory - Class in org.jdbi.v3.postgres

Maps LocalDate, LocalTime, LocalDateTime, OffsetDateTime.

JavaTimeArgumentFactory() - Constructor for class org.jdbi.v3.postgres.JavaTimeArgumentFactory

JavaTimeMapperFactory - Class in org.jdbi.v3.postgres

Provide mappers corresponding to java time types.

JavaTimeMapperFactory() - Constructor for class org.jdbi.v3.postgres.JavaTimeMapperFactory

JavaTimeZoneIdArgumentFactory - Class in org.jdbi.v3.core.argument

JavaTimeZoneIdArgumentFactory() - Constructor for class org.jdbi.v3.core.argument.JavaTimeZoneIdArgumentFactory

Jdbi - Class in org.jdbi.v3.core

Main entry point; configurable wrapper around a JDBC DataSource.

jdbiBinder() - Method in class org.jdbi.v3.guice.AbstractJdbiConfigurationModule

Provides access to the JdbiBinder instance.

jdbiBinder() - Method in class org.jdbi.v3.guice.AbstractJdbiDefinitionModule

Provides access to the JdbiBinder instance.

jdbiBinder() - Method in interface org.jdbi.v3.guice.JdbiBinder

Provides access to a JdbiBinder instance.

JdbiBinder - Interface in org.jdbi.v3.guice

Describes all operations to bind Jdbi elements in Guice.

JdbiCache<K,V> - Interface in org.jdbi.v3.core.cache

A generic cache implementation for JDBI internal use.

JdbiCacheBuilder - Interface in org.jdbi.v3.core.cache

Builder class for JdbiCache implementations.

JdbiCacheLoader<K,V> - Interface in org.jdbi.v3.core.cache

Creates a new value for a JdbiCache.

JdbiCacheStats - Interface in org.jdbi.v3.core.cache

Simple statistics about a JdbiCache instance.

JdbiCollectors - Class in org.jdbi.v3.core.collector

Registry of collector factories.

JdbiCollectors() - Constructor for class org.jdbi.v3.core.collector.JdbiCollectors

JdbiConfig<This> - Interface in org.jdbi.v3.core.config

Interface for classes that hold configuration.

JdbiConstructor - Annotation Type in org.jdbi.v3.core.mapper.reflect

Indicate to ConstructorMapper and other reflective mappers how to construct an instance.

JdbiConstructors - Class in org.jdbi.v3.core.mapper.reflect

Utilities for JdbiConstructor annotation.

JdbiException - Exception Class in org.jdbi.v3.core

Base unchecked exception for exceptions thrown from jdbi.

JdbiExecutor - Interface in org.jdbi.v3.core.async

JdbiExtension - Class in org.jdbi.v3.testing.junit5

Common functionality for all JUnit 5 extensions.

JdbiExtensionInitializer - Interface in org.jdbi.v3.testing.junit5

Initialize the data source before running a test.

JdbiExternalPostgresExtension - Class in org.jdbi.v3.testing.junit5

JdbiFactoryBean - Class in org.jdbi.v3.spring5

Utility class which constructs an Jdbi instance which can conveniently participate in Spring's transaction management system.

JdbiFactoryBean() - Constructor for class org.jdbi.v3.spring5.JdbiFactoryBean

JdbiFactoryBean(DataSource) - Constructor for class org.jdbi.v3.spring5.JdbiFactoryBean

JdbiFlywayMigration - Class in org.jdbi.v3.testing.junit5

Use Flyway to create a database schema and/or preload a database instance.

JdbiFreeBuilders - Class in org.jdbi.v3.core.mapper.freebuilder

Configures support for an FreeBuilder generated Builder) value type.

JdbiFreeBuilders() - Constructor for class org.jdbi.v3.core.mapper.freebuilder.JdbiFreeBuilders

JdbiGenericExtension - Class in org.jdbi.v3.testing.junit5

Very simple implementation of a JUnit 5 JdbiExtension which can handle any JDBC connection.

JdbiGenericExtension(String) - Constructor for class org.jdbi.v3.testing.junit5.JdbiGenericExtension

Creates a new instance for a given JDBC URI.

JdbiH2Extension - Class in org.jdbi.v3.testing.junit5

Jdbi H2 JUnit 5 rule.

JdbiH2Extension() - Constructor for class org.jdbi.v3.testing.junit5.JdbiH2Extension

JdbiH2Extension(String) - Constructor for class org.jdbi.v3.testing.junit5.JdbiH2Extension

Allows setting the options string for the H2 database.

JdbiImmutables - Class in org.jdbi.v3.core.mapper.immutables

Configures support for an Immutables generated Immutable or Modifiable value type.

JdbiImmutables() - Constructor for class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

JdbiInterceptionChain<T> - Interface in org.jdbi.v3.core.interceptor

An instance of an interception chain.

JdbiInterceptionChainHolder<S,T> - Class in org.jdbi.v3.core.interceptor

An interception chain holder to manage transformation operations.

JdbiInterceptionChainHolder() - Constructor for class org.jdbi.v3.core.interceptor.JdbiInterceptionChainHolder

Creates a new chain holder.

JdbiInterceptionChainHolder(Function<S, T>) - Constructor for class org.jdbi.v3.core.interceptor.JdbiInterceptionChainHolder

Creates a new chain holder with a default interceptor.

JdbiInterceptionChainHolder(JdbiInterceptionChainHolder<S, T>) - Constructor for class org.jdbi.v3.core.interceptor.JdbiInterceptionChainHolder

JdbiInterceptor<S,T> - Interface in org.jdbi.v3.core.interceptor

Generic interface to allow transformation operation interception.

JdbiOtjPostgresExtension - Class in org.jdbi.v3.testing.junit5

Deprecated, for removal: This API element is subject to removal in a future version.

The OtjPostgres project ships its artifact as an automatic module with filename based module name. It is strongly discouraged to ship any JPMS enabled project that depends on automatic modules with filename based module names. We have reached out to the OtjPostgres project and proposed a change that would fix this. If they ship a version that fixes this before we are ready to move to full JPMS support, we will un-deprecate this class, otherwise it will be removed with our switch to JPMS.

JdbiOtjPostgresExtension() - Constructor for class org.jdbi.v3.testing.junit5.JdbiOtjPostgresExtension

Deprecated.

JdbiPlugin - Interface in org.jdbi.v3.core.spi

A plugin is given an opportunity to customize instances of various Jdbi types before they are returned from their factories.

JdbiPlugin.Singleton - Class in org.jdbi.v3.core.spi

Abstract base class for single-install JdbiPlugins.

JdbiPostgresExtension - Class in org.jdbi.v3.testing.junit5

Jdbi PostgreSQL JUnit 5 rule using the pg-embedded component.

JdbiPostgresExtension() - Constructor for class org.jdbi.v3.testing.junit5.JdbiPostgresExtension

JdbiProperty - Annotation Type in org.jdbi.v3.core.annotation

Configure reflective bean and pojo property attributes.

JdbiRule - Class in org.jdbi.v3.testing

JUnit @Rule to manage a Jdbi instance pointed to a managed database.

JdbiRule() - Constructor for class org.jdbi.v3.testing.JdbiRule

JdbiSqliteExtension - Class in org.jdbi.v3.testing.junit5

Jdbi SQLite JUnit 5 rule.

JdbiSqliteExtension() - Constructor for class org.jdbi.v3.testing.junit5.JdbiSqliteExtension

JdbiTestcontainersExtension - Class in org.jdbi.v3.testing.junit5.tc

Support Testcontainer JDBC containers as database for Jdbi tests.

JdbiUtil - Class in org.jdbi.v3.spring5

Utility for working with Jdbi and Spring transaction bound resources

JodaTimePlugin - Class in org.jdbi.v3.jodatime2

Register date and time providers to integrate with joda-time.

JodaTimePlugin() - Constructor for class org.jdbi.v3.jodatime2.JodaTimePlugin

JoinRow - Class in org.jdbi.v3.core.mapper

Holder for a single joined row.

JoinRowMapper - Class in org.jdbi.v3.core.mapper

A RowMapper implementation to easily compose existing RowMappers.

JpaMapper<C> - Class in org.jdbi.v3.jpa

Row mapper for a JPA-annotated type as a result.

JpaMapperFactory - Class in org.jdbi.v3.jpa

Create JpaMappers for Entity annotated classes.

JpaMapperFactory() - Constructor for class org.jdbi.v3.jpa.JpaMapperFactory

JpaPlugin - Class in org.jdbi.v3.jpa

Enable minimal JPA compatibility layer.

JpaPlugin() - Constructor for class org.jdbi.v3.jpa.JpaPlugin

Json - Annotation Type in org.jdbi.v3.json

Type qualifying annotation for converting Java types to json data type.

JsonConfig - Class in org.jdbi.v3.json

JsonConfig() - Constructor for class org.jdbi.v3.json.JsonConfig

JsonMapper - Interface in org.jdbi.v3.json

Deserializes JSON to Java objects, and serializes Java objects to JSON.

JsonMapper.TypedJsonMapper - Interface in org.jdbi.v3.json

JsonPlugin - Class in org.jdbi.v3.json

JsonPlugin() - Constructor for class org.jdbi.v3.json.JsonPlugin

K

KeyColumn - Annotation Type in org.jdbi.v3.sqlobject.config

Configures the column to use for map keys, for SQL methods that return Map, or Guava's Multimap.

keys() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindMap

The set of map keys to bind.

L

LargeObjectException - Exception Class in org.jdbi.v3.postgres

LargeObjectException(Throwable) - Constructor for exception class org.jdbi.v3.postgres.LargeObjectException

length() - Method in class org.jdbi.v3.core.Sql

LinkedHashMapRowReducer<K,V> - Interface in org.jdbi.v3.core.result

A row reducer that uses LinkedHashMap (which preserves insertion order) as a result container, and returns map.values().stream() as the final result.

list() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns results in a List using the JDK specific default implementation of List as provided by Collectors.toList().

listPerBatch() - Method in interface org.jdbi.v3.core.result.BatchResultIterable

Split the results into per-batch sub-lists.

LOCALE_LOWER - Enum constant in enum org.jdbi.v3.core.mapper.CaseStrategy

All strings to lowercase in system locale.

LOCALE_UPPER - Enum constant in enum org.jdbi.v3.core.mapper.CaseStrategy

All strings to uppercase in system locale.

LocalTransactionHandler - Class in org.jdbi.v3.core.transaction

This TransactionHandler uses local JDBC transactions demarcated explicitly on the handle and passed through to be handled directly on the JDBC Connection instance.

LocalTransactionHandler() - Constructor for class org.jdbi.v3.core.transaction.LocalTransactionHandler

locate(Class<?>, Method, ConfigRegistry) - Method in class org.jdbi.v3.sqlobject.locator.AnnotationSqlLocator

locate(Class<?>, Method, ConfigRegistry) - Method in interface org.jdbi.v3.sqlobject.locator.SqlLocator

Locates and returns the SQL for the given SQL Object type and method.

locate(Class<?>, Method, ConfigRegistry) - Method in class org.jdbi.v3.sqlobject.locator.SqlObjectClasspathSqlLocator

locate(Class<?>, String) - Method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Locates SQL for the given type and name.

locate(Class<?>, String) - Method in class org.jdbi.v3.freemarker.FreemarkerSqlLocator

locate(String) - Method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Locates SQL for the given fully-qualified name.

logAfterExecution(StatementContext) - Method in class org.jdbi.v3.core.statement.Slf4JSqlLogger

logAfterExecution(StatementContext) - Method in interface org.jdbi.v3.core.statement.SqlLogger

Will be called after a query has been executed.

logBeforeExecution(StatementContext) - Method in interface org.jdbi.v3.core.statement.SqlLogger

Will be called before a query is executed.

logException(StatementContext, SQLException) - Method in class org.jdbi.v3.core.statement.Slf4JSqlLogger

logException(StatementContext, SQLException) - Method in interface org.jdbi.v3.core.statement.SqlLogger

Will be called after a query has failed.

LOWER - Enum constant in enum org.jdbi.v3.core.mapper.CaseStrategy

All strings to lowercase in root locale.

M

MacAddr - Annotation Type in org.jdbi.v3.postgres

Type qualifying annotation for MACADDR data type.

makeAccessible(T) - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Use the accessibility strategy to potentially make a reflective operation accessible.

map() - Element in annotation type org.jdbi.v3.core.annotation.JdbiProperty

Returns true if the property is mapped in a result.

map(int, CallableStatement) - Method in interface org.jdbi.v3.core.statement.CallableStatementMapper

map(ResultSet, int, StatementContext) - Method in interface org.jdbi.v3.core.mapper.ColumnMapper

Map the given column of the current row of the result set to an Object.

map(ResultSet, int, StatementContext) - Method in class org.jdbi.v3.jodatime2.DateTimeMapper

map(ResultSet, int, StatementContext) - Method in class org.jdbi.v3.postgres.HStoreColumnMapper

map(ResultSet, String, StatementContext) - Method in interface org.jdbi.v3.core.mapper.ColumnMapper

Map the given column of the current row of the result set to an Object.

map(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.JoinRowMapper

map(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.MapEntryMapper

map(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.MapMapper

map(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

map(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.reflect.FieldMapper

map(ResultSet, StatementContext) - Method in interface org.jdbi.v3.core.mapper.RowMapper

Map the current row of the result set.

map(ResultSet, StatementContext) - Method in interface org.jdbi.v3.core.mapper.RowViewMapper

map(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.SingleColumnMapper

map(ResultSet, StatementContext) - Method in class org.jdbi.v3.jpa.JpaMapper

map(Function<? super T, ? extends R>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns a ResultIterable<U> derived from this ResultIterable<T>, by transforming elements using the given mapper function.

map(ColumnMapper<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

map(ColumnMapper<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable, using the given column mapper.

map(RowMapper<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

map(RowMapper<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable, using the given row mapper.

map(RowViewMapper<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

map(RowViewMapper<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable, using the given RowViewMapper.

map(RowView) - Method in interface org.jdbi.v3.core.mapper.RowViewMapper

Produce a single result item from the current row of a RowView.

MapArguments - Class in org.jdbi.v3.core.argument

Deprecated.

use SqlStatement.bindMap(Map) instead

MapArguments(Map<String, ?>) - Constructor for class org.jdbi.v3.core.argument.MapArguments

Deprecated.

MapCollectors - Class in org.jdbi.v3.core.collector

MapEntryConfig<This> - Interface in org.jdbi.v3.core.mapper

MapEntryMapper<K,V> - Class in org.jdbi.v3.core.mapper

Maps rows to Map.Entry<K, V>, provided there are mappers registered for types K and V.

MapEntryMappers - Class in org.jdbi.v3.core.mapper

Configuration class for MapEntryMapper.

MapEntryMappers() - Constructor for class org.jdbi.v3.core.mapper.MapEntryMappers

MapMapper - Class in org.jdbi.v3.core.mapper

Yo dawg, I heard you like maps, so I made you a mapper that maps rows into Map<String,Object>.

MapMapper() - Constructor for class org.jdbi.v3.core.mapper.MapMapper

Constructs a new MapMapper and delegates case control to MapMappers.

MapMapper(boolean) - Constructor for class org.jdbi.v3.core.mapper.MapMapper

Deprecated.

use MapMappers.setCaseChange(UnaryOperator) instead.

MapMappers - Class in org.jdbi.v3.core.mapper

MapMappers() - Constructor for class org.jdbi.v3.core.mapper.MapMappers

Mappers - Class in org.jdbi.v3.core.mapper

Configuration class for obtaining row or column mappers.

Mappers() - Constructor for class org.jdbi.v3.core.mapper.Mappers

MappingException - Exception Class in org.jdbi.v3.core.mapper

Thrown when a mapper fails to map the row to a result type.

MappingException(String) - Constructor for exception class org.jdbi.v3.core.mapper.MappingException

MappingException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.mapper.MappingException

MappingException(Throwable) - Constructor for exception class org.jdbi.v3.core.mapper.MappingException

mapTo(Class<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapTo(Class<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable of the given element type.

mapTo(Type) - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapTo(Type) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable of the given element type.

mapTo(GenericType<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapTo(GenericType<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable of the given element type.

mapTo(QualifiedType<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapTo(QualifiedType<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable of the given qualified element type.

MapTo - Annotation Type in org.jdbi.v3.sqlobject.statement

Used to specify a polymorphic return type as a parameter on a query method.

mapToBean(Class<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapToBean(Class<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable of the given element type, using BeanMapper.

mapToMap() - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapToMap() - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a ResultIterable of Map<String,Object>.

mapToMap(Class<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapToMap(Class<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a Map of String and the given value class.

mapToMap(GenericType<T>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

mapToMap(GenericType<T>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Maps this result set to a Map of String and the given value type.

mapType(Function<Type, Type>) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Apply the provided mapping function to the type, and if non-empty is returned, return an Optional<QualifiedType<?>> with the returned type, and the same qualifiers as this instance.

maxFieldSize(int) - Static method in class org.jdbi.v3.core.statement.StatementCustomizers

Sets the limit of large variable size types like VARCHAR.

maxRows(int) - Static method in class org.jdbi.v3.core.statement.StatementCustomizers

Limit number of rows returned.

MaxRows - Annotation Type in org.jdbi.v3.sqlobject.customizer

Used to specify the maximum number of rows to return on a result set.

maxSize() - Method in interface org.jdbi.v3.core.cache.JdbiCacheStats

Returns the maximum size of the cache.

maxSize(int) - Method in class org.jdbi.v3.cache.caffeine.CaffeineCacheBuilder

maxSize(int) - Method in class org.jdbi.v3.cache.noop.NoopCacheBuilder

maxSize(int) - Method in interface org.jdbi.v3.core.cache.JdbiCacheBuilder

Sets an upper boundary to the cache size.

MessageFormatTemplateEngine - Class in org.jdbi.v3.core.statement

Deprecated.

MessageFormat formats integers with decimal separators, e.g. 1000 → "1,000". This hindsight realization has led us to discourage its use.

MessageFormatTemplateEngine() - Constructor for class org.jdbi.v3.core.statement.MessageFormatTemplateEngine

Deprecated.

MetaData - Class in org.jdbi.v3.core.statement

Access to Database Metadata.

MetaData(Handle, MetaData.MetaDataValueProvider<?>) - Constructor for class org.jdbi.v3.core.statement.MetaData

MetaData.MetaDataResultSetProvider - Interface in org.jdbi.v3.core.statement

MetaData.MetaDataValueProvider<T> - Interface in org.jdbi.v3.core.statement

methodNames() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindMethodsList

The list of methods to invoke on each element in the argument

migrateWithFlyway() - Method in class org.jdbi.v3.testing.JdbiRule

Deprecated.

use JdbiRule.withMigration(Migration)

migrateWithFlyway(String...) - Method in class org.jdbi.v3.testing.JdbiRule

Deprecated.

use JdbiRule.withMigration(Migration)

Migration - Class in org.jdbi.v3.testing

Represents a Flyway migration Jdbi should run.

Migration() - Constructor for class org.jdbi.v3.testing.Migration

missingExtensionHandler(Method) - Static method in interface org.jdbi.v3.core.extension.ExtensionHandler

Returns a default handler for missing functionality.

Mixin Interfaces - Search tag in package org.jdbi.v3.sqlobject

Section

modifiedRowCounts() - Method in class org.jdbi.v3.core.result.BatchResultBearing

Returns the mod counts for the executed PreparedBatch Note that some database drivers might return special values like Statement.SUCCESS_NO_INFO or Statement.EXECUTE_FAILED.

MoshiConfig - Class in org.jdbi.v3.moshi

Configuration class for Moshi integration.

MoshiConfig() - Constructor for class org.jdbi.v3.moshi.MoshiConfig

MoshiPlugin - Class in org.jdbi.v3.moshi

Moshi integration plugin.

MoshiPlugin() - Constructor for class org.jdbi.v3.moshi.MoshiPlugin

N

name() - Element in annotation type org.jdbi.v3.sqlobject.customizer.OutParameter

named(List<String>) - Static method in class org.jdbi.v3.core.statement.ParsedParameters

A static factory of named ParsedParameters instances.

NamedArgumentFinder - Interface in org.jdbi.v3.core.argument

Returns an Argument based on a name.

nameParameter(String, StatementContext) - Method in class org.jdbi.v3.core.statement.ColonPrefixSqlParser

nameParameter(String, StatementContext) - Method in class org.jdbi.v3.core.statement.HashPrefixSqlParser

nameParameter(String, StatementContext) - Method in interface org.jdbi.v3.core.statement.SqlParser

Convert rawName to a name as recognized by this parser

Nested - Annotation Type in org.jdbi.v3.core.mapper

Signals that the annotated element is a nested mapped type.

next() - Method in interface org.jdbi.v3.core.interceptor.JdbiInterceptionChain

Called from an JdbiInterceptor to execute the next interceptor on the chain.

NO_VALUE - Static variable in annotation type org.jdbi.v3.sqlobject.customizer.Bind

NON_VIRTUAL_FACTORY - Enum constant in enum org.jdbi.v3.core.extension.ExtensionFactory.FactoryFlag

The factory provides a concrete instance to back the extension type.

NONE - Enum constant in enum org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

Do not include SQL or parameter information.

NONE - Enum constant in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

NoopCache<K,V> - Class in org.jdbi.v3.cache.noop

A no operation cache implementation.

NoopCacheBuilder - Class in org.jdbi.v3.cache.noop

Cache builder for the no op cache.

NoopCachePlugin - Class in org.jdbi.v3.cache.noop

Installing this plugin uses the no op (no caching) cache.

NoopCachePlugin() - Constructor for class org.jdbi.v3.cache.noop.NoopCachePlugin

NOP - Enum constant in enum org.jdbi.v3.core.mapper.CaseStrategy

No case sensitivity.

NOP - Static variable in interface org.jdbi.v3.core.statement.TemplateEngine

Convenience constant that returns the input template.

NOP - Static variable in interface org.jdbi.v3.guice.GuiceJdbiCustomizer

Does not modify the Jdbi instance.

NOP_SQL_LOGGER - Static variable in interface org.jdbi.v3.core.statement.SqlLogger

NOP_TIMING_COLLECTOR - Static variable in interface org.jdbi.v3.core.statement.TimingCollector

Deprecated.

Use SqlLogger.NOP_SQL_LOGGER instead.

NoResultsException - Exception Class in org.jdbi.v3.core.result

Thrown when no results were found in a context that requires at least one.

NoResultsException(String, Throwable, StatementContext) - Constructor for exception class org.jdbi.v3.core.result.NoResultsException

NoResultsException(String, StatementContext) - Constructor for exception class org.jdbi.v3.core.result.NoResultsException

NoResultsException(Throwable, StatementContext) - Constructor for exception class org.jdbi.v3.core.result.NoResultsException

NoSuchCollectorException - Exception Class in org.jdbi.v3.core.collector

Thrown when Jdbi tries to produce a result Collector but doesn't have a factory to produce it with.

NoSuchCollectorException(String) - Constructor for exception class org.jdbi.v3.core.collector.NoSuchCollectorException

NoSuchCollectorException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.collector.NoSuchCollectorException

NoSuchCollectorException(Throwable) - Constructor for exception class org.jdbi.v3.core.collector.NoSuchCollectorException

NoSuchExtensionException - Exception Class in org.jdbi.v3.core.extension

Thrown when no ExtensionFactory accepts a given extension type.

NoSuchExtensionException(Class<?>) - Constructor for exception class org.jdbi.v3.core.extension.NoSuchExtensionException

Creates an instance with an extension type and the default message.

NoSuchExtensionException(Class<?>, String) - Constructor for exception class org.jdbi.v3.core.extension.NoSuchExtensionException

Creates an instance with an extension type and a custom message.

NoSuchExtensionException(Class<?>, String, Throwable) - Constructor for exception class org.jdbi.v3.core.extension.NoSuchExtensionException

Creates an instance with an extension type and a custom message.

NoSuchExtensionException(Class<?>, Throwable) - Constructor for exception class org.jdbi.v3.core.extension.NoSuchExtensionException

Creates an instance with an extension type and the default message.

NoSuchMapperException - Exception Class in org.jdbi.v3.core.mapper

Thrown when you attempt to map a type that Jdbi doesn't have a registered mapper factory for.

NoSuchMapperException(String) - Constructor for exception class org.jdbi.v3.core.mapper.NoSuchMapperException

NoSuchMapperException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.mapper.NoSuchMapperException

NoSuchMapperException(Throwable) - Constructor for exception class org.jdbi.v3.core.mapper.NoSuchMapperException

NoTemplateEngine - Class in org.jdbi.v3.core.statement

A TemplateEngine that does not do any templating but returns SQL verbatim.

NoTemplateEngine() - Constructor for class org.jdbi.v3.core.statement.NoTemplateEngine

noUnqualifiedHstoreBindings() - Static method in class org.jdbi.v3.postgres.PostgresPlugin

Do not install the legacy (unqualified) bindings for HStoreArgumentFactory and HStoreColumnMapper.

NULL - Enum constant in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Deprecated.

vaguely named in light of new additions, use BindList.EmptyHandling.NULL_STRING instead

NULL_HANDLER - Static variable in interface org.jdbi.v3.core.extension.ExtensionHandler

Handler that only returns null independent of any input parameters.

NULL_KEYWORD - Enum constant in enum org.jdbi.v3.core.statement.EmptyHandling

Render the keyword null in the query, useful e.g.

NULL_STRING - Enum constant in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Define "null", useful e.g.

NULL_VALUE - Enum constant in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Define null, leaving the result up to the TemplateEngine to decide.

NullArgument - Class in org.jdbi.v3.core.argument

A typed SQL null argument.

NullArgument(int) - Constructor for class org.jdbi.v3.core.argument.NullArgument

NullArgument(Integer) - Constructor for class org.jdbi.v3.core.argument.NullArgument

NVarchar - Annotation Type in org.jdbi.v3.core.qualifier

Argument qualifier annotation, indicating that the annotated String element should be bound as an NVARCHAR instead of a VARCHAR.

O

OBJECT_ARRAY - Enum constant in enum org.jdbi.v3.core.array.SqlArrayArgumentStrategy

Bind using PreparedStatement.setObject(int, Object) with an array object.

ObjectArgument - Class in org.jdbi.v3.core.argument

An Argument which uses setObject to support vendor specific types.

ObjectArgument(Object, Integer) - Constructor for class org.jdbi.v3.core.argument.ObjectArgument

Deprecated.

use ObjectArgument.of(Object, Integer) factory method for more consistent null handling

ObjectArgumentFactory - Class in org.jdbi.v3.core.argument

Argument factory that matches a specified type and binds it as an ObjectArgument.

ObjectFieldArguments - Class in org.jdbi.v3.core.argument

Deprecated.

this functionality will remain supported, but this class should not be API

ObjectFieldArguments(String, Object) - Constructor for class org.jdbi.v3.core.argument.ObjectFieldArguments

Deprecated.

ObjectMethodArguments - Class in org.jdbi.v3.core.argument

Deprecated.

this functionality will remain supported, but this class should not be API

ObjectMethodArguments(String, Object) - Constructor for class org.jdbi.v3.core.argument.ObjectMethodArguments

Deprecated.

of(CharSequence...) - Static method in class org.jdbi.v3.core.Sql

of(Class<C>, Consumer<C>) - Static method in class org.jdbi.v3.core.config.ConfiguringPlugin

of(Class<T>) - Static method in class org.jdbi.v3.core.mapper.reflect.BeanMapper

Returns a mapper for the given bean class

of(Class<T>) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Return a ConstructorMapper for the given type.

of(Class<T>) - Static method in class org.jdbi.v3.core.mapper.reflect.FieldMapper

Returns a mapper for the given bean class

of(Class<T>) - Static method in class org.jdbi.v3.core.qualifier.QualifiedType

Creates a QualifiedType<T> for a Class<T> with no qualifiers.

of(Class<T>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.BeanMapper

Returns a mapper for the given bean class

of(Class<T>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Return a ConstructorMapper for the given type and prefix.

of(Class<T>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.FieldMapper

Returns a mapper for the given bean class

of(Class<T>, String, Function<T, ?>) - Static method in interface org.jdbi.v3.core.array.SqlArrayTypeFactory

Create a SqlArrayTypeFactory for the given elementType that binds using a type name and convert function.

of(Iterable<? extends CharSequence>) - Static method in class org.jdbi.v3.core.Sql

of(Object) - Static method in class org.jdbi.v3.core.argument.ObjectArgument

Bind a vendor-supported object with the given SQL type.

of(Object, Integer) - Static method in class org.jdbi.v3.core.argument.ObjectArgument

Bind a vendor-supported object with the given SQL type.

of(Constructor<T>) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Return a ConstructorMapper using the given constructor

of(Constructor<T>, String) - Static method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

Instantiate a ConstructorMapper using the given constructor and prefix

of(Type) - Static method in class org.jdbi.v3.core.qualifier.QualifiedType

Creates a wildcard QualifiedType<?> for a Type with no qualifiers.

of(Type, ColumnMapper<?>) - Static method in interface org.jdbi.v3.core.mapper.ColumnMapperFactory

Create a ColumnMapperFactory from a given ColumnMapper that matches a single Type exactly.

of(Type, RowMapper<?>) - Static method in interface org.jdbi.v3.core.mapper.RowMapperFactory

Create a RowMapperFactory from a given RowMapper that matches a Type exactly.

of(String, String, String, BiFunction<String, String, String>) - Static method in class org.jdbi.v3.testing.junit5.tc.TestcontainersDatabaseInformation

Creates a new database information instance that describes a database.

of(String, Function<T, ?>) - Static method in interface org.jdbi.v3.core.array.SqlArrayType

Create a SqlArrayType from the given type and convert function.

of(String, ParsedParameters) - Static method in class org.jdbi.v3.core.statement.ParsedSql

A static factory of ParsedSql instances.

of(Supplier<ResultSet>, RowMapper<T>, StatementContext) - Static method in interface org.jdbi.v3.core.result.ResultIterable

Returns a ResultIterable backed by the given result set supplier, mapper, and context.

of(Supplier<ResultSet>, StatementContext) - Static method in interface org.jdbi.v3.core.result.ResultBearing

Returns a ResultBearing backed by the given result set supplier and context.

of(GenericType<T>) - Static method in class org.jdbi.v3.core.qualifier.QualifiedType

Creates a QualifiedType<T> for a GenericType<T> with no qualifiers.

of(QualifiedType<T>, ColumnMapper<T>) - Static method in interface org.jdbi.v3.core.mapper.QualifiedColumnMapperFactory

Create a QualifiedColumnMapperFactory from a given ColumnMapper that matches a single QualifiedType exactly.

of(ResultIterable<U>, Supplier<int[]>) - Static method in interface org.jdbi.v3.core.result.BatchResultIterable

of(ResultIterator<T>) - Static method in interface org.jdbi.v3.core.result.ResultIterable

Returns a ResultIterable backed by the given iterator.

ofScript(String, String, String, BiFunction<String, String, List<String>>) - Static method in class org.jdbi.v3.testing.junit5.tc.TestcontainersDatabaseInformation

Creates a new database information instance that describes a database.

onCreateProxy() - Method in class org.jdbi.v3.core.extension.Extensions

Throw if proxy creation is disallowed.

onDemand(Class<E>) - Method in class org.jdbi.v3.core.Jdbi

Creates an extension instance that uses the current Jdbi instance for database operations.

one() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns the only row in the result set.

one() - Method in class org.jdbi.v3.core.statement.Update

onEmpty() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindList

What to do when the argument is null or empty.

open() - Method in class org.jdbi.v3.core.Jdbi

Obtain a Handle to the data source wrapped by this Jdbi instance.

open(String) - Static method in class org.jdbi.v3.core.Jdbi

Obtain a handle with just a JDBC URL

open(String, String, String) - Static method in class org.jdbi.v3.core.Jdbi

Obtain a handle with just a JDBC URL

open(String, Properties) - Static method in class org.jdbi.v3.core.Jdbi

Obtain a handle with just a JDBC URL

open(Connection) - Static method in class org.jdbi.v3.core.Jdbi

Create a Handle wrapping a particular JDBC Connection

open(DataSource) - Static method in class org.jdbi.v3.core.Jdbi

Convenience method used to obtain a handle from a specific data source

open(ConnectionFactory) - Static method in class org.jdbi.v3.core.Jdbi

Convenience method used to obtain a handle from a ConnectionFactory.

openConnection() - Method in interface org.jdbi.v3.core.ConnectionFactory

Opens a connection.

openConnection() - Method in class org.jdbi.v3.spring5.SpringConnectionFactory

openHandle() - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Open a new Handle to the used data source.

OptionalCollectors - Class in org.jdbi.v3.core.collector

Factory methods for collectors of optional types.

org.jdbi.v3.cache.caffeine - package org.jdbi.v3.cache.caffeine

Cache implementation using the Caffeine cache library.

org.jdbi.v3.cache.noop - package org.jdbi.v3.cache.noop

A non-caching cache implementation.

org.jdbi.v3.commonstext - package org.jdbi.v3.commonstext

org.jdbi.v3.core - package org.jdbi.v3.core

The 'core' package hosts the top level interface into jdbi core.

org.jdbi.v3.core.annotation - package org.jdbi.v3.core.annotation

org.jdbi.v3.core.argument - package org.jdbi.v3.core.argument

The argument classes translate Java types into JDBC parameters.

org.jdbi.v3.core.array - package org.jdbi.v3.core.array

The array package binds Java arrays and collections to SQL arrays, and handles mapping array result types back to Java arrays and collections.

org.jdbi.v3.core.async - package org.jdbi.v3.core.async

org.jdbi.v3.core.cache - package org.jdbi.v3.core.cache

Pluggable cache interface for Jdbi internal caches.

org.jdbi.v3.core.codec - package org.jdbi.v3.core.codec

org.jdbi.v3.core.collector - package org.jdbi.v3.core.collector

The collector package reduces the mapped rows of the result set into a Stream Collector to produce the final aggregated result.

org.jdbi.v3.core.config - package org.jdbi.v3.core.config

The config classes define a configuration registry starting from each Jdbi instance.

org.jdbi.v3.core.enums - package org.jdbi.v3.core.enums

org.jdbi.v3.core.extension - package org.jdbi.v3.core.extension

The extension classes allow you to extend Jdbi's functionality by declaring interface types that may attach to Handle instances.

org.jdbi.v3.core.extension.annotation - package org.jdbi.v3.core.extension.annotation

org.jdbi.v3.core.generic - package org.jdbi.v3.core.generic

The generic package holds utility methods and helper types for reflectively working with Java generic types.

org.jdbi.v3.core.h2 - package org.jdbi.v3.core.h2

The h2 package adds vendor support for the H2 embeddable pure Java database implementation.

org.jdbi.v3.core.interceptor - package org.jdbi.v3.core.interceptor

org.jdbi.v3.core.locator - package org.jdbi.v3.core.locator

locator instances inspect text given to Jdbi and provide lookup of the actual SQL to execute.

org.jdbi.v3.core.mapper - package org.jdbi.v3.core.mapper

mappers take the JDBC ResultSet and produce Java results.

org.jdbi.v3.core.mapper.freebuilder - package org.jdbi.v3.core.mapper.freebuilder

org.jdbi.v3.core.mapper.immutables - package org.jdbi.v3.core.mapper.immutables

org.jdbi.v3.core.mapper.reflect - package org.jdbi.v3.core.mapper.reflect

mapper.reflect provides RowMappers that reflectively construct result types using techniques like constructor injection or JavaBeans setters.

org.jdbi.v3.core.qualifier - package org.jdbi.v3.core.qualifier

org.jdbi.v3.core.result - package org.jdbi.v3.core.result

result provides the streaming interface that reads rows from JDBC and drives the mapper and collector processes to produce results.

org.jdbi.v3.core.spi - package org.jdbi.v3.core.spi

The spi package includes entrypoints to extending Jdbi instances with your own custom functionality.

org.jdbi.v3.core.statement - package org.jdbi.v3.core.statement

The statement package provides most of the Fluent API to drive statement execution.

org.jdbi.v3.core.transaction - package org.jdbi.v3.core.transaction

The transaction package implements the strategy Jdbi uses to open and close transactions.

org.jdbi.v3.freemarker - package org.jdbi.v3.freemarker

freemarker provides advanced string template processing.

org.jdbi.v3.generator - package org.jdbi.v3.generator

org.jdbi.v3.gson2 - package org.jdbi.v3.gson2

org.jdbi.v3.guava - package org.jdbi.v3.guava

guava provides extra types that are commonly needed beyond built in JDK types.

org.jdbi.v3.guava.codec - package org.jdbi.v3.guava.codec

org.jdbi.v3.guice - package org.jdbi.v3.guice

Google Guice integration.

org.jdbi.v3.jackson2 - package org.jdbi.v3.jackson2

org.jdbi.v3.jodatime2 - package org.jdbi.v3.jodatime2

joda-time provides improved date and time types to pre-Java 8 applications.

org.jdbi.v3.jpa - package org.jdbi.v3.jpa

The jpa plugin provides minimal support for discovering JPA annotations like Column.

org.jdbi.v3.json - package org.jdbi.v3.json

org.jdbi.v3.meta - package org.jdbi.v3.meta

org.jdbi.v3.moshi - package org.jdbi.v3.moshi

org.jdbi.v3.postgis - package org.jdbi.v3.postgis

org.jdbi.v3.postgres - package org.jdbi.v3.postgres

The postgres plugin provides improved support for java.time, hstore, uuid, and enum types when configured with a recent Postgres database server.

org.jdbi.v3.spring5 - package org.jdbi.v3.spring5

Classes here provide integration hooks for working with the Spring framework.

org.jdbi.v3.sqlite3 - package org.jdbi.v3.sqlite3

The sqlite plugin provides improved support for java.net.URL.

org.jdbi.v3.sqlobject - package org.jdbi.v3.sqlobject

SQL Objects

org.jdbi.v3.sqlobject.config - package 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.customizer - package org.jdbi.v3.sqlobject.customizer

The sqlobject.customizer package provides annotations that customize the execution of a statement.

org.jdbi.v3.sqlobject.locator - package 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 - package 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 - package org.jdbi.v3.sqlobject.transaction

sqlobject.transaction annotations declaratively create transactions wrapping a SqlObject method.

org.jdbi.v3.stringtemplate4 - package org.jdbi.v3.stringtemplate4

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.

org.jdbi.v3.testing - package org.jdbi.v3.testing

JUnit 4 testing support.

org.jdbi.v3.testing.junit5 - package org.jdbi.v3.testing.junit5

JUnit 5 testing support.

org.jdbi.v3.testing.junit5.tc - package org.jdbi.v3.testing.junit5.tc

Jdbi test support for Testcontainer based JDBC containers.

org.jdbi.v3.vavr - package org.jdbi.v3.vavr

vavr is a functional programming library for the JVM.

otjEmbeddedPostgres() - Static method in class org.jdbi.v3.testing.junit5.JdbiExtension

Deprecated, for removal: This API element is subject to removal in a future version.

The OtjPostgres project ships its artifact as an automatic module with filename based module name. It is strongly discouraged to ship any JPMS enabled project that depends on automatic modules with filename based module names. We have reached out to the OtjPostgres project and proposed a change that would fix this. If they ship a version that fixes this before we are ready to move to full JPMS support, we will un-deprecate this class, otherwise it will be removed with our switch to JPMS.

OutParameter - Annotation Type in org.jdbi.v3.sqlobject.customizer

Declare a named out parameter on an @SqlCall annotated method.

OutParameterList - Annotation Type in org.jdbi.v3.sqlobject.customizer

OutParameters - Class in org.jdbi.v3.core.statement

Represents output from a Call (CallableStatement).

P

ParameterCustomizerFactory - Interface in org.jdbi.v3.sqlobject.statement

parameterizeClass(Class<?>, Type...) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Creates a type of class clazz with arguments as type arguments.

PARAMETERS - Enum constant in enum org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

Include bound parameters but not the SQL.

parse(String, ConfigRegistry) - Method in class org.jdbi.v3.core.statement.DefinedAttributeTemplateEngine

parse(String, ConfigRegistry) - Method in interface org.jdbi.v3.core.statement.TemplateEngine

Parse a SQL template and return a parsed representation ready to apply to a statement.

parse(String, ConfigRegistry) - Method in interface org.jdbi.v3.core.statement.TemplateEngine.Parsing

parse(String, ConfigRegistry) - Method in class org.jdbi.v3.freemarker.FreemarkerEngine

parse(String, StatementContext) - Method in class org.jdbi.v3.core.statement.CachingSqlParser

parse(String, StatementContext) - Method in interface org.jdbi.v3.core.statement.SqlParser

Parses the given SQL statement, and returns the ParsedSql for the statement.

PARSED_SQL_CACHE_SIZE - Static variable in class org.jdbi.v3.core.statement.CachingSqlParser

The default size of the parsed SQL cache.

ParsedParameters - Class in org.jdbi.v3.core.statement

The parsed parameters from an SQL statement.

ParsedSql - Class in org.jdbi.v3.core.statement

The SQL and parameters parsed from an SQL statement.

ParsedSql.Builder - Class in org.jdbi.v3.core.statement

Fluent builder for ParsedSql instances.

PeriodArgumentFactory - Class in org.jdbi.v3.postgres

Postgres version of argument factory for Period.

PeriodArgumentFactory() - Constructor for class org.jdbi.v3.postgres.PeriodArgumentFactory

PeriodColumnMapperFactory - Class in org.jdbi.v3.postgres

A column mapper which maps Postgres's PGInterval type to Java's Period.

PeriodColumnMapperFactory() - Constructor for class org.jdbi.v3.postgres.PeriodColumnMapperFactory

PgLobApi - Interface in org.jdbi.v3.postgres

positional(int) - Static method in class org.jdbi.v3.core.statement.ParsedParameters

A static factory of positional ParsedParameters instances.

PostgisPlugin - Class in org.jdbi.v3.postgis

Postgis plugin.

PostgisPlugin() - Constructor for class org.jdbi.v3.postgis.PostgisPlugin

postgres(EmbeddedPgExtension) - Static method in class org.jdbi.v3.testing.junit5.JdbiExtension

Creates a new extension using a managed, embedded postgres database.

PostgresPlugin - Class in org.jdbi.v3.postgres

Postgres plugin.

PostgresPlugin() - Constructor for class org.jdbi.v3.postgres.PostgresPlugin

PostgresTypes - Class in org.jdbi.v3.postgres

Handler for PostgreSQL custom types.

PostgresTypes() - Constructor for class org.jdbi.v3.postgres.PostgresTypes

prefix() - Element in annotation type org.jdbi.v3.commonstext.UseStringSubstitutorTemplateEngine

prefix() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterBeanMapper

Column name prefix for the bean type.

prefix() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterConstructorMapper

Column name prefix for the mapped type.

prefix() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterFieldMapper

Column name prefix for the mapped type.

prepare(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.AbstractArgumentFactory

prepare(Type, ConfigRegistry) - Method in interface org.jdbi.v3.core.argument.ArgumentFactory.Preparable

prepare(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.BuiltInArgumentFactory

Deprecated.

prepare(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.ObjectArgumentFactory

prepare(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.argument.SetObjectArgumentFactory

prepare(Type, ConfigRegistry) - Method in class org.jdbi.v3.core.array.SqlArrayArgumentFactory

prepare(QualifiedType<?>, ConfigRegistry) - Method in interface org.jdbi.v3.core.argument.QualifiedArgumentFactory.Preparable

prepare(QualifiedType<?>, ConfigRegistry) - Method in class org.jdbi.v3.core.codec.CodecFactory

prepareBatch(CharSequence) - Method in class org.jdbi.v3.core.Handle

Prepare a batch to execute.

prepareBatch(String) - Method in class org.jdbi.v3.core.Handle

Prepare a batch to execute.

PreparedBatch - Class in org.jdbi.v3.core.statement

Represents a prepared batch statement.

PreparedBatch(Handle, CharSequence) - Constructor for class org.jdbi.v3.core.statement.PreparedBatch

PreparedBatch(Handle, String) - Constructor for class org.jdbi.v3.core.statement.PreparedBatch

Backwards compatible constructor that takes an explicit string argument.

prepareFor(Type) - Method in class org.jdbi.v3.core.argument.Arguments

Obtain a prepared argument function for given type in the given context.

prepareFor(QualifiedType<?>) - Method in class org.jdbi.v3.core.argument.Arguments

Obtain a prepared argument function for given type in the given context.

prePreparedTypes() - Method in class org.jdbi.v3.core.argument.AbstractArgumentFactory

Deprecated.

no longer used

prePreparedTypes() - Method in interface org.jdbi.v3.core.argument.ArgumentFactory.Preparable

Deprecated.

no longer used

prePreparedTypes() - Method in class org.jdbi.v3.core.argument.BuiltInArgumentFactory

Deprecated.

no longer used

prePreparedTypes() - Method in interface org.jdbi.v3.core.argument.QualifiedArgumentFactory.Preparable

Deprecated.

no longer used

prePreparedTypes() - Method in class org.jdbi.v3.core.argument.SetObjectArgumentFactory

Deprecated.

no longer used

prePreparedTypes() - Method in class org.jdbi.v3.core.codec.CodecFactory

Deprecated.

no longer used

prePreparedTypes() - Method in class org.jdbi.v3.postgres.InetArgumentFactory

Deprecated.

no longer used

process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.jdbi.v3.generator.GenerateSqlObjectProcessor

process(S) - Method in class org.jdbi.v3.core.interceptor.JdbiInterceptionChainHolder

Processes a source object and returns a target object.

produce(Supplier<PreparedStatement>, StatementContext) - Method in interface org.jdbi.v3.core.result.ResultProducer

Produces a statement result from a lazily supplied PreparedStatement.

PropagateNull - Annotation Type in org.jdbi.v3.core.mapper

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.

propertyNames() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindBeanList

The list of properties to invoke on each element in the argument

provideValue(DatabaseMetaData) - Method in interface org.jdbi.v3.core.statement.MetaData.MetaDataResultSetProvider

provideValue(DatabaseMetaData) - Method in interface org.jdbi.v3.core.statement.MetaData.MetaDataValueProvider

Q

QualifiedArgumentFactory - Interface in org.jdbi.v3.core.argument

Inspect a value with optional static qualified type information and produce an Argument that binds the value to a prepared statement.

QualifiedArgumentFactory.Preparable - Interface in org.jdbi.v3.core.argument

QualifiedArgumentFactory extension interface that allows preparing arguments for efficient batch binding.

QualifiedColumnMapperFactory - Interface in org.jdbi.v3.core.mapper

Factory interface used to produce column mappers.

QualifiedType<T> - Class in org.jdbi.v3.core.qualifier

A Type qualified by a set of qualifier annotations.

qualifiedTypeOf(ELEM) - Method in class org.jdbi.v3.core.qualifier.Qualifiers

Qualifier - Annotation Type in org.jdbi.v3.core.qualifier

Annotation used to identify type qualifying annotations.

Qualifiers - Class in org.jdbi.v3.core.qualifier

Utility class for type qualifiers supported by Jdbi core.

Qualifiers() - Constructor for class org.jdbi.v3.core.qualifier.Qualifiers

Query - Class in org.jdbi.v3.core.statement

Statement providing convenience result handling for SQL queries.

Query(Handle, CharSequence) - Constructor for class org.jdbi.v3.core.statement.Query

Query(Handle, String) - Constructor for class org.jdbi.v3.core.statement.Query

Backwards compatible constructor that takes an explicit string argument.

queryMetadata(MetaData.MetaDataResultSetProvider) - Method in class org.jdbi.v3.core.Handle

Access database metadata that returns a ResultSet.

queryMetadata(MetaData.MetaDataValueProvider<T>) - Method in class org.jdbi.v3.core.Handle

Access all database metadata that returns simple values.

QueryTimeOut - Annotation Type in org.jdbi.v3.sqlobject.customizer

Specify the query timeout in seconds.

R

READ_COMMITTED - Enum constant in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

READ_UNCOMMITTED - Enum constant in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

readLob(long) - Method in interface org.jdbi.v3.postgres.PgLobApi

readOnly() - Element in annotation type org.jdbi.v3.sqlobject.transaction.Transaction

Set the connection readOnly property before the transaction starts, and restore it before it returns.

reduce(U, BiFunction<U, T, U>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Reduce the results.

reduceResultSet(U, ResultSetAccumulator<U>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

reduceResultSet(U, ResultSetAccumulator<U>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Reduce the results.

reduceRows(BiConsumer<Map<K, V>, RowView>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

reduceRows(BiConsumer<Map<K, V>, RowView>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Reduce the result rows using a Map<K, V> as the result container.

reduceRows(RowReducer<C, R>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

reduceRows(RowReducer<C, R>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Reduce the result rows using the given row reducer.

reduceRows(U, BiFunction<U, RowView, U>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

reduceRows(U, BiFunction<U, RowView, U>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Reduce the results.

ReflectionMappers - Class in org.jdbi.v3.core.mapper.reflect

Configuration class for reflective mappers.

ReflectionMappers() - Constructor for class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Create a default configuration that attempts case insensitive and snake_case matching for names.

ReflectionMapperUtil - Class in org.jdbi.v3.core.mapper.reflect

Utilities for reflective mappers.

register(Class<?>, String) - Method in class org.jdbi.v3.core.array.SqlArrayTypes

Register an array element type that is supported by the JDBC vendor.

register(Type, ColumnMapper<?>) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Register a column mapper for a given explicit Type Column mappers may be reused by RowMapper to map individual columns.

register(Type, RowMapper<?>) - Method in class org.jdbi.v3.core.mapper.RowMappers

Register a row mapper for a given type.

register(ArgumentFactory) - Method in class org.jdbi.v3.core.argument.Arguments

Registers the given argument factory.

register(QualifiedArgumentFactory) - Method in class org.jdbi.v3.core.argument.Arguments

Registers the given qualified argument factory.

register(SqlArrayType<?>) - Method in class org.jdbi.v3.core.array.SqlArrayTypes

Register a SqlArrayType which will have its parameterized type inspected to determine which element type it supports.

register(SqlArrayTypeFactory) - Method in class org.jdbi.v3.core.array.SqlArrayTypes

Register a SqlArrayTypeFactory.

register(CollectorFactory) - Method in class org.jdbi.v3.core.collector.JdbiCollectors

Register a new CollectorFactory.

register(ExtensionFactory) - Method in class org.jdbi.v3.core.extension.Extensions

Register a ExtensionFactory instance with the extension framework.

register(GenericType<T>, ColumnMapper<T>) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Register a column mapper for a given explicit GenericType Column mappers may be reused by RowMapper to map individual columns.

register(GenericType<T>, RowMapper<T>) - Method in class org.jdbi.v3.core.mapper.RowMappers

Register a row mapper for a given type.

register(ColumnMapper<?>) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Register a column mapper which will have its parameterized type inspected to determine what it maps to.

register(ColumnMapperFactory) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Register a column mapper factory.

register(QualifiedColumnMapperFactory) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Register a qualified column mapper factory.

register(RowMapper<?>) - Method in class org.jdbi.v3.core.mapper.RowMappers

Register a row mapper which will have its parameterized type inspected to determine what it maps to.

register(RowMapperFactory) - Method in class org.jdbi.v3.core.mapper.RowMappers

Register a row mapper factory.

register(QualifiedType<T>, ColumnMapper<T>) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

Register a column mapper for a given QualifiedType Column mappers may be reused by RowMapper to map individual columns.

register(HandlerDecorator) - Method in class org.jdbi.v3.sqlobject.HandlerDecorators

Deprecated.

Registers the given handler decorator with the registry.

register(HandlerFactory) - Method in class org.jdbi.v3.sqlobject.Handlers

Deprecated.

Registers the given handler factory with the registry.

registerArgument(ArgumentFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(Arguments.class).register(factory)

registerArgument(QualifiedArgumentFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(Arguments.class).register(factory)

RegisterArgumentFactories - Annotation Type in org.jdbi.v3.sqlobject.config

RegisterArgumentFactory - Annotation Type in org.jdbi.v3.sqlobject.config

Used to register an argument factory with either a sql object type or for a specific method.

registerArrayType(Class<?>, String) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)

registerArrayType(Class<T>, String, Function<T, ?>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for registering an array type as SqlArrayTypeFactory.of(Class, String, Function).

registerArrayType(SqlArrayType<?>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(SqlArrayTypes.class).register(arrayType)

registerArrayType(SqlArrayTypeFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(SqlArrayTypes.class).register(factory)

RegisterBeanMapper - Annotation Type in org.jdbi.v3.sqlobject.config

Registers a BeanMapper for a specific bean class

RegisterBeanMappers - Annotation Type in org.jdbi.v3.sqlobject.config

registerCodecFactory(CodecFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method to register a CodecFactory.

registerCollector(Type, Collector<?, ?, ?>) - Method in class org.jdbi.v3.core.collector.JdbiCollectors

Register a new Collector for the given type.

registerCollector(Type, Collector<?, ?, ?>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(JdbiCollectors.class).register(CollectorFactory.collectorFactory(collectionType, collector))

registerCollector(CollectorFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(JdbiCollectors.class).register(factory)

RegisterCollector - Annotation Type in org.jdbi.v3.sqlobject.config

Registers specifically one collector for a sql object type

RegisterCollectorFactory - Annotation Type in org.jdbi.v3.sqlobject.config

Used to register a collector factory on the current SqlStatement either for a sql object type or for a method.

registerColumnMapper(Type, ColumnMapper<?>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(ColumnMappers.class).register(type, mapper)

registerColumnMapper(GenericType<T>, ColumnMapper<T>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(ColumnMappers.class).register(type, mapper)

registerColumnMapper(ColumnMapper<?>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(ColumnMappers.class).register(mapper)

registerColumnMapper(ColumnMapperFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(ColumnMappers.class).register(factory)

registerColumnMapper(QualifiedColumnMapperFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(ColumnMappers.class).register(factory)

registerColumnMapper(QualifiedType<T>, ColumnMapper<T>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(ColumnMappers.class).register(type, mapper)

RegisterColumnMapper - Annotation Type in org.jdbi.v3.sqlobject.config

Registers a column mapper in the scope of a SQL Object type or method.

RegisterColumnMapperFactories - Annotation Type in org.jdbi.v3.sqlobject.config

RegisterColumnMapperFactory - Annotation Type in org.jdbi.v3.sqlobject.config

Registers a column mapper factory in the scope of a SQL Object type or method.

RegisterColumnMappers - Annotation Type in org.jdbi.v3.sqlobject.config

registerConfigCustomizerFactory(ConfigCustomizerFactory) - Method in class org.jdbi.v3.core.extension.Extensions

Registers a global ConfigCustomizerFactory instance.

RegisterConstructorMapper - Annotation Type in org.jdbi.v3.sqlobject.config

Registers a constructor mapper factory for the given type(s).

RegisterConstructorMappers - Annotation Type in org.jdbi.v3.sqlobject.config

registerCustomType(Class<? extends PGobject>, String) - Method in class org.jdbi.v3.postgres.PostgresTypes

Register a Postgres custom type.

registerExtension(ExtensionFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(Extensions.class).register(factory)

RegisterFieldMapper - Annotation Type in org.jdbi.v3.sqlobject.config

Register types to reflectively assign fields with FieldMapper.

RegisterFieldMappers - Annotation Type in org.jdbi.v3.sqlobject.config

registerFreeBuilder(Class<?>...) - Method in class org.jdbi.v3.core.mapper.freebuilder.JdbiFreeBuilders

Convenience method for registering many freebuilder types.

registerFreeBuilder(Class<S>) - Method in class org.jdbi.v3.core.mapper.freebuilder.JdbiFreeBuilders

Register bean arguments and row mapping for a Freebuilder value class, expecting the default generated class and builder names.

registerFreeBuilder(Class<S>, Class<I>, Supplier<?>) - Method in class org.jdbi.v3.core.mapper.freebuilder.JdbiFreeBuilders

Register bean arguments and row mapping for a FreeBuilder value class, using a supplied implementation and constructor.

registerFreeBuilder(Iterable<Class<?>>) - Method in class org.jdbi.v3.core.mapper.freebuilder.JdbiFreeBuilders

Convenience method for registering many freebuilder types.

registerHandlerCustomizer(ExtensionHandlerCustomizer) - Method in class org.jdbi.v3.core.extension.Extensions

Registers a global ExtensionHandlerCustomizer instance.

registerHandlerFactory(ExtensionHandlerFactory) - Method in class org.jdbi.v3.core.extension.Extensions

Registers a global ExtensionHandlerFactory instance.

registerImmutable(Class<?>...) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Convenience method for registering many immutable types.

registerImmutable(Class<S>) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Register bean arguments and row mapping for an Immutable* value class, expecting the default generated class and builder names.

registerImmutable(Class<S>, Class<I>, Supplier<?>) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Register bean arguments and row mapping for an Immutable* value class, using a supplied implementation and builder.

registerImmutable(Iterable<Class<?>>) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Convenience method for registering many immutable types.

RegisterJoinRowMapper - Annotation Type in org.jdbi.v3.sqlobject.config

Used to register a JoinRowMapper factory.

registerModifiable(Class<?>...) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Convenience method for registering many modifiable types.

registerModifiable(Class<S>) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Register bean arguments and row mapping for an Modifiable* value class, expecting the default generated class and public nullary constructor.

registerModifiable(Class<S>, Class<M>, Supplier<?>) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Register bean arguments and row mapping for an Modifiable* value class, using a supplied implementation and constructor.

registerModifiable(Iterable<Class<?>>) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

Convenience method for registering many modifiable types.

RegisterObjectArgumentFactories - Annotation Type in org.jdbi.v3.sqlobject.config

RegisterObjectArgumentFactory - Annotation Type in org.jdbi.v3.sqlobject.config

Registers an argument factory for a type compatible with PreparedStatement.setObject(int, Object).

registerOutParameter(int, int) - Method in class org.jdbi.v3.core.statement.Call

Register a positional output parameter.

registerOutParameter(int, int, CallableStatementMapper) - Method in class org.jdbi.v3.core.statement.Call

Register a positional output parameter.

registerOutParameter(String, int) - Method in class org.jdbi.v3.core.statement.Call

Register a named output parameter.

registerOutParameter(String, int, CallableStatementMapper) - Method in class org.jdbi.v3.core.statement.Call

Register a named output parameter.

registerRowMapper(Type, RowMapper<?>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(RowMappers.class).register(type, mapper)

registerRowMapper(GenericType<T>, RowMapper<T>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(RowMappers.class).register(type, mapper)

registerRowMapper(RowMapper<?>) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(RowMappers.class).register(mapper)

registerRowMapper(RowMapperFactory) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(RowMappers.class).register(factory)

RegisterRowMapper - Annotation Type in org.jdbi.v3.sqlobject.config

Register a row mapper in the context of a SQL Object type or method.

RegisterRowMapperFactories - Annotation Type in org.jdbi.v3.sqlobject.config

RegisterRowMapperFactory - Annotation Type in org.jdbi.v3.sqlobject.config

Registers a row mapper factory in the scope of a SQL Object type or method.

RegisterRowMappers - Annotation Type in org.jdbi.v3.sqlobject.config

release(String) - Method in class org.jdbi.v3.core.Handle

Deprecated.

Use Handle.releaseSavepoint(String)

releaseSavepoint(String) - Method in class org.jdbi.v3.core.Handle

Release a previously created savepoint.

releaseSavepoint(String) - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Releases the given savepoint.

releaseSavepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

Savepoints are not supported.

releaseSavepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

releaseSavepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

releaseSavepoint(Handle, String) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Release a previously created savepoint.

removeCleanable(Cleanable) - Method in class org.jdbi.v3.core.Handle

Unregister a Cleanable from the Handle.

removeHandleListener(HandleListener) - Method in class org.jdbi.v3.core.Handle

Remove a HandleListener from this handle.

removeListener(HandleListener) - Method in class org.jdbi.v3.core.Handles

Remove a HandleListener.

removingComments() - Static method in class org.jdbi.v3.core.locator.ClasspathSqlLocator

Return a new ClasspathSqlLocator that returns SQL with comments removed.

render(String, StatementContext) - Method in class org.jdbi.v3.commonstext.StringSubstitutorTemplateEngine

render(String, StatementContext) - Method in class org.jdbi.v3.core.statement.MessageFormatTemplateEngine

Deprecated.

render(String, StatementContext) - Method in class org.jdbi.v3.core.statement.NoTemplateEngine

render(String, StatementContext) - Method in interface org.jdbi.v3.core.statement.TemplateEngine.Parsing

render(String, StatementContext) - Method in interface org.jdbi.v3.core.statement.TemplateEngine

Renders an SQL statement from the given template, using the statement context as needed.

render(String, StatementContext) - Method in class org.jdbi.v3.stringtemplate4.StringTemplateEngine

REPEATABLE_READ - Enum constant in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

reset(Handle) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

resolveMapEntryType(Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Given a subtype of Map<K,V>, returns the corresponding map entry type Map.Entry<K,V>.

resolveMapEntryType(Type, Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Given a key and value type, returns the map entry type Map.Entry<keyType,valueType>.

resolveParameter(ParameterContext, ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

resolveType(Type, Type) - Static method in class org.jdbi.v3.core.generic.GenericTypes

Resolves the type parameter in the context of contextType.

ResultBearing - Interface in org.jdbi.v3.core.result

Provides access to the contents of a ResultSet by mapping to Java types.

ResultIterable<T> - Interface in org.jdbi.v3.core.result

An Iterable of values, usually mapped from a ResultSet.

ResultIterable.ResultIteratorDelegate<T,R> - Class in org.jdbi.v3.core.result

An implementation of ResultIterator that delegates calls to the iterator provided in the constructor.

ResultIterator<T> - Interface in org.jdbi.v3.core.result

Represents a forward-only iterator over a result set, which will lazily iterate the results.

ResultProducer<R> - Interface in org.jdbi.v3.core.result

Produces a result from an executed PreparedStatement.

ResultProducers - Class in org.jdbi.v3.core.result

Commonly used ResultProducer implementations.

ResultProducers() - Constructor for class org.jdbi.v3.core.result.ResultProducers

ResultProducers.ResultSetCreator - Interface in org.jdbi.v3.core.result

ResultSetAccumulator<T> - Interface in org.jdbi.v3.core.result

A ResultSetAccumulator repeatedly combines rows from the given ResultSet to produce a single result.

ResultSetException - Exception Class in org.jdbi.v3.core.result

Wraps exceptions thrown while traversing the JDBC result set.

ResultSetException(String, Exception, StatementContext) - Constructor for exception class org.jdbi.v3.core.result.ResultSetException

ResultSetScanner<T> - Interface in org.jdbi.v3.core.result

Scan over rows of result sets, mapping and collecting the rows to a result type.

returningGeneratedKeys(String...) - Static method in class org.jdbi.v3.core.result.ResultProducers

Result producer that returns a ResultBearing over the statement-generated keys.

returningResults() - Static method in class org.jdbi.v3.core.result.ResultProducers

Result producer that returns a ResultBearing over the statement result rows.

returningUpdateCount() - Static method in class org.jdbi.v3.core.result.ResultProducers

Result producer that eagerly executes the statement, returning the update count

rollback() - Method in class org.jdbi.v3.core.Handle

Rollback a transaction.

rollback() - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Rolls back the open transaction.

rollback(Handle) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

Called when a transaction is rolled back Will throw a RuntimeException to force transactional rollback

rollback(Handle) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

rollback(Handle) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

rollback(Handle) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Roll back the transaction.

RollbackOnlyTransactionHandler - Class in org.jdbi.v3.core.transaction

A transaction handler that always calls DelegatingTransactionHandler.rollback(org.jdbi.v3.core.Handle) instead of RollbackOnlyTransactionHandler.commit(org.jdbi.v3.core.Handle).

RollbackOnlyTransactionHandler() - Constructor for class org.jdbi.v3.core.transaction.RollbackOnlyTransactionHandler

RollbackOnlyTransactionHandler(TransactionHandler) - Constructor for class org.jdbi.v3.core.transaction.RollbackOnlyTransactionHandler

rollbackToSavepoint(String) - Method in class org.jdbi.v3.core.Handle

Rollback a transaction to a named savepoint.

rollbackToSavepoint(String) - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Rolls back to the given savepoint.

rollbackToSavepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

Savepoints are not supported.

rollbackToSavepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

rollbackToSavepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

rollbackToSavepoint(Handle, String) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Roll back to a named savepoint.

RowMapper<T> - Interface in org.jdbi.v3.core.mapper

Maps result set rows to objects.

RowMapperFactory - Interface in org.jdbi.v3.core.mapper

Factory interface used to produce row mappers.

RowMappers - Class in org.jdbi.v3.core.mapper

Configuration registry for RowMapperFactory instances.

RowMappers() - Constructor for class org.jdbi.v3.core.mapper.RowMappers

RowReducer<C,R> - Interface in org.jdbi.v3.core.result

Reduces row data from a ResultSet into a stream of result elements.

RowView - Class in org.jdbi.v3.core.result

A RowView is an accessor for ResultSet that uses RowMapper or ColumnMapper to extract values.

RowView() - Constructor for class org.jdbi.v3.core.result.RowView

RowViewMapper<T> - Interface in org.jdbi.v3.core.mapper

Higher level cousin of RowMapper that operates over RowViews rather than the bare ResultSet.

S

savepoint(String) - Method in class org.jdbi.v3.core.Handle

Create a transaction savepoint with the name provided.

savepoint(String) - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Creates a savepoint with the given name on the transaction.

savepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.CMTTransactionHandler

Savepoints are not supported.

savepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.DelegatingTransactionHandler

savepoint(Handle, String) - Method in class org.jdbi.v3.core.transaction.LocalTransactionHandler

savepoint(Handle, String) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Create a new savepoint.

scanResultSet(Supplier<ResultSet>, StatementContext) - Method in interface org.jdbi.v3.core.result.ResultSetScanner

Scans the lazily-supplied ResultSet into a result.

scanResultSet(ResultSetScanner<R>) - Method in class org.jdbi.v3.core.result.BatchResultBearing

scanResultSet(ResultSetScanner<R>) - Method in interface org.jdbi.v3.core.result.ResultBearing

Invokes the mapper with a result set supplier, and returns the value returned by the mapper.

scanResultSet(ResultSetScanner<R>) - Method in class org.jdbi.v3.core.statement.MetaData

scanResultSet(ResultSetScanner<R>) - Method in class org.jdbi.v3.core.statement.PreparedBatch

scanResultSet(ResultSetScanner<R>) - Method in class org.jdbi.v3.core.statement.Query

Script - Class in org.jdbi.v3.core.statement

Represents a number of SQL statements delimited by semicolon which will be executed in order in a batch statement.

Script(Handle, CharSequence) - Constructor for class org.jdbi.v3.core.statement.Script

Script(Handle, String) - Constructor for class org.jdbi.v3.core.statement.Script

Backwards compatible constructor that takes an explicit string argument.

select(CharSequence, Object...) - Method in class org.jdbi.v3.core.Handle

Convenience method which creates a query with the given positional arguments.

select(String, Object...) - Method in class org.jdbi.v3.core.Handle

Convenience method which creates a query with the given positional arguments.

SERIALIZABLE - Enum constant in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

SerializableTransactionRunner - Class in org.jdbi.v3.core.transaction

A TransactionHandler that automatically retries transactions that fail due to serialization failures, which can generally be resolved by automatically retrying the transaction.

SerializableTransactionRunner() - Constructor for class org.jdbi.v3.core.transaction.SerializableTransactionRunner

SerializableTransactionRunner(TransactionHandler) - Constructor for class org.jdbi.v3.core.transaction.SerializableTransactionRunner

SerializableTransactionRunner.Configuration - Class in org.jdbi.v3.core.transaction

Configuration for serializable transaction runner.

set() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns results in a Set using the JDK specific default implementation of Set as provided by Collectors.toSet().

setAccessibleObjectStrategy(Consumer<AccessibleObject>) - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Set the strategy Jdbi uses for Java accessibility rules.

setAllowProxy(boolean) - Method in class org.jdbi.v3.core.extension.Extensions

Allow using Proxy to implement extensions.

setArgumentStrategy(SqlArrayArgumentStrategy) - Method in class org.jdbi.v3.core.array.SqlArrayTypes

Sets the strategy used when binding array-type arguments to SQL statements.

setAttachAllStatementsForCleanup(boolean) - Method in class org.jdbi.v3.core.statement.SqlStatements

Sets whether all statements created will automatically attached to the corresponding Handle object automatically.

setAttachCallbackStatementsForCleanup(boolean) - Method in class org.jdbi.v3.core.statement.SqlStatements

Sets whether statements created within the Jdbi.withHandle(org.jdbi.v3.core.HandleCallback<R, X>), Jdbi.useHandle(org.jdbi.v3.core.HandleConsumer<X>), Jdbi.inTransaction(org.jdbi.v3.core.HandleCallback<R, X>) and Jdbi.useTransaction(org.jdbi.v3.core.HandleConsumer<X>) callback methods will automatically attached to the Handle object and therefore cleaned up when the callback ends.

setAutoInstallPlugins(boolean) - Method in class org.jdbi.v3.spring5.JdbiFactoryBean

Sets whether to install plugins automatically from the classpath, using ServiceLoader manifests.

setBindingNullToPrimitivesPermitted(boolean) - Method in class org.jdbi.v3.core.argument.Arguments

Whether binding null to a variable declared as a primitive type should be allowed.

setCaseChange(UnaryOperator<String>) - Method in class org.jdbi.v3.core.mapper.MapMappers

Sets the case change strategy for the database column names.

setCaseChange(UnaryOperator<String>) - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Sets the case change strategy for the database column names.

setCoalesceNullPrimitivesToDefaults(boolean) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

setColumn(int, String) - Method in class org.jdbi.v3.vavr.TupleMappers

Names a specific column in the mapper.

setColumnNameMatchers(List<ColumnNameMatcher>) - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Replace all column name matchers with the given list.

setCompletionMoment(Instant) - Method in class org.jdbi.v3.core.statement.StatementContext

Sets the query execution end.

setConcurrentUpdatable(boolean) - Method in class org.jdbi.v3.core.statement.StatementContext

Set the context to create a concurrent updatable result set.

setDataSource(DataSource) - Method in class org.jdbi.v3.spring5.JdbiFactoryBean

The datasource, which should be managed by spring's transaction system, from which the Jdbi will obtain connections

setDefaultParameterCustomizerFactory(ParameterCustomizerFactory) - Method in class org.jdbi.v3.sqlobject.SqlObjects

Configures SqlObject to use the given default parameter customizer factory.

setDeserializationView(Class<?>) - Method in class org.jdbi.v3.jackson2.Jackson2Config

Set the @JsonView used to deserialize.

setEnumStrategy(EnumStrategy) - Method in class org.jdbi.v3.core.enums.Enums

Sets the default strategy for mapping and binding enums.

setExceptionMoment(Instant) - Method in class org.jdbi.v3.core.statement.StatementContext

Sets the query execution end.

setExecutionMoment(Instant) - Method in class org.jdbi.v3.core.statement.StatementContext

Sets the query execution start.

setFailOnMissingAttribute(boolean) - Method in class org.jdbi.v3.stringtemplate4.StringTemplates

Control whether missing attributes cause a rendering exception.

setFetchSize(int) - Method in class org.jdbi.v3.core.statement.Query

Specify the fetch size for the query.

setForceEndTransactions(boolean) - Method in class org.jdbi.v3.core.Handles

Sets whether to enforce transaction termination discipline when a Handle is closed.

setFreemarkerConfiguration(Configuration) - Method in class org.jdbi.v3.freemarker.FreemarkerConfig

setGeneratedKeysColumnNames(String[]) - Method in class org.jdbi.v3.core.statement.StatementContext

Set the generated key column names.

setGlobalDefines(Map<String, Object>) - Method in class org.jdbi.v3.spring5.JdbiFactoryBean

setGson(Gson) - Method in class org.jdbi.v3.gson2.Gson2Config

Set the Gson to use for json conversion.

setHandleCallbackDecorator(HandleCallbackDecorator) - Method in class org.jdbi.v3.core.Jdbi

Specify the HandleCallbackDecorator instance to use.

setJsonMapper(JsonMapper) - Method in class org.jdbi.v3.json.JsonConfig

setKeyColumn(String) - Method in interface org.jdbi.v3.core.mapper.MapEntryConfig

Sets the column that map entry keys are loaded from.

setKeyColumn(String) - Method in class org.jdbi.v3.core.mapper.MapEntryMappers

Sets the column that map entry keys are loaded from.

setKeyColumn(String) - Method in class org.jdbi.v3.vavr.TupleMappers

setLengthLimit(int) - Method in class org.jdbi.v3.core.statement.StatementExceptions

Set a hint on how long you'd like to shorten various variable-length strings to.

setMapKeyColumn(String) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(MapEntryMappers.class).setKeyColumn(keyColumn)

setMapper(ObjectMapper) - Method in class org.jdbi.v3.jackson2.Jackson2Config

Set the ObjectMapper to use for json conversion.

setMapValueColumn(String) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(MapEntryMappers.class).setValueColumn(valueColumn)

setMaxFieldSize(int) - Method in class org.jdbi.v3.core.statement.Query

Specify the maximum field size in the result set.

setMaxRetries(int) - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner.Configuration

Sets the maximum number of retry attempts before aborting.

setMaxRows(int) - Method in class org.jdbi.v3.core.statement.Query

Specify the maximum number of rows the query is to return.

setMessageRendering(Function<StatementException, String>) - Method in class org.jdbi.v3.core.statement.StatementExceptions

Configure exception statement message generation.

setMoshi(Moshi) - Method in class org.jdbi.v3.moshi.MoshiConfig

Set the Moshi to use for json conversion.

SetObjectArgumentFactory - Class in org.jdbi.v3.core.argument

Factory that uses PreparedStatement.setObject(int, Object, int) to bind values.

setOnFailure(Consumer<List<Exception>>) - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner.Configuration

Set a consumer that is called with a list of exceptions during a run.

setOnSuccess(Consumer<List<Exception>>) - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner.Configuration

Sets a consumer that is called after a run has completed successfully.

setPlugins(Collection<JdbiPlugin>) - Method in class org.jdbi.v3.spring5.JdbiFactoryBean

Installs the given plugins which will be installed into the Jdbi.

setPreparedArgumentsEnabled(boolean) - Method in class org.jdbi.v3.core.argument.Arguments

Configure whether ArgumentFactory.Preparable factories will be processed before regular ArgumentFactory instances are.

setQueryTimeout(int) - Method in class org.jdbi.v3.core.statement.SqlStatement

Set the query timeout, in seconds, on the prepared statement.

setQueryTimeout(Integer) - Method in class org.jdbi.v3.core.statement.SqlStatements

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

setReadOnly(boolean) - Method in class org.jdbi.v3.core.Handle

Set the Handle read-only.

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.argument.Arguments

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.array.SqlArrayTypes

setRegistry(ConfigRegistry) - Method in interface org.jdbi.v3.core.config.JdbiConfig

The registry will inject itself into the configuration object.

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.extension.Extensions

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.ColumnMappers

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.freebuilder.JdbiFreeBuilders

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.immutables.JdbiImmutables

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.Mappers

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.mapper.RowMappers

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.core.qualifier.Qualifiers

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.postgres.PostgresTypes

setRegistry(ConfigRegistry) - Method in class org.jdbi.v3.vavr.TupleMappers

setReturningGeneratedKeys(boolean) - Method in class org.jdbi.v3.core.statement.StatementContext

Sets whether the current statement returns generated keys.

setSerializationFailureSqlState(String) - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner.Configuration

Sets the SQL state to consider as a serialization failure.

setSerializationView(Class<?>) - Method in class org.jdbi.v3.jackson2.Jackson2Config

Set the @JsonView used to serialize.

setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)

setSqlLocator(SqlLocator) - Method in class org.jdbi.v3.sqlobject.SqlObjects

Configures SqlObject to use the given SqlLocator.

setSqlLogger(SqlLogger) - Method in interface org.jdbi.v3.core.config.Configurable

setSqlLogger(SqlLogger) - Method in class org.jdbi.v3.core.statement.SqlStatements

Sets a SqlLogger instance to log all SQL operations.

setSqlParser(SqlParser) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(SqlStatements.class).setSqlParser(rewriter)

setSqlParser(SqlParser) - Method in class org.jdbi.v3.core.statement.SqlStatements

Sets the SqlParser used to parse parameters in SQL statements executed by Jdbi.

setStatementBuilder(StatementBuilder) - Method in class org.jdbi.v3.core.Handle

Set the statement builder for this handle.

setStatementBuilderFactory(StatementBuilderFactory) - Method in class org.jdbi.v3.core.Jdbi

Allows customization of how prepared statements are created.

setStrictMatching(boolean) - Method in class org.jdbi.v3.core.mapper.reflect.ReflectionMappers

Throw an IllegalArgumentException if a the set of fields doesn't match to columns exactly.

setTemplateCache(JdbiCacheBuilder) - Method in class org.jdbi.v3.core.statement.SqlStatements

Sets the cache used to avoid repeatedly parsing SQL statements.

setTemplateEngine(TemplateEngine) - Method in interface org.jdbi.v3.core.config.Configurable

Convenience method for getConfig(SqlStatements.class).setTemplateEngine(rewriter)

setTemplateEngine(TemplateEngine) - Method in class org.jdbi.v3.core.statement.SqlStatements

Sets the TemplateEngine used to render SQL for all SQL statements executed by Jdbi.

setTimezone(ZoneId) - Method in class org.jdbi.v3.sqlobject.customizer.TimestampedConfig

Sets the timezone used for the conversion of OffsetDateTime objects.

setTimingCollector(TimingCollector) - Method in interface org.jdbi.v3.core.config.Configurable

Deprecated.

use Configurable.setSqlLogger(org.jdbi.v3.core.statement.SqlLogger) instead

setTimingCollector(TimingCollector) - Method in class org.jdbi.v3.core.statement.SqlStatements

Deprecated.

use SqlStatements.setSqlLogger(org.jdbi.v3.core.statement.SqlLogger) instead

setTransactionHandler(TransactionHandler) - Method in class org.jdbi.v3.core.Jdbi

Specify the TransactionHandler instance to use.

setTransactionIsolation(int) - Method in class org.jdbi.v3.core.Handle

Deprecated.

Use Handle.setTransactionIsolationLevel(TransactionIsolationLevel)

setTransactionIsolation(TransactionIsolationLevel) - Method in class org.jdbi.v3.core.Handle

Deprecated.

Use Handle.setTransactionIsolationLevel(int)

setTransactionIsolationLevel(int) - Method in class org.jdbi.v3.core.Handle

Set the transaction isolation level on the underlying connection if it is different from the current isolation level.

setTransactionIsolationLevel(TransactionIsolationLevel) - Method in class org.jdbi.v3.core.Handle

Set the transaction isolation level on the underlying connection if it is different from the current isolation level.

setUntypedNullArgument(Argument) - Method in class org.jdbi.v3.core.argument.Arguments

Configure the Argument to use when binding a null we don't have a type for.

setUnusedBindingAllowed(boolean) - Method in class org.jdbi.v3.core.statement.SqlStatements

Sets whether or not an exception should be thrown when any arguments are given to a query but not actually used in it.

setValueColumn(String) - Method in interface org.jdbi.v3.core.mapper.MapEntryConfig

Sets the column that map entry values are loaded from.

setValueColumn(String) - Method in class org.jdbi.v3.core.mapper.MapEntryMappers

Sets the column that map entry values are loaded from.

setValueColumn(String) - Method in class org.jdbi.v3.vavr.TupleMappers

setView(Class<?>) - Method in class org.jdbi.v3.jackson2.Jackson2Config

Set both serialization and deserialization @JsonView to the given class.

SHORT_STATEMENT - Enum constant in enum org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

Include a length-limited SQL statement and parameter information.

SimpleExtensionConfigurer - Class in org.jdbi.v3.core.extension

Configurer base class that applies the same configuration changes independent whether an annotation is placed on the type or a method.

SimpleExtensionConfigurer() - Constructor for class org.jdbi.v3.core.extension.SimpleExtensionConfigurer

SingleColumnMapper<T> - Class in org.jdbi.v3.core.mapper

Adapts a ColumnMapper into a RowMapper by mapping a single column.

SingleColumnMapper(ColumnMapper<T>) - Constructor for class org.jdbi.v3.core.mapper.SingleColumnMapper

Constructs a row mapper which maps the first column.

SingleColumnMapper(ColumnMapper<T>, int) - Constructor for class org.jdbi.v3.core.mapper.SingleColumnMapper

Constructs a row mapper which maps the given column number.

SingleColumnMapper(ColumnMapper<T>, String) - Constructor for class org.jdbi.v3.core.mapper.SingleColumnMapper

Constructs a row mapper which maps the column with the given label.

Singleton() - Constructor for class org.jdbi.v3.core.spi.JdbiPlugin.Singleton

SingleValue - Annotation Type in org.jdbi.v3.sqlobject

Indicate to SqlObject that a type that looks like a container should be treated as a single element.

size() - Method in class org.jdbi.v3.core.statement.PreparedBatch

Returns the number of bindings in this batch.

Slf4JSqlLogger - Class in org.jdbi.v3.core.statement

Simple SqlLogger that emits some diagnostic information about Jdbi usage.

Slf4JSqlLogger() - Constructor for class org.jdbi.v3.core.statement.Slf4JSqlLogger

Slf4JSqlLogger(Logger) - Constructor for class org.jdbi.v3.core.statement.Slf4JSqlLogger

SnakeCaseColumnNameMatcher - Class in org.jdbi.v3.core.mapper.reflect

Matches snake case column names to java camel case names, ignoring case.

SnakeCaseColumnNameMatcher() - Constructor for class org.jdbi.v3.core.mapper.reflect.SnakeCaseColumnNameMatcher

specialize(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.JoinRowMapper

specialize(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.MapEntryMapper

specialize(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.MapMapper

specialize(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.reflect.ConstructorMapper

specialize(ResultSet, StatementContext) - Method in class org.jdbi.v3.core.mapper.reflect.FieldMapper

specialize(ResultSet, StatementContext) - Method in interface org.jdbi.v3.core.mapper.RowMapper

Returns a specialized row mapper, optimized for the given result set.

specialize(ResultSet, StatementContext) - Method in interface org.jdbi.v3.core.mapper.RowViewMapper

specialize(ResultSet, StatementContext) - Method in class org.jdbi.v3.jpa.JpaMapper

specialize(Handle) - Method in class org.jdbi.v3.core.transaction.SerializableTransactionRunner

specialize(Handle) - Method in interface org.jdbi.v3.core.transaction.TransactionHandler

Bind a TransactionHandler to a Handle, to allow it to track handle-local state.

SpringConnectionFactory - Class in org.jdbi.v3.spring5

SpringConnectionFactory(DataSource) - Constructor for class org.jdbi.v3.spring5.SpringConnectionFactory

Sql - Class in org.jdbi.v3.core

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.

SQL_ARRAY - Enum constant in enum org.jdbi.v3.core.array.SqlArrayArgumentStrategy

Bind using Connection.createArrayOf(String, Object[]) and PreparedStatement.setArray(int, java.sql.Array).

SQL_TEMPLATE_CACHE_SIZE - Static variable in class org.jdbi.v3.core.statement.SqlStatements

The default size of the SQL template cache.

SqlArrayArgumentFactory - Class in org.jdbi.v3.core.array

Bind a Java array or Collection to a SQL array using the SqlArrayTypeFactory for the given type information.

SqlArrayArgumentFactory() - Constructor for class org.jdbi.v3.core.array.SqlArrayArgumentFactory

SqlArrayArgumentStrategy - Enum in org.jdbi.v3.core.array

Strategies used to bind SQL array arguments to a PreparedStatement.

SqlArrayMapperFactory - Class in org.jdbi.v3.core.array

Maps SQL array columns into Java arrays or other Java container types.

SqlArrayMapperFactory() - Constructor for class org.jdbi.v3.core.array.SqlArrayMapperFactory

SqlArrayType<T> - Interface in org.jdbi.v3.core.array

Strategy for converting elements of array-like arguments into SQL array elements.

SqlArrayTypeFactory - Interface in org.jdbi.v3.core.array

Factory interface to produce SqlArrayType instances.

SqlArrayTypes - Class in org.jdbi.v3.core.array

Configuration class for SQL array binding and mapping.

SqlArrayTypes() - Constructor for class org.jdbi.v3.core.array.SqlArrayTypes

SqlBatch - Annotation Type in org.jdbi.v3.sqlobject.statement

Annotate a method to indicate that it will create and execute a SQL batch.

SqlCall - Annotation Type in org.jdbi.v3.sqlobject.statement

Support for stored proc invocation.

sqlite() - Static method in class org.jdbi.v3.testing.JdbiRule

Create a JdbiRule with an in-memory Sqlite database instance.

sqlite() - Static method in class org.jdbi.v3.testing.junit5.JdbiExtension

Creates a new extension using the SQLite database.

SQLitePlugin - Class in org.jdbi.v3.sqlite3

Jdbi plugin for SQLite.

SQLitePlugin() - Constructor for class org.jdbi.v3.sqlite3.SQLitePlugin

SqlLocator - Interface in org.jdbi.v3.sqlobject.locator

Locates SQL for jdbi SQL Object methods.

SqlLogger - Interface in org.jdbi.v3.core.statement

SqlLoggers receive query data before and after a query is executed, and after an exception is thrown by a bad query.

SqlMethodDecoratingAnnotation - Annotation Type in org.jdbi.v3.sqlobject

Deprecated.

Use UseExtensionHandlerCustomizer instead and implement ExtensionHandlerCustomizer for the value.

SqlObject - Interface in org.jdbi.v3.sqlobject

SqlObject base interface.

SqlObjectClasspathSqlLocator - Class in org.jdbi.v3.sqlobject.locator

Locates SQL in .sql files on the classpath for use with SqlQuery.

SqlObjectClasspathSqlLocator() - Constructor for class org.jdbi.v3.sqlobject.locator.SqlObjectClasspathSqlLocator

Creates a new SqlObjectClasspathSqlLocator.

SqlObjectClasspathSqlLocator(ClasspathSqlLocator) - Constructor for class org.jdbi.v3.sqlobject.locator.SqlObjectClasspathSqlLocator

Creates a new SqlObjectClasspathSqlLocator.

SqlObjectFactory - Class in org.jdbi.v3.sqlobject

Creates implementations for SqlObject interfaces.

SqlObjectPlugin - Class in org.jdbi.v3.sqlobject

Plugin that installs the SqlObject extension.

SqlObjectPlugin() - Constructor for class org.jdbi.v3.sqlobject.SqlObjectPlugin

SqlObjects - Class in org.jdbi.v3.sqlobject

Configuration class for SQL objects.

SqlObjects() - Constructor for class org.jdbi.v3.sqlobject.SqlObjects

SQL Objects - Search tag in package org.jdbi.v3.sqlobject

Section

SqlOperation - Annotation Type in org.jdbi.v3.sqlobject

Deprecated.

Use UseExtensionHandler and SqlObjectFactory.EXTENSION_ID as the id marker.

SqlParser - Interface in org.jdbi.v3.core.statement

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).

SqlQuery - Annotation Type in org.jdbi.v3.sqlobject.statement

Used to indicate that a method should execute a query.

SqlScript - Annotation Type in org.jdbi.v3.sqlobject.statement

Annotate a method to indicate that it will execute one or more SQL statements.

SqlScripts - Annotation Type in org.jdbi.v3.sqlobject.statement

Holder for repeating SqlScripts.

SqlStatement<This> - Class in org.jdbi.v3.core.statement

This class provides the common functions between Query and Update.

SqlStatementCustomizer - Interface in org.jdbi.v3.sqlobject.customizer

Used with SqlStatementCustomizerFactory to customize sql statements via annotations.

SqlStatementCustomizerFactory - Interface in org.jdbi.v3.sqlobject.customizer

Interface used in conjunction with SqlStatementCustomizingAnnotation to generate SqlStatementCustomizer instances.

SqlStatementCustomizingAnnotation - Annotation Type in org.jdbi.v3.sqlobject.customizer

Annotation used to build customizing annotations.

SqlStatementParameterCustomizer - Interface in org.jdbi.v3.sqlobject.customizer

Customize a SqlStatement according to the value of an annotated parameter.

SqlStatements - Class in org.jdbi.v3.core.statement

Configuration holder for SqlStatements.

SqlStatements() - Constructor for class org.jdbi.v3.core.statement.SqlStatements

sqlType() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterObjectArgumentFactory

SQL type constant from Types.

sqlType() - Element in annotation type org.jdbi.v3.sqlobject.customizer.OutParameter

SqlUpdate - Annotation Type in org.jdbi.v3.sqlobject.statement

Used to indicate that a method should execute a non-query sql statement.

STANDARD_HANDLE_CALLBACK_DECORATOR - Static variable in interface org.jdbi.v3.core.HandleCallbackDecorator

StatementBuilder - Interface in org.jdbi.v3.core.statement

Used to convert translated SQL into a prepared statement.

StatementBuilderFactory - Interface in org.jdbi.v3.core.statement

Used to specify how prepared statements are built.

StatementContext - Class in org.jdbi.v3.core.statement

The statement context provides access to statement-local configuration.

StatementContextListener - Interface in org.jdbi.v3.core.statement

Listener interface for the StatementContext.

StatementCustomizer - Interface in org.jdbi.v3.core.statement

Allows tweaking of statement behaviour.

StatementCustomizers - Class in org.jdbi.v3.core.statement

Some simple StatementCustomizers you might find handy.

StatementException - Exception Class in org.jdbi.v3.core.statement

Superclass for exceptions thrown while trying to execute a statement.

StatementException(String) - Constructor for exception class org.jdbi.v3.core.statement.StatementException

StatementException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.statement.StatementException

StatementException(String, Throwable, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.StatementException

StatementException(String, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.StatementException

StatementException(Throwable) - Constructor for exception class org.jdbi.v3.core.statement.StatementException

StatementException(Throwable, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.StatementException

StatementExceptions - Class in org.jdbi.v3.core.statement

Configuration for StatementException and subclasses behavior.

StatementExceptions() - Constructor for class org.jdbi.v3.core.statement.StatementExceptions

StatementExceptions.MessageRendering - Enum in org.jdbi.v3.core.statement

Control exception message generation.

statementTimeout(int) - Static method in class org.jdbi.v3.core.statement.StatementCustomizers

Set a timeout on the statement.

stream() - Method in interface org.jdbi.v3.core.result.ResultIterable

Returns the stream of results.

stream(C) - Method in interface org.jdbi.v3.core.result.RowReducer

Returns a stream of result elements from the result container.

stream(Map<K, V>) - Method in interface org.jdbi.v3.core.result.LinkedHashMapRowReducer

StreamCallback<T,R,X> - Interface in org.jdbi.v3.core.result

Callback for use with ResultIterable.withStream(StreamCallback)

StreamConsumer<T,X> - Interface in org.jdbi.v3.core.result

Callback for use with ResultIterable.useStream(StreamConsumer)

StringSubstitutorTemplateEngine - Class in org.jdbi.v3.commonstext

Register an instance of this class (SqlStatements.setTemplateEngine(org.jdbi.v3.core.statement.TemplateEngine)) to use an Apache Commons Text StringSubstitutor as a TemplateEngine.

StringSubstitutorTemplateEngine() - Constructor for class org.jdbi.v3.commonstext.StringSubstitutorTemplateEngine

Default is

StringSubstitutorTemplateEngine(Consumer<StringSubstitutor>) - Constructor for class org.jdbi.v3.commonstext.StringSubstitutorTemplateEngine

Customize the given StringSubstitutor instance to set your preferred prefix, suffix, escape character, and perhaps other configuration.

StringTemplateEngine - Class in org.jdbi.v3.stringtemplate4

Rewrites a StringTemplate template, using the attributes on the StatementContext as template parameters.

StringTemplateEngine() - Constructor for class org.jdbi.v3.stringtemplate4.StringTemplateEngine

StringTemplates - Class in org.jdbi.v3.stringtemplate4

Configuration options for StringTemplateEngine.

StringTemplates() - Constructor for class org.jdbi.v3.stringtemplate4.StringTemplates

StringTemplateSqlLocator - Class in org.jdbi.v3.stringtemplate4

Locates SQL in .sql.stg StringTemplate group files on the classpath.

stripComments() - Element in annotation type org.jdbi.v3.sqlobject.locator.UseClasspathSqlLocator

subSequence(int, int) - Method in class org.jdbi.v3.core.Sql

suffix() - Element in annotation type org.jdbi.v3.commonstext.UseStringSubstitutorTemplateEngine

supportsParameter(ParameterContext, ExtensionContext) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

T

TemplateEngine - Interface in org.jdbi.v3.core.statement

Renders an SQL statement from a template.

TemplateEngine.Parsing - Interface in org.jdbi.v3.core.statement

TestcontainersDatabaseInformation - Class in org.jdbi.v3.testing.junit5.tc

Describes the parameters needed to create a new test-specific database or schema to isolate a test.

THROW - Enum constant in enum org.jdbi.v3.core.statement.EmptyHandling

Throw IllegalArgumentException.

THROW - Enum constant in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Throw IllegalArgumentException.

Timestamped - Annotation Type in org.jdbi.v3.sqlobject.customizer

Binds the named parameter :now or a custom named parameter with the current DateTime as an OffsetDateTime.

TimestampedConfig - Class in org.jdbi.v3.sqlobject.customizer

Configuration for Timestamped.

TimestampedConfig() - Constructor for class org.jdbi.v3.sqlobject.customizer.TimestampedConfig

TimingCollector - Interface in org.jdbi.v3.core.statement

Deprecated.

Use SqlLogger instead.

toArrayListMultimap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into an ArrayListMultimap<K, V>.

toCollection(Supplier<C>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Collect the results into a collection object similar to Collectors.toCollection(Supplier).

toHashBiMap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into a HashBiMap<K, V>.

toHashMultimap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into a HashMultimap<K, V>.

toImmutableListMultimap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into an ImmutableListMultimap<K, V>.

toImmutableMap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into an ImmutableMap<K, V>.

toImmutableSetMultimap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into an ImmutableSetMultimap<K, V>.

toJson(Object, ConfigRegistry) - Method in interface org.jdbi.v3.json.JsonMapper.TypedJsonMapper

toJson(Type, Object, ConfigRegistry) - Method in interface org.jdbi.v3.json.JsonMapper

Deprecated.

toLinkedListMultimap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into a LinkedListMultimap<K, V>.

toMap(Supplier<M>) - Static method in class org.jdbi.v3.core.collector.BuiltInCollectorFactory

Deprecated.

Use MapCollectors.toMap(Supplier) instead.

toMap(Supplier<M>) - Static method in class org.jdbi.v3.core.collector.MapCollectors

toMultimap(Supplier<M>) - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into a Multimap<K, V> of the supplied type.

toOption() - Static method in class org.jdbi.v3.vavr.VavrCollectors

Returns a Collector that accumulates 0 or 1 input elements into an Option<T>.

toOptional() - Static method in class org.jdbi.v3.core.collector.BuiltInCollectorFactory

Deprecated.

Use OptionalCollectors.toOptional() instead.

toOptional() - Static method in class org.jdbi.v3.core.collector.OptionalCollectors

Returns a Collector that accumulates 0 or 1 input elements into an Optional<T>.

toOptional() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates 0 or 1 input elements into Guava's Optional<T>.

toOptional(Supplier<O>, Function<T, O>) - Static method in class org.jdbi.v3.core.collector.OptionalCollectors

Returns a Collector that accumulates 0 or 1 input elements into an arbitrary optional-style container type.

toOptionalDouble() - Static method in class org.jdbi.v3.core.collector.OptionalCollectors

Returns a Collector that accumulates 0 or 1 input Double elements into an OptionalDouble.

toOptionalInt() - Static method in class org.jdbi.v3.core.collector.OptionalCollectors

Returns a Collector that accumulates 0 or 1 input Integer elements into an OptionalInt.

toOptionalLong() - Static method in class org.jdbi.v3.core.collector.OptionalCollectors

Returns a Collector that accumulates 0 or 1 input Long elements into an OptionalLong.

toString() - Method in class org.jdbi.v3.core.argument.CharacterStreamArgument

toString() - Method in class org.jdbi.v3.core.argument.InputStreamArgument

toString() - Method in class org.jdbi.v3.core.argument.MapArguments

Deprecated.

toString() - Method in class org.jdbi.v3.core.argument.NullArgument

toString() - Method in class org.jdbi.v3.core.argument.ObjectArgument

toString() - Method in class org.jdbi.v3.core.argument.ObjectFieldArguments

Deprecated.

toString() - Method in class org.jdbi.v3.core.argument.ObjectMethodArguments

Deprecated.

toString() - Method in class org.jdbi.v3.core.extension.ExtensionMethod

toString() - Method in class org.jdbi.v3.core.mapper.reflect.CaseInsensitiveColumnNameMatcher

toString() - Method in class org.jdbi.v3.core.mapper.reflect.SnakeCaseColumnNameMatcher

toString() - Method in class org.jdbi.v3.core.qualifier.QualifiedType

toString() - Method in class org.jdbi.v3.core.Sql

toString() - Method in class org.jdbi.v3.core.statement.Binding

toString() - Method in class org.jdbi.v3.core.statement.ParsedParameters

toString() - Method in class org.jdbi.v3.core.statement.ParsedSql

toString() - Method in class org.jdbi.v3.core.statement.SqlStatement

toString() - Method in class org.jdbi.v3.testing.junit5.tc.TestcontainersDatabaseInformation

toTreeMultimap() - Static method in class org.jdbi.v3.guava.GuavaCollectors

Returns a Collector that accumulates Map.Entry<K, V> input elements into a TreeMultimap<K, V>.

Transaction - Annotation Type in org.jdbi.v3.sqlobject.transaction

Causes the annotated method to be run in a transaction.

transactional() - Element in annotation type org.jdbi.v3.sqlobject.statement.SqlBatch

Controls whether to execute the batch chunks in a transaction.

Transactional<This> - Interface in org.jdbi.v3.sqlobject.transaction

A mixin interface to expose transaction methods on the sql object.

TransactionalCallback<R,T,X> - Interface in org.jdbi.v3.sqlobject.transaction

Callback that expects an open transaction and produces a result.

TransactionalConsumer<T,X> - Interface in org.jdbi.v3.sqlobject.transaction

Callback that expects an open transaction and returns no results.

TransactionException - Exception Class in org.jdbi.v3.core.transaction

Thrown when there's a problem manipulating the transaction isolation level.

TransactionException(String) - Constructor for exception class org.jdbi.v3.core.transaction.TransactionException

TransactionException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.transaction.TransactionException

TransactionException(Throwable) - Constructor for exception class org.jdbi.v3.core.transaction.TransactionException

TransactionHandler - Interface in org.jdbi.v3.core.transaction

Interface which defines callbacks to be used when transaction methods are called on a handle.

TransactionIsolationLevel - Enum in org.jdbi.v3.core.transaction

Supported transaction isolation levels.

Transactions - Search tag in package org.jdbi.v3.sqlobject

Section

TupleMappers - Class in org.jdbi.v3.vavr

Mappers similar to MapEntryMappers but map entries in vavr are in fact of type Tuple2.

TupleMappers() - Constructor for class org.jdbi.v3.vavr.TupleMappers

TypedEnumArgumentFactory - Class in org.jdbi.v3.postgres

Default jdbi behavior is to bind Enum subclasses as a string, which Postgres won't implicitly convert to an enum type.

TypedEnumArgumentFactory() - Constructor for class org.jdbi.v3.postgres.TypedEnumArgumentFactory

TypeResolvingCodecFactory - Class in org.jdbi.v3.guava.codec

An extended CodecFactory which can resolve Codecs for subtypes.

TypeResolvingCodecFactory(Map<QualifiedType<?>, Codec<?>>) - Constructor for class org.jdbi.v3.guava.codec.TypeResolvingCodecFactory

Create a new TypeResolvingCodecFactory.

U

UnableToCreateExtensionException - Exception Class in org.jdbi.v3.core.extension

Marks that a specific extension could not be created.

UnableToCreateExtensionException(String, Object...) - Constructor for exception class org.jdbi.v3.core.extension.UnableToCreateExtensionException

Constructs a new instance with a message.

UnableToCreateExtensionException(Throwable) - Constructor for exception class org.jdbi.v3.core.extension.UnableToCreateExtensionException

UnableToCreateExtensionException(Throwable, String, Object...) - Constructor for exception class org.jdbi.v3.core.extension.UnableToCreateExtensionException

Constructs a new instance with an exception and a message.

UnableToCreateSqlObjectException - Exception Class in org.jdbi.v3.sqlobject

Thrown when constructing a SqlObject fails.

UnableToCreateSqlObjectException(String) - Constructor for exception class org.jdbi.v3.sqlobject.UnableToCreateSqlObjectException

UnableToCreateSqlObjectException(String, Throwable) - Constructor for exception class org.jdbi.v3.sqlobject.UnableToCreateSqlObjectException

UnableToCreateSqlObjectException(Throwable) - Constructor for exception class org.jdbi.v3.sqlobject.UnableToCreateSqlObjectException

UnableToCreateStatementException - Exception Class in org.jdbi.v3.core.statement

Thrown when Jdbi couldn't create a statement.

UnableToCreateStatementException(Exception, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.UnableToCreateStatementException

UnableToCreateStatementException(String) - Constructor for exception class org.jdbi.v3.core.statement.UnableToCreateStatementException

UnableToCreateStatementException(String, Throwable) - Constructor for exception class org.jdbi.v3.core.statement.UnableToCreateStatementException

UnableToCreateStatementException(String, Throwable, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.UnableToCreateStatementException

UnableToCreateStatementException(String, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.UnableToCreateStatementException

UnableToCreateStatementException(Throwable) - Constructor for exception class org.jdbi.v3.core.statement.UnableToCreateStatementException

UnableToExecuteStatementException - Exception Class in org.jdbi.v3.core.statement

Thrown when statement execution fails.

UnableToExecuteStatementException(Exception, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.UnableToExecuteStatementException

UnableToExecuteStatementException(String) - Constructor for exception class org.jdbi.v3.core.statement.UnableToExecuteStatementException

UnableToExecuteStatementException(String, Throwable, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.UnableToExecuteStatementException

UnableToExecuteStatementException(String, StatementContext) - Constructor for exception class org.jdbi.v3.core.statement.UnableToExecuteStatementException

UnableToManipulateTransactionIsolationLevelException - Exception Class in org.jdbi.v3.core.transaction

Thrown when Jdbi isn't able to change the transaction isolation level.

UnableToManipulateTransactionIsolationLevelException(int, SQLException) - Constructor for exception class org.jdbi.v3.core.transaction.UnableToManipulateTransactionIsolationLevelException

UnableToManipulateTransactionIsolationLevelException(String, SQLException) - Constructor for exception class org.jdbi.v3.core.transaction.UnableToManipulateTransactionIsolationLevelException

UnableToProduceResultException - Exception Class in org.jdbi.v3.core.result

Wraps exceptions thrown while producing Java result types.

UnableToProduceResultException(Exception, StatementContext) - Constructor for exception class org.jdbi.v3.core.result.UnableToProduceResultException

UnableToProduceResultException(String) - Constructor for exception class org.jdbi.v3.core.result.UnableToProduceResultException

UnableToProduceResultException(String, Throwable, StatementContext) - Constructor for exception class org.jdbi.v3.core.result.UnableToProduceResultException

UnableToProduceResultException(String, StatementContext) - Constructor for exception class org.jdbi.v3.core.result.UnableToProduceResultException

UnableToProduceResultException(Throwable) - Constructor for exception class org.jdbi.v3.core.result.UnableToProduceResultException

UnableToRestoreAutoCommitStateException - Exception Class in org.jdbi.v3.core.transaction

Thrown after a transaction finishes if we can't reset its isolation level.

UnableToRestoreAutoCommitStateException(Throwable) - Constructor for exception class org.jdbi.v3.core.transaction.UnableToRestoreAutoCommitStateException

UnableToRetrieveMetaDataException - Exception Class in org.jdbi.v3.core.statement

Thrown when Jdbi couldn't retrieve metadata from the connection.

UNKNOWN - Enum constant in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

The transaction isolation level wasn't specified or is unknown to jdbi.

Update - Class in org.jdbi.v3.core.statement

Used for INSERT, UPDATE, and DELETE statements

Update(Handle, CharSequence) - Constructor for class org.jdbi.v3.core.statement.Update

Update(Handle, String) - Constructor for class org.jdbi.v3.core.statement.Update

Backwards compatible constructor that takes an explicit string argument.

UPPER - Enum constant in enum org.jdbi.v3.core.mapper.CaseStrategy

All strings to uppercase in root locale.

UseAnnotationSqlLocator - Annotation Type in org.jdbi.v3.sqlobject.locator

Configures SQL Object to use AnnotationSqlLocator (the default SqlLocator).

UseClasspathSqlLocator - Annotation Type in org.jdbi.v3.sqlobject.locator

Configures SQL Object to locate SQL using the ClasspathSqlLocator.findSqlOnClasspath(Class, String) method.

UseEnumStrategy - Annotation Type in org.jdbi.v3.sqlobject.config

Use the specified EnumStrategy for binding and mapping enum values.

useExtension(E) - Method in interface org.jdbi.v3.core.extension.ExtensionConsumer

Will be invoked with a live extension.

useExtension(Class<E>, ExtensionConsumer<E, X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

useExtension(Class<E>, ExtensionConsumer<E, X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience method which opens an extension of the given type, and yields it to a callback.

useExtension(Class<E>, ExtensionConsumer<E, X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience method which opens an extension of the given type, and yields it to a callback.

UseExtensionConfigurer - Annotation Type in org.jdbi.v3.core.extension.annotation

Meta-Annotation used to identify annotations that modify configuration in the context of an extension object or method.

UseExtensionHandler - Annotation Type in org.jdbi.v3.core.extension.annotation

Meta-Annotation used to map a method to an extension handler.

UseExtensionHandlerCustomizer - Annotation Type in org.jdbi.v3.core.extension.annotation

Meta-Annotation used to identify extension method decorating annotations.

UseFreemarkerEngine - Annotation Type in org.jdbi.v3.freemarker

Configures a SQL object class or method to rewrite SQL statements using Freemarker.

UseFreemarkerSqlLocator - Annotation Type in org.jdbi.v3.freemarker

Configures SQL Object to locate SQL using the FreemarkerSqlLocator class.

useHandle(Handle) - Method in interface org.jdbi.v3.core.HandleConsumer

Will be invoked with an open Handle.

useHandle(HandleConsumer<X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

useHandle(HandleConsumer<X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

useHandle(HandleConsumer<X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

useHandle(HandleConsumer<X>) - Method in interface org.jdbi.v3.sqlobject.SqlObject

A convenience function which manages the lifecycle of the handle associated to this sql object, and yields it to a consumer for use by clients.

useIterator(IteratorConsumer<T, X>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Passes the iterator of results to the consumer.

useIterator(ResultIterator<T>) - Method in interface org.jdbi.v3.core.result.IteratorConsumer

Will be invoked with result iterator.

UseRowMapper - Annotation Type in org.jdbi.v3.sqlobject.statement

Used to specify specific row mapper on a query method.

UseRowReducer - Annotation Type in org.jdbi.v3.sqlobject.statement

Used to specify a row reducer on a result-bearing method.

UseSqlParser - Annotation Type in org.jdbi.v3.sqlobject.config

Use the specified SqlParser class to parse SQL for the annotated SQL object class or method.

useStream(Stream<T>) - Method in interface org.jdbi.v3.core.result.StreamConsumer

Will be invoked with result stream.

useStream(StreamConsumer<T, X>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Passes the stream of results to the consumer.

UseStringSubstitutorTemplateEngine - Annotation Type in org.jdbi.v3.commonstext

UseStringTemplateEngine - Annotation Type in org.jdbi.v3.stringtemplate4

Configures a SQL object class or method to rewrite SQL statements using StringTemplate.

UseStringTemplateSqlLocator - Annotation Type in org.jdbi.v3.stringtemplate4

Configures SQL Object to locate SQL using the StringTemplateSqlLocator.findStringTemplate(Class, String) method.

UseTemplateEngine - Annotation Type in org.jdbi.v3.sqlobject.config

Use the specified TemplateEngine class to render SQL for the annotated SQL object class or method.

useTransaction(HandleConsumer<X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

useTransaction(HandleConsumer<X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

useTransaction(HandleConsumer<X>) - Method in class org.jdbi.v3.core.Handle

Executes callback in a transaction.

useTransaction(HandleConsumer<X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

useTransaction(TransactionIsolationLevel, HandleConsumer<X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

useTransaction(TransactionIsolationLevel, HandleConsumer<X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

useTransaction(TransactionIsolationLevel, HandleConsumer<X>) - Method in class org.jdbi.v3.core.Handle

Executes callback in a transaction.

useTransaction(TransactionIsolationLevel, HandleConsumer<X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

useTransaction(TransactionIsolationLevel, TransactionalConsumer<This, X>) - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Executes the given callback within a transaction.

useTransaction(TransactionalConsumer<This, X>) - Method in interface org.jdbi.v3.sqlobject.transaction.Transactional

Executes the given callback within a transaction.

useTransaction(T) - Method in interface org.jdbi.v3.sqlobject.transaction.TransactionalConsumer

Execute in a transaction.

UUIDArgumentFactory - Class in org.jdbi.v3.postgres

Bind UUID arguments as an Object.

UUIDArgumentFactory() - Constructor for class org.jdbi.v3.postgres.UUIDArgumentFactory

V

value() - Element in annotation type org.jdbi.v3.core.enums.DatabaseValue

The database value that this annotation represents.

value() - Element in annotation type org.jdbi.v3.core.extension.annotation.ExtensionHandlerCustomizationOrder

The order that decorator annotations will be applied, from outermost to innermost.

value() - Element in annotation type org.jdbi.v3.core.extension.annotation.UseExtensionConfigurer

A ExtensionConfigurer type, which will be used to configure ConfigRegistry instances.

value() - Element in annotation type org.jdbi.v3.core.extension.annotation.UseExtensionHandler

ExtensionHandler factory annotation that creates the extension handler for the decorated method.

value() - Element in annotation type org.jdbi.v3.core.extension.annotation.UseExtensionHandlerCustomizer

ExtensionHandlerCustomizer class that decorates ExtensionHandler instances for methods annotated with the associated annotation.

value() - Element in annotation type org.jdbi.v3.core.mapper.Nested

The column name prefix for all members of the nested object.

value() - Element in annotation type org.jdbi.v3.core.mapper.PropagateNull

When annotating a type, the value is the column name to check for null.

value() - Element in annotation type org.jdbi.v3.core.mapper.reflect.ColumnName

value() - Element in annotation type org.jdbi.v3.jpa.BindJpa

value() - Element in annotation type org.jdbi.v3.sqlobject.config.ConfiguringAnnotation

Deprecated.

A Configurer type, which will be used to configure ConfigRegistry instances.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.KeyColumn

Returns the column name to use for map keys.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterArgumentFactories

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterArgumentFactory

The argument factory classes to register

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterBeanMapper

The mapped bean class.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterBeanMappers

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterCollector

The collector instance to register

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterCollectorFactory

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterColumnMapper

The column mapper class to register

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterColumnMapperFactories

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterColumnMapperFactory

The column mapper factory class to register

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterColumnMappers

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterConstructorMapper

The mapped type.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterConstructorMappers

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterFieldMapper

The type to map with FieldMapper.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterFieldMappers

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterJoinRowMapper

Returns the types that will be available on the JoinRows returned.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterObjectArgumentFactories

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterObjectArgumentFactory

The argument type which is compatible with PreparedStatement.setObject(int, Object).

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterRowMapper

The row mapper class to register

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterRowMapperFactories

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterRowMapperFactory

value() - Element in annotation type org.jdbi.v3.sqlobject.config.RegisterRowMappers

value() - Element in annotation type org.jdbi.v3.sqlobject.config.UseEnumStrategy

value() - Element in annotation type org.jdbi.v3.sqlobject.config.UseSqlParser

Specify the SqlParser class to use.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.UseTemplateEngine

Specify the TemplateEngine class to use.

value() - Element in annotation type org.jdbi.v3.sqlobject.config.ValueColumn

Returns the column name to use for map values.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.AllowUnusedBindings

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.Bind

The name to bind the argument to.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindBean

Prefix to apply to each bean property.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindBeanList

The attribute name to define.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindFields

Prefix to apply to each bean field name.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindList

The attribute name to define.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindMap

Prefix to apply to each map key.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindMethods

Prefix to apply to each fluent accessor name.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindMethodsList

The attribute name to define.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.BindPojo

Prefix to apply to each property.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.Define

The attribute name to define.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.DefineList

The attribute name to define.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.FetchSize

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.MaxRows

The max number of rows to return from the query.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.OutParameterList

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.QueryTimeOut

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizingAnnotation

Specify a sql statement customizer factory which will be used to create sql statement customizers.

value() - Element in annotation type org.jdbi.v3.sqlobject.customizer.Timestamped

The parameter to bind in the SQL query.

value() - Element in annotation type org.jdbi.v3.sqlobject.DecoratorOrder

Deprecated.

The order that decorator annotations will be applied, from outermost to innermost.

value() - Element in annotation type org.jdbi.v3.sqlobject.SqlMethodDecoratingAnnotation

Deprecated.

Factory class that decorates Handler instances for methods annotated with the associated annotation.

value() - Element in annotation type org.jdbi.v3.sqlobject.SqlOperation

Deprecated.

Handler class for methods annotated with the associated annotation.

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.BatchChunkSize

The batch chunk size.

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.GetGeneratedKeys

Sets the column names of the generated key(s) from a SQL statement.

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.SqlBatch

Returns the SQL string (or name) used for the batch.

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.SqlCall

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.SqlQuery

The query (or query name if using a statement locator) to be executed.

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.SqlScript

Returns the SQL string (or name).

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.SqlScripts

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.SqlUpdate

The sql (or statement name if using a statement locator) to be executed.

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.UseRowMapper

The class implementing RowMapper.

value() - Element in annotation type org.jdbi.v3.sqlobject.statement.UseRowReducer

The class implementing RowReducer.

value() - Element in annotation type org.jdbi.v3.sqlobject.transaction.Transaction

The transaction isolation level.

ValueColumn - Annotation Type in org.jdbi.v3.sqlobject.config

Configures the column to use for map values, for SQL methods that return Map, or Guava's Multimap.

valueOf(int) - Static method in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.array.SqlArrayArgumentStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.enums.EnumStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.extension.ExtensionFactory.FactoryFlag

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.mapper.CaseStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.mapper.reflect.AccessibleObjectStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.statement.EmptyHandling

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.jdbi.v3.core.array.SqlArrayArgumentStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.core.enums.EnumStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.core.extension.ExtensionFactory.FactoryFlag

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.core.mapper.CaseStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.core.mapper.reflect.AccessibleObjectStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.core.statement.EmptyHandling

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.core.statement.StatementExceptions.MessageRendering

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.core.transaction.TransactionIsolationLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Returns an array containing the constants of this enum type, in the order they are declared.

VavrCollectors - Class in org.jdbi.v3.vavr

VavrPlugin - Class in org.jdbi.v3.vavr

JDBI-Plugin for vavr.io library supports single-value arguments (Option, ...) supports vavr collections via ResultBearing.collectInto(java.lang.reflect.Type) call supports key-value mappings of a tuple result (implicitly used by map collectors) supports tuple projection supports column mapping for Option

VavrPlugin() - Constructor for class org.jdbi.v3.vavr.VavrPlugin

VOID - Enum constant in enum org.jdbi.v3.sqlobject.customizer.BindList.EmptyHandling

Define "".

W

warm(ConfigRegistry) - Method in interface org.jdbi.v3.core.extension.ExtensionHandler

Called after the method handler is constructed to pre-initialize any important configuration data structures.

warm(ConfigRegistry) - Method in interface org.jdbi.v3.sqlobject.customizer.SqlStatementCustomizer

Called after the customizer is instantiated but before any statement is available, to pre-initialize any configuration data structures.

warm(ConfigRegistry) - Method in interface org.jdbi.v3.sqlobject.customizer.SqlStatementParameterCustomizer

Called after the customizer is instantiated but before any statement is available, to pre-initialize any configuration data structures.

with(Annotation...) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Returns a QualifiedType that has the same type as this instance, but with only the given qualifiers.

with(Class<? extends Annotation>...) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Returns a QualifiedType that has the same type as this instance, but with only the given qualifiers.

withAnnotationClasses(Iterable<Class<? extends Annotation>>) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Creates a QualifiedType with the same type as this instance and new qualifiers.

withAnnotations(Iterable<? extends Annotation>) - Method in class org.jdbi.v3.core.qualifier.QualifiedType

Creates a QualifiedType with the same type as this instance and new qualifiers.

withConfig(Class<C>, Consumer<C>) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Set a JdbiConfig parameter when creating the Jdbi instance.

withCredentials(String, String) - Method in class org.jdbi.v3.testing.junit5.JdbiGenericExtension

Sets the username and password.

withCredentials(String, String) - Method in class org.jdbi.v3.testing.junit5.JdbiH2Extension

Sets the H2 username and password.

withDefaultPath() - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Use Default db/migration Flyway schema migration location.

withDefaultPath() - Method in class org.jdbi.v3.testing.Migration

Use Default db/migration Flyway schema migration location.

withExtension(E) - Method in interface org.jdbi.v3.core.extension.ExtensionCallback

Will be invoked with a live extension.

withExtension(Class<E>, ExtensionCallback<R, E, X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

withExtension(Class<E>, ExtensionCallback<R, E, X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience method which opens an extension of the given type, yields it to a callback, and returns the result of the callback.

withExtension(Class<E>, ExtensionCallback<R, E, X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience method which opens an extension of the given type, yields it to a callback, and returns the result of the callback.

withHandle(Handle) - Method in interface org.jdbi.v3.core.HandleCallback

Will be invoked with an open Handle.

withHandle(HandleCallback<R, X>) - Method in class org.jdbi.v3.core.async.AbstractJdbiExecutor

withHandle(HandleCallback<R, X>) - Method in interface org.jdbi.v3.core.async.JdbiExecutor

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

withHandle(HandleCallback<R, X>) - Method in class org.jdbi.v3.core.Jdbi

A convenience function which manages the lifecycle of a handle and yields it to a callback for use by clients.

withHandle(HandleCallback<R, X>) - Method in interface org.jdbi.v3.sqlobject.SqlObject

A convenience function which manages the lifecycle of the handle associated to this sql object, and yields it to a callback for use by clients.

withInitializer(JdbiExtensionInitializer) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Sets a JdbiExtensionInitializer to initialize the Jdbi instance or the attached data source before running a test.

withIterator(IteratorCallback<T, R, X>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Passes the iterator of results to the callback.

withIterator(ResultIterator<T>) - Method in interface org.jdbi.v3.core.result.IteratorCallback

Will be invoked with a Iterator<T>.

withMigration(Migration) - Method in class org.jdbi.v3.testing.JdbiRule

Run database migration.

withPath(String) - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Add a custom flyway migration path.

withPath(String) - Method in class org.jdbi.v3.testing.Migration

Add flyway migration path.

withPaths(String...) - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Add custom flyway migration paths.

withPaths(String...) - Method in class org.jdbi.v3.testing.Migration

Add flyway migration paths.

withPlugin(JdbiPlugin) - Method in class org.jdbi.v3.testing.JdbiRule

Install a plugin into JdbiRule.

withPlugin(JdbiPlugin) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Install a JdbiPlugin when creating the Jdbi instance.

withPlugins() - Method in class org.jdbi.v3.testing.JdbiRule

Discover and install plugins from the classpath.

withPlugins(JdbiPlugin...) - Method in class org.jdbi.v3.testing.junit5.JdbiExtension

Install multiple JdbiPlugins when creating the Jdbi instance.

withSchema(String) - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Add flyway migration schema.

withSchema(String) - Method in class org.jdbi.v3.testing.Migration

Add flyway migration schema.

withSchemas(String...) - Method in class org.jdbi.v3.testing.junit5.JdbiFlywayMigration

Add flyway migration schemas.

withSchemas(String...) - Method in class org.jdbi.v3.testing.Migration

Add flyway migration schemas.

withStream(Stream<T>) - Method in interface org.jdbi.v3.core.result.StreamCallback

Will be invoked with a Stream<T>.

withStream(StreamCallback<T, R, X>) - Method in interface org.jdbi.v3.core.result.ResultIterable

Passes the stream of results to the callback.

withUser(String) - Method in class org.jdbi.v3.testing.junit5.JdbiGenericExtension

Sets the username.

withUser(String) - Method in class org.jdbi.v3.testing.junit5.JdbiH2Extension

Sets the H2 username.

writeLob(long, InputStream) - Method in interface org.jdbi.v3.postgres.PgLobApi

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form