org.testcontainers.containers

Class JdbcDatabaseContainer<SELF extends JdbcDatabaseContainer<SELF>>

java.lang.Object

org.testcontainers.containers.FailureDetectingExternalResource

org.testcontainers.containers.GenericContainer<SELF>

org.testcontainers.containers.JdbcDatabaseContainer<SELF>

All Implemented Interfaces:

java.lang.AutoCloseable, org.junit.rules.TestRule, org.testcontainers.containers.Container<SELF>, org.testcontainers.containers.ContainerState, org.testcontainers.containers.traits.LinkableContainer, org.testcontainers.containers.wait.strategy.WaitStrategyTarget, org.testcontainers.lifecycle.Startable

public abstract class JdbcDatabaseContainer<SELF extends JdbcDatabaseContainer<SELF>>
extends org.testcontainers.containers.GenericContainer<SELF>
implements org.testcontainers.containers.traits.LinkableContainer

Base class for containers that expose a JDBC connection

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JdbcDatabaseContainer.NoDriverFoundException

Nested classes/interfaces inherited from interface org.testcontainers.containers.Container

org.testcontainers.containers.Container.ExecResult

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	parameters
protected java.util.Map<java.lang.String,java.lang.String>	urlParameters

Fields inherited from class org.testcontainers.containers.GenericContainer

CONTAINER_RUNNING_TIMEOUT_SEC, dependencies, dockerClient, INTERNAL_HOST_HOSTNAME, waitStrategy

Fields inherited from interface org.testcontainers.containers.ContainerState

STATE_HEALTHY

Constructor Summary

Constructors

Constructor and Description
JdbcDatabaseContainer(org.testcontainers.utility.DockerImageName dockerImageName)
JdbcDatabaseContainer(@NonNull java.util.concurrent.Future<java.lang.String> image)
JdbcDatabaseContainer(@NonNull java.lang.String dockerImageName) Deprecated. use JdbcDatabaseContainer(DockerImageName) instead

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.String paramName, java.lang.String value)
protected java.lang.String	constructUrlForConnection(java.lang.String queryString) Template method for constructing the JDBC URL to be used for creating Connections.
protected java.lang.String	constructUrlParameters(java.lang.String startCharacter, java.lang.String delimiter)
protected java.lang.String	constructUrlParameters(java.lang.String startCharacter, java.lang.String delimiter, java.lang.String endCharacter)
protected void	containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)
java.sql.Connection	createConnection(java.lang.String queryString) Creates a connection to the underlying containerized database instance.
java.sql.Connection	createConnection(java.lang.String queryString, java.util.Properties info) Creates a connection to the underlying containerized database instance.
protected int	getConnectTimeoutSeconds() Deprecated. should not be overridden anymore, use withConnectTimeoutSeconds(int) in constructor instead
protected org.testcontainers.delegate.DatabaseDelegate	getDatabaseDelegate()
java.lang.String	getDatabaseName()
abstract java.lang.String	getDriverClassName()
java.sql.Driver	getJdbcDriverInstance() Obtain an instance of the correct JDBC driver for this particular database container type
abstract java.lang.String	getJdbcUrl()
abstract java.lang.String	getPassword()
protected int	getStartupTimeoutSeconds() Deprecated. should not be overridden anymore, use withStartupTimeoutSeconds(int) in constructor instead
protected abstract java.lang.String	getTestQueryString()
abstract java.lang.String	getUsername()
protected void	optionallyMapResourceParameterAsVolume(@NotNull java.lang.String paramName, @NotNull java.lang.String pathNameInContainer, @NotNull java.lang.String defaultResource) Deprecated.
protected void	optionallyMapResourceParameterAsVolume(@NotNull java.lang.String paramName, @NotNull java.lang.String pathNameInContainer, @NotNull java.lang.String defaultResource, @Nullable java.lang.Integer fileMode)
protected void	runInitScriptIfRequired() Load init script content and apply it to the database if initScriptPath is set
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
protected void	waitUntilContainerStarted()
SELF	withConnectTimeoutSeconds(int connectTimeoutSeconds) Set time to allow for the database to start and establish an initial connection, in seconds.
SELF	withDatabaseName(java.lang.String dbName)
SELF	withInitScript(java.lang.String initScriptPath)
SELF	withPassword(java.lang.String password)
SELF	withStartupTimeoutSeconds(int startupTimeoutSeconds) Set startup time to allow, including image pull time, in seconds.
SELF	withUrlParam(java.lang.String paramName, java.lang.String paramValue)
SELF	withUsername(java.lang.String username)

Methods inherited from class org.testcontainers.containers.GenericContainer

