schemacrawler.schema.Catalog Maven / Gradle / Ivy
/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2021, Sualeh Fatehi .
All rights reserved.
------------------------------------------------------------------------
SchemaCrawler is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
SchemaCrawler and the accompanying materials are made available under
the terms of the Eclipse Public License v1.0, GNU General Public License
v3 or GNU Lesser General Public License v3.
You may elect to redistribute this code under any of these licenses.
The Eclipse Public License is available at:
http://www.eclipse.org/legal/epl-v10.html
The GNU General Public License v3 and the GNU Lesser General Public
License v3 are available at:
http://www.gnu.org/licenses/
========================================================================
*/
package schemacrawler.schema;
import java.util.Collection;
import java.util.Optional;
/**
* Database and connection information.
*
* @author Sualeh Fatehi
*/
public interface Catalog extends NamedObject, AttributedObject, DescribedObject, Reducible {
/**
* Gets the column data types
*
* @return Column data types
*/
Collection getColumnDataTypes();
/**
* Gets the column data types defined in the schema, by name.
*
* @return Column data types
*/
Collection getColumnDataTypes(Schema schema);
CrawlInfo getCrawlInfo();
DatabaseInfo getDatabaseInfo();
/**
* Gets the database users
*
* @return Database users
*/
Collection getDatabaseUsers();
JdbcDriverInfo getJdbcDriverInfo();
/**
* Gets the routine.
*
* @return Routines
*/
Collection getRoutines();
/**
* Gets the routine.
*
* @return Routines
*/
Collection getRoutines(Schema schema);
/**
* Gets the schemas.
*
* @return Schemas
*/
Collection getSchemas();
/**
* Gets the sequences.
*
* @return Sequences
*/
Collection getSequences();
/**
* Gets the sequences.
*
* @return Sequences
*/
Collection getSequences(Schema schema);
/**
* Gets the synonyms.
*
* @return Synonyms
*/
Collection getSynonyms();
/**
* Gets the synonyms.
*
* @return Synonyms
*/
Collection getSynonyms(Schema schema);
/**
* Gets the column data types defined by the RDBMS system.
*
* @return Column data types
*/
Collection getSystemColumnDataTypes();
/**
* Gets the tables.
*
* @return Tables
*/
Collection getTables();
/**
* Gets the tables.
*
* @return Tables
*/
Collection getTables(Schema schema);
/**
* Gets a table column by unqualified name.
*
* @param schema Schema
* @param tableName Unqualified table name
* @param name Unqualified column name
* @return Column.
*/
Optional lookupColumn(Schema schema, String tableName, String name);
/**
* Gets the column data types defined in the schema, by name.
*
* @param schema Schema
* @param dataTypeName Unqualified column data-type name
* @return Column data type
*/
Optional lookupColumnDataType(Schema schema, String dataTypeName);
/**
* Gets a routine by unqualified name.
*
* @param schema Schema
* @param routineName Unqualified routine name
* @return Routine.
*/
Optional lookupRoutine(Schema schema, String routineName);
/**
* Gets a schema by name.
*
* @param name Schema name
* @return Schema.
*/
Optional lookupSchema(String name);
/**
* Gets the sequence by unqualified name.
*
* @param schema Schema
* @param sequenceName Unqualified sequence name
* @return Sequence.
*/
Optional lookupSequence(Schema schema, String sequenceName);
/**
* Gets the synonym by unqualified name.
*
* @param schema Schema
* @param synonymName Unqualified synonym name
* @return Synonym.
*/
Optional lookupSynonym(Schema schema, String synonymName);
/**
* Gets the column data types defined by the RDBMS system, by name.
*
* @param name Column data type name
* @return Column data type
*/
Optional lookupSystemColumnDataType(String name);
/**
* Gets a table by unqualified name.
*
* @param schema Schema
* @param tableName Unqualified table name
* @return Table.
*/
Optional lookupTable(Schema schema, String tableName);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy