Database (jOOQ Meta 3.6.2 API)

All Known Implementing Classes:

AbstractDatabase, CUBRIDDatabase, DerbyDatabase, FirebirdDatabase, H2Database, HSQLDBDatabase, JDBCDatabase, MariaDBDatabase, MySQLDatabase, PostgresDatabase, SQLiteDatabase, XMLDatabase
```
public interface Database
```
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.
`DSLContext`	`create()` Create the factory for this database.
`boolean`	`dateAsTimestamp()` Whether DATE columns should be treated as TIMESTAMP columns.
`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.
`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.
`List<CheckConstraintDefinition>`	`getCheckConstraints(SchemaDefinition schema)` The check constraints contained in this database.
`CustomType`	`getConfiguredCustomType(String name)` Get a specific configured custom type by its name.
`List<CustomType>`	`getConfiguredCustomTypes()` Database objects matching any of these field names will be generated as custom types.
`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.
`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.
`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.
`List<ForeignKeyDefinition>`	`getForeignKeys(SchemaDefinition schema)` The foreign keys contained in this database.
`List<IdentityDefinition>`	`getIdentities(SchemaDefinition schema)` The identities contained in this database.
`boolean`	`getIncludeExcludeColumns()` Indicate whether include / exclude regular expression shall also match database columns.
`String[]`	`getIncludes()` Only database objects matching any of these regular expressions will be generated.
`List<String>`	`getInputSchemata()` The input schemata are the schemata that jooq-meta is reading data from.
`String`	`getOutputSchema(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.
`List<PackageDefinition>`	`getPackages(SchemaDefinition schema)` The packages contained in this database.
`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.
`SchemaVersionProvider`	`getSchemaVersionProvider()`
`List<SequenceDefinition>`	`getSequences(SchemaDefinition schema)` The sequences contained in this database.
`String[]`	`getSyntheticPrimaryKeys()` Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.
`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, 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(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`	`setConfiguredCustomTypes(List<CustomType> types)` Database objects matching any of these field names will be generated as custom types.
`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`	`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`	`setIncludeRelations(boolean includeRelations)` [#3559] Whether relations (i.e. constraints) should be included in this database.
`void`	`setIncludes(String[] includes)` Only database objects matching any of these regular expressions will be generated.
`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)`
`void`	`setSupportsUnsignedTypes(boolean supportsUnsignedTypes)` Whether this database supports unsigned types.
`void`	`setSyntheticPrimaryKeys(String[] primaryKeys)` Columns matching these regular expressions will be considered as members of synthetic primary keys in generated code.
`boolean`	`supportsUnsignedTypes()` Whether this database supports unsigned types.

- Method Detail
  - getSchemata
```
List<SchemaDefinition> getSchemata()
```
    The schemata generated from this database.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - setConnection
```
void setConnection(Connection connection)
```
    Initialise a connection to this database.
  - getConnection
```
Connection getConnection()
```
    The database connection.
  - getInputSchemata
```
List<String> getInputSchemata()
```
    The input schemata are the schemata that jooq-meta is reading data from.
  - 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.
  - 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.
  - 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.
  - 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.
  - setConfiguredCustomTypes
```
void setConfiguredCustomTypes(List<CustomType> types)
```
    Database objects matching any of these field names will be generated as custom types.
  - getConfiguredCustomTypes
```
List<CustomType> getConfiguredCustomTypes()
```
    Database objects matching any of these field names will be generated as custom types.
  - getConfiguredCustomType
```
CustomType getConfiguredCustomType(String name)
```
    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.
  - getSchemaVersionProvider
```
SchemaVersionProvider getSchemaVersionProvider()
```
  - setSchemaVersionProvider
```
void setSchemaVersionProvider(SchemaVersionProvider 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.
  - exists
```
boolean exists(Table<?> table)
```
    Check for the existence of a table in the dictionary views.
  - setProperties
```
void setProperties(Properties properties)
```
    Database properties.

Interface Database

Nested Class Summary

Method Summary

Method Detail

getSchemata

getSchema

getRelations

getSequences

getIdentities

getUniqueKeys

getForeignKeys

getCheckConstraints

getTables

getTable

getTable

getEnums

getEnum

getEnum

getUDTs

getUDT

getUDT

getArrays

getArray

getArray

getRoutines

getPackages

setConnection

getConnection

getInputSchemata

getOutputSchema

setConfiguredSchemata

setExcludes

getExcludes

setIncludes

getIncludes

setIncludeExcludeColumns

getIncludeExcludeColumns

addFilter

getFilters

filterExcludeInclude

setRegexFlags

getRegexFlags

setRecordVersionFields

getRecordVersionFields

setRecordTimestampFields

getRecordTimestampFields

setSyntheticPrimaryKeys

getSyntheticPrimaryKeys

setOverridePrimaryKeys

getOverridePrimaryKeys

setConfiguredCustomTypes

getConfiguredCustomTypes

getConfiguredCustomType

setConfiguredEnumTypes

getConfiguredEnumTypes

setConfiguredForcedTypes

getSchemaVersionProvider

setSchemaVersionProvider

getConfiguredForcedTypes

getConfiguredForcedType

getConfiguredForcedType

getDialect

create

isArrayType

setSupportsUnsignedTypes

supportsUnsignedTypes

setIgnoreProcedureReturnValues

ignoreProcedureReturnValues

setDateAsTimestamp

dateAsTimestamp

setIncludeRelations

includeRelations

exists

setProperties