Module io.helidon.data.sql.datasource

Package io.helidon.data.sql.datasource

Interface DataSourceConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

DataSourceConfig.BuilderBase.DataSourceConfigImpl

public interface DataSourceConfig
extends Prototype.Api

DataSource configuration.

This is the data.sources configuration array member node of the DataSource configuration with name and provider.<provider> nodes:

 data:
   sources:
     sql:
       - name: something
         provider.ucp:
           # provider configuration
           username: "test"
           password: "changeit"
           ...
 

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static DataSourceConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static DataSourceConfig.Builder	builder(DataSourceConfig instance)	Create a new fluent API builder from an existing instance.
static DataSourceConfig	create()	Create a new instance with default values.
static DataSourceConfig	create(Config config)	Deprecated. use create(io.helidon.config.Config)
static DataSourceConfig	create(Config config)	Create a new instance from configuration.
String	name()	DataSource name.
ProviderConfig	provider()	Configuration of the used provider, such as UCP.

Method Details

builder

static DataSourceConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

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

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

@Deprecated
static DataSourceConfig create(Config config)

Deprecated.

use create(io.helidon.config.Config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static DataSourceConfig create()

Create a new instance with default values.

Returns:

a new instance

name

String name()

DataSource name. Optional name to distinguish several data sources of the same type. First available data source is returned when name is not set.

Returns:

the repository name

provider

ProviderConfig provider()

Configuration of the used provider, such as UCP.

Returns:

provider configuration