schemacrawler.schema

Interface Catalog

All Superinterfaces:

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

All Known Implementing Classes:

BaseCatalogDecorator

public interface Catalog
extends NamedObject, AttributedObject, DescribedObject

Database and connection information.

Author:

Sualeh Fatehi

Method Summary

Modifier and Type	Method and Description
default ColumnDataType	getColumnDataType(Schema schema, String name) Deprecated.
Collection<ColumnDataType>	getColumnDataTypes() Gets the column data types
Collection<ColumnDataType>	getColumnDataTypes(Schema schema) Gets the column data types defined in the schema, by name.
CrawlHeaderInfo	getCrawlHeaderInfo()
DatabaseInfo	getDatabaseInfo()
JdbcDriverInfo	getJdbcDriverInfo()
default Routine	getRoutine(Schema schema, String name) Deprecated.
Collection<Routine>	getRoutines() Gets the routine.
Collection<Routine>	getRoutines(Schema schema) Gets the routine.
Optional<? extends Schema>	getSchema(String name) Gets a schema by name.
SchemaCrawlerInfo	getSchemaCrawlerInfo()
Collection<Schema>	getSchemas() Gets the schemas.
default Sequence	getSequence(Schema schema, String name) Deprecated.
Collection<Sequence>	getSequences() Gets the sequences.
Collection<Sequence>	getSequences(Schema schema) Gets the sequences.
default Synonym	getSynonym(Schema schema, String name) Deprecated.
Collection<Synonym>	getSynonyms() Gets the synonyms.
Collection<Synonym>	getSynonyms(Schema schema) Gets the synonyms.
Optional<? extends ColumnDataType>	getSystemColumnDataType(String name) Gets the column data types defined by the RDBMS system, by name.
Collection<ColumnDataType>	getSystemColumnDataTypes() Gets the column data types defined by the RDBMS system.
default Table	getTable(Schema schema, String name) Deprecated.
Collection<Table>	getTables() Gets the tables.
Collection<Table>	getTables(Schema schema) Gets the tables.
Optional<? extends ColumnDataType>	lookupColumnDataType(Schema schema, String name) Gets the column data types defined in the schema, by name.
Optional<? extends Routine>	lookupRoutine(Schema schema, String name) Gets a routine by unqualified name.
Optional<? extends Sequence>	lookupSequence(Schema schema, String name) Gets the sequence by unqualified name.
Optional<? extends Synonym>	lookupSynonym(Schema schema, String name) Gets the synonym by unqualified name.
Optional<? extends Table>	lookupTable(Schema schema, String name) Gets a table by unqualified name.

Methods inherited from interface schemacrawler.schema.NamedObject

getFullName, getLookupKey, getName

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface schemacrawler.schema.AttributedObject

getAttribute, getAttribute, getAttributes, removeAttribute, setAttribute

Methods inherited from interface schemacrawler.schema.DescribedObject

getRemarks, hasRemarks

Method Detail

getColumnDataType

@Deprecated
default ColumnDataType getColumnDataType(Schema schema,
                                                      String name)

Deprecated.

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

Parameters:

name - Name

Returns:

Column data type, or null if not found

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

getCrawlHeaderInfo

CrawlHeaderInfo getCrawlHeaderInfo()

getDatabaseInfo

DatabaseInfo getDatabaseInfo()

getJdbcDriverInfo

JdbcDriverInfo getJdbcDriverInfo()

getRoutine

@Deprecated
default Routine getRoutine(Schema schema,
                                        String name)

Deprecated.

Gets a column by unqualified name.

Parameters:

name - Unqualified name

Returns:

Routine, or null if not found.

getRoutines

Collection<Routine> getRoutines()

Gets the routine.

Returns:

Routines

getRoutines

Collection<Routine> getRoutines(Schema schema)

Gets the routine.

Returns:

Routines

getSchema

Optional<? extends Schema> getSchema(String name)

Gets a schema by name.

Parameters:

name - Schema name

Returns:

Schema.

getSchemaCrawlerInfo

SchemaCrawlerInfo getSchemaCrawlerInfo()

getSchemas

Collection<Schema> getSchemas()

Gets the schemas.

Returns:

Schemas

getSequence

@Deprecated
default Sequence getSequence(Schema schema,
                                          String name)

Deprecated.

Gets a sequence by unqualified name.

Parameters:

name - Unqualified name

Returns:

Sequence, or null if not found.

getSequences

Collection<Sequence> getSequences()

Gets the sequences.

Returns:

Sequences

getSequences

Collection<Sequence> getSequences(Schema schema)

Gets the sequences.

Returns:

Sequences

getSynonym

@Deprecated
default Synonym getSynonym(Schema schema,
                                        String name)

Deprecated.

Gets a synonym by unqualified name.

Parameters:

name - Unqualified name

Returns:

Synonym, or null if not found.

getSynonyms

Collection<Synonym> getSynonyms()

Gets the synonyms.

Returns:

Synonyms

getSynonyms

Collection<Synonym> getSynonyms(Schema schema)

Gets the synonyms.

Returns:

Synonyms

getSystemColumnDataType

Optional<? extends ColumnDataType> getSystemColumnDataType(String name)

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

Parameters:

name - Column data type name

Returns:

Column data type

getSystemColumnDataTypes

Collection<ColumnDataType> getSystemColumnDataTypes()

Gets the column data types defined by the RDBMS system.

Returns:

Column data types

getTable

@Deprecated
default Table getTable(Schema schema,
                                    String name)

Deprecated.

Gets a table by unqualified name.

Parameters:

name - Unqualified name

Returns:

Table, or null if not found.

getTables

Collection<Table> getTables()

Gets the tables.

Returns:

Tables

getTables

Collection<Table> getTables(Schema schema)

Gets the tables.

Returns:

Tables

lookupColumnDataType

Optional<? extends ColumnDataType> lookupColumnDataType(Schema schema,
                                                        String name)

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

Parameters:

name - Name

Returns:

Column data types

lookupRoutine

Optional<? extends Routine> lookupRoutine(Schema schema,
                                          String name)

Gets a routine by unqualified name.

Parameters:

name - Name

Returns:

Routine.

lookupSequence

Optional<? extends Sequence> lookupSequence(Schema schema,
                                            String name)

Gets the sequence by unqualified name.

Parameters:

name - Name

Returns:

Sequence.

lookupSynonym

Optional<? extends Synonym> lookupSynonym(Schema schema,
                                          String name)

Gets the synonym by unqualified name.

Parameters:

name - Name

Returns:

Synonym.

lookupTable

Optional<? extends Table> lookupTable(Schema schema,
                                      String name)

Gets a table by unqualified name.

Parameters:

name - Name

Returns:

Table.