Database (jOOQ Meta 3.11.9 API)

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractDatabase, CUBRIDDatabase, DerbyDatabase, FirebirdDatabase, H2Database, HSQLDBDatabase, JDBCDatabase, MariaDBDatabase, MySQLDatabase, PostgresDatabase, SQLiteDatabase, XMLDatabase
```
public interface Database
extends AutoCloseable
```
A general database model.

Author:

Lukas Eder

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Database.Filter
A filter type that can be used with addFilter(Filter)

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Database.Filter` A filter type that can be used with `addFilter(Filter)`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`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.
`DSLContext`	`create()` Create the factory for this database.
`boolean`	`dateAsTimestamp()` Whether DATE columns should be treated as TIMESTAMP columns.
`boolean`	`existAll(Table<?>... tables)` Check for the existence of several tables in the dictionary views.
`boolean`	`exists(Table<?> table)` Check for the existence of a table in the dictionary views.
`<D extends Definition> List<D>`	`filterExcludeInclude(List<D> definitions)` Filter a list of definitions according to the exclude / include / and filter settings of this database.
`List<Definition>`	`getAll()` Retrieve all objects.
`ArrayDefinition`	`getArray(SchemaDefinition schema, Name name)` Get a ARRAY defined in this database by name.
`ArrayDefinition`	`getArray(SchemaDefinition schema, Name name, boolean ignoreCase)` Get a ARRAY defined in this database by name.
`ArrayDefinition`	`getArray(SchemaDefinition schema, String name)` Get a ARRAY defined in this database by name.
`ArrayDefinition`	`getArray(SchemaDefinition schema, String name, boolean ignoreCase)` Get a ARRAY defined in this database by name.
`List<ArrayDefinition>`	`getArrays(SchemaDefinition schema)` The Arrays defined in this database.
`CatalogDefinition`	`getCatalog(String name)` Get a catalog defined in this database by name.
`List<CatalogDefinition>`	`getCatalogs()` The catalogs generated from this database.
`CatalogVersionProvider`	`getCatalogVersionProvider()` The database's catalog version provider.
`List<CheckConstraintDefinition>`	`getCheckConstraints(SchemaDefinition schema)` The check constraints contained in this database.
`CustomType`	`getConfiguredCustomType(String name)` Deprecated. - 3.10.0 - [#5750] - Use `getConfiguredForcedTypes()` only.
`List<CustomType>`	`getConfiguredCustomTypes()` Deprecated. - 3.10.0 - [#5750] - Use `getConfiguredForcedTypes()` only.
`List<EnumType>`	`getConfiguredEnumTypes()` Database objects matching any of these field names will be generated as enum types.
`ForcedType`	`getConfiguredForcedType(Definition definition)` Get the configured forced type object for any given `Definition`, or `null` if no `ForcedType` matches the definition.
`ForcedType`	`getConfiguredForcedType(Definition definition, DataTypeDefinition definedType)` Get the configured forced type object for any given `Definition`, or `null` if no `ForcedType` matches the definition.
`List<ForcedType>`	`getConfiguredForcedTypes()` Database objects matching any of these field names will be generated as forced types.
`Connection`	`getConnection()` The database connection.
`SQLDialect`	`getDialect()` Get the dialect for this database.
`DomainDefinition`	`getDomain(SchemaDefinition schema, Name name)` Get an domain UDT defined in this database by name.
`DomainDefinition`	`getDomain(SchemaDefinition schema, Name name, boolean ignoreCase)` Get an domain UDT defined in this database by name.
`DomainDefinition`	`getDomain(SchemaDefinition schema, String name)` Get an domain UDT defined in this database by name.
`DomainDefinition`	`getDomain(SchemaDefinition schema, String name, boolean ignoreCase)` Get an domain UDT defined in this database by name.
`List<DomainDefinition>`	`getDomains(SchemaDefinition schema)` The domain UDTs defined in this database.
`EnumDefinition`	`getEnum(SchemaDefinition schema, Name name)` Get an enum UDT defined in this database by name.
`EnumDefinition`	`getEnum(SchemaDefinition schema, Name name, boolean ignoreCase)` Get an enum UDT defined in this database by name.
`EnumDefinition`	`getEnum(SchemaDefinition schema, String name)` Get an enum UDT defined in this database by name.
`EnumDefinition`	`getEnum(SchemaDefinition schema, String name, boolean ignoreCase)` Get an enum UDT defined in this database by name.
`List<EnumDefinition>`	`getEnums(SchemaDefinition schema)` The enum UDTs defined in this database.
`List<Definition>`	`getExcluded()` Retrieve all excluded objects.
`String[]`	`getExcludes()` Database objects matching any of these regular expressions will not be generated.
`List<Database.Filter>`	`getFilters()` [#3488] The filters that are applied in addition to include / exclude.
`boolean`	`getForceIntegerTypesOnZeroScaleDecimals()` Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.
`List<ForeignKeyDefinition>`	`getForeignKeys(SchemaDefinition schema)` The foreign keys contained in this database.
`List<IdentityDefinition>`	`getIdentities(SchemaDefinition schema)` The identities contained in this database.
`List<Definition>`	`getIncluded()` Retrieve all included objects.
`boolean`	`getIncludeExcludeColumns()` Indicate whether include / exclude regular expression shall also match database columns.
`boolean`	`getIncludeForeignKeys()` whether foreign key relationships should be included.
`boolean`	`getIncludeIndexes()` whether indexes should be included.
`boolean`	`getIncludePackageConstants()` whether package constants should be included.
`boolean`	`getIncludePackageRoutines()` whether package routines should be included.
`boolean`	`getIncludePackages()` whether packages should be included.
`boolean`	`getIncludePackageUDTs()` whether package UDTs should be included.
`boolean`	`getIncludePrimaryKeys()` whether primary keys should be included.
`boolean`	`getIncludeRoutines()` whether routines should be included.
`String[]`	`getIncludes()` Only database objects matching any of these regular expressions will be generated.
`boolean`	`getIncludeSequences()` whether sequences should be included.
`boolean`	`getIncludeTables()` Whether tables (and views) should be included.
`boolean`	`getIncludeTriggerRoutines()` whether trigger routines should be included.
`boolean`	`getIncludeUDTs()` whether user defined types should be included.
`boolean`	`getIncludeUniqueKeys()` whether unique keys should be included.
`List<IndexDefinition>`	`getIndexes(SchemaDefinition schema)` The indexes contained in this database.
`List<IndexDefinition>`	`getIndexes(TableDefinition schema)` The indexes contained in this database.
`List<String>`	`getInputCatalogs()` The input catalogs are the catalogs that jooq-meta is reading data from.
`List<String>`	`getInputSchemata()` The input schemata are the schemata from all catalogs that jooq-meta is reading data from.
`List<String>`	`getInputSchemata(CatalogDefinition catalog)` The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
`List<String>`	`getInputSchemata(String catalog)` The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
`int`	`getLogSlowQueriesAfterSeconds()` Log slow queries after this amount of seconds.
`Comparator<Definition>`	`getOrderProvider()` The database's order provider.
`String`	`getOutputCatalog(String inputCatalog)` Deprecated. - 2.0.5 - This will be implemented in each `Definition.getOutputName()`
`String`	`getOutputSchema(String inputSchema)` Deprecated. - 2.0.5 - This will be implemented in each `Definition.getOutputName()`
`String`	`getOutputSchema(String inputCatalog, String inputSchema)` Deprecated. - 2.0.5 - This will be implemented in each `Definition.getOutputName()`
`String[]`	`getOverridePrimaryKeys()` Unique keys matching these regular expressions will be considered as primary keys in generated code.
`PackageDefinition`	`getPackage(SchemaDefinition schema, String inputName)` Get a package defined in this database by name.
`List<PackageDefinition>`	`getPackages(SchemaDefinition schema)` The packages contained in this database.
`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.
`List<RegexFlag>`	`getRegexFlags()` The regular expression flags that should be applied when using regular expressions.
`Relations`	`getRelations()` Retrieve the schema's primary key / foreign key relations.
`List<RoutineDefinition>`	`getRoutines(SchemaDefinition schema)` The stored routines (procedures and functions) contained in this database.
`SchemaDefinition`	`getSchema(String name)` Get a schema defined in this database by name.
`List<SchemaDefinition>`	`getSchemata()` The schemata generated from this database.
`List<SchemaDefinition>`	`getSchemata(CatalogDefinition catalog)` The schemata generated from this database and a given catalog.
`SchemaVersionProvider`	`getSchemaVersionProvider()` The database's schema version provider.
`List<SequenceDefinition>`	`getSequences(SchemaDefinition schema)` The sequences contained in this database.
`String[]`	`getSyntheticIdentities()` Columns matching these regular expressions will be considered as identity columns in generated code.
`String[]`	`getSyntheticPrimaryKeys()` Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.
`TableDefinition`	`getTable(SchemaDefinition schema, Name name)` Get a table in this database by name.
`TableDefinition`	`getTable(SchemaDefinition schema, Name name, boolean ignoreCase)` Get a table in this database by name.
`TableDefinition`	`getTable(SchemaDefinition schema, String name)` Get a table in this database by name.
`TableDefinition`	`getTable(SchemaDefinition schema, String name, boolean ignoreCase)` Get a table in this database by name.
`List<TableDefinition>`	`getTables(SchemaDefinition schema)` The tables contained in this database.
`UDTDefinition`	`getUDT(SchemaDefinition schema, Name name)` Get a UDT defined in this database by name.
`UDTDefinition`	`getUDT(SchemaDefinition schema, Name name, boolean ignoreCase)` Get a UDT defined in this database by name.
`UDTDefinition`	`getUDT(SchemaDefinition schema, String name)` Get a UDT defined in this database by name.
`UDTDefinition`	`getUDT(SchemaDefinition schema, String name, boolean ignoreCase)` Get a UDT defined in this database by name.
`List<UDTDefinition>`	`getUDTs(PackageDefinition pkg)` The UDTs defined in this database.
`List<UDTDefinition>`	`getUDTs(SchemaDefinition schema)` The UDTs defined in this database.
`List<UniqueKeyDefinition>`	`getUniqueKeys(SchemaDefinition schema)` The unique keys contained in this database.
`boolean`	`ignoreProcedureReturnValues()` Whether this database should ignore procedure return values.
`boolean`	`includeRelations()` [#3559] Whether relations (i.e. constraints) should be included in this database.
`boolean`	`isArrayType(String dataType)` Check whether a type is an array type.
`void`	`setCatalogVersionProvider(CatalogVersionProvider provider)` The database's catalog version provider.
`void`	`setConfiguredCatalogs(List<Catalog> catalogs)` The input and output catalogs.
`void`	`setConfiguredCustomTypes(List<CustomType> types)` Deprecated. - 3.10.0 - [#5750] - Use `getConfiguredForcedTypes()` only.
`void`	`setConfiguredEnumTypes(List<EnumType> types)` Database objects matching any of these field names will be generated as enum types.
`void`	`setConfiguredForcedTypes(List<ForcedType> types)` Database objects matching any of these field names will be generated as forced types.
`void`	`setConfiguredSchemata(List<Schema> schemata)` The input and output schemata.
`void`	`setConnection(Connection connection)` Initialise a connection to this database.
`void`	`setDateAsTimestamp(boolean dateAsTimestamp)` Whether DATE columns should be treated as TIMESTAMP columns.
`void`	`setExcludes(String[] excludes)` Database objects matching any of these regular expressions will not be generated.
`void`	`setForceIntegerTypesOnZeroScaleDecimals(boolean forceIntegerTypesOnZeroScaleDecimals)` Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.
`void`	`setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues)` Whether this database should ignore procedure return values.
`void`	`setIncludeExcludeColumns(boolean includeExcludeColumns)` Indicate whether include / exclude regular expression shall also match database columns.
`void`	`setIncludeForeignKeys(boolean includeForeignKeys)` whether foreign key relationships should be included.
`void`	`setIncludeIndexes(boolean includeIndexes)` whether indexes should be included.
`void`	`setIncludePackageConstants(boolean includePackageConstants)` whether package constants should be included.
`void`	`setIncludePackageRoutines(boolean includePackageRoutines)` whether package routines should be included.
`void`	`setIncludePackages(boolean includePackages)` whether packages should be included.
`void`	`setIncludePackageUDTs(boolean includePackageUDTs)` whether package UDTs should be included.
`void`	`setIncludePrimaryKeys(boolean includePrimaryKeys)` whether primary keys should be included.
`void`	`setIncludeRelations(boolean includeRelations)` [#3559] Whether relations (i.e. constraints) should be included in this database.
`void`	`setIncludeRoutines(boolean includeRoutines)` whether routines should be included.
`void`	`setIncludes(String[] includes)` Only database objects matching any of these regular expressions will be generated.
`void`	`setIncludeSequences(boolean includeSequences)` whether sequences should be included.
`void`	`setIncludeTables(boolean includeTables)` Whether tables (and views) should be included.
`void`	`setIncludeTriggerRoutines(boolean includeTriggerRoutines)` whether trigger routines should be included.
`void`	`setIncludeUDTs(boolean includeUDTs)` whether user defined types should be included.
`void`	`setIncludeUniqueKeys(boolean includeUniqueKeys)` whether unique keys should be included.
`void`	`setLogSlowQueriesAfterSeconds(int logSlowQueriesAfterSeconds)` Log slow queries after this amount of seconds.
`void`	`setOrderProvider(Comparator<Definition> provider)` The database's order provider.
`void`	`setOverridePrimaryKeys(String[] primaryKeys)` Unique keys matching these regular expressions will be considered as primary keys in generated code.
`void`	`setProperties(Properties properties)` Database properties.
`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.
`void`	`setRegexFlags(List<RegexFlag> regexFlags)` The regular expression flags that should be applied when using regular expressions.
`void`	`setSchemaVersionProvider(SchemaVersionProvider provider)` The database's schema version provider.
`void`	`setSupportsUnsignedTypes(boolean supportsUnsignedTypes)` Whether this database supports unsigned types.
`void`	`setSyntheticIdentities(String[] syntheticIdentities)` Columns matching these regular expressions will be considered as identity columns in generated code.
`void`	`setSyntheticPrimaryKeys(String[] primaryKeys)` Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.
`void`	`setTableValuedFunctions(boolean tableValuedFunctions)` [#4838] Whether table-valued functions should be reported as tables.
`<D extends Definition> List<D>`	`sort(List<D> definitions)` Sort a list of definitions according to the `getOrderProvider()` defined in this database.
`boolean`	`supportsUnsignedTypes()` Whether this database supports unsigned types.
`boolean`	`tableValuedFunctions()` [#4838] Whether table-valued functions should be reported as tables.

- Method Detail
  - getCatalogs
```
List<CatalogDefinition> getCatalogs()
```
    The catalogs generated from this database.
  - getCatalog
```
CatalogDefinition getCatalog(String name)
```
    Get a catalog defined in this database by name.
  - getSchemata
```
List<SchemaDefinition> getSchemata()
```
    The schemata generated from this database.
  - getSchemata
```
List<SchemaDefinition> getSchemata(CatalogDefinition catalog)
```
    The schemata generated from this database and a given catalog.
  - getSchema
```
SchemaDefinition getSchema(String name)
```
    Get a schema defined in this database by name.
  - getRelations
```
Relations getRelations()
```
    Retrieve the schema's primary key / foreign key relations.
  - getSequences
```
List<SequenceDefinition> getSequences(SchemaDefinition schema)
```
    The sequences contained in this database.
  - getIdentities
```
List<IdentityDefinition> getIdentities(SchemaDefinition schema)
```
    The identities contained in this database.
  - getIndexes
```
List<IndexDefinition> getIndexes(SchemaDefinition schema)
```
    The indexes contained in this database.
  - getIndexes
```
List<IndexDefinition> getIndexes(TableDefinition schema)
```
    The indexes contained in this database.
  - getUniqueKeys
```
List<UniqueKeyDefinition> getUniqueKeys(SchemaDefinition schema)
```
    The unique keys contained in this database.
  - getForeignKeys
```
List<ForeignKeyDefinition> getForeignKeys(SchemaDefinition schema)
```
    The foreign keys contained in this database.
  - getCheckConstraints
```
List<CheckConstraintDefinition> getCheckConstraints(SchemaDefinition schema)
```
    The check constraints contained in this database.
  - getTables
```
List<TableDefinition> getTables(SchemaDefinition schema)
```
    The tables contained in this database.
  - getTable
```
TableDefinition getTable(SchemaDefinition schema,
                         String name)
```
    Get a table in this database by name.
  - getTable
```
TableDefinition getTable(SchemaDefinition schema,
                         String name,
                         boolean ignoreCase)
```
    Get a table in this database by name.
  - getTable
```
TableDefinition getTable(SchemaDefinition schema,
                         Name name)
```
    Get a table in this database by name.
  - getTable
```
TableDefinition getTable(SchemaDefinition schema,
                         Name name,
                         boolean ignoreCase)
```
    Get a table in this database by name.
  - getEnums
```
List<EnumDefinition> getEnums(SchemaDefinition schema)
```
    The enum UDTs defined in this database.
  - getEnum
```
EnumDefinition getEnum(SchemaDefinition schema,
                       String name)
```
    Get an enum UDT defined in this database by name.
  - getEnum
```
EnumDefinition getEnum(SchemaDefinition schema,
                       String name,
                       boolean ignoreCase)
```
    Get an enum UDT defined in this database by name.
  - getEnum
```
EnumDefinition getEnum(SchemaDefinition schema,
                       Name name)
```
    Get an enum UDT defined in this database by name.
  - getEnum
```
EnumDefinition getEnum(SchemaDefinition schema,
                       Name name,
                       boolean ignoreCase)
```
    Get an enum UDT defined in this database by name.
  - getDomains
```
List<DomainDefinition> getDomains(SchemaDefinition schema)
```
    The domain UDTs defined in this database.
  - getDomain
```
DomainDefinition getDomain(SchemaDefinition schema,
                           String name)
```
    Get an domain UDT defined in this database by name.
  - getDomain
```
DomainDefinition getDomain(SchemaDefinition schema,
                           String name,
                           boolean ignoreCase)
```
    Get an domain UDT defined in this database by name.
  - getDomain
```
DomainDefinition getDomain(SchemaDefinition schema,
                           Name name)
```
    Get an domain UDT defined in this database by name.
  - getDomain
```
DomainDefinition getDomain(SchemaDefinition schema,
                           Name name,
                           boolean ignoreCase)
```
    Get an domain UDT defined in this database by name.
  - getUDTs
```
List<UDTDefinition> getUDTs(SchemaDefinition schema)
```
    The UDTs defined in this database.
  - getUDT
```
UDTDefinition getUDT(SchemaDefinition schema,
                     String name)
```
    Get a UDT defined in this database by name.
  - getUDT
```
UDTDefinition getUDT(SchemaDefinition schema,
                     String name,
                     boolean ignoreCase)
```
    Get a UDT defined in this database by name.
  - getUDT
```
UDTDefinition getUDT(SchemaDefinition schema,
                     Name name)
```
    Get a UDT defined in this database by name.
  - getUDT
```
UDTDefinition getUDT(SchemaDefinition schema,
                     Name name,
                     boolean ignoreCase)
```
    Get a UDT defined in this database by name.
  - getUDTs
```
List<UDTDefinition> getUDTs(PackageDefinition pkg)
```
    The UDTs defined in this database.
  - getArrays
```
List<ArrayDefinition> getArrays(SchemaDefinition schema)
```
    The Arrays defined in this database.
  - getArray
```
ArrayDefinition getArray(SchemaDefinition schema,
                         String name)
```
    Get a ARRAY defined in this database by name.
  - getArray
```
ArrayDefinition getArray(SchemaDefinition schema,
                         String name,
                         boolean ignoreCase)
```
    Get a ARRAY defined in this database by name.
  - getArray
```
ArrayDefinition getArray(SchemaDefinition schema,
                         Name name)
```
    Get a ARRAY defined in this database by name.
  - getArray
```
ArrayDefinition getArray(SchemaDefinition schema,
                         Name name,
                         boolean ignoreCase)
```
    Get a ARRAY defined in this database by name.
  - getRoutines
```
List<RoutineDefinition> getRoutines(SchemaDefinition schema)
```
    The stored routines (procedures and functions) contained in this database.
  - getPackages
```
List<PackageDefinition> getPackages(SchemaDefinition schema)
```
    The packages contained in this database.
  - getPackage
```
PackageDefinition getPackage(SchemaDefinition schema,
                             String inputName)
```
    Get a package defined in this database by name.
  - setConnection
```
void setConnection(Connection connection)
```
    Initialise a connection to this database.
  - getConnection
```
Connection getConnection()
```
    The database connection.
  - getInputCatalogs
```
List<String> getInputCatalogs()
```
    The input catalogs are the catalogs that jooq-meta is reading data from.
  - getInputSchemata
```
List<String> getInputSchemata()
```
    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 getInputSchemata(String) instead to disambiguate schema names (e.g. in SQL Server, there are multiple "dbo" schemas).
  - getInputSchemata
```
List<String> getInputSchemata(CatalogDefinition catalog)
```
    The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
  - getInputSchemata
```
List<String> getInputSchemata(String catalog)
```
    The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
  - getOutputCatalog
```
@Deprecated
String getOutputCatalog(String inputCatalog)
```
    Deprecated. - 2.0.5 - This will be implemented in each Definition.getOutputName()
    
    The output catalog is the catalog used by jooq-codegen in class names.
  - getOutputSchema
```
@Deprecated
String getOutputSchema(String inputSchema)
```
    Deprecated. - 2.0.5 - This will be implemented in each Definition.getOutputName()
    
    The output schema is the schema used by jooq-codegen in class names.
  - getOutputSchema
```
@Deprecated
String getOutputSchema(String inputCatalog,
                                    String inputSchema)
```
    Deprecated. - 2.0.5 - This will be implemented in each Definition.getOutputName()
    
    The output schema is the schema used by jooq-codegen in class names.
  - setConfiguredCatalogs
```
void setConfiguredCatalogs(List<Catalog> catalogs)
```
    The input and output catalogs.
  - setConfiguredSchemata
```
void setConfiguredSchemata(List<Schema> schemata)
```
    The input and output schemata.
  - setExcludes
```
void setExcludes(String[] excludes)
```
    Database objects matching any of these regular expressions will not be generated.
  - getExcludes
```
String[] getExcludes()
```
    Database objects matching any of these regular expressions will not be generated.
  - setIncludes
```
void setIncludes(String[] includes)
```
    Only database objects matching any of these regular expressions will be generated.
  - getIncludes
```
String[] getIncludes()
```
    Only database objects matching any of these regular expressions will be generated.
  - setIncludeExcludeColumns
```
void setIncludeExcludeColumns(boolean includeExcludeColumns)
```
    Indicate whether include / exclude regular expression shall also match database columns.
  - getIncludeExcludeColumns
```
boolean getIncludeExcludeColumns()
```
    Indicate whether include / exclude regular expression shall also match database columns.
  - setIncludeForeignKeys
```
void setIncludeForeignKeys(boolean includeForeignKeys)
```
    whether foreign key relationships should be included.
  - getIncludeForeignKeys
```
boolean getIncludeForeignKeys()
```
    whether foreign key relationships should be included.
  - setIncludeUniqueKeys
```
void setIncludeUniqueKeys(boolean includeUniqueKeys)
```
    whether unique keys should be included.
  - getIncludeUniqueKeys
```
boolean getIncludeUniqueKeys()
```
    whether unique keys should be included.
  - setIncludePrimaryKeys
```
void setIncludePrimaryKeys(boolean includePrimaryKeys)
```
    whether primary keys should be included.
  - getIncludePrimaryKeys
```
boolean getIncludePrimaryKeys()
```
    whether primary keys should be included.
  - setIncludeIndexes
```
void setIncludeIndexes(boolean includeIndexes)
```
    whether indexes should be included.
  - getIncludeIndexes
```
boolean getIncludeIndexes()
```
    whether indexes should be included.
  - setIncludeSequences
```
void setIncludeSequences(boolean includeSequences)
```
    whether sequences should be included.
  - getIncludeSequences
```
boolean getIncludeSequences()
```
    whether sequences should be included.
  - setIncludeUDTs
```
void setIncludeUDTs(boolean includeUDTs)
```
    whether user defined types should be included.
  - getIncludeUDTs
```
boolean getIncludeUDTs()
```
    whether user defined types should be included.
  - setIncludePackages
```
void setIncludePackages(boolean includePackages)
```
    whether packages should be included.
  - getIncludePackages
```
boolean getIncludePackages()
```
    whether packages should be included.
  - setIncludePackageRoutines
```
void setIncludePackageRoutines(boolean includePackageRoutines)
```
    whether package routines should be included.
  - getIncludePackageRoutines
```
boolean getIncludePackageRoutines()
```
    whether package routines should be included.
  - setIncludePackageUDTs
```
void setIncludePackageUDTs(boolean includePackageUDTs)
```
    whether package UDTs should be included.
  - getIncludePackageUDTs
```
boolean getIncludePackageUDTs()
```
    whether package UDTs should be included.
  - setIncludePackageConstants
```
void setIncludePackageConstants(boolean includePackageConstants)
```
    whether package constants should be included.
  - getIncludePackageConstants
```
boolean getIncludePackageConstants()
```
    whether package constants should be included.
  - setIncludeRoutines
```
void setIncludeRoutines(boolean includeRoutines)
```
    whether routines should be included.
  - getIncludeRoutines
```
boolean getIncludeRoutines()
```
    whether routines should be included.
  - setIncludeTriggerRoutines
```
void setIncludeTriggerRoutines(boolean includeTriggerRoutines)
```
    whether trigger routines should be included.
  - getIncludeTriggerRoutines
```
boolean getIncludeTriggerRoutines()
```
    whether trigger routines should be included.
  - setIncludeTables
```
void setIncludeTables(boolean includeTables)
```
    Whether tables (and views) should be included.
  - setForceIntegerTypesOnZeroScaleDecimals
```
void setForceIntegerTypesOnZeroScaleDecimals(boolean forceIntegerTypesOnZeroScaleDecimals)
```
    Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.
  - getForceIntegerTypesOnZeroScaleDecimals
```
boolean getForceIntegerTypesOnZeroScaleDecimals()
```
    Whether zero-scale decimal types should be treated as their most appropriate, corresponding integer type.
  - getIncludeTables
```
boolean getIncludeTables()
```
    Whether tables (and views) should be included.
  - addFilter
```
void addFilter(Database.Filter filter)
```
    [#3488] Add an additional filter to the database that is applied in addition to include / exclude.
  - getFilters
```
List<Database.Filter> getFilters()
```
    [#3488] The filters that are applied in addition to include / exclude.
  - filterExcludeInclude
```
<D extends Definition> List<D> filterExcludeInclude(List<D> definitions)
```
    Filter a list of definitions according to the exclude / include / and filter settings of this database.
  - sort
```
<D extends Definition> List<D> sort(List<D> definitions)
```
    Sort a list of definitions according to the getOrderProvider() defined in this database.
  - getIncluded
```
List<Definition> getIncluded()
```
    Retrieve all included objects.
  - getExcluded
```
List<Definition> getExcluded()
```
    Retrieve all excluded objects.
  - getAll
```
List<Definition> getAll()
```
    Retrieve all objects.
  - setRegexFlags
```
void setRegexFlags(List<RegexFlag> regexFlags)
```
    The regular expression flags that should be applied when using regular expressions.
  - getRegexFlags
```
List<RegexFlag> getRegexFlags()
```
    The regular expression flags that should be applied when using regular expressions.
  - setRecordVersionFields
```
void setRecordVersionFields(String[] recordVersionFields)
```
    Table columns matching these regular expressions will be considered as record version fields in generated code.
  - getRecordVersionFields
```
String[] getRecordVersionFields()
```
    Table columns matching these regular expressions will be considered as record version fields in generated code.
  - setRecordTimestampFields
```
void setRecordTimestampFields(String[] recordTimestampFields)
```
    Table columns matching these regular expressions will be considered as record timestamp fields in generated code.
  - getRecordTimestampFields
```
String[] getRecordTimestampFields()
```
    Table columns matching these regular expressions will be considered as record timestamp fields in generated code.
  - setSyntheticPrimaryKeys
```
void setSyntheticPrimaryKeys(String[] primaryKeys)
```
    Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.
  - getSyntheticPrimaryKeys
```
String[] getSyntheticPrimaryKeys()
```
    Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.
  - setOverridePrimaryKeys
```
void setOverridePrimaryKeys(String[] primaryKeys)
```
    Unique keys matching these regular expressions will be considered as primary keys in generated code.
  - getOverridePrimaryKeys
```
String[] getOverridePrimaryKeys()
```
    Unique keys matching these regular expressions will be considered as primary keys in generated code.
  - setSyntheticIdentities
```
void setSyntheticIdentities(String[] syntheticIdentities)
```
    Columns matching these regular expressions will be considered as identity columns in generated code.
  - getSyntheticIdentities
```
String[] getSyntheticIdentities()
```
    Columns matching these regular expressions will be considered as identity columns in generated code.
  - setConfiguredCustomTypes
```
@Deprecated
void setConfiguredCustomTypes(List<CustomType> types)
```
    Deprecated. - 3.10.0 - [#5750] - Use getConfiguredForcedTypes() only.
    
    Database objects matching any of these field names will be generated as custom types.
  - getConfiguredCustomTypes
```
@Deprecated
List<CustomType> getConfiguredCustomTypes()
```
    Deprecated. - 3.10.0 - [#5750] - Use getConfiguredForcedTypes() only.
    
    Database objects matching any of these field names will be generated as custom types.
  - getConfiguredCustomType
```
@Deprecated
CustomType getConfiguredCustomType(String name)
```
    Deprecated. - 3.10.0 - [#5750] - Use getConfiguredForcedTypes() only.
    
    Get a specific configured custom type by its name.
  - setConfiguredEnumTypes
```
void setConfiguredEnumTypes(List<EnumType> types)
```
    Database objects matching any of these field names will be generated as enum types.
  - getConfiguredEnumTypes
```
List<EnumType> getConfiguredEnumTypes()
```
    Database objects matching any of these field names will be generated as enum types.
  - setConfiguredForcedTypes
```
void setConfiguredForcedTypes(List<ForcedType> types)
```
    Database objects matching any of these field names will be generated as forced types.
  - getLogSlowQueriesAfterSeconds
```
int getLogSlowQueriesAfterSeconds()
```
    Log slow queries after this amount of seconds.
  - setLogSlowQueriesAfterSeconds
```
void setLogSlowQueriesAfterSeconds(int logSlowQueriesAfterSeconds)
```
    Log slow queries after this amount of seconds.
  - getSchemaVersionProvider
```
SchemaVersionProvider getSchemaVersionProvider()
```
    The database's schema version provider.
  - setSchemaVersionProvider
```
void setSchemaVersionProvider(SchemaVersionProvider provider)
```
    The database's schema version provider.
  - getCatalogVersionProvider
```
CatalogVersionProvider getCatalogVersionProvider()
```
    The database's catalog version provider.
  - setCatalogVersionProvider
```
void setCatalogVersionProvider(CatalogVersionProvider provider)
```
    The database's catalog version provider.
  - getOrderProvider
```
Comparator<Definition> getOrderProvider()
```
    The database's order provider.
  - setOrderProvider
```
void setOrderProvider(Comparator<Definition> provider)
```
    The database's order provider.
  - getConfiguredForcedTypes
```
List<ForcedType> getConfiguredForcedTypes()
```
    Database objects matching any of these field names will be generated as forced types.
  - getConfiguredForcedType
```
ForcedType getConfiguredForcedType(Definition definition)
```
    Get the configured forced type object for any given Definition, or null if no ForcedType matches the definition.
  - getConfiguredForcedType
```
ForcedType getConfiguredForcedType(Definition definition,
                                   DataTypeDefinition definedType)
```
    Get the configured forced type object for any given Definition, or null if no ForcedType matches the definition.
  - getDialect
```
SQLDialect getDialect()
```
    Get the dialect for this database.
  - create
```
DSLContext create()
```
    Create the factory for this database.
  - isArrayType
```
boolean isArrayType(String dataType)
```
    Check whether a type is an array type.
  - setSupportsUnsignedTypes
```
void setSupportsUnsignedTypes(boolean supportsUnsignedTypes)
```
    Whether this database supports unsigned types.
  - supportsUnsignedTypes
```
boolean supportsUnsignedTypes()
```
    Whether this database supports unsigned types.
  - setIgnoreProcedureReturnValues
```
void setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues)
```
    Whether this database should ignore procedure return values.
  - ignoreProcedureReturnValues
```
boolean ignoreProcedureReturnValues()
```
    Whether this database should ignore procedure return values.
  - setDateAsTimestamp
```
void setDateAsTimestamp(boolean dateAsTimestamp)
```
    Whether DATE columns should be treated as TIMESTAMP columns.
  - dateAsTimestamp
```
boolean dateAsTimestamp()
```
    Whether DATE columns should be treated as TIMESTAMP columns.
  - setIncludeRelations
```
void setIncludeRelations(boolean includeRelations)
```
    [#3559] Whether relations (i.e. constraints) should be included in this database.
  - includeRelations
```
boolean includeRelations()
```
    [#3559] Whether relations (i.e. constraints) should be included in this database.
  - setTableValuedFunctions
```
void setTableValuedFunctions(boolean tableValuedFunctions)
```
    [#4838] Whether table-valued functions should be reported as tables.
  - tableValuedFunctions
```
boolean tableValuedFunctions()
```
    [#4838] Whether table-valued functions should be reported as tables.
  - exists
```
boolean exists(Table<?> table)
```
    Check for the existence of a table in the dictionary views.
  - existAll
```
boolean existAll(Table<?>... tables)
```
    Check for the existence of several tables in the dictionary views.
  - setProperties
```
void setProperties(Properties properties)
```
    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.
  - getProperties
```
Properties getProperties()
```
    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.
  - close
```
void close()
```
    Release any resources that this Database may have allocated.
    
    Specified by:
    
    close in interface AutoCloseable

Interface Database

Nested Class Summary

Method Summary

Method Detail

getCatalogs

getCatalog

getSchemata

getSchemata

getSchema

getRelations

getSequences

getIdentities

getIndexes

getIndexes

getUniqueKeys

getForeignKeys

getCheckConstraints

getTables

getTable

getTable

getTable

getTable

getEnums

getEnum

getEnum

getEnum

getEnum

getDomains

getDomain

getDomain

getDomain

getDomain

getUDTs

getUDT

getUDT

getUDT

getUDT

getUDTs

getArrays

getArray

getArray

getArray

getArray

getRoutines

getPackages

getPackage

setConnection

getConnection

getInputCatalogs

getInputSchemata

getInputSchemata

getInputSchemata

getOutputCatalog

getOutputSchema

getOutputSchema

setConfiguredCatalogs

setConfiguredSchemata

setExcludes

getExcludes

setIncludes

getIncludes

setIncludeExcludeColumns

getIncludeExcludeColumns

setIncludeForeignKeys

getIncludeForeignKeys

setIncludeUniqueKeys

getIncludeUniqueKeys

setIncludePrimaryKeys

getIncludePrimaryKeys

setIncludeIndexes

getIncludeIndexes

setIncludeSequences

getIncludeSequences

setIncludeUDTs

getIncludeUDTs

setIncludePackages

getIncludePackages

setIncludePackageRoutines

getIncludePackageRoutines

setIncludePackageUDTs