Interface VertxSqlClientConfiguration
Vert.x SQL client module configuration.
- Since:
- 1.2
- Author:
- Jeremy Kuhn
-
Method Summary
Modifier and TypeMethodDescriptionA JSON containing database connection options.The RDBMS password.db_uri()
The URI to connect to the RDBMS.db_user()
The RDBMS user.default int
The amount of time a client will wait for a connection from the pool.default TimeUnit
The connection timeout unit.default int
The idle timeout of a pooled connection.default TimeUnit
The idle timeout unit.default int
The maximum pool size.default int
The maximum wait queue size.default int
The connection pool cleaner period in ms.
-
Method Details
-
db_uri
String db_uri()The URI to connect to the RDBMS.
- Returns:
- a database URI
-
db_user
String db_user()The RDBMS user.
- Returns:
- the user
-
db_password
String db_password()The RDBMS password.
- Returns:
- the password
-
db_json_options
String db_json_options()A JSON containing database connection options.
- Returns:
- database connection options
-
pool_maxSize
default int pool_maxSize()The maximum pool size.
Defaults to
PoolOptions.DEFAULT_MAX_SIZE
- Returns:
- the maximum pool size
-
pool_maxWaitQueueSize
default int pool_maxWaitQueueSize()The maximum wait queue size.
Defaults to
PoolOptions.DEFAULT_MAX_WAIT_QUEUE_SIZE
- Returns:
- the maximum wait queue size
-
pool_idleTimeout
default int pool_idleTimeout()The idle timeout of a pooled connection.
Defaults to
PoolOptions.DEFAULT_IDLE_TIMEOUT
- Returns:
- the pooled connection idle timeout
-
pool_idleTimeoutUnit
The idle timeout unit.
Defaults to
PoolOptions.DEFAULT_IDLE_TIMEOUT_TIME_UNIT
- Returns:
- the idle timeout unit
-
pool_poolCleanerPeriod
default int pool_poolCleanerPeriod()The connection pool cleaner period in ms.
Defaults to
PoolOptions.DEFAULT_POOL_CLEANER_PERIOD
- Returns:
- the pool cleaner period in ms
-
pool_connectionTimeout
default int pool_connectionTimeout()The amount of time a client will wait for a connection from the pool.
Defaults to
PoolOptions.DEFAULT_CONNECTION_TIMEOUT
- Returns:
- the connection timeout
-
pool_connectionTimeoutUnit
The connection timeout unit.
Defaults to
PoolOptions.DEFAULT_CONNECTION_TIMEOUT_TIME_UNIT
- Returns:
- the connection timeout unit
-