Top Description Fields Constructors Methods
org.jooq

public final Class DDLExportConfiguration

extends Object
Class Inheritance
Imports
java.util.Arrays, .Collection, .Collections, .EnumSet, .Set

A configuration type for use with the various Meta#ddl() methods.
Author
Lukas Eder

Field Summary

Modifier and TypeField and Description
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final EnumSet<DDLFlag>
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean
private final boolean

Constructor Summary

AccessConstructor and Description
public
DDLExportConfiguration()

Create a new default export configuration instance.

private
DDLExportConfiguration(Collection<DDLFlag> flags, boolean createSchemaIfNotExists, boolean createTableIfNotExists, boolean createIndexIfNotExists, boolean createDomainIfNotExists, boolean createSequenceIfNotExists, boolean createViewIfNotExists, boolean createOrReplaceView, boolean respectCatalogOrder, boolean respectSchemaOrder, boolean respectTableOrder, boolean respectColumnOrder, boolean respectConstraintOrder, boolean respectIndexOrder, boolean respectDomainOrder, boolean respectSequenceOrder, boolean defaultSequenceFlags, boolean includeConstraintsOnViews)

Method Summary

Modifier and TypeMethod and Description
public final boolean
createDomainIfNotExists()

Whether to generate CREATE DOMAIN IF NOT EXISTS statements.

public final DDLExportConfiguration
createDomainIfNotExists(boolean newCreateDomainIfNotExists)

Whether to generate CREATE DOMAIN IF NOT EXISTS statements.

public final boolean
createIndexIfNotExists()

Whether to generate CREATE INDEX IF NOT EXISTS statements.

public final DDLExportConfiguration
createIndexIfNotExists(boolean newCreateIndexIfNotExists)

Whether to generate CREATE INDEX IF NOT EXISTS statements.

public final boolean
createOrReplaceView()

Whether to generate CREATE OR REPLACE VIEW statements.

public final DDLExportConfiguration
createOrReplaceView(boolean newCreateOrReplaceView)

Whether to generate CREATE OR REPLACE VIEW statements.

public final boolean
createSchemaIfNotExists()

Whether to generate CREATE SCHEMA IF NOT EXISTS statements.

public final DDLExportConfiguration
createSchemaIfNotExists(boolean newCreateSchemaIfNotExists)

Whether to generate CREATE SCHEMA IF NOT EXISTS statements.

public final boolean
createSequenceIfNotExists()

Whether to generate CREATE SEQUENCE IF NOT EXISTS statements.

public final DDLExportConfiguration
createSequenceIfNotExists(boolean newCreateSequenceIfNotExists)

Whether to generate CREATE SEQUENCE IF NOT EXISTS statements.

public final boolean
createTableIfNotExists()

Whether to generate CREATE TABLE IF NOT EXISTS statements.

public final DDLExportConfiguration
createTableIfNotExists(boolean newCreateTableIfNotExists)

Whether to generate CREATE TABLE IF NOT EXISTS statements.

public final boolean
createViewIfNotExists()

Whether to generate CREATE VIEW IF NOT EXISTS statements.

public final DDLExportConfiguration
createViewIfNotExists(boolean newCreateViewIfNotExists)

Whether to generate CREATE VIEW IF NOT EXISTS statements.

public final boolean
defaultSequenceFlags()

Whether to explicitly produce defaults for all sequence flags, when they're not defined explicitly.

public final DDLExportConfiguration
defaultSequenceFlags(boolean newDefaultSequenceFlags)

Whether to explicitly produce defaults for all sequence flags, when they're not defined explicitly.

public final Set<DDLFlag>
flags()

The DDLFlag that are enabled on this configuration.

public final DDLExportConfiguration
flags(DDLFlag... newFlags)

The DDLFlag that are enabled on this configuration.

public final DDLExportConfiguration
flags(Collection<DDLFlag> newFlags)

The DDLFlag that are enabled on this configuration.

public final boolean
includeConstraintsOnViews()

