org.apache.ddlutils.platform.mysql

Class MySqlModelReader

java.lang.Object

org.apache.ddlutils.platform.JdbcModelReader

org.apache.ddlutils.platform.mysql.MySqlModelReader

Direct Known Subclasses:

MySql50ModelReader

public class MySqlModelReader
extends JdbcModelReader

Reads a database model from a MySql database.

Constructor Summary

Constructors

Constructor and Description
MySqlModelReader(Platform platform) Creates a new model reader for MySql databases.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	isInternalForeignKeyIndex(DatabaseMetaDataWrapper metaData, Table table, ForeignKey fk, Index index) Tries to determine whether the index is the internal database-generated index for the given foreign key.
protected boolean	isInternalPrimaryKeyIndex(DatabaseMetaDataWrapper metaData, Table table, Index index) Tries to determine whether the index is the internal database-generated index for the given table's primary key.
protected Column	readColumn(DatabaseMetaDataWrapper metaData, Map values) Extracts a column definition from the result set.
protected Table	readTable(DatabaseMetaDataWrapper metaData, Map values) Reads the next table from the meta data.

Methods inherited from class org.apache.ddlutils.platform.JdbcModelReader

closeResultSet, closeStatement, convertAction, determineAutoIncrementFromResultSetMetaData, determineSchemaOf, getColumnsForColumn, getColumnsForFK, getColumnsForIndex, getColumnsForPK, getColumnsForTable, getConnection, getDatabase, getDatabase, getDefaultCatalogPattern, getDefaultColumnPattern, getDefaultSchemaPattern, getDefaultTablePattern, getDefaultTableTypes, getLog, getPlatform, getPlatformInfo, initColumnsForColumn, initColumnsForFK, initColumnsForIndex, initColumnsForPK, initColumnsForTable, matches, readColumns, readColumns, readForeignKey, readForeignKeys, readIndex, readIndices, readPrimaryKeyName, readPrimaryKeyNames, readTables, removeInternalForeignKeyIndex, removeInternalPrimaryKeyIndex, removeSystemIndices, setDefaultCatalogPattern, setDefaultColumnPattern, setDefaultSchemaPattern, setDefaultTablePattern, setDefaultTableTypes, sortForeignKeys, unescape

Methods inherited from class java.lang.Object

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

Constructor Detail

MySqlModelReader

public MySqlModelReader(Platform platform)

Creates a new model reader for MySql databases.

Parameters:

platform - The platform that this model reader belongs to

Method Detail

readTable

protected Table readTable(DatabaseMetaDataWrapper metaData,
              Map values)
                   throws SQLException

Reads the next table from the meta data.

Overrides:

readTable in class JdbcModelReader

Parameters:

metaData - The database meta data

values - The table metadata values as defined by JdbcModelReader.getColumnsForTable()

Returns:

The table or null if the result set row did not contain a valid table

Throws:

SQLException

readColumn

protected Column readColumn(DatabaseMetaDataWrapper metaData,
                Map values)
                     throws SQLException

Extracts a column definition from the result set.

Overrides:

readColumn in class JdbcModelReader

Parameters:

metaData - The database meta data

values - The column meta data values as defined by JdbcModelReader.getColumnsForColumn()

Returns:

The column

Throws:

SQLException

isInternalPrimaryKeyIndex

protected boolean isInternalPrimaryKeyIndex(DatabaseMetaDataWrapper metaData,
                                Table table,
                                Index index)

Tries to determine whether the index is the internal database-generated index for the given table's primary key. Note that only unique indices with the correct columns are fed to this method. Redefine this method for specific platforms if there are better ways to determine internal indices.

Overrides:

isInternalPrimaryKeyIndex in class JdbcModelReader

Parameters:

metaData - The database meta data

table - The table owning the index

index - The index to check

Returns:

true if the index seems to be an internal primary key one

isInternalForeignKeyIndex

protected boolean isInternalForeignKeyIndex(DatabaseMetaDataWrapper metaData,
                                Table table,
                                ForeignKey fk,
                                Index index)

Tries to determine whether the index is the internal database-generated index for the given foreign key. Note that only non-unique indices with the correct columns are fed to this method. Redefine this method for specific platforms if there are better ways to determine internal indices.

Overrides:

isInternalForeignKeyIndex in class JdbcModelReader

Parameters:

metaData - The database meta data

table - The table owning the index and foreign key

fk - The foreign key

index - The index to check

Returns:

true if the index seems to be an internal primary key one