schemacrawler.schema.Catalog Maven / Gradle / Ivy
/*
*
* SchemaCrawler
* http://www.schemacrawler.com
* Copyright (c) 2000-2016, Sualeh Fatehi.
*
* This library is free software; you can redistribute it and/or modify it under the terms
* of the GNU Lesser General Public License as published by the Free Software Foundation;
* either version 2.1 of the License, or (at your option) any later version.
*
* This library 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.
* See the GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307, USA.
*
*/
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
{
/**
* 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();
JdbcDriverInfo getJdbcDriverInfo();
/**
* Gets the routine.
*
* @return Routines
*/
Collection getRoutines();
/**
* Gets the routine.
*
* @return Routines
*/
Collection getRoutines(Schema schema);
SchemaCrawlerInfo getSchemaCrawlerInfo();
/**
* 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 the column data types defined in the schema, by name.
*
* @param name
* Name
* @return Column data types
*/
Optional lookupColumnDataType(Schema schema,
String name);
/**
* Gets a routine by unqualified name.
*
* @param name
* Name
* @return Routine.
*/
Optional lookupRoutine(Schema schema, String name);
/**
* Gets a schema by name.
*
* @param name
* Schema name
* @return Schema.
*/
Optional lookupSchema(String name);
/**
* Gets the sequence by unqualified name.
*
* @param name
* Name
* @return Sequence.
*/
Optional lookupSequence(Schema schema, String name);
/**
* Gets the synonym by unqualified name.
*
* @param name
* Name
* @return Synonym.
*/
Optional lookupSynonym(Schema schema, String name);
/**
* 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 name
* Name
* @return Table.
*/
Optional lookupTable(Schema schema, String name);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy