Package io.ebean.docker.container

Interface ContainerConfig

All Known Implementing Classes:

BaseConfig, ClickHouseConfig, CockroachConfig, DbConfig, ElasticConfig, HanaConfig, MariaDBConfig, MySqlConfig, NuoDBConfig, OracleConfig, PostgresConfig, RedisConfig, SqlServerConfig

public interface ContainerConfig

Configuration details associated with a container.

Method Summary

Modifier and Type	Method	Description
String	containerName()	Return the container name.
Connection	createAdminConnection()	Return a DB connection using the admin user.
Connection	createConnection()	Return a DB connection.
Connection	createConnectionNoSchema()	Return a DB connection without schema (as it maybe is not created yet).
String	jdbcAdminUrl()	Return a DB connection url for the admin database user.
String	jdbcUrl()	Return a DB connection url or null if not a database container.
String	platform()	Return the type of container.
void	setShutdownMode(StopMode shutdownHookMode)	Set the shutdown hook mode to automatically stop/remove the container on JVM shutdown.
void	setStartMode(StartMode startMode)	Set the start mode.
void	setStopMode(StopMode stopMode)	Set the stop mode used when stop() is called.
String	startDescription()	Return a good description for starting the container typically for logging.
String	stopDescription()	Return a good description for stopping the container typically for logging.
String	version()	Return the image version.

Method Detail

platform

String platform()

Return the type of container. postgres, mysql, elastic etc.

containerName

String containerName()

Return the container name.

version

String version()

Return the image version.

jdbcUrl

String jdbcUrl()

Return a DB connection url or null if not a database container.

jdbcAdminUrl

String jdbcAdminUrl()

Return a DB connection url for the admin database user.

createConnection

Connection createConnection()
                     throws SQLException

Return a DB connection.

Throws:

SQLException

createConnectionNoSchema

Connection createConnectionNoSchema()
                             throws SQLException

Return a DB connection without schema (as it maybe is not created yet).

Throws:

SQLException

createAdminConnection

Connection createAdminConnection()
                          throws SQLException

Return a DB connection using the admin user.

Throws:

SQLException

setStartMode

void setStartMode(StartMode startMode)

Set the start mode. One of create, dropCreate, or container [only].

setStopMode

void setStopMode(StopMode stopMode)

Set the stop mode used when stop() is called.

setShutdownMode

void setShutdownMode(StopMode shutdownHookMode)

Set the shutdown hook mode to automatically stop/remove the container on JVM shutdown.

startDescription

String startDescription()

Return a good description for starting the container typically for logging.

stopDescription

String stopDescription()

Return a good description for stopping the container typically for logging.