Whether to include constraints on views.

public final DDLExportConfiguration
includeConstraintsOnViews(boolean newIncludeConstraintsOnViews)

Whether to include constraints on views.

public final boolean
respectCatalogOrder()

Whether to respect the catalog order produced by the Meta source when generated catalog DDL.

public final DDLExportConfiguration
respectCatalogOrder(boolean newRespectCatalogOrder)

Whether to respect the catalog order produced by the Meta source when generated catalog DDL.

public final boolean
respectColumnOrder()

Whether to respect the column order produced by the Meta source when generated column DDL.

public final DDLExportConfiguration
respectColumnOrder(boolean newRespectColumnOrder)

Whether to respect the column order produced by the Meta source when generated column DDL.

public final boolean
respectConstraintOrder()

Whether to respect the constraint order produced by the Meta source when generated constraint DDL.

public final DDLExportConfiguration
respectConstraintOrder(boolean newRespectConstraintOrder)

Whether to respect the constraint order produced by the Meta source when generated constraint DDL.

public final boolean
respectDomainOrder()

Whether to respect the domain order produced by the Meta source when generated domain DDL.

public final DDLExportConfiguration
respectDomainOrder(boolean newRespectDomainOrder)

Whether to respect the sequence order produced by the Meta source when generated sequence DDL.

public final boolean
respectIndexOrder()

Whether to respect the index order produced by the Meta source when generated index DDL.

public final DDLExportConfiguration
respectIndexOrder(boolean newRespectIndexOrder)

Whether to respect the index order produced by the Meta source when generated index DDL.

public final boolean
respectSchemaOrder()

Whether to respect the schema order produced by the Meta source when generated schema DDL.

public final DDLExportConfiguration
respectSchemaOrder(boolean newRespectSchemaOrder)

Whether to respect the schema order produced by the Meta source when generated schema DDL.

public final boolean
respectSequenceOrder()

Whether to respect the sequence order produced by the Meta source when generated sequence DDL.

public final DDLExportConfiguration
respectSequenceOrder(boolean newRespectSequenceOrder)

Whether to respect the sequence order produced by the Meta source when generated sequence DDL.

public final boolean
respectTableOrder()

Whether to respect the table order produced by the Meta source when generated table DDL.

public final DDLExportConfiguration
respectTableOrder(boolean newRespectTableOrder)

Whether to respect the table order produced by the Meta source when generated table DDL.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

createDomainIfNotExistsback to summary
private final boolean createDomainIfNotExists
createIndexIfNotExistsback to summary
private final boolean createIndexIfNotExists
createOrReplaceViewback to summary
private final boolean createOrReplaceView
createSchemaIfNotExistsback to summary
private final boolean createSchemaIfNotExists
createSequenceIfNotExistsback to summary
private final boolean createSequenceIfNotExists
createTableIfNotExistsback to summary
private final boolean createTableIfNotExists
createViewIfNotExistsback to summary
private final boolean createViewIfNotExists
defaultSequenceFlagsback to summary
private final boolean defaultSequenceFlags
flagsback to summary
private final EnumSet<DDLFlag> flags
includeConstraintsOnViewsback to summary
private final boolean includeConstraintsOnViews
respectCatalogOrderback to summary
private final boolean respectCatalogOrder
respectColumnOrderback to summary
private final boolean respectColumnOrder
respectConstraintOrderback to summary
private final boolean respectConstraintOrder
respectDomainOrderback to summary
private final boolean respectDomainOrder
respectIndexOrderback to summary
private final boolean respectIndexOrder
respectSchemaOrderback to summary
private final boolean respectSchemaOrder
respectSequenceOrderback to summary
private final boolean respectSequenceOrder
respectTableOrderback to summary
private final boolean respectTableOrder

Constructor Detail

DDLExportConfigurationback to summary
public DDLExportConfiguration()

Create a new default export configuration instance.

