Package io.ebean.docker.commands

Class YugabyteContainer

java.lang.Object

io.ebean.docker.commands.JdbcBaseDbContainer

io.ebean.docker.commands.YugabyteContainer

All Implemented Interfaces:

Container

public class YugabyteContainer
extends JdbcBaseDbContainer

Creates Yugabyte container (with common commands for roles and database as Postgres).

Constructor Summary

Constructors

Constructor	Description
YugabyteContainer(YugabyteConfig config)

Method Summary

Modifier and Type	Method	Description
ContainerConfig	config()	Returns the container configuration.
static YugabyteContainer	create(String version, Properties properties)	Create Yugabyte container with configuration from properties.
Connection	createConnection()	Create a connection to this database container.
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.

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

startWithCreate, startWithDropCreate, waitForDatabaseReady

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

YugabyteContainer

public YugabyteContainer(YugabyteConfig config)

Method Detail

create

public static YugabyteContainer create(String version,
                                       Properties properties)

Create Yugabyte container with configuration from properties.

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.

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