Package org.dbunit.ext.mysql

Class MultiSchemaMySqlMetadataHandler

java.lang.Object

org.dbunit.ext.mysql.MySqlMetadataHandler

org.dbunit.ext.mysql.MultiSchemaMySqlMetadataHandler

All Implemented Interfaces:

IMetadataHandler

public class MultiSchemaMySqlMetadataHandler
extends MySqlMetadataHandler

A MySqlMetadataHandler for connections not restricted to a single schema (MySQL "catalog"), e.g. a connection made as MySQL's "root" specifically to work across several schemas at once with DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES enabled.

MySqlMetadataHandler's getTables()/getColumns()/getPrimaryKeys() pass a null schema straight through as the JDBC catalog argument. Per the JDBC specification catalog=null means "do not narrow the search by catalog", but MySQL Connector/J instead treats it as "the connection's current catalog only" by default (its nullCatalogMeansCurrent connection property), so tables in every other catalog are silently invisible and a lookup for one of them fails with NoSuchTableException.

This handler works around that driver behavior at the application level: whenever no single schema is given, it enumerates the catalogs visible to the connection (skipping MySQL's own information_schema/mysql/performance_schema/sys system catalogs) and unions the per-catalog results instead of ever passing a null catalog to the driver.

Configure it the same way as any other IMetadataHandler:

 config.setProperty(DatabaseConfig.FEATURE_QUALIFIED_TABLE_NAMES, true);
 config.setProperty(DatabaseConfig.PROPERTY_METADATA_HANDLER, new MultiSchemaMySqlMetadataHandler());
 

Since:

3.5.0

Constructor Summary

Constructors

Constructor	Description
MultiSchemaMySqlMetadataHandler()

Method Summary

Modifier and Type	Method	Description
ResultSet	getColumns(DatabaseMetaData databaseMetaData, String schemaName, String tableName)	Returns the result set for an invocation of DatabaseMetaData.getColumns(String, String, String, String).
ResultSet	getPrimaryKeys(DatabaseMetaData metaData, String schemaName, String tableName)	Returns the primary keys of the given table.
ResultSet	getTables(DatabaseMetaData metaData, String schemaName, String[] tableType)	Returns the tables in the given schema that matches one of the given tableTypes.
boolean	tableExists(DatabaseMetaData metaData, String schema, String tableName)	Checks if the given table exists.

Methods inherited from class org.dbunit.ext.mysql.MySqlMetadataHandler

getSchema, matches, matches, matchesColumn, supportsColumnCache

Methods inherited from class java.lang.Object

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

Constructor Details

MultiSchemaMySqlMetadataHandler

public MultiSchemaMySqlMetadataHandler()

Method Details

getTables

public ResultSet getTables(DatabaseMetaData metaData,
 String schemaName,
 String[] tableType)
                    throws SQLException

Description copied from interface: IMetadataHandler

Returns the tables in the given schema that matches one of the given tableTypes.

Specified by:

getTables in interface IMetadataHandler

Overrides:

getTables in class MySqlMetadataHandler

Parameters:

metaData - The database meta data

schemaName - schema for which the tables should be retrieved; null returns all schemas

tableType - a list of table types to include; null returns all types

Returns:

The ResultSet which is retrieved using DatabaseMetaData.getTables(String, String, String, String[])

Throws:

SQLException - if a database access error occurs.

getColumns

public ResultSet getColumns(DatabaseMetaData databaseMetaData,
 String schemaName,
 String tableName)
                     throws SQLException

Description copied from interface: IMetadataHandler

Returns the result set for an invocation of DatabaseMetaData.getColumns(String, String, String, String).

Specified by:

getColumns in interface IMetadataHandler

Overrides:

getColumns in class MySqlMetadataHandler

Parameters:

databaseMetaData - The database metadata to be used for retrieving the columns

schemaName - The schema name

tableName - The table name

Returns:

The result set containing all columns

Throws:

SQLException - if a database access error occurs.

getPrimaryKeys

public ResultSet getPrimaryKeys(DatabaseMetaData metaData,
 String schemaName,
 String tableName)
                         throws SQLException

Description copied from interface: IMetadataHandler

Returns the primary keys of the given table.

Specified by:

getPrimaryKeys in interface IMetadataHandler

Overrides:

getPrimaryKeys in class MySqlMetadataHandler

Parameters:

metaData - The database meta data

schemaName - schema for which the tables should be retrieved; null returns all schemas

tableName - table for which the primary keys are retrieved

Returns:

The ResultSet which is retrieved using DatabaseMetaData.getPrimaryKeys(String, String, String)

Throws:

SQLException - if a database access error occurs.

tableExists

public boolean tableExists(DatabaseMetaData metaData,
 String schema,
 String tableName)
                    throws SQLException

Description copied from interface: IMetadataHandler

Checks if the given table exists.

Specified by:

tableExists in interface IMetadataHandler

Overrides:

tableExists in class MySqlMetadataHandler

Parameters:

metaData - The database meta data

schema - The schema in which the table should be searched. If null the schema is not used to narrow the table name.

tableName - The table name to be searched

Returns:

Returns true if the given table exists in the given schema. Else returns false.

Throws:

SQLException - if a database access error occurs.