addEnv, addExposedPort, addExposedPorts, addFileSystemBind, addFixedExposedPort, addFixedExposedPort, addLink, apply, canBeReused, configure, containerIsCreated, containerIsStarted, containerIsStarting, containerIsStarting, containerIsStopped, containerIsStopping, copyFileFromContainer, createVolumeDirectory, dependsOn, dependsOn, dependsOn, doStart, equals, failed, finished, getBinds, getCommandParts, getContainerId, getContainerInfo, getContainerName, getCopyToFileContainerPathMap, getCreateContainerCmdModifiers, getDependencies, getDockerClient, getDockerImageName, getEnv, getEnvMap, getExposedPorts, getExtraHosts, getImage, getIpAddress, getLabels, getLinkedContainers, getLivenessCheckPort, getLivenessCheckPortNumbers, getLivenessCheckPorts, getLogConsumers, getNetwork, getNetworkAliases, getNetworkMode, getPortBindings, getShmSize, getStartupAttempts, getStartupCheckStrategy, getTestHostIpAddress, getTmpFsMapping, getVolumesFroms, getWaitStrategy, getWorkingDirectory, hashCode, isHostAccessible, isPrivilegedMode, isShouldBeReused, logger, setBinds, setCommand, setCommand, setCommandParts, setContainerDef, setCopyToFileContainerPathMap, setDockerImageName, setEnv, setExposedPorts, setExtraHosts, setHostAccessible, setImage, setLabels, setLinkedContainers, setLogConsumers, setNetwork, setNetworkAliases, setNetworkMode, setPortBindings, setPrivilegedMode, setShmSize, setStartupAttempts, setStartupCheckStrategy, setTmpFsMapping, setVolumesFroms, setWaitStrategy, setWorkingDirectory, start, starting, stop, succeeded, toString, waitingFor, withAccessToHost, withClasspathResourceMapping, withClasspathResourceMapping, withCommand, withCommand, withCopyFileToContainer, withCopyToContainer, withCreateContainerCmdModifier, withEnv, withEnv, withExposedPorts, withExtraHost, withFileSystemBind, withImagePullPolicy, withLabel, withLabels, withLogConsumer, withMinimumRunningDuration, withNetwork, withNetworkAliases, withNetworkMode, withPrivilegedMode, withReuse, withSharedMemorySize, withStartupAttempts, withStartupCheckStrategy, withStartupTimeout, withTmpFs, withVolumesFrom, withWorkingDirectory

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.testcontainers.containers.traits.LinkableContainer

getContainerName

Methods inherited from interface org.testcontainers.containers.Container

addFileSystemBind, followOutput, followOutput, self, withEnv, withFileSystemBind

Methods inherited from interface org.testcontainers.containers.ContainerState

copyFileFromContainer, copyFileToContainer, copyFileToContainer, execInContainer, execInContainer, execInContainer, execInContainer, execInContainerWithUser, execInContainerWithUser, getBoundPortNumbers, getContainerIpAddress, getCurrentContainerInfo, getFirstMappedPort, getHost, getLogs, getLogs, getMappedPort, isCreated, isHealthy, isRunning

Methods inherited from interface org.testcontainers.lifecycle.Startable

close

Field Detail

parameters

protected java.util.Map<java.lang.String,java.lang.String> parameters

urlParameters

protected java.util.Map<java.lang.String,java.lang.String> urlParameters

Constructor Detail

JdbcDatabaseContainer

public JdbcDatabaseContainer(@NonNull
                             @NonNull java.lang.String dockerImageName)

Deprecated. use JdbcDatabaseContainer(DockerImageName) instead

JdbcDatabaseContainer

public JdbcDatabaseContainer(@NonNull
                             @NonNull java.util.concurrent.Future<java.lang.String> image)

JdbcDatabaseContainer

public JdbcDatabaseContainer(org.testcontainers.utility.DockerImageName dockerImageName)

Method Detail

getDriverClassName

public abstract java.lang.String getDriverClassName()

Returns:

the name of the actual JDBC driver to use

getJdbcUrl

public abstract java.lang.String getJdbcUrl()

Returns:

a JDBC URL that may be used to connect to the dockerized DB

getDatabaseName

public java.lang.String getDatabaseName()

Returns:

the database name

getUsername

public abstract java.lang.String getUsername()

Returns:

the standard database username that should be used for connections

getPassword

public abstract java.lang.String getPassword()

Returns:

the standard password that should be used for connections

getTestQueryString

protected abstract java.lang.String getTestQueryString()

Returns:

a test query string suitable for testing that this particular database type is alive

withUsername

public SELF withUsername(java.lang.String username)

withPassword

public SELF withPassword(java.lang.String password)

withDatabaseName

public SELF withDatabaseName(java.lang.String dbName)

withUrlParam

public SELF withUrlParam(java.lang.String paramName,
                         java.lang.String paramValue)

withStartupTimeoutSeconds

public SELF withStartupTimeoutSeconds(int startupTimeoutSeconds)

