Interface JdbcClientConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<JdbcClient>, SqlConfig

All Known Implementing Classes:

JdbcClientConfig.BuilderBase.JdbcClientConfigImpl

public interface JdbcClientConfig
extends Prototype.Api, SqlConfig

Configuration for a JDBC client.

A client can use an existing data source owned by the application, a named data source, or direct connection settings. An existing data source can be supplied only through a programmatic builder. Registry managed clients are configured under data.clients.jdbc.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JdbcClientConfig.Builder	Fluent API builder for JdbcClient.
static class	JdbcClientConfig.BuilderBase<BUILDER extends JdbcClientConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends JdbcClientConfig>	Fluent API builder base for JdbcClientConfig.

Method Summary

Modifier and Type	Method	Description
static JdbcClientConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static JdbcClientConfig.Builder	builder(JdbcClientConfig instance)	Create a new fluent API builder from an existing instance.
static JdbcClientConfig	create(Config config)	Create a new instance from configuration.
String	name()	Logical name of this client.
int	parameterCountCacheCapacity()	The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues.
int	parameterCountCacheMaxSqlLength()	The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
JdbcClient	build()	Create a new instance of the runtime type from this config object.

Methods inherited from interface SqlConfig

connection, dataSource, dataSourceName

Modifier and Type	Method	Description
Optional<ConnectionConfig>	connection()	Direct JDBC connection properties.
default Optional<DataSource>	dataSource()	Existing DataSource owned by the application.
Optional<String>	dataSourceName()	Name of the registered DataSource to use.

Method Details

builder

static JdbcClientConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static JdbcClientConfig.Builder builder(JdbcClientConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static JdbcClientConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

name

String name()

Logical name of this client.

Returns:

client name

parameterCountCacheCapacity

int parameterCountCacheCapacity()

The maximum number of SQL marker counts retained by this client must be between zero and 4096 inclusive, where zero disables retention while marker validation continues. This value is owned by Helidon Data JDBC and is not passed to JDBC.

Returns:

parameter count cache capacity

parameterCountCacheMaxSqlLength

int parameterCountCacheMaxSqlLength()

The maximum SQL string length admitted to the parameter count cache must be a positive number of UTF-16 code units and its product with the cache capacity must not exceed 16,777,216 code units, but SQL longer than this value remains executable and is scanned without being retained. This value is owned by Helidon Data JDBC and is not passed to JDBC.

Returns:

maximum cacheable SQL length