schemacrawler.tools.utility

Class SchemaCrawlerUtility

java.lang.Object

schemacrawler.tools.utility.SchemaCrawlerUtility

@UtilityMarker
public final class SchemaCrawlerUtility
extends Object

SchemaCrawler utility methods.

Author:

sfatehi

Method Summary

Modifier and Type	Method and Description
static Catalog	getCatalog(Connection connection, SchemaCrawlerOptions schemaCrawlerOptions) Crawls a database, and returns a catalog.
static Catalog	getCatalog(Connection connection, SchemaRetrievalOptions schemaRetrievalOptions, SchemaCrawlerOptions schemaCrawlerOptions, Config additionalConfig)
static ResultsColumns	getResultsColumns(ResultSet resultSet) Obtains result-set metadata from a live result-set.
static SchemaRetrievalOptions	matchSchemaRetrievalOptions(Connection connection) Returns database specific options using an existing SchemaCrawler database plugin.

Methods inherited from class java.lang.Object

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

Method Detail

getCatalog

public static Catalog getCatalog(Connection connection,
                                 SchemaCrawlerOptions schemaCrawlerOptions)
                          throws SchemaCrawlerException

Crawls a database, and returns a catalog.

Parameters:

connection - Live database connection.

schemaCrawlerOptions - Options.

Returns:

Database catalog.

Throws:

SchemaCrawlerException - On an exception.

getCatalog

public static Catalog getCatalog(Connection connection,
                                 SchemaRetrievalOptions schemaRetrievalOptions,
                                 SchemaCrawlerOptions schemaCrawlerOptions,
                                 Config additionalConfig)
                          throws SchemaCrawlerException

Throws:

SchemaCrawlerException

getResultsColumns

public static ResultsColumns getResultsColumns(ResultSet resultSet)
                                        throws SchemaCrawlerException

Obtains result-set metadata from a live result-set.

Parameters:

resultSet - Live result-set.

Returns:

Result-set metadata.

Throws:

SchemaCrawlerException - On an exception.

matchSchemaRetrievalOptions

public static SchemaRetrievalOptions matchSchemaRetrievalOptions(Connection connection)
                                                          throws SchemaCrawlerException

Returns database specific options using an existing SchemaCrawler database plugin.

Returns:

SchemaRetrievalOptions

Throws:

SchemaCrawlerException - On an exception.