Module org.jooq.meta

Package org.jooq.meta

Class AbstractDatabase

java.lang.Object

org.jooq.meta.AbstractDatabase

All Implemented Interfaces:

AutoCloseable, Database

Direct Known Subclasses:

AbstractMetaDatabase, CUBRIDDatabase, DerbyDatabase, FirebirdDatabase, H2Database, HSQLDBDatabase, MySQLDatabase, PostgresDatabase, SQLiteDatabase, XMLDatabase

public abstract class AbstractDatabase
extends Object
implements Database

A base implementation for all types of databases.

Author:

Lukas Eder

Nested Class Summary

Nested classes/interfaces inherited from interface org.jooq.meta.Database

Database.Filter

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDatabase()

Method Summary

Modifier and Type	Method	Description
final void	addFilter(Database.Filter filter)	[#3488] Add an additional filter to the database that is applied in addition to include / exclude.
void	close()	Release any resources that this Database may have allocated.
boolean	commercial()
boolean	commercial(Supplier<String> logMessage)
protected boolean	configuredDialectIsNotFamilyAndSupports(List<SQLDialect> d, Supplier<Boolean> ifFamily)	Check if the configured dialect is versioned explicitly and supports a given dialect.
final DSLContext	create()	Create the factory for this database.
protected final DSLContext	create(boolean muteExceptions)
protected abstract DSLContext	create0()	Create a new Factory
final boolean	dateAsTimestamp()	Whether DATE columns should be treated as TIMESTAMP columns.
String	embeddableDomains()	A regular expression matching domain type definitions for which embeddable types should be generated.
String	embeddablePrimaryKeys()	A regular expression matching primary keys for which embeddable types should be generated.
String	embeddableUniqueKeys()	A regular expression matching unique keys for which embeddable types should be generated.
final boolean	existAll(Table<?>... t)	Check for the existence of several tables in the dictionary views.
final boolean	existAll(TableField<?,?>... f)	Check for the existence of several table fields in the dictionary views.
final boolean	exists(Table<?> table)	Check for the existence of a table in the dictionary views.
final boolean	exists(TableField<?,?> field)	Check for the existence of a table field in the dictionary views.
protected boolean	exists0(Table<?> table)	[#8972] Subclasses may override this method for a more efficient implementation.
protected boolean	exists0(TableField<?,?> field)	[#8972] Subclasses may override this method for a more efficient implementation.
protected final <R extends Record> boolean	exists1(Table<?> find, Table<R> in, TableField<R,String> schemaQualifier, TableField<R,String> tableQualifier)	A utility method to look up a table in a single dictionary view.
protected final <R extends Record> boolean	exists1(TableField<?,?> find, Table<R> in, TableField<R,String> schemaQualifier, TableField<R,String> tableQualifier, TableField<R,String> columnQualifier)	A utility method to look up a field in a single dictionary view.
protected static final String	fetchedSize(Collection<?> fetched, Collection<?> included)
protected final <T extends Definition> List<T>	filter(List<T> definitions, String include)
protected final <T extends Definition> List<T>	filter(List<T> definitions, List<String> include)
final <T extends Definition> List<T>	filterExcludeInclude(List<T> definitions)	Filter a list of definitions according to the exclude / include / and filter settings of this database.
protected final <T extends Definition> List<T>	filterExcludeInclude(List<T> definitions, String[] e, String[] i, List<Database.Filter> f)
protected final <T extends Definition> List<T>	filterExcludeInclude(List<T> definitions, String e, String i)
protected final <T extends Definition> List<T>	filterPackage(List<T> definitions, PackageDefinition pkg)
protected final <T extends Definition> List<T>	filterPackage(List<T> definitions, PackageDefinition pkg, Map<PackageDefinition,List<T>> cache)
protected final <T extends Definition> List<T>	filterSchema(List<T> definitions, SchemaDefinition schema)
protected final <T extends Definition> List<T>	filterSchema(List<T> definitions, SchemaDefinition schema, Map<SchemaDefinition,List<T>> cache)
protected final <T extends TableElementDefinition> List<T>	filterTable(List<T> definitions, TableDefinition table)
protected final <T extends TableElementDefinition> List<T>	filterTable(List<T> definitions, TableDefinition table, Map<TableDefinition,List<T>> cache)
final List<Definition>	getAll()	Retrieve all objects.
final ArrayDefinition	getArray(SchemaDefinition schema, String name)	Get a ARRAY defined in this database by name.
final ArrayDefinition	getArray(SchemaDefinition schema, String name, boolean ignoreCase)	Get a ARRAY defined in this database by name.
final ArrayDefinition	getArray(SchemaDefinition schema, Name name)	Get a ARRAY defined in this database by name.
final ArrayDefinition	getArray(SchemaDefinition schema, Name name, boolean ignoreCase)	Get a ARRAY defined in this database by name.
final List<ArrayDefinition>	getArrays(SchemaDefinition schema)	The Arrays defined in this database.
protected abstract List<ArrayDefinition>	getArrays0()	Retrieve ALL ARRAYs from the database.
final String	getBasedir()	The basedir that can be used by file based implementations to resolve relative paths.
final CatalogDefinition	getCatalog(String inputName)	Get a catalog defined in this database by name.
final List<CatalogDefinition>	getCatalogs()	The catalogs generated from this database.
protected abstract List<CatalogDefinition>	getCatalogs0()	Retrieve ALL catalogs from the database.
final CatalogVersionProvider	getCatalogVersionProvider()	The database's catalog version provider.
final List<CheckConstraintDefinition>	getCheckConstraints(SchemaDefinition schema)	The check constraints contained in this database.
List<CommentType>	getConfiguredComments()	Get the configured comments.
final CustomType	getConfiguredCustomType(String typeName)	Deprecated.
final List<CustomType>	getConfiguredCustomTypes()	Deprecated.
final List<EmbeddableDefinitionType>	getConfiguredEmbeddables()	Get the configured embeddable type definitions for any given Definition.
final List<EnumType>	getConfiguredEnumTypes()	Database objects matching any of these field names will be generated as enum types.
final ForcedType	getConfiguredForcedType(Definition definition)	Get the configured forced type object for any given Definition, or null if no ForcedType matches the definition.
final ForcedType	getConfiguredForcedType(Definition definition, DataTypeDefinition definedType)	Get the configured forced type object for any given Definition, or null if no ForcedType matches the definition.
final List<ForcedType>	getConfiguredForcedTypes()	Database objects matching any of these field names will be generated as forced types.
List<SyntheticColumnType>	getConfiguredSyntheticColumns()	Get the configured synthetic columns.
List<SyntheticDaoType>	getConfiguredSyntheticDaos()	Get the configured synthetic DAOs.
List<SyntheticForeignKeyType>	getConfiguredSyntheticForeignKeys()	Get the configured synthetic foreign keys.
List<SyntheticIdentityType>	getConfiguredSyntheticIdentities()	Get the configured synthetic identities.
List<SyntheticPrimaryKeyType>	getConfiguredSyntheticPrimaryKeys()	Get the configured synthetic primary keys.
List<SyntheticReadonlyColumnType>	getConfiguredSyntheticReadonlyColumns()	Get the configured synthetic readonly columns.
List<SyntheticReadonlyRowidType>	getConfiguredSyntheticReadonlyRowids()	Get the configured synthetic readonly rowids.
List<SyntheticUniqueKeyType>	getConfiguredSyntheticUniqueKeys()	Get the configured synthetic unique keys.
List<SyntheticViewType>	getConfiguredSyntheticViews()	Get the configured synthetic views.
final Connection	getConnection()	The database connection.
protected final DataTypeDefinition	getDataTypeForMAX_VAL(SchemaDefinition schema, BigInteger value)	Get the data type considering a known max value
protected static final <D extends Definition> D	getDefinition(List<D> definitions, String name, boolean ignoreCase)
protected static final <D extends Definition> D	getDefinition(List<D> definitions, Name name, boolean ignoreCase)
final SQLDialect	getDialect()	Get the dialect for this database.
final DomainDefinition	getDomain(SchemaDefinition schema, String name)	Get an domain UDT defined in this database by name.
final DomainDefinition	getDomain(SchemaDefinition schema, String name, boolean ignoreCase)	Get an domain UDT defined in this database by name.
final DomainDefinition	getDomain(SchemaDefinition schema, Name name)	Get an domain UDT defined in this database by name.
final DomainDefinition	getDomain(SchemaDefinition schema, Name name, boolean ignoreCase)	Get an domain UDT defined in this database by name.
final List<DomainDefinition>	getDomains()	The domain UDTs defined in this database.
final List<DomainDefinition>	getDomains(SchemaDefinition schema)	The domain UDTs defined in this database.
protected abstract List<DomainDefinition>	getDomains0()	Retrieve ALL domain UDTs from the database.
final List<EmbeddableDefinition>	getEmbeddables()	Get all embeddables.
final List<EmbeddableDefinition>	getEmbeddables(SchemaDefinition schema)	Get all embeddables for a given defining schema.
final List<EmbeddableDefinition>	getEmbeddables(TableDefinition table)	Get all embeddables for a given defining table.
final List<EmbeddableDefinition>	getEmbeddablesByReferencingTable(TableDefinition table)	Get all embeddables for a given referencing table.
final EnumDefinition	getEnum(SchemaDefinition schema, String name)	Get an enum UDT defined in this database by name.
final EnumDefinition	getEnum(SchemaDefinition schema, String name, boolean ignoreCase)	Get an enum UDT defined in this database by name.
final EnumDefinition	getEnum(SchemaDefinition schema, Name name)	Get an enum UDT defined in this database by name.
final EnumDefinition	getEnum(SchemaDefinition schema, Name name, boolean ignoreCase)	Get an enum UDT defined in this database by name.
final List<EnumDefinition>	getEnums(SchemaDefinition schema)	The enum UDTs defined in this database.
protected abstract List<EnumDefinition>	getEnums0()	Retrieve ALL enum UDTs from the database.
final List<Definition>	getExcluded()	Retrieve all excluded objects.
final String[]	getExcludes()	Database objects matching any of these regular expressions will not be generated.
final String	getExcludeSql()	Database objects matching any of the regular expressions produced by this SQL query will not be generated, in addition to the ones specified by Database.getExcludes().
final List<Database.Filter>	getFilters()	[#3488] The filters that are applied in addition to include / exclude.
boolean	getForcedTypesForBuiltinDataTypeExtensions()	Whether some additional forced types for built in data type extensions, such as the ones from jooq-codegen-postgres should be added.
boolean	getForcedTypesForXMLSchemaCollections()	Whether some additional forced types for XMLSchemaCollectionDefinition types should be created automatically for columns that have non-ambiguous references to an XMLTypeDefinition.
boolean	getForceIntegerTypesOnZeroScaleDecimals()	Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.
final List<ForeignKeyDefinition>	getForeignKeys()	The foreign keys contained in this database.
final List<ForeignKeyDefinition>	getForeignKeys(SchemaDefinition schema)	The foreign keys contained in this database.
final List<IdentityDefinition>	getIdentities(SchemaDefinition schema)	The identities contained in this database.
final boolean	getIncludeCheckConstraints()	whether check constraints should be included.
final List<Definition>	getIncluded()	Retrieve all included objects.
final boolean	getIncludeDomains()	whether domains should be included.
final boolean	getIncludeEmbeddables()	Whether embeddable types should be included.
final boolean	getIncludeExcludeColumns()	Indicate whether include / exclude regular expression shall also match database columns.
final boolean	getIncludeExcludePackageRoutines()	Indicate whether include / exclude regular expression shall also match package routines.
final boolean	getIncludeForeignKeys()	whether foreign key relationships should be included.
final boolean	getIncludeIndexes()	whether indexes should be included.
final boolean	getIncludeInvisibleColumns()	Whether invisible columns should be included.
final boolean	getIncludePackageConstants()	whether package constants should be included.
final boolean	getIncludePackageRoutines()	whether package routines should be included.
final boolean	getIncludePackages()	whether packages should be included.
final boolean	getIncludePackageUDTs()	whether package UDTs should be included.
final boolean	getIncludePrimaryKeys()	whether primary keys should be included.
final boolean	getIncludeRoutines()	whether routines should be included.
final String[]	getIncludes()	Only database objects matching any of these regular expressions will be generated.
final boolean	getIncludeSequences()	whether sequences should be included.
final String	getIncludeSql()	Only database objects matching any of the regular expressions produced by this SQL query will be generated, in addition to the ones specified by Database.getIncludes().
final boolean	getIncludeSystemCheckConstraints()	whether system generated check constraints should be included.
final boolean	getIncludeSystemIndexes()	whether system generated indexes should be included.
final boolean	getIncludeSystemSequences()	whether system generated sequences should be included.
final boolean	getIncludeSystemTables()	whether system generated tables should be included.
final boolean	getIncludeSystemUDTs()	whether system generated UDTs should be included.
final boolean	getIncludeTables()	Whether tables (and views) should be included.
boolean	getIncludeTriggerRoutines()	whether trigger routines should be included.
final boolean	getIncludeUDTs()	whether user defined types should be included.
final boolean	getIncludeUniqueKeys()	whether unique keys should be included.
final boolean	getIncludeXMLSchemaCollections()	whether XML schema collections should be included.
final List<IndexDefinition>	getIndexes(SchemaDefinition schema)	The indexes contained in this database.
final List<IndexDefinition>	getIndexes(TableDefinition table)	The indexes contained in this database.
protected List<IndexDefinition>	getIndexes0()	Retrieve ALL indexes from the database
final List<String>	getInputCatalogs()	The input catalogs are the catalogs that jooq-meta is reading data from.
final List<String>	getInputSchemata()	The input schemata are the schemata from all catalogs that jooq-meta is reading data from.
final List<String>	getInputSchemata(String catalog)	The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
final List<String>	getInputSchemata(CatalogDefinition catalog)	The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
final List<UniqueKeyDefinition>	getKeys()	The unique and primary keys contained in this database.
final List<UniqueKeyDefinition>	getKeys(SchemaDefinition schema)	The unique and primary keys contained in this database.
final int	getLogSlowQueriesAfterSeconds()	Log slow queries after this amount of seconds.
final int	getLogSlowResultsAfterSeconds()	Log slow results after this amount of seconds.
final Comparator<Definition>	getOrderProvider()	The database's order provider.
String	getOutputCatalog(String inputCatalog)	Deprecated.
String	getOutputSchema(String inputSchema)	Deprecated.
String	getOutputSchema(String inputCatalog, String inputSchema)	The output schema is the schema used by jooq-codegen in class names.
String[]	getOverridePrimaryKeys()	Deprecated.
PackageDefinition	getPackage(SchemaDefinition schema, String inputName)	Get a package defined in this database by name.
final List<PackageDefinition>	getPackages(SchemaDefinition schema)	The packages contained in this database.
protected abstract List<PackageDefinition>	getPackages0()	Retrieve ALL packages from the database.
final List<UniqueKeyDefinition>	getPrimaryKeys()	The primary keys contained in this database.
final List<UniqueKeyDefinition>	getPrimaryKeys(SchemaDefinition schema)	The primary keys contained in this database.
final Properties	getProperties()	Database properties.
String[]	getRecordTimestampFields()	Table columns matching these regular expressions will be considered as record timestamp fields in generated code.
String[]	getRecordVersionFields()	Table columns matching these regular expressions will be considered as record version fields in generated code.
final List<RegexFlag>	getRegexFlags()	The regular expression flags that should be applied when using regular expressions.
final boolean	getRegexMatchesPartialQualification()	Whether the regular expressions matching database objects should match partially qualified names as well as fully qualified and unqualified names.
final Relations	getRelations()	Retrieve the schema's primary key / foreign key relations.
protected final Relations	getRelations0()	Retrieve ALL relations from the database.
protected RenderQuotedNames	getRenderQuotedNames()	Subclasses may override this.
final List<RoutineDefinition>	getRoutines(SchemaDefinition schema)	The stored routines (procedures and functions) contained in this database.
protected abstract List<RoutineDefinition>	getRoutines0()	Retrieve ALL stored routines (functions and procedures) from the database.
final SchemaDefinition	getSchema(String inputName)	Get a schema defined in this database by name.
final List<SchemaDefinition>	getSchemata()	The schemata generated from this database.
final List<SchemaDefinition>	getSchemata(CatalogDefinition catalog)	The schemata generated from this database and a given catalog.
protected abstract List<SchemaDefinition>	getSchemata0()	Retrieve ALL schemata from the database.
final SchemaVersionProvider	getSchemaVersionProvider()	The database's schema version provider.
final List<SequenceDefinition>	getSequences()	The sequences contained in this database.
final List<SequenceDefinition>	getSequences(SchemaDefinition schema)	The sequences contained in this database.
protected abstract List<SequenceDefinition>	getSequences0()	Retrieve ALL sequences from the database.
final Map<Definition,String>	getSources()	Get the sources for all objects that offer sources.
protected Map<Definition,String>	getSources0()	Retrieve ALL source code from the database.
final boolean	getSqlMatchesPartialQualification()	Whether the SQL statements matching database objects should match partially qualified names as well as fully qualified and unqualified names.
final String[]	getSyntheticIdentities()	Deprecated.
String[]	getSyntheticPrimaryKeys()	Deprecated.
final TableDefinition	getTable(SchemaDefinition schema, String name)	Get a table in this database by name.
final TableDefinition	getTable(SchemaDefinition schema, String name, boolean ignoreCase)	Get a table in this database by name.
final TableDefinition	getTable(SchemaDefinition schema, Name name)	Get a table in this database by name.
final TableDefinition	getTable(SchemaDefinition schema, Name name, boolean ignoreCase)	Get a table in this database by name.
final List<TableDefinition>	getTables()	The tables contained in this database.
final List<TableDefinition>	getTables(SchemaDefinition schema)	The tables contained in this database.
protected abstract List<TableDefinition>	getTables0()	Retrieve ALL tables from the database.
final UDTDefinition	getUDT(SchemaDefinition schema, String name)	Get a UDT defined in this database by name.
final UDTDefinition	getUDT(SchemaDefinition schema, String name, boolean ignoreCase)	Get a UDT defined in this database by name.
final UDTDefinition	getUDT(SchemaDefinition schema, Name name)	Get a UDT defined in this database by name.
final UDTDefinition	getUDT(SchemaDefinition schema, Name name, boolean ignoreCase)	Get a UDT defined in this database by name.
final List<UDTDefinition>	getUDTs()	The UDTs defined in this database.
final List<UDTDefinition>	getUDTs(PackageDefinition pkg)	The UDTs defined in this database.
final List<UDTDefinition>	getUDTs(SchemaDefinition schema)	The UDTs defined in this database.
protected abstract List<UDTDefinition>	getUDTs0()	Retrieve ALL UDTs from the database.
final List<UniqueKeyDefinition>	getUniqueKeys()	The unique keys contained in this database.
final List<UniqueKeyDefinition>	getUniqueKeys(SchemaDefinition schema)	The unique keys contained in this database.
List<CommentType>	getUnusedComments()	Retrieve the not-yet used comments.
final List<EmbeddableDefinitionType>	getUnusedEmbeddables()	Retrieve the not-yet used embeddables.
List<ForcedType>	getUnusedForcedTypes()	Retrieve the not-yet used forced types.
List<SyntheticColumnType>	getUnusedSyntheticColumns()	Retrieve the not-yet used synthetic columns.
List<SyntheticForeignKeyType>	getUnusedSyntheticForeignKeys()	Retrieve the not-yet used synthetic foreign keys.
List<SyntheticIdentityType>	getUnusedSyntheticIdentities()	Retrieve the not-yet used synthetic identities.
List<SyntheticPrimaryKeyType>	getUnusedSyntheticPrimaryKeys()	Retrieve the not-yet used synthetic primary keys.
List<SyntheticReadonlyColumnType>	getUnusedSyntheticReadonlyColumns()	Retrieve the not-yet used synthetic readonly columns.
List<SyntheticReadonlyRowidType>	getUnusedSyntheticReadonlyRowids()	Retrieve the not-yet used synthetic readonly rowids.
List<SyntheticUniqueKeyType>	getUnusedSyntheticUniqueKeys()	Retrieve the not-yet used synthetic unique keys.
List<SyntheticViewType>	getUnusedSyntheticViews()	Retrieve the not-yet used synthetic views.
final XMLSchemaCollectionDefinition	getXMLSchemaCollection(SchemaDefinition schema, String inputName)	The XML schema collection generated from this database by name
final List<XMLSchemaCollectionDefinition>	getXMLSchemaCollections()	The XML schema collections generated from this database.
final List<XMLSchemaCollectionDefinition>	getXMLSchemaCollections(SchemaDefinition schema)	The XML schema collections generated from this database.
protected abstract List<XMLSchemaCollectionDefinition>	getXMLSchemaCollections0()	Retrieve ALL XML schema collections from the database.
final boolean	ignoreProcedureReturnValues()	Whether this database should ignore procedure return values.
final boolean	includeRelations()	[#3559] Whether relations (i.e.
final boolean	integerDisplayWidths()	Whether this database includes integer display widths in metadata, where applicable.
final boolean	isArrayType(String dataType)	Check whether a type is an array type.
final boolean	javaTimeTypes()	Whether java.time types are used, as opposed to java.sql types.
protected abstract void	loadCheckConstraints(DefaultRelations r)	Retrieve CHECK constraints and store them to relations.
protected abstract void	loadForeignKeys(DefaultRelations r)	Retrieve foreign keys and store them to relations.
protected abstract void	loadPrimaryKeys(DefaultRelations r)	Retrieve primary keys and store them to relations
protected abstract void	loadUniqueKeys(DefaultRelations r)	Retrieve non-primary unique keys and store them to relations
void	markUsed(CommentType object)	Mark a comment as used.
final void	markUsed(EmbeddableDefinitionType embeddable)	Mark an embeddable as used.
void	markUsed(ForcedType forcedType)	Mark a forced type as used.
void	markUsed(SyntheticColumnType column)	Mark a synthetic column as used.
void	markUsed(SyntheticForeignKeyType foreignKey)	Mark a synthetic foreign key as used.
void	markUsed(SyntheticIdentityType identity)	Mark a synthetic identity as used.
void	markUsed(SyntheticPrimaryKeyType primaryKey)	Mark a synthetic primary key as used.
void	markUsed(SyntheticReadonlyColumnType readonlyColumn)	Mark a synthetic readonly column as used.
void	markUsed(SyntheticReadonlyRowidType readonlyRowid)	Mark a synthetic readonly rowids as used.
void	markUsed(SyntheticUniqueKeyType uniqueKey)	Mark a synthetic unique key as used.
void	markUsed(SyntheticViewType view)	Mark a synthetic view as used.
final OnError	onError()	The behaviour when errors are encountered.
protected final Field<Integer>	overload(Field<String> schema, Field<String> name, Field<String> order)
boolean	readonlyComputedColumns()	Whether computed columns columns should expose DataType.readonly() behaviour.
boolean	readonlyIdentities()	Whether identity columns should expose DataType.readonly() behaviour.
boolean	readonlyNonUpdatableColumns()	Whether columns that are known not to be updatable (e.g.
boolean	requireCommercial(Supplier<String> logMessage)
final void	setBasedir(String basedir)	The basedir that can be used by file based implementations to resolve relative paths.
final void	setCatalogVersionProvider(CatalogVersionProvider catalogVersionProvider)	The database's catalog version provider.
final void	setConfiguredCatalogs(List<CatalogMappingType> catalogs)	The input and output catalogs.
void	setConfiguredComments(List<CommentType> configuredComments)	Configure the comments.
final void	setConfiguredCustomTypes(List<CustomType> configuredCustomTypes)	Deprecated.
final void	setConfiguredEmbeddables(List<EmbeddableDefinitionType> configuredEmbeddables)	Configure the embeddable types.
final void	setConfiguredEnumTypes(List<EnumType> configuredEnumTypes)	Database objects matching any of these field names will be generated as enum types.
final void	setConfiguredForcedTypes(List<ForcedType> configuredForcedTypes)	Database objects matching any of these field names will be generated as forced types.
final void	setConfiguredSchemata(List<SchemaMappingType> schemata)	The input and output schemata.
void	setConfiguredSyntheticObjects(SyntheticObjectsType configuredSyntheticObjects)	Configure the synthetic objects.
final void	setConnection(Connection connection)	Initialise a connection to this database.
final void	setDateAsTimestamp(boolean dateAsTimestamp)	Whether DATE columns should be treated as TIMESTAMP columns.
final void	setDialect(SQLDialect dialect)	Set the dialect for this database.
void	setEmbeddableDomains(String embeddableDomains)	A regular expression matching domain type definitions for which embeddable types should be generated.
void	setEmbeddablePrimaryKeys(String embeddablePrimaryKeys)	A regular expression matching primary keys for which embeddable types should be generated.
void	setEmbeddableUniqueKeys(String embeddableUniqueKeys)	A regular expression matching unique keys for which embeddable types should be generated.
final void	setExcludes(String[] excludes)	Database objects matching any of these regular expressions will not be generated.
final void	setExcludeSql(String sql)	Database objects matching any of the regular expressions produced by this SQL query will not be generated, in addition to the ones specified by Database.getExcludes().
void	setForcedTypesForBuiltinDataTypeExtensions(boolean forcedTypesForBuiltinDataTypeExtensions)	Whether some additional forced types for built in data type extensions, such as the ones from jooq-codegen-postgres should be added.
void	setForcedTypesForXMLSchemaCollections(boolean forcedTypesForXMLSchemaCollections)	Whether some additional forced types for XMLSchemaCollectionDefinition types should be created automatically for columns that have non-ambiguous references to an XMLTypeDefinition.
void	setForceIntegerTypesOnZeroScaleDecimals(boolean forceIntegerTypesOnZeroScaleDecimals)	Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.
final void	setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues)	Whether this database should ignore procedure return values.
final void	setIncludeCheckConstraints(boolean includeCheckConstraints)	whether check constraints should be included.
final void	setIncludeDomains(boolean includeDomains)	whether domains should be included.
final void	setIncludeEmbeddables(boolean includeEmbeddables)	Whether embeddable types should be included.
final void	setIncludeExcludeColumns(boolean includeExcludeColumns)	Indicate whether include / exclude regular expression shall also match database columns.
final void	setIncludeExcludePackageRoutines(boolean includeExcludePackageRoutines)	Indicate whether include / exclude regular expression shall also match package routines.
final void	setIncludeForeignKeys(boolean includeForeignKeys)	whether foreign key relationships should be included.
final void	setIncludeIndexes(boolean includeIndexes)	whether indexes should be included.
final void	setIncludeInvisibleColumns(boolean includeInvisibleColumns)	Whether invisible columns should be included.
final void	setIncludePackageConstants(boolean includePackageConstants)	whether package constants should be included.
final void	setIncludePackageRoutines(boolean includePackageRoutines)	whether package routines should be included.
final void	setIncludePackages(boolean includePackages)	whether packages should be included.
final void	setIncludePackageUDTs(boolean includePackageUDTs)	whether package UDTs should be included.
final void	setIncludePrimaryKeys(boolean includePrimaryKeys)	whether primary keys should be included.
final void	setIncludeRelations(boolean includeRelations)	[#3559] Whether relations (i.e.
final void	setIncludeRoutines(boolean includeRoutines)	whether routines should be included.
final void	setIncludes(String[] includes)	Only database objects matching any of these regular expressions will be generated.
final void	setIncludeSequences(boolean includeSequences)	whether sequences should be included.
final void	setIncludeSql(String sql)	Only database objects matching any of the regular expressions produced by this SQL query will be generated, in addition to the ones specified by Database.getIncludes().
final void	setIncludeSystemCheckConstraints(boolean includeSystemCheckConstraints)	whether system generated check constraints should be included.
final void	setIncludeSystemIndexes(boolean includeSystemIndexes)	whether system generated indexes should be included.
final void	setIncludeSystemSequences(boolean includeSystemSequences)	whether system generated sequences should be included.
final void	setIncludeSystemTables(boolean includeSystemTables)	whether system generated tables should be included.
final void	setIncludeSystemUDTs(boolean includeSystemUDTs)	whether system generated UDTs should be included.
final void	setIncludeTables(boolean includeTables)	Whether tables (and views) should be included.
void	setIncludeTriggerRoutines(boolean includeTriggerRoutines)	whether trigger routines should be included.
final void	setIncludeUDTs(boolean includeUDTs)	whether user defined types should be included.
final void	setIncludeUniqueKeys(boolean includeUniqueKeys)	whether unique keys should be included.
final void	setIncludeXMLSchemaCollections(boolean includeXMLSchemaCollections)	whether XML schema collections should be included.
final void	setIntegerDisplayWidths(boolean integerDisplayWidths)	Whether this database includes integer display widths in metadata, where applicable.
final void	setJavaTimeTypes(boolean javaTimeTypes)	Whether java.time types are used, as opposed to java.sql types.
final void	setLogSlowQueriesAfterSeconds(int logSlowQueriesAfterSeconds)	Log slow queries after this amount of seconds.
final void	setLogSlowResultsAfterSeconds(int logSlowResultsAfterSeconds)	Log slow results after this amount of seconds.
final void	setOnError(OnError onError)	The behaviour when errors are encountered.
final void	setOrderProvider(Comparator<Definition> provider)	The database's order provider.
void	setOverridePrimaryKeys(String[] overridePrimaryKeys)	Deprecated.
final void	setProperties(Properties properties)	Database properties.
void	setReadonlyComputedColumns(boolean readonlyComputedColumns)	Whether computed columns columns should expose DataType.readonly() behaviour.
void	setReadonlyIdentities(boolean readonlyIdentities)	Whether identity columns should expose DataType.readonly() behaviour.
void	setReadonlyNonUpdatableColumns(boolean readonlyNonUpdatableColumns)	Whether columns that are known not to be updatable (e.g.
void	setRecordTimestampFields(String[] recordTimestampFields)	Table columns matching these regular expressions will be considered as record timestamp fields in generated code.
void	setRecordVersionFields(String[] recordVersionFields)	Table columns matching these regular expressions will be considered as record version fields in generated code.
final void	setRegexFlags(List<RegexFlag> regexFlags)	The regular expression flags that should be applied when using regular expressions.
final void	setRegexMatchesPartialQualification(boolean regexMatchesPartialQualification)	Whether the regular expressions matching database objects should match partially qualified names as well as fully qualified and unqualified names.
final void	setSchemaVersionProvider(SchemaVersionProvider schemaVersionProvider)	The database's schema version provider.
final void	setSqlMatchesPartialQualification(boolean sqlMatchesPartialQualification)	Whether the SQL statements matching database objects should match partially qualified names as well as fully qualified and unqualified names.
final void	setSupportsUnsignedTypes(boolean supportsUnsignedTypes)	Whether this database supports unsigned types.
void	setSyntheticIdentities(String[] syntheticIdentities)	Deprecated.
void	setSyntheticPrimaryKeys(String[] syntheticPrimaryKeys)	Deprecated.
final void	setTableValuedFunctions(boolean tableValuedFunctions)	[#4838] Whether table-valued functions should be reported as tables.
final <T extends Definition> List<T>	sort(List<T> definitions)	Sort a list of definitions according to the Database.getOrderProvider() defined in this database.
final boolean	supportsUnsignedTypes()	Whether this database supports unsigned types.
final boolean	tableValuedFunctions()	[#4838] Whether table-valued functions should be reported as tables.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractDatabase

protected AbstractDatabase()

Method Details

getDialect

public final SQLDialect getDialect()

Description copied from interface: Database

Get the dialect for this database.

Specified by:

getDialect in interface Database

setDialect

public final void setDialect(SQLDialect dialect)

Description copied from interface: Database

Set the dialect for this database.

Specified by:

setDialect in interface Database

setConnection

public final void setConnection(Connection connection)

Description copied from interface: Database

Initialise a connection to this database.

Specified by:

setConnection in interface Database

getConnection

public final Connection getConnection()

Description copied from interface: Database

The database connection.

Specified by:

getConnection in interface Database

commercial

public boolean commercial()

commercial

public boolean commercial(Supplier<String> logMessage)

requireCommercial

public boolean requireCommercial(Supplier<String> logMessage)

create

public final DSLContext create()

Description copied from interface: Database

Create the factory for this database.

Specified by:

create in interface Database

create

protected final DSLContext create(boolean muteExceptions)

getRenderQuotedNames

protected RenderQuotedNames getRenderQuotedNames()

Subclasses may override this.

configuredDialectIsNotFamilyAndSupports

protected boolean configuredDialectIsNotFamilyAndSupports(List<SQLDialect> d,
 Supplier<Boolean> ifFamily)

Check if the configured dialect is versioned explicitly and supports a given dialect.

This can be used as an optimisation to check if a dialect supports e.g. a SQLDialect#POSTGRES_12 without needing to query the information schema.

exists

public final boolean exists(TableField<?,?> field)

Description copied from interface: Database

Check for the existence of a table field in the dictionary views.

Specified by:

exists in interface Database

exists0

protected boolean exists0(TableField<?,?> field)

[#8972] Subclasses may override this method for a more efficient implementation.

exists1

protected final <R extends Record> boolean exists1(TableField<?,?> find,
 Table<R> in,
 TableField<R,String> schemaQualifier,
 TableField<R,String> tableQualifier,
 TableField<R,String> columnQualifier)

A utility method to look up a field in a single dictionary view.

Parameters:

find - The field to look up

in - The dictionary view

schemaQualifier - The column in the dictionary view qualifying the schema

tableQualifier - The column in the dictionary view qualifying the table

columnQualifier - The column in the dictionary view qualifying the column

existAll

public final boolean existAll(TableField<?,?>... f)

Description copied from interface: Database

Check for the existence of several table fields in the dictionary views.

Specified by:

existAll in interface Database

exists

public final boolean exists(Table<?> table)

Description copied from interface: Database

Check for the existence of a table in the dictionary views.

Specified by:

exists in interface Database

exists0

protected boolean exists0(Table<?> table)

[#8972] Subclasses may override this method for a more efficient implementation.

exists1

protected final <R extends Record> boolean exists1(Table<?> find,
 Table<R> in,
 TableField<R,String> schemaQualifier,
 TableField<R,String> tableQualifier)

A utility method to look up a table in a single dictionary view.

Parameters:

find - The table to look up

in - The dictionary view

schemaQualifier - The column in the dictionary view qualifying the schema

tableQualifier - The column in the dictionary view qualifying the table

existAll

public final boolean existAll(Table<?>... t)

Description copied from interface: Database

Check for the existence of several tables in the dictionary views.

Specified by:

existAll in interface Database

getSources

public final Map<Definition,String> getSources()

Description copied from interface: Database

Get the sources for all objects that offer sources.

Specified by:

getSources in interface Database

getCatalogs

public final List<CatalogDefinition> getCatalogs()

Description copied from interface: Database

The catalogs generated from this database.

Specified by:

getCatalogs in interface Database

getCatalog

public final CatalogDefinition getCatalog(String inputName)

Description copied from interface: Database

Get a catalog defined in this database by name.

Specified by:

getCatalog in interface Database

getSchemata

public final List<SchemaDefinition> getSchemata()

Description copied from interface: Database

The schemata generated from this database.

Specified by:

getSchemata in interface Database

getSchemata

public final List<SchemaDefinition> getSchemata(CatalogDefinition catalog)

Description copied from interface: Database

The schemata generated from this database and a given catalog.

Specified by:

getSchemata in interface Database

getSchema

public final SchemaDefinition getSchema(String inputName)

Description copied from interface: Database

Get a schema defined in this database by name.

Specified by:

getSchema in interface Database

getXMLSchemaCollections

public final List<XMLSchemaCollectionDefinition> getXMLSchemaCollections()

Description copied from interface: Database

The XML schema collections generated from this database.

Specified by:

getXMLSchemaCollections in interface Database

getXMLSchemaCollections

public final List<XMLSchemaCollectionDefinition> getXMLSchemaCollections(SchemaDefinition schema)

Description copied from interface: Database

The XML schema collections generated from this database.

Specified by:

getXMLSchemaCollections in interface Database

getXMLSchemaCollection

public final XMLSchemaCollectionDefinition getXMLSchemaCollection(SchemaDefinition schema,
 String inputName)

Description copied from interface: Database

The XML schema collection generated from this database by name

Specified by:

getXMLSchemaCollection in interface Database

getInputCatalogs

public final List<String> getInputCatalogs()

Description copied from interface: Database

The input catalogs are the catalogs that jooq-meta is reading data from.

Specified by:

getInputCatalogs in interface Database

getInputSchemata

public final List<String> getInputSchemata()

Description copied from interface: Database

The input schemata are the schemata from all catalogs that jooq-meta is reading data from.

This will combine the schemata from all catalogs in a single list. If you're working with a multi-catalog environment, you may want to call Database.getInputSchemata(String) instead to disambiguate schema names (e.g. in SQL Server, there are multiple "dbo" schemas).

Specified by:

getInputSchemata in interface Database

getInputSchemata

public final List<String> getInputSchemata(CatalogDefinition catalog)

Description copied from interface: Database

The input schemata are the schemata from a given catalog that jooq-meta is reading data from.

Specified by:

getInputSchemata in interface Database

getInputSchemata

public final List<String> getInputSchemata(String catalog)

Description copied from interface: Database

The input schemata are the schemata from a given catalog that jooq-meta is reading data from.

Specified by:

getInputSchemata in interface Database

getOutputCatalog

@Deprecated
public String getOutputCatalog(String inputCatalog)

Deprecated.

Description copied from interface: Database

The output catalog is the catalog used by jooq-codegen in class names.

Specified by:

getOutputCatalog in interface Database

getOutputSchema

@Deprecated
public String getOutputSchema(String inputSchema)

Deprecated.

Description copied from interface: Database

The output schema is the schema used by jooq-codegen in class names.

Specified by:

getOutputSchema in interface Database

getOutputSchema

public String getOutputSchema(String inputCatalog,
 String inputSchema)

Description copied from interface: Database

The output schema is the schema used by jooq-codegen in class names.

Specified by:

getOutputSchema in interface Database

setConfiguredCatalogs

public final void setConfiguredCatalogs(List<CatalogMappingType> catalogs)

Description copied from interface: Database

The input and output catalogs.

Specified by:

setConfiguredCatalogs in interface Database

setConfiguredSchemata

public final void setConfiguredSchemata(List<SchemaMappingType> schemata)

Description copied from interface: Database

The input and output schemata.

Specified by:

setConfiguredSchemata in interface Database

setProperties

public final void setProperties(Properties properties)

Description copied from interface: Database

Database properties.

These properties are typically used by database implementations like the jooq-meta-extensions's JPADatabase (reverse-engineering JPA-annotated entities: properties are used to describe entity lookup paths) or the XMLDatabase (reverse-engineering an XML file: properties are used to describe the XML file's location).

User-defined database implementations may use these properties for the same reason.

Specified by:

setProperties in interface Database

getProperties

public final Properties getProperties()

Description copied from interface: Database

Database properties.

These properties are typically used by database implementations like the jooq-meta-extensions's JPADatabase (reverse-engineering JPA-annotated entities: properties are used to describe entity lookup paths) or the XMLDatabase (reverse-engineering an XML file: properties are used to describe the XML file's location).

User-defined database implementations may use these properties for the same reason.

Specified by:

getProperties in interface Database

setBasedir

public final void setBasedir(String basedir)

Description copied from interface: Database

The basedir that can be used by file based implementations to resolve relative paths.

Specified by:

setBasedir in interface Database

getBasedir

public final String getBasedir()

Description copied from interface: Database

The basedir that can be used by file based implementations to resolve relative paths.

Specified by:

getBasedir in interface Database

setOnError

public final void setOnError(OnError onError)

Description copied from interface: Database

The behaviour when errors are encountered.

Specified by:

setOnError in interface Database

onError

public final OnError onError()

Description copied from interface: Database

The behaviour when errors are encountered.

Specified by:

onError in interface Database

getFilters

public final List<Database.Filter> getFilters()

Description copied from interface: Database

[#3488] The filters that are applied in addition to include / exclude.

Specified by:

getFilters in interface Database

addFilter

public final void addFilter(Database.Filter filter)

Description copied from interface: Database

[#3488] Add an additional filter to the database that is applied in addition to include / exclude.

Specified by:

addFilter in interface Database

setExcludes

public final void setExcludes(String[] excludes)

Description copied from interface: Database

Database objects matching any of these regular expressions will not be generated.

Specified by:

setExcludes in interface Database

getExcludes

public final String[] getExcludes()

Description copied from interface: Database

Database objects matching any of these regular expressions will not be generated.

Specified by:

getExcludes in interface Database

setExcludeSql

public final void setExcludeSql(String sql)

Description copied from interface: Database

Database objects matching any of the regular expressions produced by this SQL query will not be generated, in addition to the ones specified by Database.getExcludes().

Specified by:

setExcludeSql in interface Database

getExcludeSql

public final String getExcludeSql()

Description copied from interface: Database

Database objects matching any of the regular expressions produced by this SQL query will not be generated, in addition to the ones specified by Database.getExcludes().

Specified by:

getExcludeSql in interface Database

setIncludes

public final void setIncludes(String[] includes)

Description copied from interface: Database

Only database objects matching any of these regular expressions will be generated.

Specified by:

setIncludes in interface Database

getIncludes

public final String[] getIncludes()

Description copied from interface: Database

Only database objects matching any of these regular expressions will be generated.

Specified by:

getIncludes in interface Database

setIncludeSql

public final void setIncludeSql(String sql)

Description copied from interface: Database

Only database objects matching any of the regular expressions produced by this SQL query will be generated, in addition to the ones specified by Database.getIncludes().

Specified by:

setIncludeSql in interface Database

getIncludeSql

public final String getIncludeSql()

Description copied from interface: Database

Only database objects matching any of the regular expressions produced by this SQL query will be generated, in addition to the ones specified by Database.getIncludes().

Specified by:

getIncludeSql in interface Database

setIncludeExcludeColumns

public final void setIncludeExcludeColumns(boolean includeExcludeColumns)

Description copied from interface: Database

Indicate whether include / exclude regular expression shall also match database columns.

Specified by:

setIncludeExcludeColumns in interface Database

getIncludeExcludeColumns

public final boolean getIncludeExcludeColumns()

Description copied from interface: Database

Indicate whether include / exclude regular expression shall also match database columns.

Specified by:

getIncludeExcludeColumns in interface Database

setIncludeExcludePackageRoutines

public final void setIncludeExcludePackageRoutines(boolean includeExcludePackageRoutines)

Description copied from interface: Database

Indicate whether include / exclude regular expression shall also match package routines.

Specified by:

setIncludeExcludePackageRoutines in interface Database

getIncludeExcludePackageRoutines

public final boolean getIncludeExcludePackageRoutines()

Description copied from interface: Database

Indicate whether include / exclude regular expression shall also match package routines.

Specified by:

getIncludeExcludePackageRoutines in interface Database

setIncludeInvisibleColumns

public final void setIncludeInvisibleColumns(boolean includeInvisibleColumns)

Description copied from interface: Database

Whether invisible columns should be included.

Specified by:

setIncludeInvisibleColumns in interface Database

getIncludeInvisibleColumns

public final boolean getIncludeInvisibleColumns()

Description copied from interface: Database

Whether invisible columns should be included.

Specified by:

getIncludeInvisibleColumns in interface Database

getIncludeTables

public final boolean getIncludeTables()

Description copied from interface: Database

Whether tables (and views) should be included.

Specified by:

getIncludeTables in interface Database

setIncludeTables

public final void setIncludeTables(boolean includeTables)

Description copied from interface: Database

Whether tables (and views) should be included.

Specified by:

setIncludeTables in interface Database

getIncludeEmbeddables

public final boolean getIncludeEmbeddables()

Description copied from interface: Database

Whether embeddable types should be included.

Specified by:

getIncludeEmbeddables in interface Database

setIncludeEmbeddables

public final void setIncludeEmbeddables(boolean includeEmbeddables)

Description copied from interface: Database

Whether embeddable types should be included.

Specified by:

setIncludeEmbeddables in interface Database

getIncludeRoutines

public final boolean getIncludeRoutines()

Description copied from interface: Database

whether routines should be included.

Specified by:

getIncludeRoutines in interface Database

setIncludeRoutines

public final void setIncludeRoutines(boolean includeRoutines)

Description copied from interface: Database

whether routines should be included.

Specified by:

setIncludeRoutines in interface Database

setIncludeTriggerRoutines

public void setIncludeTriggerRoutines(boolean includeTriggerRoutines)

Description copied from interface: Database

whether trigger routines should be included.

Specified by:

setIncludeTriggerRoutines in interface Database

getIncludeTriggerRoutines

public boolean getIncludeTriggerRoutines()

Description copied from interface: Database

whether trigger routines should be included.

Specified by:

getIncludeTriggerRoutines in interface Database

getIncludePackages

public final boolean getIncludePackages()

Description copied from interface: Database

whether packages should be included.

Specified by:

getIncludePackages in interface Database

setIncludePackages

public final void setIncludePackages(boolean includePackages)

Description copied from interface: Database

whether packages should be included.

Specified by:

setIncludePackages in interface Database

getIncludePackageRoutines

public final boolean getIncludePackageRoutines()

Description copied from interface: Database

whether package routines should be included.

Specified by:

getIncludePackageRoutines in interface Database

setIncludePackageRoutines

public final void setIncludePackageRoutines(boolean includePackageRoutines)

Description copied from interface: Database

whether package routines should be included.

Specified by:

setIncludePackageRoutines in interface Database

getIncludePackageUDTs

public final boolean getIncludePackageUDTs()

Description copied from interface: Database

whether package UDTs should be included.

Specified by:

getIncludePackageUDTs in interface Database

setIncludePackageUDTs

public final void setIncludePackageUDTs(boolean includePackageUDTs)

Description copied from interface: Database

whether package UDTs should be included.

Specified by:

setIncludePackageUDTs in interface Database

getIncludePackageConstants

public final boolean getIncludePackageConstants()

Description copied from interface: Database

whether package constants should be included.

Specified by:

getIncludePackageConstants in interface Database

setIncludePackageConstants

public final void setIncludePackageConstants(boolean includePackageConstants)

Description copied from interface: Database

whether package constants should be included.

Specified by:

setIncludePackageConstants in interface Database

getIncludeXMLSchemaCollections

public final boolean getIncludeXMLSchemaCollections()

Description copied from interface: Database

whether XML schema collections should be included.

Specified by:

getIncludeXMLSchemaCollections in interface Database

setIncludeXMLSchemaCollections

public final void setIncludeXMLSchemaCollections(boolean includeXMLSchemaCollections)

Description copied from interface: Database

whether XML schema collections should be included.

Specified by:

setIncludeXMLSchemaCollections in interface Database

getIncludeUDTs

public final boolean getIncludeUDTs()

Description copied from interface: Database

whether user defined types should be included.

Specified by:

getIncludeUDTs in interface Database

setIncludeUDTs

public final void setIncludeUDTs(boolean includeUDTs)

Description copied from interface: Database

whether user defined types should be included.

Specified by:

setIncludeUDTs in interface Database

getIncludeDomains

public final boolean getIncludeDomains()

Description copied from interface: Database

whether domains should be included.

Specified by:

getIncludeDomains in interface Database

setIncludeDomains

public final void setIncludeDomains(boolean includeDomains)

Description copied from interface: Database

whether domains should be included.

Specified by:

setIncludeDomains in interface Database

getIncludeSequences

public final boolean getIncludeSequences()

Description copied from interface: Database

whether sequences should be included.

Specified by:

getIncludeSequences in interface Database

setIncludeSequences

public final void setIncludeSequences(boolean includeSequences)

Description copied from interface: Database

whether sequences should be included.

Specified by:

setIncludeSequences in interface Database

setIncludeCheckConstraints

public final void setIncludeCheckConstraints(boolean includeCheckConstraints)

Description copied from interface: Database

whether check constraints should be included.

Specified by:

setIncludeCheckConstraints in interface Database

getIncludeCheckConstraints

public final boolean getIncludeCheckConstraints()

Description copied from interface: Database

whether check constraints should be included.

Specified by:

getIncludeCheckConstraints in interface Database

setIncludeSystemTables

public final void setIncludeSystemTables(boolean includeSystemTables)

Description copied from interface: Database

whether system generated tables should be included.

Specified by:

setIncludeSystemTables in interface Database

getIncludeSystemTables

public final boolean getIncludeSystemTables()

Description copied from interface: Database

whether system generated tables should be included.

Specified by:

getIncludeSystemTables in interface Database

setIncludeSystemIndexes

public final void setIncludeSystemIndexes(boolean includeSystemIndexes)

Description copied from interface: Database

whether system generated indexes should be included.

Specified by:

setIncludeSystemIndexes in interface Database

getIncludeSystemIndexes

public final boolean getIncludeSystemIndexes()

Description copied from interface: Database

whether system generated indexes should be included.

Specified by:

getIncludeSystemIndexes in interface Database

setIncludeSystemCheckConstraints

public final void setIncludeSystemCheckConstraints(boolean includeSystemCheckConstraints)

Description copied from interface: Database

whether system generated check constraints should be included.

Specified by:

setIncludeSystemCheckConstraints in interface Database

getIncludeSystemCheckConstraints

public final boolean getIncludeSystemCheckConstraints()

Description copied from interface: Database

whether system generated check constraints should be included.

Specified by:

getIncludeSystemCheckConstraints in interface Database

setIncludeSystemSequences

public final void setIncludeSystemSequences(boolean includeSystemSequences)

Description copied from interface: Database

whether system generated sequences should be included.

Specified by:

setIncludeSystemSequences in interface Database

getIncludeSystemSequences

public final boolean getIncludeSystemSequences()

Description copied from interface: Database

whether system generated sequences should be included.

Specified by:

getIncludeSystemSequences in interface Database

setIncludeSystemUDTs

public final void setIncludeSystemUDTs(boolean includeSystemUDTs)

Description copied from interface: Database

whether system generated UDTs should be included.

Specified by:

setIncludeSystemUDTs in interface Database

getIncludeSystemUDTs

public final boolean getIncludeSystemUDTs()

Description copied from interface: Database

whether system generated UDTs should be included.

Specified by:

getIncludeSystemUDTs in interface Database

setIncludeIndexes

public final void setIncludeIndexes(boolean includeIndexes)

Description copied from interface: Database

whether indexes should be included.

Specified by:

setIncludeIndexes in interface Database

getIncludeIndexes

public final boolean getIncludeIndexes()

Description copied from interface: Database

whether indexes should be included.

Specified by:

getIncludeIndexes in interface Database

getIncludePrimaryKeys

public final boolean getIncludePrimaryKeys()

Description copied from interface: Database

whether primary keys should be included.

Specified by:

getIncludePrimaryKeys in interface Database

setIncludePrimaryKeys

public final void setIncludePrimaryKeys(boolean includePrimaryKeys)

Description copied from interface: Database

whether primary keys should be included.

Specified by:

setIncludePrimaryKeys in interface Database

getIncludeUniqueKeys

public final boolean getIncludeUniqueKeys()

Description copied from interface: Database

whether unique keys should be included.

Specified by:

getIncludeUniqueKeys in interface Database

setIncludeUniqueKeys

public final void setIncludeUniqueKeys(boolean includeUniqueKeys)

Description copied from interface: Database

whether unique keys should be included.

Specified by:

setIncludeUniqueKeys in interface Database

getIncludeForeignKeys

public final boolean getIncludeForeignKeys()

Description copied from interface: Database

whether foreign key relationships should be included.

Specified by:

getIncludeForeignKeys in interface Database

setIncludeForeignKeys

public final void setIncludeForeignKeys(boolean includeForeignKeys)

Description copied from interface: Database

whether foreign key relationships should be included.

Specified by:

setIncludeForeignKeys in interface Database

setRegexFlags

public final void setRegexFlags(List<RegexFlag> regexFlags)

Description copied from interface: Database

The regular expression flags that should be applied when using regular expressions.

Specified by:

setRegexFlags in interface Database

getRegexFlags

public final List<RegexFlag> getRegexFlags()

Description copied from interface: Database

The regular expression flags that should be applied when using regular expressions.

Specified by:

getRegexFlags in interface Database

setRegexMatchesPartialQualification

public final void setRegexMatchesPartialQualification(boolean regexMatchesPartialQualification)

Description copied from interface: Database

Whether the regular expressions matching database objects should match partially qualified names as well as fully qualified and unqualified names.

Specified by:

setRegexMatchesPartialQualification in interface Database

getRegexMatchesPartialQualification

public final boolean getRegexMatchesPartialQualification()

Description copied from interface: Database

Whether the regular expressions matching database objects should match partially qualified names as well as fully qualified and unqualified names.

Specified by:

getRegexMatchesPartialQualification in interface Database

setSqlMatchesPartialQualification

public final void setSqlMatchesPartialQualification(boolean sqlMatchesPartialQualification)

Description copied from interface: Database

Whether the SQL statements matching database objects should match partially qualified names as well as fully qualified and unqualified names.

Specified by:

setSqlMatchesPartialQualification in interface Database

getSqlMatchesPartialQualification

public final boolean getSqlMatchesPartialQualification()

Description copied from interface: Database

Whether the SQL statements matching database objects should match partially qualified names as well as fully qualified and unqualified names.

Specified by:

getSqlMatchesPartialQualification in interface Database

setRecordVersionFields

public void setRecordVersionFields(String[] recordVersionFields)

Description copied from interface: Database

Table columns matching these regular expressions will be considered as record version fields in generated code.

Specified by:

setRecordVersionFields in interface Database

getRecordVersionFields

public String[] getRecordVersionFields()

Description copied from interface: Database

Table columns matching these regular expressions will be considered as record version fields in generated code.

Specified by:

getRecordVersionFields in interface Database

setRecordTimestampFields

public void setRecordTimestampFields(String[] recordTimestampFields)

Description copied from interface: Database

Table columns matching these regular expressions will be considered as record timestamp fields in generated code.

Specified by:

setRecordTimestampFields in interface Database

getRecordTimestampFields

public String[] getRecordTimestampFields()

Description copied from interface: Database

Table columns matching these regular expressions will be considered as record timestamp fields in generated code.

Specified by:

getRecordTimestampFields in interface Database

setSyntheticPrimaryKeys

@Deprecated
public void setSyntheticPrimaryKeys(String[] syntheticPrimaryKeys)

Deprecated.

Description copied from interface: Database

Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.

Specified by:

setSyntheticPrimaryKeys in interface Database

getSyntheticPrimaryKeys

@Deprecated
public String[] getSyntheticPrimaryKeys()

Deprecated.

Description copied from interface: Database

Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.

Specified by:

getSyntheticPrimaryKeys in interface Database

setOverridePrimaryKeys

@Deprecated
public void setOverridePrimaryKeys(String[] overridePrimaryKeys)

Deprecated.

Description copied from interface: Database

Unique keys matching these regular expressions will be considered as primary keys in generated code.

Specified by:

setOverridePrimaryKeys in interface Database

getOverridePrimaryKeys

@Deprecated
public String[] getOverridePrimaryKeys()

Deprecated.

Description copied from interface: Database

Unique keys matching these regular expressions will be considered as primary keys in generated code.

Specified by:

getOverridePrimaryKeys in interface Database

setSyntheticIdentities

@Deprecated
public void setSyntheticIdentities(String[] syntheticIdentities)

Deprecated.

Description copied from interface: Database

Columns matching these regular expressions will be considered as identity columns in generated code.

Specified by:

setSyntheticIdentities in interface Database

getSyntheticIdentities

@Deprecated
public final String[] getSyntheticIdentities()

Deprecated.

Description copied from interface: Database

Columns matching these regular expressions will be considered as identity columns in generated code.

Specified by:

getSyntheticIdentities in interface Database

setConfiguredEnumTypes

public final void setConfiguredEnumTypes(List<EnumType> configuredEnumTypes)

Description copied from interface: Database

Database objects matching any of these field names will be generated as enum types.

Specified by:

setConfiguredEnumTypes in interface Database

getConfiguredEnumTypes

public final List<EnumType> getConfiguredEnumTypes()

Description copied from interface: Database

Database objects matching any of these field names will be generated as enum types.

Specified by:

getConfiguredEnumTypes in interface Database

setConfiguredCustomTypes

@Deprecated
public final void setConfiguredCustomTypes(List<CustomType> configuredCustomTypes)

Deprecated.

Description copied from interface: Database

Database objects matching any of these field names will be generated as custom types.

Specified by:

setConfiguredCustomTypes in interface Database

getConfiguredCustomTypes

@Deprecated
public final List<CustomType> getConfiguredCustomTypes()

Deprecated.

Description copied from interface: Database

Database objects matching any of these field names will be generated as custom types.

Specified by:

getConfiguredCustomTypes in interface Database

getConfiguredCustomType

@Deprecated
public final CustomType getConfiguredCustomType(String typeName)

Deprecated.

Description copied from interface: Database

Get a specific configured custom type by its name.

Specified by:

getConfiguredCustomType in interface Database

markUsed

public void markUsed(ForcedType forcedType)

Description copied from interface: Database

Mark a forced type as used.

Specified by:

markUsed in interface Database

getUnusedForcedTypes

public List<ForcedType> getUnusedForcedTypes()

Description copied from interface: Database

Retrieve the not-yet used forced types.

Specified by:

getUnusedForcedTypes in interface Database

setConfiguredForcedTypes

public final void setConfiguredForcedTypes(List<ForcedType> configuredForcedTypes)

Description copied from interface: Database

Database objects matching any of these field names will be generated as forced types.

Specified by:

setConfiguredForcedTypes in interface Database

getConfiguredForcedTypes

public final List<ForcedType> getConfiguredForcedTypes()

Description copied from interface: Database

Database objects matching any of these field names will be generated as forced types.

Specified by:

getConfiguredForcedTypes in interface Database

getForcedTypesForBuiltinDataTypeExtensions

public boolean getForcedTypesForBuiltinDataTypeExtensions()

Description copied from interface: Database

Whether some additional forced types for built in data type extensions, such as the ones from jooq-codegen-postgres should be added.

Specified by:

getForcedTypesForBuiltinDataTypeExtensions in interface Database

setForcedTypesForBuiltinDataTypeExtensions

public void setForcedTypesForBuiltinDataTypeExtensions(boolean forcedTypesForBuiltinDataTypeExtensions)

Description copied from interface: Database

Whether some additional forced types for built in data type extensions, such as the ones from jooq-codegen-postgres should be added.

Specified by:

setForcedTypesForBuiltinDataTypeExtensions in interface Database

getForcedTypesForXMLSchemaCollections

public boolean getForcedTypesForXMLSchemaCollections()

Description copied from interface: Database

Whether some additional forced types for XMLSchemaCollectionDefinition types should be created automatically for columns that have non-ambiguous references to an XMLTypeDefinition.

This feature is available in the commercial distribution only.

Specified by:

getForcedTypesForXMLSchemaCollections in interface Database

setForcedTypesForXMLSchemaCollections

public void setForcedTypesForXMLSchemaCollections(boolean forcedTypesForXMLSchemaCollections)

Description copied from interface: Database

Whether some additional forced types for XMLSchemaCollectionDefinition types should be created automatically for columns that have non-ambiguous references to an XMLTypeDefinition.

This feature is available in the commercial distribution only.

Specified by:

setForcedTypesForXMLSchemaCollections in interface Database

getLogSlowQueriesAfterSeconds

public final int getLogSlowQueriesAfterSeconds()

Description copied from interface: Database

Log slow queries after this amount of seconds.

Specified by:

getLogSlowQueriesAfterSeconds in interface Database

setLogSlowQueriesAfterSeconds

public final void setLogSlowQueriesAfterSeconds(int logSlowQueriesAfterSeconds)

Description copied from interface: Database

Log slow queries after this amount of seconds.

Specified by:

setLogSlowQueriesAfterSeconds in interface Database

getLogSlowResultsAfterSeconds

public final int getLogSlowResultsAfterSeconds()

Description copied from interface: Database

Log slow results after this amount of seconds.

Specified by:

getLogSlowResultsAfterSeconds in interface Database

setLogSlowResultsAfterSeconds

public final void setLogSlowResultsAfterSeconds(int logSlowResultsAfterSeconds)

Description copied from interface: Database

Log slow results after this amount of seconds.

Specified by:

setLogSlowResultsAfterSeconds in interface Database

getSchemaVersionProvider

public final SchemaVersionProvider getSchemaVersionProvider()

Description copied from interface: Database

The database's schema version provider.

Specified by:

getSchemaVersionProvider in interface Database

setSchemaVersionProvider

public final void setSchemaVersionProvider(SchemaVersionProvider schemaVersionProvider)

Description copied from interface: Database

The database's schema version provider.

Specified by:

setSchemaVersionProvider in interface Database

getCatalogVersionProvider

public final CatalogVersionProvider getCatalogVersionProvider()

Description copied from interface: Database

The database's catalog version provider.

Specified by:

getCatalogVersionProvider in interface Database

setCatalogVersionProvider

public final void setCatalogVersionProvider(CatalogVersionProvider catalogVersionProvider)

Description copied from interface: Database

The database's catalog version provider.

Specified by:

setCatalogVersionProvider in interface Database

getOrderProvider

public final Comparator<Definition> getOrderProvider()

Description copied from interface: Database

The database's order provider.

Specified by:

getOrderProvider in interface Database

setOrderProvider

public final void setOrderProvider(Comparator<Definition> provider)

Description copied from interface: Database

The database's order provider.

Specified by:

setOrderProvider in interface Database

setSupportsUnsignedTypes

public final void setSupportsUnsignedTypes(boolean supportsUnsignedTypes)

Description copied from interface: Database

Whether this database supports unsigned types.

Specified by:

setSupportsUnsignedTypes in interface Database

supportsUnsignedTypes

public final boolean supportsUnsignedTypes()

Description copied from interface: Database

Whether this database supports unsigned types.

Specified by:

supportsUnsignedTypes in interface Database

setIntegerDisplayWidths

public final void setIntegerDisplayWidths(boolean integerDisplayWidths)

Description copied from interface: Database

Whether this database includes integer display widths in metadata, where applicable.

Specified by:

setIntegerDisplayWidths in interface Database

integerDisplayWidths

public final boolean integerDisplayWidths()

Description copied from interface: Database

Whether this database includes integer display widths in metadata, where applicable.

Specified by:

integerDisplayWidths in interface Database

setIgnoreProcedureReturnValues

public final void setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues)

Description copied from interface: Database

Whether this database should ignore procedure return values.

Specified by:

setIgnoreProcedureReturnValues in interface Database

ignoreProcedureReturnValues

public final boolean ignoreProcedureReturnValues()

Description copied from interface: Database

Whether this database should ignore procedure return values.

Specified by:

ignoreProcedureReturnValues in interface Database

setDateAsTimestamp

public final void setDateAsTimestamp(boolean dateAsTimestamp)

Description copied from interface: Database

Whether DATE columns should be treated as TIMESTAMP columns.

Specified by:

setDateAsTimestamp in interface Database

dateAsTimestamp

public final boolean dateAsTimestamp()

Description copied from interface: Database

Whether DATE columns should be treated as TIMESTAMP columns.

Specified by:

dateAsTimestamp in interface Database

setJavaTimeTypes

public final void setJavaTimeTypes(boolean javaTimeTypes)

Description copied from interface: Database

Whether java.time types are used, as opposed to java.sql types.

Specified by:

setJavaTimeTypes in interface Database

javaTimeTypes

public final boolean javaTimeTypes()

Description copied from interface: Database

Whether java.time types are used, as opposed to java.sql types.

Specified by:

javaTimeTypes in interface Database

setIncludeRelations

public final void setIncludeRelations(boolean includeRelations)

Description copied from interface: Database

[#3559] Whether relations (i.e. constraints) should be included in this database.

Specified by:

setIncludeRelations in interface Database

includeRelations

public final boolean includeRelations()

Description copied from interface: Database

[#3559] Whether relations (i.e. constraints) should be included in this database.

Specified by:

includeRelations in interface Database

setForceIntegerTypesOnZeroScaleDecimals

public void setForceIntegerTypesOnZeroScaleDecimals(boolean forceIntegerTypesOnZeroScaleDecimals)

Description copied from interface: Database

Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.

Specified by:

setForceIntegerTypesOnZeroScaleDecimals in interface Database

getForceIntegerTypesOnZeroScaleDecimals

public boolean getForceIntegerTypesOnZeroScaleDecimals()

Description copied from interface: Database

Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.

Specified by:

getForceIntegerTypesOnZeroScaleDecimals in interface Database

setTableValuedFunctions

public final void setTableValuedFunctions(boolean tableValuedFunctions)

Description copied from interface: Database

[#4838] Whether table-valued functions should be reported as tables.

Specified by:

setTableValuedFunctions in interface Database

tableValuedFunctions

public final boolean tableValuedFunctions()

Description copied from interface: Database

[#4838] Whether table-valued functions should be reported as tables.

Specified by:

tableValuedFunctions in interface Database

getSequences

public final List<SequenceDefinition> getSequences()

Description copied from interface: Database

The sequences contained in this database.

Specified by:

getSequences in interface Database

getSequences

public final List<SequenceDefinition> getSequences(SchemaDefinition schema)

Description copied from interface: Database

The sequences contained in this database.

Specified by:

getSequences in interface Database

getIdentities

public final List<IdentityDefinition> getIdentities(SchemaDefinition schema)

Description copied from interface: Database

The identities contained in this database.

Specified by:

getIdentities in interface Database

getUniqueKeys

public final List<UniqueKeyDefinition> getUniqueKeys()

Description copied from interface: Database

The unique keys contained in this database.

Specified by:

getUniqueKeys in interface Database

getPrimaryKeys

public final List<UniqueKeyDefinition> getPrimaryKeys(SchemaDefinition schema)

Description copied from interface: Database

The primary keys contained in this database.

Specified by:

getPrimaryKeys in interface Database

getPrimaryKeys

public final List<UniqueKeyDefinition> getPrimaryKeys()

Description copied from interface: Database

The primary keys contained in this database.

Specified by:

getPrimaryKeys in interface Database

getUniqueKeys

public final List<UniqueKeyDefinition> getUniqueKeys(SchemaDefinition schema)

Description copied from interface: Database

The unique keys contained in this database.

Specified by:

getUniqueKeys in interface Database

getKeys

public final List<UniqueKeyDefinition> getKeys()

Description copied from interface: Database

The unique and primary keys contained in this database.

Specified by:

getKeys in interface Database

getKeys

public final List<UniqueKeyDefinition> getKeys(SchemaDefinition schema)

Description copied from interface: Database

The unique and primary keys contained in this database.

Specified by:

getKeys in interface Database

getForeignKeys

public final List<ForeignKeyDefinition> getForeignKeys()

Description copied from interface: Database

The foreign keys contained in this database.

Specified by:

getForeignKeys in interface Database

getForeignKeys

public final List<ForeignKeyDefinition> getForeignKeys(SchemaDefinition schema)

Description copied from interface: Database

The foreign keys contained in this database.

Specified by:

getForeignKeys in interface Database

getCheckConstraints

public final List<CheckConstraintDefinition> getCheckConstraints(SchemaDefinition schema)

Description copied from interface: Database

The check constraints contained in this database.

Specified by:

getCheckConstraints in interface Database

getTables

public final List<TableDefinition> getTables()

Description copied from interface: Database

The tables contained in this database.

Specified by:

getTables in interface Database

getTables

public final List<TableDefinition> getTables(SchemaDefinition schema)

Description copied from interface: Database

The tables contained in this database.

Specified by:

getTables in interface Database

getTable

public final TableDefinition getTable(SchemaDefinition schema,
 String name)

Description copied from interface: Database

Get a table in this database by name.

Specified by:

getTable in interface Database

getTable

public final TableDefinition getTable(SchemaDefinition schema,
 String name,
 boolean ignoreCase)

Description copied from interface: Database

Get a table in this database by name.

Specified by:

getTable in interface Database

getTable

public final TableDefinition getTable(SchemaDefinition schema,
 Name name)

Description copied from interface: Database

Get a table in this database by name.

Specified by:

getTable in interface Database

getTable

public final TableDefinition getTable(SchemaDefinition schema,
 Name name,
 boolean ignoreCase)

Description copied from interface: Database

Get a table in this database by name.

Specified by:

getTable in interface Database

getEnums

public final List<EnumDefinition> getEnums(SchemaDefinition schema)

Description copied from interface: Database

The enum UDTs defined in this database.

Specified by:

getEnums in interface Database

getConfiguredForcedType

public final ForcedType getConfiguredForcedType(Definition definition)

Description copied from interface: Database

Get the configured forced type object for any given Definition, or null if no ForcedType matches the definition.

Specified by:

getConfiguredForcedType in interface Database

getConfiguredForcedType

public final ForcedType getConfiguredForcedType(Definition definition,
 DataTypeDefinition definedType)

Description copied from interface: Database

Get the configured forced type object for any given Definition, or null if no ForcedType matches the definition.

Specified by:

getConfiguredForcedType in interface Database

markUsed

public final void markUsed(EmbeddableDefinitionType embeddable)

Description copied from interface: Database

Mark an embeddable as used.

Specified by:

markUsed in interface Database

getUnusedEmbeddables

public final List<EmbeddableDefinitionType> getUnusedEmbeddables()

Description copied from interface: Database

Retrieve the not-yet used embeddables.

Specified by:

getUnusedEmbeddables in interface Database

setConfiguredEmbeddables

public final void setConfiguredEmbeddables(List<EmbeddableDefinitionType> configuredEmbeddables)

Description copied from interface: Database

Configure the embeddable types.

Specified by:

setConfiguredEmbeddables in interface Database

getConfiguredEmbeddables

public final List<EmbeddableDefinitionType> getConfiguredEmbeddables()

Description copied from interface: Database

Get the configured embeddable type definitions for any given Definition.

Specified by:

getConfiguredEmbeddables in interface Database

embeddablePrimaryKeys

public String embeddablePrimaryKeys()

Description copied from interface: Database

A regular expression matching primary keys for which embeddable types should be generated.

This feature is available in the commercial distribution only.

Specified by:

embeddablePrimaryKeys in interface Database

setEmbeddablePrimaryKeys

public void setEmbeddablePrimaryKeys(String embeddablePrimaryKeys)

Description copied from interface: Database

A regular expression matching primary keys for which embeddable types should be generated.

This feature is available in the commercial distribution only.

Specified by:

setEmbeddablePrimaryKeys in interface Database

embeddableUniqueKeys

public String embeddableUniqueKeys()

Description copied from interface: Database

A regular expression matching unique keys for which embeddable types should be generated.

This feature is available in the commercial distribution only.

Specified by:

embeddableUniqueKeys in interface Database

setEmbeddableUniqueKeys

public void setEmbeddableUniqueKeys(String embeddableUniqueKeys)

Description copied from interface: Database

A regular expression matching unique keys for which embeddable types should be generated.

This feature is available in the commercial distribution only.

Specified by:

setEmbeddableUniqueKeys in interface Database

embeddableDomains

public String embeddableDomains()

Description copied from interface: Database

A regular expression matching domain type definitions for which embeddable types should be generated.

This feature is available in the commercial distribution only.

Specified by:

embeddableDomains in interface Database

setEmbeddableDomains

public void setEmbeddableDomains(String embeddableDomains)

Description copied from interface: Database

A regular expression matching domain type definitions for which embeddable types should be generated.

This feature is available in the commercial distribution only.

Specified by:

setEmbeddableDomains in interface Database

readonlyIdentities

public boolean readonlyIdentities()

Description copied from interface: Database

Whether identity columns should expose DataType.readonly() behaviour.

This feature is available in the commercial distribution only.

Specified by:

readonlyIdentities in interface Database

setReadonlyIdentities

public void setReadonlyIdentities(boolean readonlyIdentities)

Description copied from interface: Database

Whether identity columns should expose DataType.readonly() behaviour.

This feature is available in the commercial distribution only.

Specified by:

setReadonlyIdentities in interface Database

readonlyComputedColumns

public boolean readonlyComputedColumns()

Description copied from interface: Database

Whether computed columns columns should expose DataType.readonly() behaviour.

This feature is available in the commercial distribution only.

Specified by:

readonlyComputedColumns in interface Database

setReadonlyComputedColumns

public void setReadonlyComputedColumns(boolean readonlyComputedColumns)

Description copied from interface: Database

Whether computed columns columns should expose DataType.readonly() behaviour.

This feature is available in the commercial distribution only.

Specified by:

setReadonlyComputedColumns in interface Database

readonlyNonUpdatableColumns

public boolean readonlyNonUpdatableColumns()

Description copied from interface: Database

Whether columns that are known not to be updatable (e.g. in views) should expose DataType.readonly() behaviour.

This feature is available in the commercial distribution only.

Specified by:

readonlyNonUpdatableColumns in interface Database

setReadonlyNonUpdatableColumns

public void setReadonlyNonUpdatableColumns(boolean readonlyNonUpdatableColumns)

Description copied from interface: Database

Whether columns that are known not to be updatable (e.g. in views) should expose DataType.readonly() behaviour.

This feature is available in the commercial distribution only.

Specified by:

setReadonlyNonUpdatableColumns in interface Database

getEmbeddables

public final List<EmbeddableDefinition> getEmbeddables()

Description copied from interface: Database

Get all embeddables.

Specified by:

getEmbeddables in interface Database

getEmbeddables

public final List<EmbeddableDefinition> getEmbeddables(SchemaDefinition schema)

Description copied from interface: Database

Get all embeddables for a given defining schema.

Specified by:

getEmbeddables in interface Database

getEmbeddables

public final List<EmbeddableDefinition> getEmbeddables(TableDefinition table)

Description copied from interface: Database

Get all embeddables for a given defining table.

Specified by:

getEmbeddables in interface Database

getEmbeddablesByReferencingTable

public final List<EmbeddableDefinition> getEmbeddablesByReferencingTable(TableDefinition table)

Description copied from interface: Database

Get all embeddables for a given referencing table.

Specified by:

getEmbeddablesByReferencingTable in interface Database

getEnum

public final EnumDefinition getEnum(SchemaDefinition schema,
 String name)

Description copied from interface: Database

Get an enum UDT defined in this database by name.

Specified by:

getEnum in interface Database

getEnum

public final EnumDefinition getEnum(SchemaDefinition schema,
 String name,
 boolean ignoreCase)

Description copied from interface: Database

Get an enum UDT defined in this database by name.

Specified by:

getEnum in interface Database

getEnum

public final EnumDefinition getEnum(SchemaDefinition schema,
 Name name)

Description copied from interface: Database

Get an enum UDT defined in this database by name.

Specified by:

getEnum in interface Database

getEnum

public final EnumDefinition getEnum(SchemaDefinition schema,
 Name name,
 boolean ignoreCase)

Description copied from interface: Database

Get an enum UDT defined in this database by name.

Specified by:

getEnum in interface Database

getDomains

public final List<DomainDefinition> getDomains()

Description copied from interface: Database

The domain UDTs defined in this database.

Specified by:

getDomains in interface Database

getDomains

public final List<DomainDefinition> getDomains(SchemaDefinition schema)

Description copied from interface: Database

The domain UDTs defined in this database.

Specified by:

getDomains in interface Database

getDomain

public final DomainDefinition getDomain(SchemaDefinition schema,
 String name)

Description copied from interface: Database

Get an domain UDT defined in this database by name.

Specified by:

getDomain in interface Database

getDomain

public final DomainDefinition getDomain(SchemaDefinition schema,
 String name,
 boolean ignoreCase)

Description copied from interface: Database

Get an domain UDT defined in this database by name.

Specified by:

getDomain in interface Database

getDomain

public final DomainDefinition getDomain(SchemaDefinition schema,
 Name name)

Description copied from interface: Database

Get an domain UDT defined in this database by name.

Specified by:

getDomain in interface Database

getDomain

public final DomainDefinition getDomain(SchemaDefinition schema,
 Name name,
 boolean ignoreCase)

Description copied from interface: Database

Get an domain UDT defined in this database by name.

Specified by:

getDomain in interface Database

getArrays

public final List<ArrayDefinition> getArrays(SchemaDefinition schema)

Description copied from interface: Database

The Arrays defined in this database.

Specified by:

getArrays in interface Database

getArray

public final ArrayDefinition getArray(SchemaDefinition schema,
 String name)

Description copied from interface: Database

Get a ARRAY defined in this database by name.

Specified by:

getArray in interface Database

getArray

public final ArrayDefinition getArray(SchemaDefinition schema,
 String name,
 boolean ignoreCase)

Description copied from interface: Database

Get a ARRAY defined in this database by name.

Specified by:

getArray in interface Database

getArray

public final ArrayDefinition getArray(SchemaDefinition schema,
 Name name)

Description copied from interface: Database

Get a ARRAY defined in this database by name.

Specified by:

getArray in interface Database

getArray

public final ArrayDefinition getArray(SchemaDefinition schema,
 Name name,
 boolean ignoreCase)

Description copied from interface: Database

Get a ARRAY defined in this database by name.

Specified by:

getArray in interface Database

getUDTs

public final List<UDTDefinition> getUDTs()

Description copied from interface: Database

The UDTs defined in this database.

Specified by:

getUDTs in interface Database

getUDTs

public final List<UDTDefinition> getUDTs(SchemaDefinition schema)

Description copied from interface: Database

The UDTs defined in this database.

Specified by:

getUDTs in interface Database

getUDT

public final UDTDefinition getUDT(SchemaDefinition schema,
 String name)

Description copied from interface: Database

Get a UDT defined in this database by name.

Specified by:

getUDT in interface Database

getUDT

public final UDTDefinition getUDT(SchemaDefinition schema,
 String name,
 boolean ignoreCase)

Description copied from interface: Database

Get a UDT defined in this database by name.

Specified by:

getUDT in interface Database

getUDT

public final UDTDefinition getUDT(SchemaDefinition schema,
 Name name)

Description copied from interface: Database

Get a UDT defined in this database by name.

Specified by:

getUDT in interface Database

getUDT

public final UDTDefinition getUDT(SchemaDefinition schema,
 Name name,
 boolean ignoreCase)

Description copied from interface: Database

Get a UDT defined in this database by name.

Specified by:

getUDT in interface Database

getUDTs

public final List<UDTDefinition> getUDTs(PackageDefinition pkg)

Description copied from interface: Database

The UDTs defined in this database.

Specified by:

getUDTs in interface Database

getRelations

public final Relations getRelations()

Description copied from interface: Database

Retrieve the schema's primary key / foreign key relations.

Specified by:

getRelations in interface Database

getIndexes

public final List<IndexDefinition> getIndexes(SchemaDefinition schema)

Description copied from interface: Database

The indexes contained in this database.

Specified by:

getIndexes in interface Database

getIndexes

public final List<IndexDefinition> getIndexes(TableDefinition table)

Description copied from interface: Database

The indexes contained in this database.

Specified by:

getIndexes in interface Database

getRoutines

public final List<RoutineDefinition> getRoutines(SchemaDefinition schema)

Description copied from interface: Database

The stored routines (procedures and functions) contained in this database.

Specified by:

getRoutines in interface Database

getPackages

public final List<PackageDefinition> getPackages(SchemaDefinition schema)

Description copied from interface: Database

The packages contained in this database.

Specified by:

getPackages in interface Database

getPackage

public PackageDefinition getPackage(SchemaDefinition schema,
 String inputName)

Description copied from interface: Database

Get a package defined in this database by name.

Specified by:

getPackage in interface Database

getDefinition

protected static final <D extends Definition> D getDefinition(List<D> definitions,
 String name,
 boolean ignoreCase)

getDefinition

protected static final <D extends Definition> D getDefinition(List<D> definitions,
 Name name,
 boolean ignoreCase)

filterSchema

protected final <T extends Definition> List<T> filterSchema(List<T> definitions,
 SchemaDefinition schema,
 Map<SchemaDefinition,List<T>> cache)

filterSchema

protected final <T extends Definition> List<T> filterSchema(List<T> definitions,
 SchemaDefinition schema)

filterPackage

protected final <T extends Definition> List<T> filterPackage(List<T> definitions,
 PackageDefinition pkg,
 Map<PackageDefinition,List<T>> cache)

filterPackage

protected final <T extends Definition> List<T> filterPackage(List<T> definitions,
 PackageDefinition pkg)

filterTable

protected final <T extends TableElementDefinition>
List<T> filterTable(List<T> definitions,
 TableDefinition table,
 Map<TableDefinition,List<T>> cache)

filterTable

protected final <T extends TableElementDefinition>
List<T> filterTable(List<T> definitions,
 TableDefinition table)

filterExcludeInclude

public final <T extends Definition> List<T> filterExcludeInclude(List<T> definitions)

Description copied from interface: Database

Filter a list of definitions according to the exclude / include / and filter settings of this database.

Specified by:

filterExcludeInclude in interface Database

sort

public final <T extends Definition> List<T> sort(List<T> definitions)

Description copied from interface: Database

Sort a list of definitions according to the Database.getOrderProvider() defined in this database.

Specified by:

sort in interface Database

getIncluded

public final List<Definition> getIncluded()

Description copied from interface: Database

Retrieve all included objects.

Specified by:

getIncluded in interface Database

getExcluded

public final List<Definition> getExcluded()

Description copied from interface: Database

Retrieve all excluded objects.

Specified by:

getExcluded in interface Database

getAll

public final List<Definition> getAll()

Description copied from interface: Database

Retrieve all objects.

Specified by:

getAll in interface Database

filter

protected final <T extends Definition> List<T> filter(List<T> definitions,
 String include)

filter

protected final <T extends Definition> List<T> filter(List<T> definitions,
 List<String> include)

filterExcludeInclude

protected final <T extends Definition> List<T> filterExcludeInclude(List<T> definitions,
 String e,
 String i)

filterExcludeInclude

protected final <T extends Definition> List<T> filterExcludeInclude(List<T> definitions,
 String[] e,
 String[] i,
 List<Database.Filter> f)

getRelations0

protected final Relations getRelations0()

Retrieve ALL relations from the database.

isArrayType

public final boolean isArrayType(String dataType)

Description copied from interface: Database

Check whether a type is an array type.

Specified by:

isArrayType in interface Database

fetchedSize

protected static final String fetchedSize(Collection<?> fetched,
 Collection<?> included)

setConfiguredComments

public void setConfiguredComments(List<CommentType> configuredComments)

Description copied from interface: Database

Configure the comments.

Specified by:

setConfiguredComments in interface Database

getConfiguredComments

public List<CommentType> getConfiguredComments()

Description copied from interface: Database

Get the configured comments.

Specified by:

getConfiguredComments in interface Database

markUsed

public void markUsed(CommentType object)

Description copied from interface: Database

Mark a comment as used.

Specified by:

markUsed in interface Database

getUnusedComments

public List<CommentType> getUnusedComments()

Description copied from interface: Database

Retrieve the not-yet used comments.

Specified by:

getUnusedComments in interface Database

setConfiguredSyntheticObjects

public void setConfiguredSyntheticObjects(SyntheticObjectsType configuredSyntheticObjects)

Description copied from interface: Database

Configure the synthetic objects.

Specified by:

setConfiguredSyntheticObjects in interface Database

getConfiguredSyntheticColumns

public List<SyntheticColumnType> getConfiguredSyntheticColumns()

Description copied from interface: Database

Get the configured synthetic columns.

Specified by:

getConfiguredSyntheticColumns in interface Database

getConfiguredSyntheticReadonlyColumns

public List<SyntheticReadonlyColumnType> getConfiguredSyntheticReadonlyColumns()

Description copied from interface: Database

Get the configured synthetic readonly columns.

Specified by:

getConfiguredSyntheticReadonlyColumns in interface Database

getConfiguredSyntheticReadonlyRowids

public List<SyntheticReadonlyRowidType> getConfiguredSyntheticReadonlyRowids()

Description copied from interface: Database

Get the configured synthetic readonly rowids.

Specified by:

getConfiguredSyntheticReadonlyRowids in interface Database

getConfiguredSyntheticIdentities

public List<SyntheticIdentityType> getConfiguredSyntheticIdentities()

Description copied from interface: Database

Get the configured synthetic identities.

Specified by:

getConfiguredSyntheticIdentities in interface Database

getConfiguredSyntheticPrimaryKeys

public List<SyntheticPrimaryKeyType> getConfiguredSyntheticPrimaryKeys()

Description copied from interface: Database

Get the configured synthetic primary keys.

Specified by:

getConfiguredSyntheticPrimaryKeys in interface Database

getConfiguredSyntheticUniqueKeys

public List<SyntheticUniqueKeyType> getConfiguredSyntheticUniqueKeys()

Description copied from interface: Database

Get the configured synthetic unique keys.

Specified by:

getConfiguredSyntheticUniqueKeys in interface Database

getConfiguredSyntheticForeignKeys

public List<SyntheticForeignKeyType> getConfiguredSyntheticForeignKeys()

Description copied from interface: Database

Get the configured synthetic foreign keys.

Specified by:

getConfiguredSyntheticForeignKeys in interface Database

getConfiguredSyntheticViews

public List<SyntheticViewType> getConfiguredSyntheticViews()

Description copied from interface: Database

Get the configured synthetic views.

Specified by:

getConfiguredSyntheticViews in interface Database

getConfiguredSyntheticDaos

public List<SyntheticDaoType> getConfiguredSyntheticDaos()

Description copied from interface: Database

Get the configured synthetic DAOs.

Specified by:

getConfiguredSyntheticDaos in interface Database

markUsed

public void markUsed(SyntheticColumnType column)

Description copied from interface: Database

Mark a synthetic column as used.

Specified by:

markUsed in interface Database

markUsed

public void markUsed(SyntheticReadonlyColumnType readonlyColumn)

Description copied from interface: Database

Mark a synthetic readonly column as used.

Specified by:

markUsed in interface Database

markUsed

public void markUsed(SyntheticReadonlyRowidType readonlyRowid)

Description copied from interface: Database

Mark a synthetic readonly rowids as used.

Specified by:

markUsed in interface Database

markUsed

public void markUsed(SyntheticIdentityType identity)

Description copied from interface: Database

Mark a synthetic identity as used.

Specified by:

markUsed in interface Database

markUsed

public void markUsed(SyntheticPrimaryKeyType primaryKey)

Description copied from interface: Database

Mark a synthetic primary key as used.

Specified by:

markUsed in interface Database

markUsed

public void markUsed(SyntheticUniqueKeyType uniqueKey)

Description copied from interface: Database

Mark a synthetic unique key as used.

Specified by:

markUsed in interface Database

markUsed

public void markUsed(SyntheticForeignKeyType foreignKey)

Description copied from interface: Database

Mark a synthetic foreign key as used.

Specified by:

markUsed in interface Database

markUsed

public void markUsed(SyntheticViewType view)

Description copied from interface: Database

Mark a synthetic view as used.

Specified by:

markUsed in interface Database

getUnusedSyntheticColumns

public List<SyntheticColumnType> getUnusedSyntheticColumns()

Description copied from interface: Database

Retrieve the not-yet used synthetic columns.

Specified by:

getUnusedSyntheticColumns in interface Database

getUnusedSyntheticReadonlyColumns

public List<SyntheticReadonlyColumnType> getUnusedSyntheticReadonlyColumns()

Description copied from interface: Database

Retrieve the not-yet used synthetic readonly columns.

Specified by:

getUnusedSyntheticReadonlyColumns in interface Database

getUnusedSyntheticReadonlyRowids

public List<SyntheticReadonlyRowidType> getUnusedSyntheticReadonlyRowids()

Description copied from interface: Database

Retrieve the not-yet used synthetic readonly rowids.

Specified by:

getUnusedSyntheticReadonlyRowids in interface Database

getUnusedSyntheticIdentities

public List<SyntheticIdentityType> getUnusedSyntheticIdentities()

Description copied from interface: Database

Retrieve the not-yet used synthetic identities.

Specified by:

getUnusedSyntheticIdentities in interface Database

getUnusedSyntheticPrimaryKeys

public List<SyntheticPrimaryKeyType> getUnusedSyntheticPrimaryKeys()

Description copied from interface: Database

Retrieve the not-yet used synthetic primary keys.

Specified by:

getUnusedSyntheticPrimaryKeys in interface Database

getUnusedSyntheticUniqueKeys

public List<SyntheticUniqueKeyType> getUnusedSyntheticUniqueKeys()

Description copied from interface: Database

Retrieve the not-yet used synthetic unique keys.

Specified by:

getUnusedSyntheticUniqueKeys in interface Database

getUnusedSyntheticForeignKeys

public List<SyntheticForeignKeyType> getUnusedSyntheticForeignKeys()

Description copied from interface: Database

Retrieve the not-yet used synthetic foreign keys.

Specified by:

getUnusedSyntheticForeignKeys in interface Database

getUnusedSyntheticViews

public List<SyntheticViewType> getUnusedSyntheticViews()

Description copied from interface: Database

Retrieve the not-yet used synthetic views.

Specified by:

getUnusedSyntheticViews in interface Database

close

public void close()

Description copied from interface: Database

Release any resources that this Database may have allocated.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Database

create0

protected abstract DSLContext create0()

Create a new Factory

getSources0

protected Map<Definition,String> getSources0()
                                      throws SQLException

Retrieve ALL source code from the database.

Throws:

SQLException

getIndexes0

protected List<IndexDefinition> getIndexes0()
                                     throws SQLException

Retrieve ALL indexes from the database

Throws:

SQLException

loadPrimaryKeys

protected abstract void loadPrimaryKeys(DefaultRelations r)
                                 throws SQLException

Retrieve primary keys and store them to relations

Throws:

SQLException

loadUniqueKeys

protected abstract void loadUniqueKeys(DefaultRelations r)
                                throws SQLException

Retrieve non-primary unique keys and store them to relations

Throws:

SQLException

loadForeignKeys

protected abstract void loadForeignKeys(DefaultRelations r)
                                 throws SQLException

Retrieve foreign keys and store them to relations. Unique keys are already loaded.

Throws:

SQLException

loadCheckConstraints

protected abstract void loadCheckConstraints(DefaultRelations r)
                                      throws SQLException

Retrieve CHECK constraints and store them to relations.

Throws:

SQLException

getCatalogs0

protected abstract List<CatalogDefinition> getCatalogs0()
                                                 throws SQLException

Retrieve ALL catalogs from the database. This will be filtered in getCatalogs()

Throws:

SQLException

getSchemata0

protected abstract List<SchemaDefinition> getSchemata0()
                                                throws SQLException

Retrieve ALL schemata from the database. This will be filtered in getSchemata()

Throws:

SQLException

getSequences0

protected abstract List<SequenceDefinition> getSequences0()
                                                   throws SQLException

Retrieve ALL sequences from the database. This will be filtered in getTables(SchemaDefinition)

Throws:

SQLException

getTables0

protected abstract List<TableDefinition> getTables0()
                                             throws SQLException

Retrieve ALL tables from the database. This will be filtered in getTables(SchemaDefinition)

Throws:

SQLException

getRoutines0

protected abstract List<RoutineDefinition> getRoutines0()
                                                 throws SQLException

Retrieve ALL stored routines (functions and procedures) from the database. This will be filtered in getRoutines(SchemaDefinition)

Throws:

SQLException

getPackages0

protected abstract List<PackageDefinition> getPackages0()
                                                 throws SQLException

Retrieve ALL packages from the database. This will be filtered in getPackages(SchemaDefinition)

Throws:

SQLException

getEnums0

protected abstract List<EnumDefinition> getEnums0()
                                           throws SQLException

Retrieve ALL enum UDTs from the database. This will be filtered in getEnums(SchemaDefinition)

Throws:

SQLException

getDomains0

protected abstract List<DomainDefinition> getDomains0()
                                               throws SQLException

Retrieve ALL domain UDTs from the database. This will be filtered in getDomains(SchemaDefinition)

Throws:

SQLException

getXMLSchemaCollections0

protected abstract List<XMLSchemaCollectionDefinition> getXMLSchemaCollections0()
                                                                         throws SQLException

Retrieve ALL XML schema collections from the database. This will be filtered in getXMLSchemaCollections()

Throws:

SQLException

getUDTs0

protected abstract List<UDTDefinition> getUDTs0()
                                         throws SQLException

Retrieve ALL UDTs from the database. This will be filtered in getEnums(SchemaDefinition)

Throws:

SQLException

getArrays0

protected abstract List<ArrayDefinition> getArrays0()
                                             throws SQLException

Retrieve ALL ARRAYs from the database. This will be filtered in getArrays(SchemaDefinition)

Throws:

SQLException

getDataTypeForMAX_VAL

protected final DataTypeDefinition getDataTypeForMAX_VAL(SchemaDefinition schema,
 BigInteger value)

Get the data type considering a known max value

overload

protected final Field<Integer> overload(Field<String> schema,
 Field<String> name,
 Field<String> order)