org.apache.beam.it.jdbc

Interface JDBCResourceManager

All Superinterfaces:

org.apache.beam.it.common.ResourceManager

All Known Implementing Classes:

AbstractJDBCResourceManager, MSSQLResourceManager, MySQLResourceManager, OracleResourceManager, PostgresResourceManager

public interface JDBCResourceManager
extends org.apache.beam.it.common.ResourceManager

Interface for managing JDBC resources in integration tests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JDBCResourceManager.JDBCSchema Object for managing JDBC table schemas in JDBCResourceManager instances.

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.
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 interface org.apache.beam.it.common.ResourceManager

cleanupAll

Method Detail

getUri

java.lang.String getUri()

Returns the URI connection string to the JDBC Database.

getUsername

java.lang.String getUsername()

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

Returns:

the database username.

getPassword

java.lang.String getPassword()

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

Returns:

the database password.

getDatabaseName

java.lang.String getDatabaseName()

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

Returns:

the name of the JDBC Database.

createTable

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

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

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.

Throws:

JDBCResourceManagerException - if there is an error creating the table or if the table already exists.

write

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 createTable(String, JDBCSchema) to be called for the target table beforehand.

The maps in the rows list must use the column name as the key. i.e. [{col1: val1, col2: val2, ...}, {col1: val3, col2: val4, ...}, ...]

Parameters:

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

rows - A list of maps 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

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).

Parameters:

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

Returns:

a list containing the table rows.

getTableSchema

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

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

Parameters:

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

Returns:

the list of column names.

runSQLQuery

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

Run the given SQL query.

Parameters:

sql - The SQL query to run.

Returns:

A ResultSet containing the result of the execution.

runSQLUpdate

void runSQLUpdate(java.lang.String sql)

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

Parameters:

sql - The SQL DML statement to run.

getRowCount

long getRowCount(java.lang.String tableName)

Gets the number of rows in table.

Parameters:

tableName - The name of the table.

Returns:

a count of number of rows in the table.