schemacrawler.crawl
Class DatabaseSchemaCrawler

java.lang.Object
  schemacrawler.crawl.DatabaseSchemaCrawler

All Implemented Interfaces:

SchemaCrawler

public final class DatabaseSchemaCrawler
extends Object
implements SchemaCrawler

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

Author:

Sualeh Fatehi

Constructor Summary

DatabaseSchemaCrawler(Connection connection)
Constructs a SchemaCrawler object, from a connection.

Method Summary

void	crawl(SchemaCrawlerOptions options, CrawlHandler handler) Crawls the schema for all tables and views, and other database objects.
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

DatabaseSchemaCrawler

public DatabaseSchemaCrawler(Connection connection)
                      throws SchemaCrawlerException

Constructs a SchemaCrawler object, from a connection.

Parameters:

connection - An database connection.

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 void crawl(SchemaCrawlerOptions options,
                  CrawlHandler handler)
           throws SchemaCrawlerException

Crawls the schema for all tables and views, and other database objects. The options control the extent of the crawling, while the handler is responsible for doing something (such as outputting details) each time a new object is found and processed.

Specified by:

crawl in interface SchemaCrawler

Parameters:

options - Options

handler - Handler for SchemaCrawler

Throws:

SchemaCrawlerException - On an exception

See Also:

SchemaCrawler.crawl(schemacrawler.schemacrawler.SchemaCrawlerOptions, schemacrawler.schemacrawler.CrawlHandler)