Package com.github.nwillc.funjdbc

Interface DbAccessor

All Superinterfaces:

ConnectionProvider

All Known Subinterfaces:

Migration

All Known Implementing Classes:

Manager, MigrationBase

public interface DbAccessor
extends ConnectionProvider

Interface, with default methods providing JDBC database access functionality.

Method Summary

Modifier and Type	Method	Description
default <K,V> void	dbEnrich(java.util.Map<K,V> map, Extractor<K> keyExtractor, Enricher<V> enricher, SqlStatement sqlStatement)	Given a map of entities, and a query that extracts details about them, then execute that query and enrich the entities with the results.
default boolean	dbExecute(SqlStatement sqlStatement)	Execute a SQL statement.
default <T> java.util.Optional<T>	dbFind(Extractor<T> extractor, SqlStatement sqlStatement)	Extract the result from a SQL query which returns at most one result.
default <T> java.util.stream.Stream<T>	dbInsertGetGeneratedKeys(SqlStatement sqlStatement, java.lang.String[] keyColumns, Extractor<T> longExtractor)	Execute an insert into a table with an auto incremented key, returning a stream of the keys.
default <T> java.util.stream.Stream<T>	dbQuery(Extractor<T> extractor, SqlStatement sqlStatement)	Extract results from a SQL query designed to return multiple results.
default int	dbUpdate(SqlStatement sqlStatement)	Execute a SQL update or delete.
default <T> java.util.stream.Stream<T>	stream(Extractor<T> extractor, java.sql.ResultSet resultSet)	Given an Extractor and ResultSet return a Stream of results.

Methods inherited from interface com.github.nwillc.funjdbc.functions.ConnectionProvider

getConnection

Method Detail

dbQuery

default <T> java.util.stream.Stream<T> dbQuery(Extractor<T> extractor,
                                               SqlStatement sqlStatement)
                                        throws java.sql.SQLException

Extract results from a SQL query designed to return multiple results. The SQL, and it's optional args are formatted with String.format(String, Object ...) method. Note, Streams are Closeable, and the resultant Stream should be closed when completed to insure database resources involved in the stream are freed.

Type Parameters:

T - Type extracted and returned in the stream

Parameters:

extractor - The extractor to process the ResultSet with

sqlStatement - The SQL statement

Returns:

a stream of the extracted elements

Throws:

java.sql.SQLException - if the query or an extraction fails

dbEnrich

default <K,V> void dbEnrich(java.util.Map<K,V> map,
                            Extractor<K> keyExtractor,
                            Enricher<V> enricher,
                            SqlStatement sqlStatement)
                     throws java.sql.SQLException

Given a map of entities, and a query that extracts details about them, then execute that query and enrich the entities with the results.

Type Parameters:

K - the key type

V - the entity type

Parameters:

map - A map of entities the enrich

keyExtractor - an Extractor to get the entity key from the detail records

enricher - a function to enrich an entity from the detail record

sqlStatement - The SQL statement

Throws:

java.sql.SQLException - may result from the query or enrichments

stream

default <T> java.util.stream.Stream<T> stream(Extractor<T> extractor,
                                              java.sql.ResultSet resultSet)

Given an Extractor and ResultSet return a Stream of results. Note, Streams are Closeable, and the resultant Stream should be closed when completed to insure database resources involved in the stream are freed.

Type Parameters:

T - the type parameter

Parameters:

extractor - the extractor

resultSet - the result set

Returns:

the stream

dbFind

default <T> java.util.Optional<T> dbFind(Extractor<T> extractor,
                                         SqlStatement sqlStatement)
                                  throws java.sql.SQLException

Extract the result from a SQL query which returns at most one result. The SQL, and it's optional args are formatted with String.format(String, Object ...) method.

Type Parameters:

T - Type extracted and optionally returned

Parameters:

extractor - the extractor to extract teh result

sqlStatement - the SQL statement

Returns:

an Optional of the data

Throws:

java.sql.SQLException - if the query or extraction fails, or if multiple rows returned

dbUpdate

default int dbUpdate(SqlStatement sqlStatement)
              throws java.sql.SQLException

Execute a SQL update or delete. The SQL, and it's optional args are formatted with String.format(String, Object ...) method.

Parameters:

sqlStatement - The SQL statement

Returns:

the count of rows updated.

Throws:

java.sql.SQLException - if the update fails

dbInsertGetGeneratedKeys

default <T> java.util.stream.Stream<T> dbInsertGetGeneratedKeys(SqlStatement sqlStatement,
                                                                java.lang.String[] keyColumns,
                                                                Extractor<T> longExtractor)
                                                         throws java.sql.SQLException

Execute an insert into a table with an auto incremented key, returning a stream of the keys.

Parameters:

sqlStatement - The SQL statement

Returns:

the stream of keys generated

Throws:

java.sql.SQLException - if the insert failed

Since:

0.13.0

dbExecute

default boolean dbExecute(SqlStatement sqlStatement)
                   throws java.sql.SQLException

Execute a SQL statement.

Parameters:

sqlStatement - The SQL statement

Returns:

true if the first result is a ResultSet object; false if it is an update count or there are no results

Throws:

java.sql.SQLException - if the SQL is invalid

Since:

0.9.3