org.testcontainers.jdbc

Class ContainerDatabaseDriver

java.lang.Object

org.testcontainers.jdbc.ContainerDatabaseDriver

All Implemented Interfaces:

java.sql.Driver

public class ContainerDatabaseDriver
extends java.lang.Object
implements java.sql.Driver

Test Containers JDBC proxy driver. This driver will handle JDBC URLs of the form:

jdbc:tc:type://host:port/database?querystring

where type is a supported database type (e.g. mysql, postgresql, oracle). Behind the scenes a new docker container will be launched running the required database engine. New JDBC connections will be created using the database's standard driver implementation, connected to the container.

If TC_INITSCRIPT is set in querystring, it will be used as the path for an init script that should be run to initialize the database after the container is created. This should be a classpath resource.

Similarly TC_INITFUNCTION may be a method reference for a function that can initialize the database. Such a function must accept a javax.sql.Connection as its only parameter. An example of a valid method reference would be com.myapp.SomeClass::initFunction

Constructor Summary

Constructors

Constructor and Description
ContainerDatabaseDriver()

Method Summary

Modifier and Type	Method and Description
boolean	acceptsURL(java.lang.String url)
java.sql.Connection	connect(java.lang.String url, java.util.Properties info)
int	getMajorVersion()
int	getMinorVersion()
java.util.logging.Logger	getParentLogger()
java.sql.DriverPropertyInfo[]	getPropertyInfo(java.lang.String url, java.util.Properties info)
boolean	jdbcCompliant()
static void	killContainer(java.lang.String jdbcUrl) Utility method to kill a database container directly from test support code.
static void	killContainers() Utility method to kill ALL database containers directly from test support code.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContainerDatabaseDriver

public ContainerDatabaseDriver()

Method Detail

acceptsURL

public boolean acceptsURL(java.lang.String url)
                   throws java.sql.SQLException

Specified by:

acceptsURL in interface java.sql.Driver

Throws:

java.sql.SQLException

connect

public java.sql.Connection connect(java.lang.String url,
                                   java.util.Properties info)
                            throws java.sql.SQLException

Specified by:

connect in interface java.sql.Driver

Throws:

java.sql.SQLException

getPropertyInfo

public java.sql.DriverPropertyInfo[] getPropertyInfo(java.lang.String url,
                                                     java.util.Properties info)
                                              throws java.sql.SQLException

Specified by:

getPropertyInfo in interface java.sql.Driver

Throws:

java.sql.SQLException

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface java.sql.Driver

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface java.sql.Driver

jdbcCompliant

public boolean jdbcCompliant()

Specified by:

jdbcCompliant in interface java.sql.Driver

getParentLogger

public java.util.logging.Logger getParentLogger()
                                         throws java.sql.SQLFeatureNotSupportedException

Specified by:

getParentLogger in interface java.sql.Driver

Throws:

java.sql.SQLFeatureNotSupportedException

killContainers

public static void killContainers()

Utility method to kill ALL database containers directly from test support code. It shouldn't be necessary to use this, but it is provided for convenience - e.g. for situations where many different database containers are being tested and cleanup is needed to limit resource usage.

killContainer

public static void killContainer(java.lang.String jdbcUrl)

Utility method to kill a database container directly from test support code. It shouldn't be necessary to use this, but it is provided for convenience - e.g. for situations where many different database containers are being tested and cleanup is needed to limit resource usage.

Parameters:

jdbcUrl - the JDBC URL of the container which should be killed