schemacrawler.schema.Catalog Maven / Gradle / Ivy

Go to download

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

SchemaCrawler is an open-source Java API that makes working with database metadata as easy as working with plain old Java objects. SchemaCrawler is also a database schema discovery and comprehension, and schema documentation tool. You can search for database schema objects using regular expressions, and output the schema and data in a readable text format. The output is designed to be diff-ed against other database schemas.

There is a newer version: 16.22.2

Show newest version

/*
========================================================================
SchemaCrawler
http://www.schemacrawler.com
Copyright (c) 2000-2016, 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
{

  /**
   * 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 - 2024 Weber Informatics LLC | Privacy Policy