net.java.ao.schema.helper.DatabaseMetaDataReader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activeobjects Show documentation

This is the full Active Objects library, if you don't know which one to use, you probably want this one.

The newest version!

package net.java.ao.schema.helper;

import net.java.ao.RawEntity;

import java.sql.DatabaseMetaData;

public interface DatabaseMetaDataReader {

    /**
     * Checks if the table corresponding to given type exists in the database.
     *
     * @param databaseMetaData of the database to be checked
     * @param type to check against
     * @return true if the table exists, false otherwise
     */
    public boolean isTablePresent(DatabaseMetaData databaseMetaData, Class> type);

    /**
     * Gets the names of the existing tables in the DB
     *
     * @param databaseMetaData the meta data from which to extract the table names
     * @return an {@link Iterable} of table names as {@link String strings}
     */
    Iterable getTableNames(DatabaseMetaData databaseMetaData);

    /**
     * @param databaseMetaData
     * @param tableName
     * @return
     */
    Iterable getFields(DatabaseMetaData databaseMetaData, String tableName);

    /**
     * Gets the list of foreign keys for a given table
     *
     * @param databaseMetaData the database metadata to read the information from
     * @param tableName        the name of the table from which to read the foreign keys
     * @return an {@link Iterable} of foreign keys
     */
    Iterable getForeignKeys(DatabaseMetaData databaseMetaData, String tableName);

    /**
     * Gets the list of simple indexes for a given table. AO only supports single column indexes, and as
     * such composite indexes will not be returned by this method even if they exist in the table.
     * Prior to AO v1.1.4 this method returned fragments of composite indexes and it was then possible for
     * the migration code to crash because it would try to delete the same index multiple times.
     *
     * @param databaseMetaData the database metadata to read the information from
     * @param tableName        the name of the table from which to read the indexes
     * @return an {@link Iterable} of simple indexes
     */
    Iterable getIndexes(DatabaseMetaData databaseMetaData, String tableName);
}