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, DatabaseSpecificOverrideOptions databaseSpecificOverrideOptions) Constructs a SchemaCrawler object, from a connection.

Method Summary

Modifier and Type	Method and Description
Catalog	crawl(SchemaCrawlerOptions options) Crawls the database, to obtain database metadata.
static ResultsColumns	getResultColumns(ResultSet resultSet) Gets the result set columns metadata.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaCrawler

public SchemaCrawler(Connection connection,
                     DatabaseSpecificOverrideOptions databaseSpecificOverrideOptions)
              throws SchemaCrawlerException

Constructs a SchemaCrawler object, from a connection.

Parameters:

connection - An database connection.

databaseSpecificOverrideOptions - Database specific overrides

Throws:

SchemaCrawlerException - On a crawler exception

Method Detail

getResultColumns

public static ResultsColumns getResultColumns(ResultSet resultSet)

Gets the result set columns metadata.

Parameters:

resultSet - Result set

Returns:

Schema

crawl

public Catalog crawl(SchemaCrawlerOptions options)
              throws SchemaCrawlerException

Crawls the database, to obtain database metadata.

Parameters:

options - SchemaCrawler options that control what metadata is returned

Returns:

Database metadata

Throws:

SchemaCrawlerException - On an exception