Module io.helidon.dbclient

Package io.helidon.dbclient.spi

Interface DbClientProviderBuilder<T extends DbClientProviderBuilder<T>>

Type Parameters:

T - type of the builder extending implementing this interface.

All Superinterfaces:

Builder<DbClient>, Supplier<DbClient>

All Known Implementing Classes:

JdbcDbClientProviderBuilder, MongoDbClientProviderBuilder

public interface DbClientProviderBuilder<T extends DbClientProviderBuilder<T>>
extends Builder<DbClient>

Database provider builder.

Method Summary

Modifier and Type	Method	Description
T	addInterceptor(DbInterceptor interceptor)	Add an interceptor.
T	addInterceptor(DbInterceptor interceptor, DbStatementType... dbStatementTypes)	Add an interceptor thas is active only on configured statement types.
T	addInterceptor(DbInterceptor interceptor, String... statementNames)	Add an interceptor that is active only on the configured statement names.
<TYPE> T	addMapper(DbMapper<TYPE> dbMapper, GenericType<TYPE> mappedType)	Add a custom mapper with generic types support.
<TYPE> T	addMapper(DbMapper<TYPE> dbMapper, Class<TYPE> mappedClass)	Add a custom mapper.
T	addMapperProvider(DbMapperProvider provider)	Database schema mappers provider.
DbClient	build()	Build database handler for specific provider.
T	config(Config config)	Use database connection configuration from configuration file.
T	mapperManager(MapperManager manager)	Mapper manager for generic mapping, such as mapping of parameters to expected types.
T	password(String password)	Set database connection p¨assword.
T	statements(DbStatements statements)	Statements to use either from configuration or manually configured.
T	url(String url)	Set database connection string (URL).
T	username(String username)	Set database connection user name.

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

config

T config(Config config)

Use database connection configuration from configuration file.

Parameters:

config - Config instance with database connection attributes

Returns:

database provider builder

url

T url(String url)

Set database connection string (URL).

Parameters:

url - database connection string

Returns:

database provider builder

username

T username(String username)

Set database connection user name.

Parameters:

username - database connection user name

Returns:

database provider builder

password

T password(String password)

Set database connection p¨assword.

Parameters:

password - database connection password

Returns:

database provider builder

statements

T statements(DbStatements statements)

Statements to use either from configuration or manually configured.

Parameters:

statements - Statements to use

Returns:

updated builder instance

addMapperProvider

T addMapperProvider(DbMapperProvider provider)

Database schema mappers provider.

Parameters:

provider - database schema mappers provider to use

Returns:

updated builder instance

addMapper

<TYPE> T addMapper(DbMapper<TYPE> dbMapper,
                   Class<TYPE> mappedClass)

Add a custom mapper.

Type Parameters:

TYPE - type of the supported class

Parameters:

dbMapper - the mapper capable of mapping the mappedClass to various database objects

mappedClass - class that this mapper supports

Returns:

updated builder instance.

addMapper

<TYPE> T addMapper(DbMapper<TYPE> dbMapper,
                   GenericType<TYPE> mappedType)

Add a custom mapper with generic types support.

Type Parameters:

TYPE - type of the supported class

Parameters:

dbMapper - the mapper capable of mapping the mappedClass to various database objects

mappedType - type that this mapper supports

Returns:

updated builder instance.

mapperManager

T mapperManager(MapperManager manager)

Mapper manager for generic mapping, such as mapping of parameters to expected types.

Parameters:

manager - mapper manager

Returns:

updated builder instance

addInterceptor

T addInterceptor(DbInterceptor interceptor)

Add an interceptor. This allows to add implementation of tracing, metrics, logging etc. without the need to hard-code these into the base.

Parameters:

interceptor - interceptor instance

Returns:

updated builder instance

addInterceptor

T addInterceptor(DbInterceptor interceptor,
                 String... statementNames)

Add an interceptor that is active only on the configured statement names. This interceptor is only executed on named statements.

Parameters:

interceptor - interceptor instance

statementNames - statement names to be active on

Returns:

updated builder instance

addInterceptor

T addInterceptor(DbInterceptor interceptor,
                 DbStatementType... dbStatementTypes)

Add an interceptor thas is active only on configured statement types. This interceptor is executed on all statements of that type.

Note the specific handling of the following types:

• DbStatementType.DML - used only when the statement is created as a DML statement such as when using DbExecute.createDmlStatement(String) (this interceptor would not be enabled for inserts, updates, deletes)
• DbStatementType.UNKNOWN - used only when the statement is created as a general statement such as when using DbExecute.createStatement(String) (this interceptor would not be enabled for any other statements)

Parameters:

interceptor - interceptor instance

dbStatementTypes - statement types to be active on

Returns:

updated builder instance

build

DbClient build()

Build database handler for specific provider.

Specified by:

build in interface Builder<T extends DbClientProviderBuilder<T>>

Returns:

database handler instance