org.jooq.Meta Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: https://www.jooq.org/legal/licensing
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
// ...
// ...
import static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.DERBY;
import static org.jooq.SQLDialect.FIREBIRD;
// ...
import static org.jooq.SQLDialect.H2;
// ...
import static org.jooq.SQLDialect.HSQLDB;
// ...
// ...
import static org.jooq.SQLDialect.MARIADB;
import static org.jooq.SQLDialect.MYSQL;
// ...
import static org.jooq.SQLDialect.POSTGRES;
// ...
import static org.jooq.SQLDialect.SQLITE;
// ...
// ...
// ...
import static org.jooq.SQLDialect.YUGABYTEDB;
import java.sql.DatabaseMetaData;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Collection;
import java.util.List;
import java.util.function.Predicate;
import org.jooq.exception.DataAccessException;
import org.jooq.util.xml.jaxb.InformationSchema;
import org.jetbrains.annotations.NotNull;
/**
* A wrapping object for {@link DatabaseMetaData} or for other sources of
* database meta information (e.g. {@link InformationSchema})
*
* This object can be obtained through {@link DSLContext#meta()} in order to
* provide convenient access to your database meta data. This abstraction has
* two purposes:
*
*
* - To increase API convenience, as no checked {@link SQLException} is
* thrown, only the unchecked {@link DataAccessException}
* - To increase API convenience, as the returned objects are always jOOQ
* objects, not JDBC {@link ResultSet} objects with hard-to-remember API
* constraints
*
*
* This type is a {@link Scope} with independent lifecycle and its own
* {@link #data()} map.
*
* @author Lukas Eder
*/
public interface Meta extends Scope {
/**
* Get all catalog objects from the underlying meta data source.
*
* For those databases that don't really support JDBC meta data catalogs, a
* single empty catalog (named "") will be returned. In other
* words, there is always at least one catalog in a database.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List getCatalogs() throws DataAccessException;
/**
* Get a catalog object by name from the underlying meta data source, or
* null if no such object exists.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
Catalog getCatalog(String name) throws DataAccessException;
/**
* Get a catalog object by name from the underlying meta data source, or
* null if no such object exists.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
Catalog getCatalog(Name name) throws DataAccessException;
/**
* Get all schema objects from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List getSchemas() throws DataAccessException;
/**
* Get all schema objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List getSchemas(String name) throws DataAccessException;
/**
* Get all schema objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List getSchemas(Name name) throws DataAccessException;
/**
* Get all table objects from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getTables() throws DataAccessException;
/**
* Get all table objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getTables(String name) throws DataAccessException;
/**
* Get all table objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getTables(Name name) throws DataAccessException;
/**
* Get all domain objects from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support({ H2, POSTGRES })
List> getDomains() throws DataAccessException;
/**
* Get all domain objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support({ H2, POSTGRES })
List> getDomains(String name) throws DataAccessException;
/**
* Get all domain objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support({ H2, POSTGRES })
List> getDomains(Name name) throws DataAccessException;
/**
* Get all sequence objects from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, POSTGRES })
List> getSequences() throws DataAccessException;
/**
* Get all sequence objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, POSTGRES })
List> getSequences(String name) throws DataAccessException;
/**
* Get all sequence objects by name from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, POSTGRES })
List> getSequences(Name name) throws DataAccessException;
/**
* Get all primary keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getPrimaryKeys() throws DataAccessException;
/**
* Get all primary keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getPrimaryKeys(String name) throws DataAccessException;
/**
* Get all primary keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getPrimaryKeys(Name name) throws DataAccessException;
/**
* Get all unique keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getUniqueKeys() throws DataAccessException;
/**
* Get all unique keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getUniqueKeys(String name) throws DataAccessException;
/**
* Get all unique keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getUniqueKeys(Name name) throws DataAccessException;
/**
* Get all foreign keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getForeignKeys() throws DataAccessException;
/**
* Get all foreign keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getForeignKeys(String name) throws DataAccessException;
/**
* Get all foreign keys from the underlying meta data source.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List> getForeignKeys(Name name) throws DataAccessException;
/**
* Get all indexes from the underlying meta data sources.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List getIndexes() throws DataAccessException;
/**
* Get all indexes from the underlying meta data sources.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List getIndexes(String name) throws DataAccessException;
/**
* Get all indexes from the underlying meta data sources.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
@Support
List getIndexes(Name name) throws DataAccessException;
/**
* Create a wrapper {@link Meta} instance filtering out some catalogs.
*/
@NotNull
Meta filterCatalogs(Predicate filter);
/**
* Create a wrapper {@link Meta} instance filtering out some schemas.
*/
@NotNull
Meta filterSchemas(Predicate filter);
/**
* Create a wrapper {@link Meta} instance filtering out some tables.
*/
@NotNull
Meta filterTables(Predicate> filter);
/**
* Create a wrapper {@link Meta} instance filtering out some domains.
*/
@NotNull
Meta filterDomains(Predicate> filter);
/**
* Create a wrapper {@link Meta} instance filtering out some sequences.
*/
@NotNull
Meta filterSequences(Predicate> filter);
/**
* Create a wrapper {@link Meta} instance filtering out some primary keys.
*/
@NotNull
Meta filterPrimaryKeys(Predicate> filter);
/**
* Create a wrapper {@link Meta} instance filtering out some unique keys.
*/
@NotNull
Meta filterUniqueKeys(Predicate> filter);
/**
* Create a wrapper {@link Meta} instance filtering out some foreign keys.
*/
@NotNull
Meta filterForeignKeys(Predicate> filter);
/**
* Create a wrapper {@link Meta} instance filtering out some indexes.
*/
@NotNull
Meta filterIndexes(Predicate filter);
/**
* Eager-create an in-memory copy of this {@link Meta} instance without any
* connection to the original data source.
*/
@NotNull
Meta snapshot() throws DataAccessException;
/**
* Generate a creation script for the entire meta data.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
Queries ddl() throws DataAccessException;
/**
* Generate a creation script for the entire meta data.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
Queries ddl(DDLExportConfiguration configuration) throws DataAccessException;
/**
* Apply a migration to this meta to produce a new {@link Meta}.
*
* @see Parser#parse(String)
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
Meta apply(String migration) throws DataAccessException;
/**
* Apply a migration to this meta to produce a new {@link Meta}.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
Meta apply(Query... migration) throws DataAccessException;
/**
* Apply a migration to this meta to produce a new {@link Meta}.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
Meta apply(Collection migration) throws DataAccessException;
/**
* Apply a migration to this meta to produce a new {@link Meta}.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
Meta apply(Queries migration) throws DataAccessException;
/**
* Generate a migration script to get from this meta data to another one.
*
* See {@link #migrateTo(Meta, MigrationConfiguration)} for more details.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
* @see #migrateTo(Meta, MigrationConfiguration)
*/
@NotNull
Queries migrateTo(Meta other) throws DataAccessException;
/**
* Generate a migration script to get from this meta data to another one.
*
* To some extent, some database migrations can be generated automatically
* by comparing two versions of a schema. This is what
* migrateTo() does. It supports:
*
*
* - Schema additions / removals
* - Table additions / removals
* - Column additions / removals
* - Column data type changes
* - Constraint additions / removals
* - Index additions / removals
* - Sequence additions / removals
* - Comment additions / removals
*
*
* More complex, structural changes, such as moving some columns from one
* table to another, or turning a to-one relationship into a to-many
* relationship, as well as data migrations, can currently not be detected
* automatically.
*
* @throws DataAccessException If something went wrong fetching the meta
* objects
*/
@NotNull
Queries migrateTo(Meta other, MigrationConfiguration configuration) throws DataAccessException;
/**
* Export to the {@link InformationSchema} format.
*
* This allows for serialising schema meta information as XML using JAXB.
* See also {@link Constants#XSD_META} for details.
*/
@NotNull
InformationSchema informationSchema() throws DataAccessException;
}