schemacrawler.schemacrawler

Class SchemaCrawlerOptionsBuilder

java.lang.Object

schemacrawler.schemacrawler.SchemaCrawlerOptionsBuilder

All Implemented Interfaces:

OptionsBuilder<SchemaCrawlerOptionsBuilder,SchemaCrawlerOptions>

public final class SchemaCrawlerOptionsBuilder
extends java.lang.Object
implements OptionsBuilder<SchemaCrawlerOptionsBuilder,SchemaCrawlerOptions>

SchemaCrawler options.

Author:

Sualeh Fatehi

Method Summary

Modifier and Type	Method and Description
static SchemaCrawlerOptionsBuilder	builder()
SchemaCrawlerOptionsBuilder	childTableFilterDepth(int childTableFilterDepth)
SchemaCrawlerOptionsBuilder	fromConfig(Config config) Options from properties.
SchemaCrawlerOptionsBuilder	fromOptions(SchemaCrawlerOptions options)
SchemaCrawlerOptionsBuilder	grepOnlyMatching(boolean grepOnlyMatching)
SchemaCrawlerOptionsBuilder	hideEmptyTables() Deprecated.
SchemaCrawlerOptionsBuilder	hideEmptyTables(boolean value) Deprecated.
SchemaCrawlerOptionsBuilder	includeAllRoutines()
SchemaCrawlerOptionsBuilder	includeAllSequences()
SchemaCrawlerOptionsBuilder	includeAllSynonyms()
SchemaCrawlerOptionsBuilder	includeColumns(InclusionRule columnInclusionRule)
SchemaCrawlerOptionsBuilder	includeGreppedColumns(InclusionRule grepColumnInclusionRule)
SchemaCrawlerOptionsBuilder	includeGreppedDefinitions(InclusionRule grepDefinitionInclusionRule)
SchemaCrawlerOptionsBuilder	includeGreppedRoutineColumns(InclusionRule grepRoutineColumnInclusionRule)
SchemaCrawlerOptionsBuilder	includeRoutineColumns(InclusionRule routineColumnInclusionRule)
SchemaCrawlerOptionsBuilder	includeRoutines(InclusionRule routineInclusionRule)
SchemaCrawlerOptionsBuilder	includeSchemas(InclusionRule schemaInclusionRule)
SchemaCrawlerOptionsBuilder	includeSequences(InclusionRule sequenceInclusionRule)
SchemaCrawlerOptionsBuilder	includeSynonyms(InclusionRule synonymInclusionRule)
SchemaCrawlerOptionsBuilder	includeTables(InclusionRule tableInclusionRule)
SchemaCrawlerOptionsBuilder	invertGrepMatch(boolean grepInvertMatch)
static SchemaCrawlerOptions	newSchemaCrawlerOptions()
SchemaCrawlerOptionsBuilder	noEmptyTables() Corresponds to the -noemptytables command-line argument.
SchemaCrawlerOptionsBuilder	noEmptyTables(boolean value) Corresponds to the -noemptytables=<boolean> command-line argument.
SchemaCrawlerOptionsBuilder	parentTableFilterDepth(int parentTableFilterDepth)
SchemaCrawlerOptionsBuilder	routineTypes(java.util.Collection<RoutineType> routineTypes)
SchemaCrawlerOptionsBuilder	routineTypes(java.lang.String routineTypesString) Sets routine types from a comma-separated list of routine types.
SchemaCrawlerOptionsBuilder	tableNamePattern(java.lang.String tableNamePattern)
SchemaCrawlerOptionsBuilder	tableTypes(java.util.Collection<java.lang.String> tableTypes)
SchemaCrawlerOptionsBuilder	tableTypes(java.lang.String tableTypesString) Sets table types requested for output from a comma-separated list of table types.
SchemaCrawlerOptionsBuilder	title(java.lang.String title)
Config	toConfig()
SchemaCrawlerOptions	toOptions()
SchemaCrawlerOptionsBuilder	withSchemaInfoLevel(SchemaInfoLevel schemaInfoLevel)
SchemaCrawlerOptionsBuilder	withSchemaInfoLevel(SchemaInfoLevelBuilder schemaInfoLevelBuilder)

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static SchemaCrawlerOptionsBuilder builder()

newSchemaCrawlerOptions

public static SchemaCrawlerOptions newSchemaCrawlerOptions()

childTableFilterDepth

public SchemaCrawlerOptionsBuilder childTableFilterDepth(int childTableFilterDepth)

fromConfig

public SchemaCrawlerOptionsBuilder fromConfig(Config config)

Options from properties.

Specified by:

fromConfig in interface OptionsBuilder<SchemaCrawlerOptionsBuilder,SchemaCrawlerOptions>