DDLExportConfigurationback to summary
private DDLExportConfiguration(Collection<DDLFlag> flags, boolean createSchemaIfNotExists, boolean createTableIfNotExists, boolean createIndexIfNotExists, boolean createDomainIfNotExists, boolean createSequenceIfNotExists, boolean createViewIfNotExists, boolean createOrReplaceView, boolean respectCatalogOrder, boolean respectSchemaOrder, boolean respectTableOrder, boolean respectColumnOrder, boolean respectConstraintOrder, boolean respectIndexOrder, boolean respectDomainOrder, boolean respectSequenceOrder, boolean defaultSequenceFlags, boolean includeConstraintsOnViews)

Method Detail

createDomainIfNotExistsback to summary
public final boolean createDomainIfNotExists()

Whether to generate CREATE DOMAIN IF NOT EXISTS statements.

Not all RDBMS support this flag. Check DSLContext#createDomainIfNotExists(Domain) to see if your SQLDialect supports the clause.

createDomainIfNotExistsback to summary
public final DDLExportConfiguration createDomainIfNotExists(boolean newCreateDomainIfNotExists)

Whether to generate CREATE DOMAIN IF NOT EXISTS statements.

createIndexIfNotExistsback to summary
public final boolean createIndexIfNotExists()

Whether to generate CREATE INDEX IF NOT EXISTS statements.

Not all RDBMS support this flag. Check DSLContext#createIndexIfNotExists(Index) to see if your SQLDialect supports the clause.

createIndexIfNotExistsback to summary
public final DDLExportConfiguration createIndexIfNotExists(boolean newCreateIndexIfNotExists)

Whether to generate CREATE INDEX IF NOT EXISTS statements.

createOrReplaceViewback to summary
public final boolean createOrReplaceView()

Whether to generate CREATE OR REPLACE VIEW statements.

Not all RDBMS support this flag. Check DSLContext#createOrReplaceView(Table, Field...) to see if your SQLDialect supports the clause.

createOrReplaceViewback to summary
public final DDLExportConfiguration createOrReplaceView(boolean newCreateOrReplaceView)

Whether to generate CREATE OR REPLACE VIEW statements.

createSchemaIfNotExistsback to summary
public final boolean createSchemaIfNotExists()

Whether to generate CREATE SCHEMA IF NOT EXISTS statements.

Not all RDBMS support this flag. Check DSLContext#createSchemaIfNotExists(Schema) to see if your SQLDialect supports the clause.

createSchemaIfNotExistsback to summary
public final DDLExportConfiguration createSchemaIfNotExists(boolean newCreateSchemaIfNotExists)

Whether to generate CREATE SCHEMA IF NOT EXISTS statements.

createSequenceIfNotExistsback to summary
public final boolean createSequenceIfNotExists()

Whether to generate CREATE SEQUENCE IF NOT EXISTS statements.

Not all RDBMS support this flag. Check DSLContext#createSequenceIfNotExists(Sequence) to see if your SQLDialect supports the clause.

createSequenceIfNotExistsback to summary
public final DDLExportConfiguration createSequenceIfNotExists(boolean newCreateSequenceIfNotExists)

Whether to generate CREATE SEQUENCE IF NOT EXISTS statements.

createTableIfNotExistsback to summary
public final boolean createTableIfNotExists()

Whether to generate CREATE TABLE IF NOT EXISTS statements.

Not all RDBMS support this flag. Check DSLContext#createTableIfNotExists(Table) to see if your SQLDialect supports the clause.

createTableIfNotExistsback to summary
public final DDLExportConfiguration createTableIfNotExists(boolean newCreateTableIfNotExists)

Whether to generate CREATE TABLE IF NOT EXISTS statements.

createViewIfNotExistsback to summary
public final boolean createViewIfNotExists()

Whether to generate CREATE VIEW IF NOT EXISTS statements.

Not all RDBMS support this flag. Check DSLContext#createViewIfNotExists(Table, Field...) to see if your SQLDialect supports the clause.

