org.dbunit.database

Interface IDatabaseConnection

All Known Implementing Classes:

AbstractDatabaseConnection, DatabaseConnection, DatabaseDataSourceConnection, Db2Connection, H2Connection, HsqldbConnection, MckoiConnection, MsSqlConnection, MySqlConnection, OracleConnection

public interface IDatabaseConnection

This interface represents a connection to a specific database.

Since:

Mar 6, 2002

Version:

$Revision$

Author:

Manuel Laflamme

Method Summary

Modifier and Type	Method and Description
void	close() Close this connection.
IDataSet	createDataSet() Creates a dataset corresponding to the entire database.
IDataSet	createDataSet(java.lang.String[] tableNames) Creates a dataset containing only the specified tables from the database.
ITable	createQueryTable(java.lang.String tableName, java.lang.String sql) Creates a table with the result of the specified SQL statement.
ITable	createTable(java.lang.String tableName) Creates a table with the result of a select * from tableName SQL statement.
ITable	createTable(java.lang.String tableName, java.sql.PreparedStatement preparedStatement) Creates a table using the given PreparedStatement to retrieve a ResultSet.
DatabaseConfig	getConfig() Returns this connection database configuration
java.sql.Connection	getConnection() Returns a JDBC database connection.
int	getRowCount(java.lang.String tableName) Returns the specified table row count.
int	getRowCount(java.lang.String tableName, java.lang.String whereClause) Returns the specified table row count according specified where clause.
java.lang.String	getSchema() Returns the database schema name.
IStatementFactory	getStatementFactory() Deprecated. Use getConfig()

Method Detail

getConnection

java.sql.Connection getConnection()
                           throws java.sql.SQLException

Returns a JDBC database connection.

Throws:

java.sql.SQLException

getSchema

java.lang.String getSchema()

Returns the database schema name.

close

void close()
    throws java.sql.SQLException

Close this connection.

Throws:

java.sql.SQLException

createDataSet

IDataSet createDataSet()
                throws java.sql.SQLException

Creates a dataset corresponding to the entire database.

Throws:

java.sql.SQLException

createDataSet

IDataSet createDataSet(java.lang.String[] tableNames)
                throws java.sql.SQLException,
                       DataSetException

Creates a dataset containing only the specified tables from the database.

Parameters:

tableNames - The tables for which a dataset shall be created

Returns:

The new dataset

Throws:

java.sql.SQLException

DataSetException

createQueryTable

ITable createQueryTable(java.lang.String tableName,
                        java.lang.String sql)
                 throws DataSetException,
                        java.sql.SQLException

Creates a table with the result of the specified SQL statement. The table can be the result of a join statement.

Parameters:

tableName - The name to be returned by ITableMetaData.getTableName().

sql - The SQL SELECT statement

Returns:

The new table

Throws:

DataSetException

java.sql.SQLException

createTable

ITable createTable(java.lang.String tableName,
                   java.sql.PreparedStatement preparedStatement)
            throws DataSetException,
                   java.sql.SQLException

Creates a table using the given PreparedStatement to retrieve a ResultSet.

Parameters:

tableName - The name to be returned by ITableMetaData.getTableName().

preparedStatement - The statement to be executed as query

Returns:

The new table

Throws:

DataSetException

java.sql.SQLException

Since:

2.4.4

createTable

ITable createTable(java.lang.String tableName)
            throws DataSetException,
                   java.sql.SQLException

Creates a table with the result of a select * from tableName SQL statement.

Parameters:

tableName - The name of the database table to be queried which is also returned by ITableMetaData.getTableName().

Throws:

DataSetException

java.sql.SQLException

getRowCount

int getRowCount(java.lang.String tableName)
         throws java.sql.SQLException

Returns the specified table row count.

Parameters:

tableName - the table name

Returns:

the row count

Throws:

java.sql.SQLException

getRowCount

int getRowCount(java.lang.String tableName,
                java.lang.String whereClause)
         throws java.sql.SQLException

Returns the specified table row count according specified where clause.

Parameters:

tableName - the table name

whereClause - the where clause

Returns:

the row count

Throws:

java.sql.SQLException

getConfig

DatabaseConfig getConfig()

Returns this connection database configuration

getStatementFactory

IStatementFactory getStatementFactory()

Deprecated. Use getConfig()