Class MongoDbClientBuilder

java.lang.Object

io.helidon.dbclient.DbClientBuilderBase<MongoDbClientBuilder>

io.helidon.dbclient.mongodb.MongoDbClientBuilder

All Implemented Interfaces:

Builder<MongoDbClientBuilder, DbClient>, DbClientBuilder<MongoDbClientBuilder>, Supplier<DbClient>

public final class MongoDbClientBuilder
extends DbClientBuilderBase<MongoDbClientBuilder>
implements DbClientBuilder<MongoDbClientBuilder>

Builder for mongoDB database.

Method Summary

Modifier and Type	Method	Description
MongoDbClientBuilder	config(Config config)	Use database connection configuration from configuration file.
static MongoDbClientBuilder	create()	Create a new instance.
MongoDbClientBuilder	credDb(String db)	Credential database.
DbClient	doBuild()	Actual DbClientBuilderBase.build() implementation for DbClient subclasses.

Methods inherited from class DbClientBuilderBase

addMapper, addMapper, addMapperProvider, addService, build, clientServices, dbMapperManager, dbMapperManager, mapperManager, mapperManager, missingMapParametersAsNull, missingMapParametersAsNull, password, password, statements, statements, url, url, username, username

Modifier and Type	Method	Description
<TYPE> MongoDbClientBuilder	addMapper(DbMapper<TYPE> dbMapper, GenericType<TYPE> mappedType)	Add a custom mapper with generic types support.
<TYPE> MongoDbClientBuilder	addMapper(DbMapper<TYPE> dbMapper, Class<TYPE> mappedClass)	Add a custom mapper.
MongoDbClientBuilder	addMapperProvider(DbMapperProvider provider)	Database schema mappers provider.
MongoDbClientBuilder	addService(DbClientService clientService)	Add an interceptor.
DbClient	build()	Build the instance from this builder.
List<DbClientService>	clientServices()	Get configured client services (interceptors).
DbMapperManager	dbMapperManager()	Get manager of all configured mappers.
MongoDbClientBuilder	dbMapperManager(DbMapperManager manager)	Mapper manager of all configured mappers.
Mappers	mapperManager()	Get Mapper manager.
MongoDbClientBuilder	mapperManager(Mappers manager)	Mapper manager for generic mapping, such as mapping of parameters to expected types.
boolean	missingMapParametersAsNull()	Configured missing values in named parameters Map handling.
MongoDbClientBuilder	missingMapParametersAsNull(boolean missingMapParametersAsNull)	Missing values in named parameters Map are considered as null values.
String	password()	Get database user password.
MongoDbClientBuilder	password(String password)	Set database connection password.
DbStatements	statements()	Get configured statements to be used by database provider.
MongoDbClientBuilder	statements(DbStatements statements)	Statements to use either from configuration or manually configured.
String	url()	Get database URL.
MongoDbClientBuilder	url(String url)	Set database connection string (URL).
String	username()	Get database user name.
MongoDbClientBuilder	username(String username)	Set database connection username.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default DbClient	get()
default MongoDbClientBuilder	identity()	Instance of this builder as the correct type.
default MongoDbClientBuilder	update(Consumer<MongoDbClientBuilder> consumer)	Update the builder in a fluent API way.

Method Details

create

public static MongoDbClientBuilder create()

Create a new instance.

Returns:

new MongoDB client builder

doBuild

public DbClient doBuild()

Description copied from class: DbClientBuilderBase

Actual DbClientBuilderBase.build() implementation for DbClient subclasses.

Specified by:

doBuild in class DbClientBuilderBase<MongoDbClientBuilder>

Returns:

new client

config

public MongoDbClientBuilder config(Config config)

Description copied from interface: DbClientBuilder

Use database connection configuration from configuration file.

Specified by:

config in interface DbClientBuilder<MongoDbClientBuilder>

Overrides:

config in class DbClientBuilderBase<MongoDbClientBuilder>

Parameters:

config - Config instance with database connection attributes

Returns:

database provider builder

credDb

public MongoDbClientBuilder credDb(String db)

Credential database.

Parameters:

db - database name

Returns:

updated builder instance