Class MetaData

java.lang.Object

org.jdbi.v3.core.statement.MetaData

All Implemented Interfaces:

Closeable, AutoCloseable, Configurable<MetaData>, ResultBearing

public final class MetaData
extends Object
implements ResultBearing

Access to Database Metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetaData.MetaDataResultSetProvider
static interface	MetaData.MetaDataValueProvider<T>

Constructor Summary

Constructors

Constructor	Description
MetaData(Handle handle, MetaData.MetaDataValueProvider<?> metaDataFunction)

Method Summary

Modifier and Type	Method	Description
final MetaData	attachToHandleForCleanup()	Registers with the handle for cleaning when the handle is closed.
void	close()
<R> R	execute()
ConfigRegistry	getConfig()	Returns the configuration registry associated with this object.
final StatementContext	getContext()	Returns the statement context associated with this statement.
final Handle	getHandle()
<R> R	scanResultSet(ResultSetScanner<R> resultSetScanner)	Invokes the mapper with a result set supplier, and returns the value returned by the mapper.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Configurable

addCustomizer, configure, define, getConfig, registerArgument, registerArgument, registerArrayType, registerArrayType, registerArrayType, registerArrayType, registerCodecFactory, registerCollector, registerCollector, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerColumnMapper, registerExtension, registerRowMapper, registerRowMapper, registerRowMapper, registerRowMapper, setMapKeyColumn, setMapValueColumn, setSqlArrayArgumentStrategy, setSqlLogger, setSqlParser, setTemplateEngine, setTimingCollector

