public interface Database extends AutoCloseable
| Modifier and Type | Interface and Description |
|---|---|
static interface |
Database.Filter
A filter type that can be used with
addFilter(Filter) |
| 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.
|
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.
|
boolean |
existAll(Table<?>... tables)
Check for the existence of several tables in the dictionary views.
|
boolean |
existAll(TableField<?,?>... fields)
Check for the existence of several table fields in the dictionary views.
|
boolean |
exists(Table<?> table)
Check for the existence of a table in the dictionary views.
|
boolean |
exists(TableField<?,?> field)
Check for the existence of a table field in the dictionary views.
|
<D extends Definition> |
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.
|
String |
getBasedir()
The basedir that can be used by file based implementations to resolve
relative paths.
|
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<EmbeddableDefinitionType> |
getConfiguredEmbeddables()
Get the configured embeddable type definitions for any given
Definition. |
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.
|
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<SyntheticUniqueKeyType> |
getConfiguredSyntheticUniqueKeys()
Get the configured synthetic unique keys.
|
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()
The domain UDTs defined in this database.
|
List<DomainDefinition> |
getDomains(SchemaDefinition schema)
The domain UDTs defined in this database.
|
List<EmbeddableDefinition> |
getEmbeddables()
Get all embeddables.
|
List<EmbeddableDefinition> |
getEmbeddables(SchemaDefinition schema)
Get all embeddables for a given defining schema.
|
List<EmbeddableDefinition> |
getEmbeddables(TableDefinition table)
Get all embeddables for a given defining table.
|
List<EmbeddableDefinition> |
getEmbeddablesByReferencingTable(TableDefinition table)
Get all embeddables for a given referencing table.
|
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()
The foreign keys contained in this database.
|
List<ForeignKeyDefinition> |
getForeignKeys(SchemaDefinition schema)
The foreign keys contained in this database.
|
List<IdentityDefinition> |
getIdentities(SchemaDefinition schema)
The identities contained in this database.
|
boolean |
getIncludeCheckConstraints()
whether check constraints should be included.
|
List<Definition> |
getIncluded()
Retrieve all included objects.
|
boolean |
getIncludeDomains()
whether domains should be included.
|
boolean |
getIncludeEmbeddables()
Whether embeddable types should be included.
|
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 |
getIncludeInvisibleColumns()
Whether invisible columns 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 |
getIncludeSystemCheckConstraints()
whether system generated check constraints should be included.
|
boolean |
getIncludeSystemIndexes()
whether system generated indexes 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.
|
int |
getLogSlowResultsAfterSeconds()
Log slow results 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()
Deprecated.
- 3.14.0 - [#10588] - Use
getConfiguredSyntheticPrimaryKeys() instead. |
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.
|
boolean |
getRegexMatchesPartialQualification()
Whether the regular expressions matching database objects should match
partially qualified names as well as fully qualified and unqualified
names.
|
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()
The sequences contained in this database.
|
List<SequenceDefinition> |
getSequences(SchemaDefinition schema)
The sequences contained in this database.
|
boolean |
getSqlMatchesPartialQualification()
Whether the SQL statements matching database objects should match
partially qualified names as well as fully qualified and unqualified
names.
|
String[] |
getSyntheticIdentities()
Deprecated.
- 3.14.0 - [#10588] - Use
getConfiguredSyntheticIdentities() instead. |
String[] |
getSyntheticPrimaryKeys()
Deprecated.
- 3.14.0 - [#10588] - Use
getConfiguredSyntheticPrimaryKeys() instead. |
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()
The tables contained in this database.
|
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()
The UDTs defined in this database.
|
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()
The unique keys contained in this database.
|
List<UniqueKeyDefinition> |
getUniqueKeys(SchemaDefinition schema)
The unique keys contained in this database.
|
List<EmbeddableDefinitionType> |
getUnusedEmbeddables()
Retrieve the not-yet used embeddables.
|
List<ForcedType> |
getUnusedForcedTypes()
Retrieve the not-yet used forced types.
|
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<SyntheticUniqueKeyType> |
getUnusedSyntheticUniqueKeys()
Retrieve the not-yet used synthetic unique keys.
|
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 |
integerDisplayWidths()
Whether this database includes integer display widths in metadata, where
applicable.
|
boolean |
isArrayType(String dataType)
Check whether a type is an array type.
|
boolean |
javaTimeTypes()
Whether
java.time types are used, as opposed to
java.sql types. |
void |
markUsed(EmbeddableDefinitionType embeddable)
Mark an embeddable as used.
|
void |
markUsed(ForcedType forcedType)
Mark a forced type 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(SyntheticUniqueKeyType uniqueKey)
Mark a synthetic unique key as used.
|
OnError |
onError()
The behaviour when errors are encountered.
|
void |
setBasedir(String basedir)
The basedir that can be used by file based implementations to resolve
relative paths.
|
void |
setCatalogVersionProvider(CatalogVersionProvider provider)
The database's catalog version provider.
|
void |
setConfiguredCatalogs(List<CatalogMappingType> catalogs)
The input and output catalogs.
|
void |
setConfiguredCustomTypes(List<CustomType> types)
Deprecated.
- 3.10.0 - [#5750] - Use
getConfiguredForcedTypes() only. |
void |
setConfiguredEmbeddables(List<EmbeddableDefinitionType> configuredEmbeddables)
Configure the embeddable 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<SchemaMappingType> schemata)
The input and output schemata.
|
void |
setConfiguredSyntheticObjects(SyntheticObjectsType configuredSyntheticObjects)
Configure the synthetic objects.
|
void |
setConnection(Connection connection)
Initialise a connection to this database.
|
void |
setDateAsTimestamp(boolean dateAsTimestamp)
Whether DATE columns should be treated as TIMESTAMP columns.
|
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.
|
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 |
setIncludeCheckConstraints(boolean checkConstraints)
whether check constraints should be included.
|
void |
setIncludeDomains(boolean includeDomains)
whether domains should be included.
|
void |
setIncludeEmbeddables(boolean includeEmbeddables)
Whether embeddable types should be included.
|
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 |
setIncludeInvisibleColumns(boolean includeInvisibleColumns)
Whether invisible columns 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 |
setIncludeSystemCheckConstraints(boolean systemCheckConstraints)
whether system generated check constraints should be included.
|
void |
setIncludeSystemIndexes(boolean systemIndexes)
whether system generated indexes 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 |
setIntegerDisplayWidths(boolean integerDisplayWidths)
Whether this database includes integer display widths in metadata, where
applicable.
|
void |
setJavaTimeTypes(boolean javaTimeTypes)
Whether
java.time types are used, as opposed to
java.sql types. |
void |
setLogSlowQueriesAfterSeconds(int logSlowQueriesAfterSeconds)
Log slow queries after this amount of seconds.
|
void |
setLogSlowResultsAfterSeconds(int logSlowResultsAfterSeconds)
Log slow results after this amount of seconds.
|
void |
setOnError(OnError onError)
The behaviour when errors are encountered.
|
void |
setOrderProvider(Comparator<Definition> provider)
The database's order provider.
|
void |
setOverridePrimaryKeys(String[] primaryKeys)
Deprecated.
- 3.14.0 - [#10588] - Use
#setConfiguredSyntheticKeys(SyntheticKeysType)
instead. |
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 |
setRegexMatchesPartialQualification(boolean regexMatchesPartialQualification)
Whether the regular expressions matching database objects should match
partially qualified names as well as fully qualified and unqualified
names.
|
void |
setSchemaVersionProvider(SchemaVersionProvider provider)
The database's schema version provider.
|
void |
setSqlMatchesPartialQualification(boolean sqlMatchesPartialQualification)
Whether the SQL statements matching database objects should match
partially qualified names as well as fully qualified and unqualified
names.
|
void |
setSupportsUnsignedTypes(boolean supportsUnsignedTypes)
Whether this database supports unsigned types.
|
void |
setSyntheticIdentities(String[] syntheticIdentities)
Deprecated.
- 3.14.0 - [#10588] - Use
#setConfiguredSyntheticKeys(SyntheticKeysType)
instead. |
void |
setSyntheticPrimaryKeys(String[] primaryKeys)
Deprecated.
- 3.14.0 - [#10588] - Use
#setConfiguredSyntheticKeys(SyntheticKeysType)
instead. |
void |
setTableValuedFunctions(boolean tableValuedFunctions)
[#4838] Whether table-valued functions should be reported as tables.
|
<D extends Definition> |
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.
|
List<CatalogDefinition> getCatalogs()
CatalogDefinition getCatalog(String name)
List<SchemaDefinition> getSchemata()
List<SchemaDefinition> getSchemata(CatalogDefinition catalog)
SchemaDefinition getSchema(String name)
Relations getRelations()
List<SequenceDefinition> getSequences()
List<SequenceDefinition> getSequences(SchemaDefinition schema)
List<IdentityDefinition> getIdentities(SchemaDefinition schema)
List<IndexDefinition> getIndexes(SchemaDefinition schema)
List<IndexDefinition> getIndexes(TableDefinition schema)
List<UniqueKeyDefinition> getUniqueKeys()
List<UniqueKeyDefinition> getUniqueKeys(SchemaDefinition schema)
List<ForeignKeyDefinition> getForeignKeys()
List<ForeignKeyDefinition> getForeignKeys(SchemaDefinition schema)
List<CheckConstraintDefinition> getCheckConstraints(SchemaDefinition schema)
List<TableDefinition> getTables()
List<TableDefinition> getTables(SchemaDefinition schema)
TableDefinition getTable(SchemaDefinition schema, String name)
TableDefinition getTable(SchemaDefinition schema, String name, boolean ignoreCase)
TableDefinition getTable(SchemaDefinition schema, Name name)
TableDefinition getTable(SchemaDefinition schema, Name name, boolean ignoreCase)
List<EmbeddableDefinition> getEmbeddables()
List<EmbeddableDefinition> getEmbeddables(SchemaDefinition schema)
List<EmbeddableDefinition> getEmbeddables(TableDefinition table)
List<EmbeddableDefinition> getEmbeddablesByReferencingTable(TableDefinition table)
List<EnumDefinition> getEnums(SchemaDefinition schema)
EnumDefinition getEnum(SchemaDefinition schema, String name)
EnumDefinition getEnum(SchemaDefinition schema, String name, boolean ignoreCase)
EnumDefinition getEnum(SchemaDefinition schema, Name name)
EnumDefinition getEnum(SchemaDefinition schema, Name name, boolean ignoreCase)
List<DomainDefinition> getDomains()
List<DomainDefinition> getDomains(SchemaDefinition schema)
DomainDefinition getDomain(SchemaDefinition schema, String name)
DomainDefinition getDomain(SchemaDefinition schema, String name, boolean ignoreCase)
DomainDefinition getDomain(SchemaDefinition schema, Name name)
DomainDefinition getDomain(SchemaDefinition schema, Name name, boolean ignoreCase)
List<UDTDefinition> getUDTs()
List<UDTDefinition> getUDTs(SchemaDefinition schema)
UDTDefinition getUDT(SchemaDefinition schema, String name)
UDTDefinition getUDT(SchemaDefinition schema, String name, boolean ignoreCase)
UDTDefinition getUDT(SchemaDefinition schema, Name name)
UDTDefinition getUDT(SchemaDefinition schema, Name name, boolean ignoreCase)
List<UDTDefinition> getUDTs(PackageDefinition pkg)
List<ArrayDefinition> getArrays(SchemaDefinition schema)
ArrayDefinition getArray(SchemaDefinition schema, String name)
ArrayDefinition getArray(SchemaDefinition schema, String name, boolean ignoreCase)
ArrayDefinition getArray(SchemaDefinition schema, Name name)
ArrayDefinition getArray(SchemaDefinition schema, Name name, boolean ignoreCase)
List<RoutineDefinition> getRoutines(SchemaDefinition schema)
List<PackageDefinition> getPackages(SchemaDefinition schema)
PackageDefinition getPackage(SchemaDefinition schema, String inputName)
void setConnection(Connection connection)
Connection getConnection()
List<String> getInputCatalogs()
List<String> getInputSchemata()
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).
List<String> getInputSchemata(CatalogDefinition catalog)
List<String> getInputSchemata(String catalog)
@Deprecated String getOutputCatalog(String inputCatalog)
Definition.getOutputName()@Deprecated String getOutputSchema(String inputSchema)
Definition.getOutputName()@Deprecated String getOutputSchema(String inputCatalog, String inputSchema)
Definition.getOutputName()void setConfiguredCatalogs(List<CatalogMappingType> catalogs)
void setConfiguredSchemata(List<SchemaMappingType> schemata)
void setExcludes(String[] excludes)
String[] getExcludes()
void setIncludes(String[] includes)
String[] getIncludes()
void setIncludeExcludeColumns(boolean includeExcludeColumns)
boolean getIncludeExcludeColumns()
void setIncludeForeignKeys(boolean includeForeignKeys)
boolean getIncludeForeignKeys()
void setIncludeUniqueKeys(boolean includeUniqueKeys)
boolean getIncludeUniqueKeys()
void setIncludePrimaryKeys(boolean includePrimaryKeys)
boolean getIncludePrimaryKeys()
void setIncludeCheckConstraints(boolean checkConstraints)
boolean getIncludeCheckConstraints()
void setIncludeSystemIndexes(boolean systemIndexes)
boolean getIncludeSystemIndexes()
void setIncludeSystemCheckConstraints(boolean systemCheckConstraints)
boolean getIncludeSystemCheckConstraints()
void setIncludeIndexes(boolean includeIndexes)
boolean getIncludeIndexes()
void setIncludeDomains(boolean includeDomains)
boolean getIncludeDomains()
void setIncludeSequences(boolean includeSequences)
boolean getIncludeSequences()
void setIncludeUDTs(boolean includeUDTs)
boolean getIncludeUDTs()
void setIncludePackages(boolean includePackages)
boolean getIncludePackages()
void setIncludePackageRoutines(boolean includePackageRoutines)
boolean getIncludePackageRoutines()
void setIncludePackageUDTs(boolean includePackageUDTs)
boolean getIncludePackageUDTs()
void setIncludePackageConstants(boolean includePackageConstants)
boolean getIncludePackageConstants()
void setIncludeRoutines(boolean includeRoutines)
boolean getIncludeRoutines()
void setIncludeTriggerRoutines(boolean includeTriggerRoutines)
boolean getIncludeTriggerRoutines()
void setIncludeTables(boolean includeTables)
boolean getIncludeTables()
void setIncludeEmbeddables(boolean includeEmbeddables)
boolean getIncludeEmbeddables()
void setIncludeInvisibleColumns(boolean includeInvisibleColumns)
boolean getIncludeInvisibleColumns()
void setForceIntegerTypesOnZeroScaleDecimals(boolean forceIntegerTypesOnZeroScaleDecimals)
boolean getForceIntegerTypesOnZeroScaleDecimals()
void setOnError(OnError onError)
OnError onError()
void addFilter(Database.Filter filter)
List<Database.Filter> getFilters()
<D extends Definition> List<D> filterExcludeInclude(List<D> definitions)
<D extends Definition> List<D> sort(List<D> definitions)
getOrderProvider() defined in this database.List<Definition> getIncluded()
List<Definition> getExcluded()
List<Definition> getAll()
void setRegexFlags(List<RegexFlag> regexFlags)
List<RegexFlag> getRegexFlags()
void setRegexMatchesPartialQualification(boolean regexMatchesPartialQualification)
boolean getRegexMatchesPartialQualification()
void setSqlMatchesPartialQualification(boolean sqlMatchesPartialQualification)
boolean getSqlMatchesPartialQualification()
void setRecordVersionFields(String[] recordVersionFields)
String[] getRecordVersionFields()
void setRecordTimestampFields(String[] recordTimestampFields)
String[] getRecordTimestampFields()
@Deprecated void setSyntheticPrimaryKeys(String[] primaryKeys)
#setConfiguredSyntheticKeys(SyntheticKeysType)
instead.@Deprecated String[] getSyntheticPrimaryKeys()
getConfiguredSyntheticPrimaryKeys() instead.@Deprecated void setOverridePrimaryKeys(String[] primaryKeys)
#setConfiguredSyntheticKeys(SyntheticKeysType)
instead.@Deprecated String[] getOverridePrimaryKeys()
getConfiguredSyntheticPrimaryKeys() instead.@Deprecated void setSyntheticIdentities(String[] syntheticIdentities)
#setConfiguredSyntheticKeys(SyntheticKeysType)
instead.@Deprecated String[] getSyntheticIdentities()
getConfiguredSyntheticIdentities() instead.@Deprecated void setConfiguredCustomTypes(List<CustomType> types)
getConfiguredForcedTypes() only.@Deprecated List<CustomType> getConfiguredCustomTypes()
getConfiguredForcedTypes() only.@Deprecated CustomType getConfiguredCustomType(String name)
getConfiguredForcedTypes() only.void setConfiguredEnumTypes(List<EnumType> types)
List<EnumType> getConfiguredEnumTypes()
void setConfiguredForcedTypes(List<ForcedType> types)
int getLogSlowQueriesAfterSeconds()
void setLogSlowQueriesAfterSeconds(int logSlowQueriesAfterSeconds)
int getLogSlowResultsAfterSeconds()
void setLogSlowResultsAfterSeconds(int logSlowResultsAfterSeconds)
SchemaVersionProvider getSchemaVersionProvider()
void setSchemaVersionProvider(SchemaVersionProvider provider)
CatalogVersionProvider getCatalogVersionProvider()
void setCatalogVersionProvider(CatalogVersionProvider provider)
Comparator<Definition> getOrderProvider()
void setOrderProvider(Comparator<Definition> provider)
void markUsed(ForcedType forcedType)
List<ForcedType> getUnusedForcedTypes()
List<ForcedType> getConfiguredForcedTypes()
ForcedType getConfiguredForcedType(Definition definition)
Definition,
or null if no ForcedType matches the definition.ForcedType getConfiguredForcedType(Definition definition, DataTypeDefinition definedType)
Definition,
or null if no ForcedType matches the definition.void setConfiguredEmbeddables(List<EmbeddableDefinitionType> configuredEmbeddables)
List<EmbeddableDefinitionType> getConfiguredEmbeddables()
Definition.void markUsed(EmbeddableDefinitionType embeddable)
List<EmbeddableDefinitionType> getUnusedEmbeddables()
String embeddablePrimaryKeys()
void setEmbeddablePrimaryKeys(String embeddablePrimaryKeys)
String embeddableUniqueKeys()
void setEmbeddableUniqueKeys(String embeddableUniqueKeys)
String embeddableDomains()
void setEmbeddableDomains(String embeddableDomains)
void setConfiguredSyntheticObjects(SyntheticObjectsType configuredSyntheticObjects)
List<SyntheticIdentityType> getConfiguredSyntheticIdentities()
List<SyntheticPrimaryKeyType> getConfiguredSyntheticPrimaryKeys()
List<SyntheticUniqueKeyType> getConfiguredSyntheticUniqueKeys()
List<SyntheticForeignKeyType> getConfiguredSyntheticForeignKeys()
void markUsed(SyntheticIdentityType identity)
List<SyntheticIdentityType> getUnusedSyntheticIdentities()
void markUsed(SyntheticPrimaryKeyType primaryKey)
List<SyntheticPrimaryKeyType> getUnusedSyntheticPrimaryKeys()
void markUsed(SyntheticUniqueKeyType uniqueKey)
List<SyntheticUniqueKeyType> getUnusedSyntheticUniqueKeys()
void markUsed(SyntheticForeignKeyType foreignKey)
List<SyntheticForeignKeyType> getUnusedSyntheticForeignKeys()
SQLDialect getDialect()
DSLContext create()
boolean isArrayType(String dataType)
void setSupportsUnsignedTypes(boolean supportsUnsignedTypes)
boolean supportsUnsignedTypes()
void setIntegerDisplayWidths(boolean integerDisplayWidths)
boolean integerDisplayWidths()
void setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues)
boolean ignoreProcedureReturnValues()
void setDateAsTimestamp(boolean dateAsTimestamp)
boolean dateAsTimestamp()
void setJavaTimeTypes(boolean javaTimeTypes)
java.time types are used, as opposed to
java.sql types.boolean javaTimeTypes()
java.time types are used, as opposed to
java.sql types.void setIncludeRelations(boolean includeRelations)
boolean includeRelations()
void setTableValuedFunctions(boolean tableValuedFunctions)
boolean tableValuedFunctions()
boolean exists(TableField<?,?> field)
boolean existAll(TableField<?,?>... fields)
boolean exists(Table<?> table)
boolean existAll(Table<?>... tables)
void setProperties(Properties 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.
Properties getProperties()
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.
void setBasedir(String basedir)
String getBasedir()
void close()
close in interface AutoCloseableCopyright © 2021. All rights reserved.