Module io.helidon.dbclient.jdbc

Package io.helidon.dbclient.jdbc

Interface JdbcConnectionPool

All Superinterfaces:

NamedService, NamedService

All Known Subinterfaces:

CloseableJdbcConnectionPool

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface JdbcConnectionPool
extends NamedService

JDBC connection pool.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JdbcConnectionPool.BuilderBase<B extends JdbcConnectionPool.BuilderBase<B,T>,T extends JdbcConnectionPool>	Base fluent API builder for JdbcConnectionPool.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DB_TYPE	Default JDBC connection pool dbType() value.

Method Summary

Modifier and Type	Method	Description
Connection	connection()	Return a connection from the pool.
static JdbcConnectionPool	create(Config config)	Deprecated, for removal: This API element is subject to removal in a future version. create(io.helidon.config.Config) instead
static JdbcConnectionPool	create(Config config)	Create a JDBC connection pool from provided configuration.
default String	dbType()	The type of this database.
default String	name()	Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).
default String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Field Details

DEFAULT_DB_TYPE

static final String DEFAULT_DB_TYPE

Default JDBC connection pool dbType() value.

See Also:

• Constant Field Values

Method Details

create

@Deprecated(since="4.4.0",
            forRemoval=true)
static JdbcConnectionPool create(Config config)

Deprecated, for removal: This API element is subject to removal in a future version.

create(io.helidon.config.Config) instead

Create a JDBC connection pool from provided configuration.

Parameters:

config - configuration of connection pool

Returns:

a new instance configured from the provided config

create

static JdbcConnectionPool create(Config config)

Create a JDBC connection pool from provided configuration.

Optional configuration parameters

key	default value	description
url		JDBC URL of the database - this property is required when only configuration is used. Example: jdbc:mysql://127.0.0.1:3306/pokemon?useSSL=false
username		Username used to connect to the database
password		Password used to connect to the database

Parameters:

config - configuration of connection pool

Returns:

a new instance configured from the provided config

connection

Connection connection()

Return a connection from the pool. The call to Connection.close() should return that connection to the pool. The connection pool should handle capacity issues and timeouts using unchecked exceptions thrown by this method.

Returns:

a connection read to execute statements

dbType

default String dbType()

The type of this database. This could be "jdbc:mysql", etc. Default value is just "jdbc" but implementing class should set something more specific.

Returns:

type of this database

name

default String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).

Specified by:

name in interface NamedService

Specified by:

name in interface NamedService

Returns:

name of this service

type

default String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Specified by:

type in interface NamedService

Returns:

type of this service