Module com.aoapps.dbc

Package com.aoapps.dbc.meta

Class Catalog

java.lang.Object

com.aoapps.dbc.meta.Catalog

public class Catalog
extends Object

A friendly wrapper around database meta data.

Author:

AO Industries, Inc.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Catalog(DatabaseMetaData metaData, String name)

Method Summary

Modifier and Type	Method	Description
SymmetricGraph<Table,Edge<Table>,SQLException>	getForeignKeyGraph()	Gets a graph view of the imported/exported table relationships within this catalog.
SymmetricGraph<Table,Edge<Table>,SQLException>	getForeignKeyGraph(Set<String> tableTypes)	Gets a graph view of the imported/exported table relationships within this catalog.
DatabaseMetaData	getMetaData()
String	getName()
Schema	getSchema(String name)	Gets the schema of the provided name.
Optional<Schema>	getSchemaOptional(String name)	Gets the schema of the provided name.
SortedMap<String,Schema>	getSchemas()	Gets all schemas for this catalog keyed by unique name.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Catalog

protected Catalog(DatabaseMetaData metaData,
 String name)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getMetaData

public DatabaseMetaData getMetaData()

getName

public String getName()

getSchemas

public SortedMap<String,Schema> getSchemas()
                                    throws SQLException

Gets all schemas for this catalog keyed by unique name.

Throws:

SQLException

See Also:

• DatabaseMetaData.getSchemas()

getSchemaOptional

public Optional<Schema> getSchemaOptional(String name)
                                   throws SQLException

Gets the schema of the provided name.

Throws:

SQLException

getSchema

public Schema getSchema(String name)
                 throws NoRowException,
SQLException

Gets the schema of the provided name.

Throws:

NoRowException - if the schema doesn't exist

SQLException

getForeignKeyGraph

public SymmetricGraph<Table,Edge<Table>,SQLException> getForeignKeyGraph()

Gets a graph view of the imported/exported table relationships within this catalog.

getForeignKeyGraph

public SymmetricGraph<Table,Edge<Table>,SQLException> getForeignKeyGraph(Set<String> tableTypes)

Gets a graph view of the imported/exported table relationships within this catalog.

TODO: Check is symmetric in JUnit test

Parameters:

tableTypes - the set of tables types or null for all types