Interface JdbcClient

public interface JdbcClient

A fluent JdbcClient with common JDBC query and update operations, supporting JDBC-style positional as well as Spring-style named parameters with a convenient unified facade for JDBC PreparedStatement execution.

An example for retrieving a query result as a java.util.Optional:

Optional<Integer> value = client.sql("SELECT AGE FROM CUSTOMER WHERE ID = :id")
    .param("id", 3)
    .query(Integer.class)
    .optional();

Delegates to JdbcTemplate and NamedParameterJdbcTemplate. Batch updates are supported in a fluent fashion through JdbcClient.StatementSpec.batch(); for other complex JDBC operations — for example, stored procedure calls — you may use those lower-level template classes directly, or alternatively SimpleJdbcInsert and SimpleJdbcCall.

Since:

6.1

Author:

Juergen Hoeller, Sam Brannen, Jiri Krokviak, Yanming Zhou

See Also:

• ResultSetExtractor
• RowCallbackHandler
• RowMapper
• JdbcOperations
• NamedParameterJdbcOperations
• JdbcTemplate
• NamedParameterJdbcTemplate

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	JdbcClient.BatchSpec	A specification for accumulating several sets of parameters for a batch update, with each set representing the parameters for one statement execution within the batch.
static interface	JdbcClient.MappedQuerySpec<T extends @Nullable Object>	A specification for RowMapper-mapped queries.
static interface	JdbcClient.ResultQuerySpec	A specification for simple result queries.
static interface	JdbcClient.StatementSpec	A statement specification for parameter bindings and query/update execution.

Method Summary

Modifier and Type	Method	Description
static JdbcClient	create(DataSource dataSource)	Create a JdbcClient for the given DataSource.
static JdbcClient	create(JdbcOperations jdbcTemplate)	Create a JdbcClient for the given JdbcOperations delegate, typically an JdbcTemplate.
static JdbcClient	create(NamedParameterJdbcOperations jdbcTemplate)	Create a JdbcClient for the given NamedParameterJdbcOperations delegate, typically an NamedParameterJdbcTemplate.
static JdbcClient	create(NamedParameterJdbcOperations jdbcTemplate, org.springframework.core.convert.ConversionService conversionService)	Create a JdbcClient for the given NamedParameterJdbcOperations delegate, typically an NamedParameterJdbcTemplate.
JdbcClient.StatementSpec	sql(String sql)	The starting point for any JDBC operation: a custom SQL String.

Method Details

sql

JdbcClient.StatementSpec sql(String sql)

The starting point for any JDBC operation: a custom SQL String.

Parameters:

sql - the SQL query or update statement as a String

Returns:

a chained statement specification

create

static JdbcClient create(DataSource dataSource)

Create a JdbcClient for the given DataSource.

Parameters:

dataSource - the DataSource to obtain connections from

create

static JdbcClient create(JdbcOperations jdbcTemplate)

Create a JdbcClient for the given JdbcOperations delegate, typically an JdbcTemplate.

Use this factory method to reuse existing JdbcTemplate configuration, including its DataSource.

Parameters:

jdbcTemplate - the delegate to perform operations on

create

static JdbcClient create(NamedParameterJdbcOperations jdbcTemplate)

Create a JdbcClient for the given NamedParameterJdbcOperations delegate, typically an NamedParameterJdbcTemplate.

Use this factory method to reuse existing NamedParameterJdbcTemplate configuration, including its underlying JdbcTemplate and DataSource.

Parameters:

jdbcTemplate - the delegate to perform operations on

create

static JdbcClient create(NamedParameterJdbcOperations jdbcTemplate,
 org.springframework.core.convert.ConversionService conversionService)

Create a JdbcClient for the given NamedParameterJdbcOperations delegate, typically an NamedParameterJdbcTemplate.

Use this factory method to reuse existing NamedParameterJdbcTemplate configuration, including its underlying JdbcTemplate and DataSource, along with a custom ConversionService for queries with mapped classes.

Parameters:

jdbcTemplate - the delegate to perform operations on

conversionService - a ConversionService for converting fetched JDBC values to mapped classes in JdbcClient.StatementSpec.query(Class)

Since:

7.0