Set startup time to allow, including image pull time, in seconds.

Parameters:

startupTimeoutSeconds - startup time to allow, including image pull time, in seconds

Returns:

self

withConnectTimeoutSeconds

public SELF withConnectTimeoutSeconds(int connectTimeoutSeconds)

Set time to allow for the database to start and establish an initial connection, in seconds.

Parameters:

connectTimeoutSeconds - time to allow for the database to start and establish an initial connection in seconds

Returns:

self

withInitScript

public SELF withInitScript(java.lang.String initScriptPath)

waitUntilContainerStarted

protected void waitUntilContainerStarted()

Overrides:

waitUntilContainerStarted in class org.testcontainers.containers.GenericContainer<SELF extends JdbcDatabaseContainer<SELF>>

containerIsStarted

protected void containerIsStarted(com.github.dockerjava.api.command.InspectContainerResponse containerInfo)

Overrides:

containerIsStarted in class org.testcontainers.containers.GenericContainer<SELF extends JdbcDatabaseContainer<SELF>>

getJdbcDriverInstance

public java.sql.Driver getJdbcDriverInstance()
                                      throws JdbcDatabaseContainer.NoDriverFoundException

Obtain an instance of the correct JDBC driver for this particular database container type

Returns:

a JDBC Driver

Throws:

JdbcDatabaseContainer.NoDriverFoundException

createConnection

public java.sql.Connection createConnection(java.lang.String queryString)
                                     throws java.sql.SQLException,
                                            JdbcDatabaseContainer.NoDriverFoundException

Creates a connection to the underlying containerized database instance.

Parameters:

queryString - query string parameters that should be appended to the JDBC connection URL. The '?' character must be included

Returns:

a Connection

Throws:

java.sql.SQLException - if there is a repeated failure to create the connection

JdbcDatabaseContainer.NoDriverFoundException

createConnection

public java.sql.Connection createConnection(java.lang.String queryString,
                                            java.util.Properties info)
                                     throws java.sql.SQLException,
                                            JdbcDatabaseContainer.NoDriverFoundException

Creates a connection to the underlying containerized database instance.

Parameters:

queryString - query string parameters that should be appended to the JDBC connection URL. The '?' character must be included

info - additional properties to be passed to the JDBC driver

Returns:

a Connection

Throws:

java.sql.SQLException - if there is a repeated failure to create the connection

JdbcDatabaseContainer.NoDriverFoundException

constructUrlForConnection

protected java.lang.String constructUrlForConnection(java.lang.String queryString)

Template method for constructing the JDBC URL to be used for creating Connections. This should be overridden if the JDBC URL and query string concatenation or URL string construction needs to be different to normal.

Parameters:

queryString - query string parameters that should be appended to the JDBC connection URL. The '?' character must be included

Returns:

a full JDBC URL including queryString

constructUrlParameters

protected java.lang.String constructUrlParameters(java.lang.String startCharacter,
                                                  java.lang.String delimiter)

constructUrlParameters

protected java.lang.String constructUrlParameters(java.lang.String startCharacter,
                                                  java.lang.String delimiter,
                                                  java.lang.String endCharacter)

optionallyMapResourceParameterAsVolume

@Deprecated
protected void optionallyMapResourceParameterAsVolume(@NotNull
                                                                  @NotNull java.lang.String paramName,
                                                                  @NotNull
                                                                  @NotNull java.lang.String pathNameInContainer,
                                                                  @NotNull
                                                                  @NotNull java.lang.String defaultResource)

Deprecated.

optionallyMapResourceParameterAsVolume

protected void optionallyMapResourceParameterAsVolume(@NotNull
                                                      @NotNull java.lang.String paramName,
                                                      @NotNull
                                                      @NotNull java.lang.String pathNameInContainer,
                                                      @NotNull
                                                      @NotNull java.lang.String defaultResource,
                                                      @Nullable
                                                      @Nullable java.lang.Integer fileMode)

runInitScriptIfRequired

protected void runInitScriptIfRequired()

Load init script content and apply it to the database if initScriptPath is set

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

addParameter

public void addParameter(java.lang.String paramName,
                         java.lang.String value)

getStartupTimeoutSeconds

@Deprecated
protected int getStartupTimeoutSeconds()

Deprecated. should not be overridden anymore, use withStartupTimeoutSeconds(int) in constructor instead

Returns:

startup time to allow, including image pull time, in seconds

getConnectTimeoutSeconds

@Deprecated
protected int getConnectTimeoutSeconds()

Deprecated. should not be overridden anymore, use withConnectTimeoutSeconds(int) in constructor instead

Returns:

time to allow for the database to start and establish an initial connection, in seconds

getDatabaseDelegate

protected org.testcontainers.delegate.DatabaseDelegate getDatabaseDelegate()