schemacrawler.crawl

Class SchemaCrawler

java.lang.Object

schemacrawler.crawl.SchemaCrawler

public final class SchemaCrawler
extends Object

SchemaCrawler uses database meta-data to get the details about the schema.

Author:

Sualeh Fatehi

Constructor Summary

Constructors

Constructor and Description
SchemaCrawler(Connection connection, SchemaRetrievalOptions schemaRetrievalOptions, SchemaCrawlerOptions options) Constructs a SchemaCrawler object, from a connection.

Method Summary

Modifier and Type	Method and Description
Catalog	crawl() Crawls the database, to obtain database metadata.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaCrawler

public SchemaCrawler(Connection connection,
                     SchemaRetrievalOptions schemaRetrievalOptions,
                     SchemaCrawlerOptions options)

Constructs a SchemaCrawler object, from a connection.

Parameters:

connection - An database connection.

schemaRetrievalOptions - Database-specific schema retrieval overrides

options - SchemaCrawler options

Method Detail

crawl

public Catalog crawl()
              throws SchemaCrawlerException

Crawls the database, to obtain database metadata.

Returns:

Database metadata

Throws:

SchemaCrawlerException - On an exception