org.apache.beam.it.jdbc

Class AbstractJDBCResourceManager<T extends JdbcDatabaseContainer<?>>

java.lang.Object

org.apache.beam.it.testcontainers.TestContainerResourceManager<JdbcDatabaseContainer<?>>

org.apache.beam.it.jdbc.AbstractJDBCResourceManager<T>

All Implemented Interfaces:

org.apache.beam.it.common.ResourceManager, JDBCResourceManager

Direct Known Subclasses:

MSSQLResourceManager, MySQLResourceManager, OracleResourceManager, PostgresResourceManager

public abstract class AbstractJDBCResourceManager<T extends JdbcDatabaseContainer<?>>
extends TestContainerResourceManager<JdbcDatabaseContainer<?>>
implements JDBCResourceManager

Abstract class for implementation of JDBCResourceManager interface.

The class supports one database, and multiple tables per database object. A database is created when the container first spins up, if one is not given.

The database name is formed using testId. The database name will be "{testId}-{ISO8601 time, microsecond precision}", with additional formatting.

The class is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractJDBCResourceManager.Builder<T extends JdbcDatabaseContainer<?>> Builder for AbstractJDBCResourceManager.

Nested classes/interfaces inherited from interface org.apache.beam.it.jdbc.JDBCResourceManager

JDBCResourceManager.JDBCSchema

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	databaseName
protected static java.lang.String	DEFAULT_JDBC_USERNAME
protected org.apache.beam.it.jdbc.JDBCDriverFactory	driver
protected java.lang.String	password
protected java.lang.String	username

Fields inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

HOST_IP, port

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractJDBCResourceManager(T container, AbstractJDBCResourceManager.Builder<T> builder)

Method Summary

Modifier and Type	Method and Description
boolean	createTable(java.lang.String tableName, JDBCResourceManager.JDBCSchema schema) Creates a table within the current database given a table name and JDBC schema.
java.lang.String	getDatabaseName() Returns the name of the Database that this JDBC manager will operate in.
protected java.lang.String	getFirstRow(java.lang.String tableName) Retrieves the first row from the table.
protected abstract int	getJDBCPort() Return the default port that this JDBC implementation listens on.
abstract java.lang.String	getJDBCPrefix()
java.lang.String	getPassword() Returns the password used to log in to the JDBC database.
long	getRowCount(java.lang.String tableName) Gets the number of rows in table.
java.util.List<java.lang.String>	getTableSchema(java.lang.String tableName) Returns the schema of the given table as a list of strings.
java.lang.String	getUri() Returns the URI connection string to the JDBC Database.
java.lang.String	getUsername() Returns the username used to log in to the JDBC database.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	readTable(java.lang.String tableName) Reads all the rows in a table and returns in the format of a list of Maps, which contain all the columns (including ID).
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	runSQLQuery(java.lang.String sql) Run the given SQL query.
void	runSQLUpdate(java.lang.String sql) Run the given SQL DML statement (INSERT, UPDATE and DELETE).
boolean	write(java.lang.String tableName, java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows) Writes the given mapped rows into the specified columns.

Methods inherited from class org.apache.beam.it.testcontainers.TestContainerResourceManager

cleanupAll, getDockerImageName, getHost, getPort

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.beam.it.common.ResourceManager

cleanupAll

Field Detail

DEFAULT_JDBC_USERNAME

protected static final java.lang.String DEFAULT_JDBC_USERNAME

See Also:

Constant Field Values

driver

protected final org.apache.beam.it.jdbc.JDBCDriverFactory driver

databaseName

protected final java.lang.String databaseName

username

protected final java.lang.String username

password

protected final java.lang.String password

Constructor Detail

AbstractJDBCResourceManager

protected AbstractJDBCResourceManager(T container,
                                      AbstractJDBCResourceManager.Builder<T> builder)

Method Detail

getJDBCPort

protected abstract int getJDBCPort()

Return the default port that this JDBC implementation listens on.

Returns:

the JDBC port.

getUsername