Modifier and Type	Method	Description
default MetaData	addCustomizer(StatementCustomizer customizer)
default <C extends JdbiConfig<C>> MetaData	configure(Class<C> configClass, Consumer<C> configurer)	Passes the configuration object of the given type to the configurer, then returns this object.
default MetaData	define(String key, Object value)	Convenience method for getConfig(SqlStatements.class).define(key, value)
default <C extends JdbiConfig<C>> C	getConfig(Class<C> configClass)	Gets the configuration object of the given type, associated with this object.
default MetaData	registerArgument(ArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default MetaData	registerArgument(QualifiedArgumentFactory factory)	Convenience method for getConfig(Arguments.class).register(factory)
default MetaData	registerArrayType(Class<?> elementType, String sqlTypeName)	Convenience method for getConfig(SqlArrayTypes.class).register(elementType, sqlTypeName)
default <T> MetaData	registerArrayType(Class<T> elementType, String sqlTypeName, Function<T,?> conversion)	Convenience method for registering an array type as SqlArrayTypeFactory.of(Class, String, Function).
default MetaData	registerArrayType(SqlArrayType<?> arrayType)	Convenience method for getConfig(SqlArrayTypes.class).register(arrayType)
default MetaData	registerArrayType(SqlArrayTypeFactory factory)	Convenience method for getConfig(SqlArrayTypes.class).register(factory)
default MetaData	registerCodecFactory(CodecFactory codecFactory)	Convenience method to register a CodecFactory.
default MetaData	registerCollector(Type collectionType, Collector<?,?,?> collector)	Convenience method for getConfig(JdbiCollectors.class).register(CollectorFactory.collectorFactory(collectionType, collector))
default MetaData	registerCollector(CollectorFactory factory)	Convenience method for getConfig(JdbiCollectors.class).register(factory)
default MetaData	registerColumnMapper(Type type, ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default <T> MetaData	registerColumnMapper(GenericType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default MetaData	registerColumnMapper(ColumnMapper<?> mapper)	Convenience method for getConfig(ColumnMappers.class).register(mapper)
default MetaData	registerColumnMapper(ColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default MetaData	registerColumnMapper(QualifiedColumnMapperFactory factory)	Convenience method for getConfig(ColumnMappers.class).register(factory)
default <T> MetaData	registerColumnMapper(QualifiedType<T> type, ColumnMapper<T> mapper)	Convenience method for getConfig(ColumnMappers.class).register(type, mapper)
default MetaData	registerExtension(ExtensionFactory factory)	Convenience method for getConfig(Extensions.class).register(factory)
default MetaData	registerRowMapper(Type type, RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default <T> MetaData	registerRowMapper(GenericType<T> type, RowMapper<T> mapper)	Convenience method for getConfig(RowMappers.class).register(type, mapper)
default MetaData	registerRowMapper(RowMapper<?> mapper)	Convenience method for getConfig(RowMappers.class).register(mapper)
default MetaData	registerRowMapper(RowMapperFactory factory)	Convenience method for getConfig(RowMappers.class).register(factory)
default MetaData	setMapKeyColumn(String keyColumn)	Convenience method for getConfig(MapEntryMappers.class).setKeyColumn(keyColumn)
default MetaData	setMapValueColumn(String valueColumn)	Convenience method for getConfig(MapEntryMappers.class).setValueColumn(valueColumn)
default MetaData	setSqlArrayArgumentStrategy(SqlArrayArgumentStrategy strategy)	Convenience method for getConfig(SqlArrayTypes.class).setArgumentStrategy(strategy)
default MetaData	setSqlLogger(SqlLogger sqlLogger)
default MetaData	setSqlParser(SqlParser parser)	Convenience method for getConfig(SqlStatements.class).setSqlParser(rewriter)
default MetaData	setTemplateEngine(TemplateEngine templateEngine)	Convenience method for getConfig(SqlStatements.class).setTemplateEngine(rewriter)
default MetaData	setTimingCollector(TimingCollector collector)	Deprecated, for removal: This API element is subject to removal in a future version. use Configurable.setSqlLogger(SqlLogger) instead

Methods inherited from interface ResultBearing

collectInto, collectInto, collectInto, collectRows, map, map, map, mapTo, mapTo, mapTo, mapTo, mapToBean, mapToMap, mapToMap, mapToMap, reduceResultSet, reduceRows, reduceRows, reduceRows

Modifier and Type	Method	Description
default <R> R	collectInto(Class<R> containerType)	Collect the results into a container of the given type.
default Object	collectInto(Type containerType)	Collect the results into a container of the given type.
default <R> R	collectInto(GenericType<R> containerType)	Collect the results into a container of the given generic type.
default <A,R> R	collectRows(Collector<RowView,A,R> collector)	Collect the results using the given collector.
default <T> ResultIterable<T>	map(ColumnMapper<T> mapper)	Maps this result set to a ResultIterable, using the given column mapper.
default <T> ResultIterable<T>	map(RowMapper<T> mapper)	Maps this result set to a ResultIterable, using the given row mapper.
default <T> ResultIterable<T>	map(RowViewMapper<T> mapper)	Maps this result set to a ResultIterable, using the given RowViewMapper.
default <T> ResultIterable<T>	mapTo(Class<T> type)	Maps this result set to a ResultIterable of the given element type.
default ResultIterable<?>	mapTo(Type type)	Maps this result set to a ResultIterable of the given element type.
default <T> ResultIterable<T>	mapTo(GenericType<T> type)	Maps this result set to a ResultIterable of the given element type.
default <T> ResultIterable<T>	mapTo(QualifiedType<T> type)	Maps this result set to a ResultIterable of the given qualified element type.
default <T> ResultIterable<T>	mapToBean(Class<T> type)	Maps this result set to a ResultIterable of the given element type, using BeanMapper.
default ResultIterable<Map<String,Object>>	mapToMap()	Maps this result set to a ResultIterable of Map<String,Object>.
default <T> ResultIterable<Map<String,T>>	mapToMap(Class<T> valueType)	Maps this result set to a Map of String and the given value class.
default <T> ResultIterable<Map<String,T>>	mapToMap(GenericType<T> valueType)	Maps this result set to a Map of String and the given value type.
default <U> U	reduceResultSet(U seed, ResultSetAccumulator<U> accumulator)	Reduce the results.
default <K,V> Stream<V>	reduceRows(BiConsumer<Map<K,V>,RowView> accumulator)	Reduce the result rows using a Map<K, V> as the result container.
default <C,R> Stream<R>	reduceRows(RowReducer<C,R> rowReducer)	Reduce the result rows using the given row reducer.
default <U> U	reduceRows(U seed, BiFunction<U,RowView,U> accumulator)	Reduce the results.

Constructor Details

MetaData

public MetaData(Handle handle,
 MetaData.MetaDataValueProvider<?> metaDataFunction)

Method Details

scanResultSet

public <R> R scanResultSet(ResultSetScanner<R> resultSetScanner)

Description copied from interface: ResultBearing

Invokes the mapper with a result set supplier, and returns the value returned by the mapper.

Specified by:

scanResultSet in interface ResultBearing

Type Parameters:

R - result type returned by the mapper.

Parameters:

resultSetScanner - result set scanner

Returns:

the value returned by the mapper.

execute

public <R> R execute()

getHandle

public final Handle getHandle()

getConfig

public ConfigRegistry getConfig()

Description copied from interface: Configurable

Returns the configuration registry associated with this object.

Specified by:

getConfig in interface Configurable<This>

Returns:

the configuration registry associated with this object.

getContext

public final StatementContext getContext()

Returns the statement context associated with this statement.

Returns:

the statement context associated with this statement.

attachToHandleForCleanup

@Beta
public final MetaData attachToHandleForCleanup()

Registers with the handle for cleaning when the handle is closed.
There are some situations where Statements need to be cleaned up to avoid resource leaks. This method registers the current Statement it with the Handle. If the statement or the context are cleaned by themselves, it will automatically unregister, so in normal operations, resources should not pool for cleanup with the Handle.

Since:

3.35.0

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable