Package io.ebean.docker.commands

Class CockroachContainer

java.lang.Object

io.ebean.docker.commands.BaseDbContainer

io.ebean.docker.commands.CockroachContainer

All Implemented Interfaces:

Container

public class CockroachContainer
extends BaseDbContainer
implements Container

Commands for controlling a cockroachDB docker container.

Constructor Summary

Constructors

Constructor	Description
CockroachContainer(CockroachConfig config)	Create with configuration.

Method Summary

Modifier and Type	Method	Description
ContainerConfig	config()	Returns the container configuration.
static CockroachContainer	create(String version, Properties properties)	Create Postgres container with configuration from properties.
Connection	createConnection()	Create a connection to this database container.
boolean	isDatabaseReady()	Wait for the 'database system is ready'
boolean	isRunning()	Return true if the container is running.
String	jdbcUrl()	Return the JDBC url to connect to this container.
void	registerShutdownHook()	Register a JVM Shutdown hook to stop the container with the given mode.
boolean	start()	Start the container.
boolean	startContainerOnly()	Start the container only without creating database, user, extensions etc.
void	stop()	Stop using the configured stopMode of 'stop' or 'remove'.
void	stopOnly()	Stop the container only (no remove).
void	stopRemove()	Stop and remove the container effectively deleting the database.
boolean	waitForDatabaseReady()	Return true when the DB is ready for taking commands (like create database, user etc).

Methods inherited from class io.ebean.docker.commands.BaseDbContainer

startWithCreate, startWithDropCreate

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ebean.docker.container.Container

config, isRunning, start, stop, stopOnly

Constructor Detail

CockroachContainer

public CockroachContainer(CockroachConfig config)

Create with configuration.

Method Detail

create

public static CockroachContainer create(String version,
                                        Properties properties)

Create Postgres container with configuration from properties.

isDatabaseReady

public boolean isDatabaseReady()

Wait for the 'database system is ready'

jdbcUrl

public String jdbcUrl()

Return the JDBC url to connect to this container.

createConnection

public Connection createConnection()
                            throws SQLException

Create a connection to this database container.

Throws:

SQLException

start

public boolean start()

Description copied from interface: Container

Start the container.

Specified by:

start in interface Container

startContainerOnly

public boolean startContainerOnly()

Start the container only without creating database, user, extensions etc.

waitForDatabaseReady

public boolean waitForDatabaseReady()

Return true when the DB is ready for taking commands (like create database, user etc).

config

public ContainerConfig config()

Description copied from interface: Container

Returns the container configuration.

Specified by:

config in interface Container

isRunning

public boolean isRunning()

Description copied from interface: Container

Return true if the container is running.

Specified by:

isRunning in interface Container

registerShutdownHook

public void registerShutdownHook()

Register a JVM Shutdown hook to stop the container with the given mode.

stop

public void stop()

Stop using the configured stopMode of 'stop' or 'remove'.

Remove additionally removes the container (expected use in build agents).

Specified by:

stop in interface Container

stopRemove

public void stopRemove()

Stop and remove the container effectively deleting the database.

stopOnly

public void stopOnly()

Stop the container only (no remove).

Specified by:

stopOnly in interface Container