Parameters:

config - Configuration properties

fromOptions

public SchemaCrawlerOptionsBuilder fromOptions(SchemaCrawlerOptions options)

Specified by:

fromOptions in interface OptionsBuilder<SchemaCrawlerOptionsBuilder,SchemaCrawlerOptions>

grepOnlyMatching

public SchemaCrawlerOptionsBuilder grepOnlyMatching(boolean grepOnlyMatching)

hideEmptyTables

@Deprecated
public final SchemaCrawlerOptionsBuilder hideEmptyTables()

Deprecated.

hideEmptyTables

@Deprecated
public final SchemaCrawlerOptionsBuilder hideEmptyTables(boolean value)

Deprecated.

includeAllRoutines

public SchemaCrawlerOptionsBuilder includeAllRoutines()

includeAllSequences

public SchemaCrawlerOptionsBuilder includeAllSequences()

includeAllSynonyms

public SchemaCrawlerOptionsBuilder includeAllSynonyms()

includeColumns

public SchemaCrawlerOptionsBuilder includeColumns(InclusionRule columnInclusionRule)

includeGreppedColumns

public SchemaCrawlerOptionsBuilder includeGreppedColumns(InclusionRule grepColumnInclusionRule)

includeGreppedDefinitions

public SchemaCrawlerOptionsBuilder includeGreppedDefinitions(InclusionRule grepDefinitionInclusionRule)

includeGreppedRoutineColumns

public SchemaCrawlerOptionsBuilder includeGreppedRoutineColumns(InclusionRule grepRoutineColumnInclusionRule)

includeRoutineColumns

public SchemaCrawlerOptionsBuilder includeRoutineColumns(InclusionRule routineColumnInclusionRule)

includeRoutines

public SchemaCrawlerOptionsBuilder includeRoutines(InclusionRule routineInclusionRule)

includeSchemas

public SchemaCrawlerOptionsBuilder includeSchemas(InclusionRule schemaInclusionRule)

includeSequences

public SchemaCrawlerOptionsBuilder includeSequences(InclusionRule sequenceInclusionRule)

includeSynonyms

public SchemaCrawlerOptionsBuilder includeSynonyms(InclusionRule synonymInclusionRule)

includeTables

public SchemaCrawlerOptionsBuilder includeTables(InclusionRule tableInclusionRule)

invertGrepMatch

public SchemaCrawlerOptionsBuilder invertGrepMatch(boolean grepInvertMatch)

noEmptyTables

public final SchemaCrawlerOptionsBuilder noEmptyTables()

Corresponds to the -noemptytables command-line argument.

noEmptyTables

public final SchemaCrawlerOptionsBuilder noEmptyTables(boolean value)

Corresponds to the -noemptytables=<boolean> command-line argument.

parentTableFilterDepth

public SchemaCrawlerOptionsBuilder parentTableFilterDepth(int parentTableFilterDepth)

routineTypes

public SchemaCrawlerOptionsBuilder routineTypes(java.util.Collection<RoutineType> routineTypes)

routineTypes

public SchemaCrawlerOptionsBuilder routineTypes(java.lang.String routineTypesString)

Sets routine types from a comma-separated list of routine types.

Parameters:

routineTypesString - Comma-separated list of routine types.

tableNamePattern

public SchemaCrawlerOptionsBuilder tableNamePattern(java.lang.String tableNamePattern)

tableTypes

public SchemaCrawlerOptionsBuilder tableTypes(java.util.Collection<java.lang.String> tableTypes)

tableTypes

public SchemaCrawlerOptionsBuilder tableTypes(java.lang.String tableTypesString)

Sets table types requested for output from a comma-separated list of table types. For example: TABLE,VIEW,SYSTEM_TABLE,GLOBAL TEMPORARY,ALIAS,SYNONYM

Parameters:

tableTypesString - Comma-separated list of table types. Can be null if all supported table types are requested.

title

public SchemaCrawlerOptionsBuilder title(java.lang.String title)

toConfig

public Config toConfig()

Specified by:

toConfig in interface OptionsBuilder<SchemaCrawlerOptionsBuilder,SchemaCrawlerOptions>

toOptions

public SchemaCrawlerOptions toOptions()

Specified by:

toOptions in interface OptionsBuilder<SchemaCrawlerOptionsBuilder,SchemaCrawlerOptions>

withSchemaInfoLevel

public SchemaCrawlerOptionsBuilder withSchemaInfoLevel(SchemaInfoLevel schemaInfoLevel)

withSchemaInfoLevel

public SchemaCrawlerOptionsBuilder withSchemaInfoLevel(SchemaInfoLevelBuilder schemaInfoLevelBuilder)