createViewIfNotExistsback to summary
public final DDLExportConfiguration createViewIfNotExists(boolean newCreateViewIfNotExists)

Whether to generate CREATE VIEW IF NOT EXISTS statements.

defaultSequenceFlagsback to summary
public final boolean defaultSequenceFlags()

Whether to explicitly produce defaults for all sequence flags, when they're not defined explicitly.

defaultSequenceFlagsback to summary
public final DDLExportConfiguration defaultSequenceFlags(boolean newDefaultSequenceFlags)

Whether to explicitly produce defaults for all sequence flags, when they're not defined explicitly.

flagsback to summary
public final Set<DDLFlag> flags()

The DDLFlag that are enabled on this configuration.

flagsback to summary
public final DDLExportConfiguration flags(DDLFlag... newFlags)

The DDLFlag that are enabled on this configuration.

flagsback to summary
public final DDLExportConfiguration flags(Collection<DDLFlag> newFlags)

The DDLFlag that are enabled on this configuration.

includeConstraintsOnViewsback to summary
public final boolean includeConstraintsOnViews()

Whether to include constraints on views.

includeConstraintsOnViewsback to summary
public final DDLExportConfiguration includeConstraintsOnViews(boolean newIncludeConstraintsOnViews)

Whether to include constraints on views.

respectCatalogOrderback to summary
public final boolean respectCatalogOrder()

Whether to respect the catalog order produced by the Meta source when generated catalog DDL.

respectCatalogOrderback to summary
public final DDLExportConfiguration respectCatalogOrder(boolean newRespectCatalogOrder)

Whether to respect the catalog order produced by the Meta source when generated catalog DDL.

respectColumnOrderback to summary
public final boolean respectColumnOrder()

Whether to respect the column order produced by the Meta source when generated column DDL.

respectColumnOrderback to summary
public final DDLExportConfiguration respectColumnOrder(boolean newRespectColumnOrder)

Whether to respect the column order produced by the Meta source when generated column DDL.

respectConstraintOrderback to summary
public final boolean respectConstraintOrder()

Whether to respect the constraint order produced by the Meta source when generated constraint DDL.

respectConstraintOrderback to summary
public final DDLExportConfiguration respectConstraintOrder(boolean newRespectConstraintOrder)

Whether to respect the constraint order produced by the Meta source when generated constraint DDL.

respectDomainOrderback to summary
public final boolean respectDomainOrder()

Whether to respect the domain order produced by the Meta source when generated domain DDL.

respectDomainOrderback to summary
public final DDLExportConfiguration respectDomainOrder(boolean newRespectDomainOrder)

Whether to respect the sequence order produced by the Meta source when generated sequence DDL.

respectIndexOrderback to summary
public final boolean respectIndexOrder()

Whether to respect the index order produced by the Meta source when generated index DDL.

respectIndexOrderback to summary
public final DDLExportConfiguration respectIndexOrder(boolean newRespectIndexOrder)

Whether to respect the index order produced by the Meta source when generated index DDL.

respectSchemaOrderback to summary
public final boolean respectSchemaOrder()

Whether to respect the schema order produced by the Meta source when generated schema DDL.

respectSchemaOrderback to summary
public final DDLExportConfiguration respectSchemaOrder(boolean newRespectSchemaOrder)

Whether to respect the schema order produced by the Meta source when generated schema DDL.

respectSequenceOrderback to summary
public final boolean respectSequenceOrder()

Whether to respect the sequence order produced by the Meta source when generated sequence DDL.

respectSequenceOrderback to summary
public final DDLExportConfiguration respectSequenceOrder(boolean newRespectSequenceOrder)

Whether to respect the sequence order produced by the Meta source when generated sequence DDL.

respectTableOrderback to summary
public final boolean respectTableOrder()

Whether to respect the table order produced by the Meta source when generated table DDL.

respectTableOrderback to summary
public final DDLExportConfiguration respectTableOrder(boolean newRespectTableOrder)

Whether to respect the table order produced by the Meta source when generated table DDL.