schemacrawler.schema

Interface Catalog

All Superinterfaces:

AttributedObject, Comparable<NamedObject>, DescribedObject, NamedObject, Reducible, Serializable

public interface Catalog
extends NamedObject, AttributedObject, DescribedObject, Reducible

Database and connection information.

Author:

Sualeh Fatehi

Method Summary

Modifier and Type	Method and Description
Collection<ColumnDataType>	getColumnDataTypes() Gets the column data types
Collection<ColumnDataType>	getColumnDataTypes(Schema schema) Gets the column data types defined in the schema, by name.
CrawlInfo	getCrawlInfo()
DatabaseInfo	getDatabaseInfo()
Collection<DatabaseUser>	getDatabaseUsers() Gets the database users
JdbcDriverInfo	getJdbcDriverInfo()
Collection<Routine>	getRoutines() Gets the routine.
Collection<Routine>	getRoutines(Schema schema) Gets the routine.
Collection<Routine>	getRoutines(Schema schema, String routineName) Gets a routine by unqualified name.
Collection<Schema>	getSchemas() Gets the schemas.
Collection<Sequence>	getSequences() Gets the sequences.
Collection<Sequence>	getSequences(Schema schema) Gets the sequences.
Collection<Synonym>	getSynonyms() Gets the synonyms.
Collection<Synonym>	getSynonyms(Schema schema) Gets the synonyms.
Collection<ColumnDataType>	getSystemColumnDataTypes() Gets the column data types defined by the RDBMS system.
Collection<Table>	getTables() Gets the tables.
Collection<Table>	getTables(Schema schema) Gets the tables.
Optional<Column>	lookupColumn(Schema schema, String tableName, String name) Gets a table column by unqualified name.
<C extends ColumnDataType> Optional<C>	lookupColumnDataType(Schema schema, String dataTypeName) Gets the column data types defined in the schema, by name.
<S extends Schema> Optional<S>	lookupSchema(String name) Gets a schema by name.
<S extends Sequence> Optional<S>	lookupSequence(Schema schema, String sequenceName) Gets the sequence by unqualified name.
<S extends Synonym> Optional<S>	lookupSynonym(Schema schema, String synonymName) Gets the synonym by unqualified name.
<C extends ColumnDataType> Optional<C>	lookupSystemColumnDataType(String name) Gets the column data types defined by the RDBMS system, by name.
<T extends Table> Optional<T>	lookupTable(Schema schema, String tableName) Gets a table by unqualified name.

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getName, key

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, hasAttribute, lookupAttribute, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks, setRemarks

Methods inherited from interface schemacrawler.schema.Reducible

reduce

Method Detail

getColumnDataTypes

Collection<ColumnDataType> getColumnDataTypes()

Gets the column data types

Returns:

Column data types

getColumnDataTypes

Collection<ColumnDataType> getColumnDataTypes(Schema schema)

Gets the column data types defined in the schema, by name.

Returns:

Column data types

getCrawlInfo

CrawlInfo getCrawlInfo()

getDatabaseInfo

DatabaseInfo getDatabaseInfo()

getDatabaseUsers

Collection<DatabaseUser> getDatabaseUsers()

Gets the database users

Returns:

Database users

getJdbcDriverInfo

JdbcDriverInfo getJdbcDriverInfo()

getRoutines

Collection<Routine> getRoutines()

Gets the routine.

Returns:

Routines

getRoutines

Collection<Routine> getRoutines(Schema schema)

Gets the routine.

Returns:

Routines

getRoutines

Collection<Routine> getRoutines(Schema schema,
                                String routineName)

Gets a routine by unqualified name.

Parameters:

schema - Schema

routineName - Unqualified routine name

Returns:

Routine.

getSchemas

Collection<Schema> getSchemas()

Gets the schemas.

Returns:

Schemas

getSequences

Collection<Sequence> getSequences()

Gets the sequences.

Returns:

Sequences

getSequences

Collection<Sequence> getSequences(Schema schema)

Gets the sequences.

Returns:

Sequences

getSynonyms

Collection<Synonym> getSynonyms()

Gets the synonyms.

Returns:

Synonyms

getSynonyms

Collection<Synonym> getSynonyms(Schema schema)

Gets the synonyms.

Returns:

Synonyms

getSystemColumnDataTypes

Collection<ColumnDataType> getSystemColumnDataTypes()

Gets the column data types defined by the RDBMS system.

Returns:

Column data types

getTables

Collection<Table> getTables()

Gets the tables.

Returns:

Tables

getTables

Collection<Table> getTables(Schema schema)

Gets the tables.

Returns:

Tables

lookupColumn

Optional<Column> lookupColumn(Schema schema,
                              String tableName,
                              String name)

Gets a table column by unqualified name.

Parameters:

schema - Schema

tableName - Unqualified table name

name - Unqualified column name

Returns:

Column.

lookupColumnDataType

<C extends ColumnDataType> Optional<C> lookupColumnDataType(Schema schema,
                                                            String dataTypeName)

Gets the column data types defined in the schema, by name.

Parameters:

schema - Schema

dataTypeName - Unqualified column data-type name

Returns:

Column data type

lookupSchema

<S extends Schema> Optional<S> lookupSchema(String name)

Gets a schema by name.

Parameters:

name - Schema name

Returns:

Schema.

lookupSequence

<S extends Sequence> Optional<S> lookupSequence(Schema schema,
                                                String sequenceName)

Gets the sequence by unqualified name.

Parameters:

schema - Schema

sequenceName - Unqualified sequence name

Returns:

Sequence.

lookupSynonym

<S extends Synonym> Optional<S> lookupSynonym(Schema schema,
                                              String synonymName)

Gets the synonym by unqualified name.

Parameters:

schema - Schema

synonymName - Unqualified synonym name

Returns:

Synonym.

lookupSystemColumnDataType

<C extends ColumnDataType> Optional<C> lookupSystemColumnDataType(String name)

Gets the column data types defined by the RDBMS system, by name.

Parameters:

name - Column data type name

Returns:

Column data type

lookupTable

<T extends Table> Optional<T> lookupTable(Schema schema,
                                          String tableName)

Gets a table by unqualified name.

Parameters:

schema - Schema

tableName - Unqualified table name

Returns:

Table.