Module rxmicro.data.sql

Package io.rxmicro.data.sql

Class SQLDatabaseConfig

java.lang.Object

io.rxmicro.config.Config

io.rxmicro.data.sql.SQLDatabaseConfig

Direct Known Subclasses:

SQLPooledDatabaseConfig

public class SQLDatabaseConfig
extends io.rxmicro.config.Config

Allows configuring SQL DB options.

Since:

0.1

Author:

nedis

See Also:

Duration

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_HOST	Default SQL database server host.

Fields inherited from class io.rxmicro.config.Config

KEY_VALUE_ENTRY_DELIMITER, RX_MICRO_CONFIG_DIRECTORY_NAME, RX_MICRO_CONFIG_FILE_NAME, VALUES_DELIMITER

Constructor Summary

Constructors

Constructor	Description
SQLDatabaseConfig()	Creates an SQL config instance with default settings.

Method Summary

Modifier and Type	Method	Description
String	getConnectionString()	Returns the connection string built from schema, host, port and database parameters.
Duration	getConnectTimeout()	Returns the connection timeout.
String	getDatabase()	Returns the database name.
String	getHost()	Returns the server host name.
Optional<Map<String,String>>	getOptions()	Returns the db specific options.
CharSequence	getPassword()	Returns the database password.
int	getPort()	Returns the server port.
String	getUser()	Returns the database username.
SQLDatabaseConfig	setConnectTimeout(Duration connectTimeout)	Sets the connection timeout.
SQLDatabaseConfig	setDatabase(String database)	Sets the database name.
SQLDatabaseConfig	setHost(String host)	Sets the server host name.
SQLDatabaseConfig	setOptions(Map<String,String> options)	Sets the additional database options.
SQLDatabaseConfig	setPassword(CharSequence password)	Sets the database password.
SQLDatabaseConfig	setPort(int port)	Sets the server port.
SQLDatabaseConfig	setUser(String user)	Sets the database username.
protected void	validate(String namespace)

Methods inherited from class io.rxmicro.config.Config

getDefaultNameSpace, getDefaultNameSpace, getNameSpace

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

Default SQL database server host.

See Also:

Constant Field Values

Constructor Detail

SQLDatabaseConfig

public SQLDatabaseConfig()

Creates an SQL config instance with default settings.

Method Detail

getHost

public String getHost()

Returns the server host name.

Returns:

the server host name

setHost

@BuilderMethod
public SQLDatabaseConfig setHost(String host)

Sets the server host name.

Parameters:

host - the server host name

Returns:

the reference to this SQLDatabaseConfig instance

getPort

public int getPort()

Returns the server port.

Returns:

the server port

setPort

@BuilderMethod
public SQLDatabaseConfig setPort(int port)

Sets the server port.

Parameters:

port - the server port

Returns:

the reference to this SQLDatabaseConfig instance

getUser

public String getUser()

Returns the database username.

Returns:

the database username

setUser

@BuilderMethod
public SQLDatabaseConfig setUser(String user)

Sets the database username.

Parameters:

user - the database username

Returns:

the reference to this SQLDatabaseConfig instance

getPassword

public CharSequence getPassword()

Returns the database password.

Returns:

the database password

setPassword

@BuilderMethod
public SQLDatabaseConfig setPassword(CharSequence password)

Sets the database password.

Parameters:

password - the database password

Returns:

the reference to this SQLDatabaseConfig instance

getDatabase

public String getDatabase()

Returns the database name.

Returns:

the database name

setDatabase

@BuilderMethod
public SQLDatabaseConfig setDatabase(String database)

Sets the database name.

Parameters:

database - the database name

Returns:

the reference to this SQLDatabaseConfig instance

setOptions

@BuilderMethod
public SQLDatabaseConfig setOptions(Map<String,String> options)

Sets the additional database options.

Parameters:

options - the additional options

Returns:

the reference to this SQLDatabaseConfig instance

getOptions

public Optional<Map<String,String>> getOptions()

Returns the db specific options.

Returns:

the db specific options

getConnectTimeout

public Duration getConnectTimeout()

Returns the connection timeout.

Returns:

the connection timeout

setConnectTimeout

@BuilderMethod
public SQLDatabaseConfig setConnectTimeout(Duration connectTimeout)

Sets the connection timeout.

Parameters:

connectTimeout - the connection timeout

Returns:

the reference to this SQLDatabaseConfig instance

getConnectionString

public String getConnectionString()

Returns the connection string built from schema, host, port and database parameters.

Returns:

the connection string built from schema, host, port and database parameters

validate

protected void validate(String namespace)

Overrides:

validate in class io.rxmicro.config.Config