io.vertx.ext.jdbc.spi

Interface DataSourceProvider

public interface DataSourceProvider

Author:

Nick Scavelli

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_DATA_SOURCE_PROVIDER_NAME The default data source provider name.

Method Summary

Modifier and Type	Method and Description
void	close(DataSource dataSource)
static DataSourceProvider	create(DataSource dataSource, JsonObject config) Init provider with specific DataSource and config.
static DataSourceProvider	create(JsonObject config)
DataSource	getDataSource(JsonObject config)
default JsonObject	getInitialConfig() Get the SQL initial configuration
default DataSourceProvider	init(JsonObject sqlConfig) Init provider with specific configuration
static Optional<java.util.function.Supplier<DataSourceProvider>>	loadDefaultDataSourceProvider() Load a datasource provider form the JVM system properties with the DEFAULT_DATA_SOURCE_PROVIDER_NAME key.
int	maximumPoolSize(DataSource dataSource, JsonObject config)
default JsonObject	toJson(JDBCConnectOptions connectOptions, PoolOptions poolOptions) Transforms the JDBCConnectOptions and PoolOptions into a config suitable to be passed as create(JsonObject) argument.

Field Detail

DEFAULT_DATA_SOURCE_PROVIDER_NAME

static final String DEFAULT_DATA_SOURCE_PROVIDER_NAME

The default data source provider name.

See Also:

Constant Field Values

Method Detail

loadDefaultDataSourceProvider

static Optional<java.util.function.Supplier<DataSourceProvider>> loadDefaultDataSourceProvider()

Load a datasource provider form the JVM system properties with the DEFAULT_DATA_SOURCE_PROVIDER_NAME key. The value can be one of:

• C3P0: C3P0DataSourceProvider
• Hikari: HikariCPDataSourceProvider
• Agroal: AgroalCPDataSourceProvider

When there is no JVM wide defined provider or the value is incorrect, AgroalCPDataSourceProvider is returned.

toJson

default JsonObject toJson(JDBCConnectOptions connectOptions,
                          PoolOptions poolOptions)

Transforms the JDBCConnectOptions and PoolOptions into a config suitable to be passed as create(JsonObject) argument.

init

default DataSourceProvider init(JsonObject sqlConfig)

Init provider with specific configuration

Parameters:

sqlConfig - SQL connection configuration

Returns:

a reference to this for fluent API

Since:

4.2.0

getInitialConfig

default JsonObject getInitialConfig()

Get the SQL initial configuration

Returns:

an initial configuration

Since:

4.2.0

maximumPoolSize

int maximumPoolSize(DataSource dataSource,
                    JsonObject config)
             throws SQLException

Throws:

SQLException

getDataSource

DataSource getDataSource(JsonObject config)
                  throws SQLException

Throws:

SQLException

close

void close(DataSource dataSource)
    throws SQLException

Throws:

SQLException

create

static DataSourceProvider create(JsonObject config)

create

static DataSourceProvider create(DataSource dataSource,
                                 JsonObject config)

Init provider with specific DataSource and config. The config expects that several properties are set:

• url - the connection string
• user - the connection user name
• database - the database name
• maxPoolSize - the max allowed number of connections in the pool

Parameters:

dataSource - a pre initialized data source

config - the configuration for the datasource

Returns:

a reference to this for fluent API

Since:

4.2.0