public java.lang.String getUsername()

Description copied from interface: JDBCResourceManager

Returns the username used to log in to the JDBC database.

Specified by:

getUsername in interface JDBCResourceManager

Returns:

the database username.

getPassword

public java.lang.String getPassword()

Description copied from interface: JDBCResourceManager

Returns the password used to log in to the JDBC database.

Specified by:

getPassword in interface JDBCResourceManager

Returns:

the database password.

getUri

public java.lang.String getUri()

Description copied from interface: JDBCResourceManager

Returns the URI connection string to the JDBC Database.

Specified by:

getUri in interface JDBCResourceManager

getJDBCPrefix

public abstract java.lang.String getJDBCPrefix()

getDatabaseName

public java.lang.String getDatabaseName()

Description copied from interface: JDBCResourceManager

Returns the name of the Database that this JDBC manager will operate in.

Specified by:

getDatabaseName in interface JDBCResourceManager

Returns:

the name of the JDBC Database.

createTable

public boolean createTable(java.lang.String tableName,
                           JDBCResourceManager.JDBCSchema schema)

Description copied from interface: JDBCResourceManager

Creates a table within the current database given a table name and JDBC schema.

Specified by:

createTable in interface JDBCResourceManager

Parameters:

tableName - The name of the table.

schema - A JDBCResourceManager.JDBCSchema object that defines the table.

Returns:

A boolean indicating whether the resource was created.

write

public boolean write(java.lang.String tableName,
                     java.util.List<java.util.Map<java.lang.String,java.lang.Object>> rows)
              throws JDBCResourceManagerException

Writes the given mapped rows into the specified columns. This method requires JDBCResourceManager.createTable(String, JDBCSchema) to be called for the target table beforehand.

The rows map must use the row id as the key, and the values will be inserted into the columns at the row with that id. i.e. {0: [val1, val2, ...], 1: [val1, val2, ...], ...}

Specified by:

write in interface JDBCResourceManager

Parameters:

tableName - The name of the table to insert the given rows into.

rows - A map representing the rows to be inserted into the table.

Throws:

JDBCResourceManagerException - if method is called after resources have been cleaned up, if the manager object has no dataset, if the table does not exist or if there is an Exception when attempting to insert the rows.

readTable

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> readTable(java.lang.String tableName)

Description copied from interface: JDBCResourceManager

Reads all the rows in a table and returns in the format of a list of Maps, which contain all the columns (including ID).

Specified by:

readTable in interface JDBCResourceManager

Parameters:

tableName - The name of the table to read rows from.

Returns:

a list containing the table rows.

getTableSchema

public java.util.List<java.lang.String> getTableSchema(java.lang.String tableName)

Description copied from interface: JDBCResourceManager

Returns the schema of the given table as a list of strings.

Specified by:

getTableSchema in interface JDBCResourceManager

Parameters:

tableName - the name of the table to fetch the schema of.

Returns:

the list of column names.

getFirstRow

protected java.lang.String getFirstRow(java.lang.String tableName)

Retrieves the first row from the table.

Parameters:

tableName - the name of the table to query.

Returns:

the first row from the table.

runSQLQuery

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> runSQLQuery(java.lang.String sql)

Description copied from interface: JDBCResourceManager

Run the given SQL query.

Specified by:

runSQLQuery in interface JDBCResourceManager

Parameters:

sql - The SQL query to run.

Returns:

A ResultSet containing the result of the execution.

runSQLUpdate

public void runSQLUpdate(java.lang.String sql)

Description copied from interface: JDBCResourceManager

Run the given SQL DML statement (INSERT, UPDATE and DELETE).

Specified by:

runSQLUpdate in interface JDBCResourceManager

Parameters:

sql - The SQL DML statement to run.

getRowCount

public long getRowCount(java.lang.String tableName)

Description copied from interface: JDBCResourceManager

Gets the number of rows in table.

Specified by:

getRowCount in interface JDBCResourceManager

Parameters:

tableName - The name of the table.

Returns:

a count of number of rows in the table.