Interface SqlConfig

All Superinterfaces:

Prototype.Api

All Known Subinterfaces:

JdbcClientConfig, io.helidon.data.jdbc.JdbcClientConfigBlueprint, JpaPersistenceUnitConfig, io.helidon.data.jakarta.persistence.JpaPersistenceUnitConfigBlueprint

All Known Implementing Classes:

JdbcClientConfig.BuilderBase.JdbcClientConfigImpl, JpaPersistenceUnitConfig.BuilderBase.JpaPersistenceUnitConfigImpl, SqlConfig.BuilderBase.SqlConfigImpl

public interface SqlConfig
extends Prototype.Api

SQL specific connection configuration.

Exactly one connection source is required: direct JDBC connection properties, the name of a registered DataSource, or an existing DataSource supplied programmatically.

See Also:

• builder()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SqlConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static SqlConfig.Builder	builder(SqlConfig instance)	Create a new fluent API builder from an existing instance.
Optional<ConnectionConfig>	connection()	Direct JDBC connection properties.
static SqlConfig	create(Config config)	Create a new instance from configuration.
default Optional<DataSource>	dataSource()	Existing DataSource owned by the application.
Optional<String>	dataSourceName()	Name of the registered DataSource to use.

Method Details

builder

static SqlConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static SqlConfig.Builder builder(SqlConfig 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 SqlConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

connection

Optional<ConnectionConfig> connection()

Direct JDBC connection properties.

Returns:

configured connection properties

dataSourceName

Optional<String> dataSourceName()

Name of the registered DataSource to use.

Returns:

configured data source name

dataSource

default Optional<DataSource> dataSource()

Existing DataSource owned by the application.

This option is available only through programmatic builders. The application retains ownership of the data source lifecycle.

Returns:

configured data source