org.jooq.meta.Database Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: https://www.jooq.org/legal/licensing
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq.meta;
import java.sql.Connection;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import org.jooq.DSLContext;
import org.jooq.DataType;
import org.jooq.Name;
// ...
import org.jooq.SQLDialect;
import org.jooq.Table;
import org.jooq.TableField;
import org.jooq.meta.jaxb.CatalogMappingType;
import org.jooq.meta.jaxb.CommentType;
import org.jooq.meta.jaxb.CustomType;
import org.jooq.meta.jaxb.EmbeddableDefinitionType;
import org.jooq.meta.jaxb.EnumType;
import org.jooq.meta.jaxb.ForcedType;
import org.jooq.meta.jaxb.OnError;
import org.jooq.meta.jaxb.RegexFlag;
import org.jooq.meta.jaxb.SchemaMappingType;
import org.jooq.meta.jaxb.SyntheticColumnType;
import org.jooq.meta.jaxb.SyntheticDaoType;
import org.jooq.meta.jaxb.SyntheticEnumType;
import org.jooq.meta.jaxb.SyntheticForeignKeyType;
import org.jooq.meta.jaxb.SyntheticIdentityType;
import org.jooq.meta.jaxb.SyntheticObjectsType;
import org.jooq.meta.jaxb.SyntheticPrimaryKeyType;
import org.jooq.meta.jaxb.SyntheticReadonlyColumnType;
import org.jooq.meta.jaxb.SyntheticReadonlyRowidType;
import org.jooq.meta.jaxb.SyntheticUniqueKeyType;
import org.jooq.meta.jaxb.SyntheticViewType;
/**
* A general database model.
*
* @author Lukas Eder
*/
public interface Database extends AutoCloseable {
/**
* Get the sources for all objects that offer sources.
*/
Map getSources();
/**
* Get the comments for all objects that offer comments.
*/
Map getComments();
/**
* The catalogs generated from this database.
*/
List getCatalogs();
/**
* Get a catalog defined in this database by name.
*/
CatalogDefinition getCatalog(String name);
/**
* The schemata generated from this database.
*/
List getSchemata();
/**
* The schemata generated from this database and a given catalog.
*/
List getSchemata(CatalogDefinition catalog);
/**
* Get a schema defined in this database by name.
*/
SchemaDefinition getSchema(String name);
/**
* The XML schema collections generated from this database.
*/
List getXMLSchemaCollections();
/**
* The XML schema collections generated from this database.
*/
List getXMLSchemaCollections(SchemaDefinition schema);
/**
* The XML schema collection generated from this database by name
*/
XMLSchemaCollectionDefinition getXMLSchemaCollection(SchemaDefinition schema, String name);
/**
* Retrieve the schema's primary key / foreign key relations.
*/
Relations getRelations();
/**
* The sequences contained in this database.
*/
List getSequences();
/**
* The sequences contained in this database.
*/
List getSequences(SchemaDefinition schema);
/**
* The identities contained in this database.
*/
List getIdentities(SchemaDefinition schema);
/**
* The indexes contained in this database.
*/
List getIndexes(SchemaDefinition schema);
/**
* The indexes contained in this database.
*/
List getIndexes(TableDefinition schema);
/**
* The unique keys contained in this database.
*/
List getUniqueKeys();
/**
* The unique keys contained in this database.
*/
List getUniqueKeys(SchemaDefinition schema);
/**
* The primary keys contained in this database.
*/
List getPrimaryKeys();
/**
* The primary keys contained in this database.
*/
List getPrimaryKeys(SchemaDefinition schema);
/**
* The unique and primary keys contained in this database.
*/
List getKeys();
/**
* The unique and primary keys contained in this database.
*/
List getKeys(SchemaDefinition schema);
/**
* The foreign keys contained in this database.
*/
List getForeignKeys();
/**
* The foreign keys contained in this database.
*/
List getForeignKeys(SchemaDefinition schema);
/**
* The check constraints contained in this database.
*/
List getCheckConstraints(SchemaDefinition schema);
/**
* The tables contained in this database.
*/
List getTables();
/**
* The tables contained in this database.
*/
List getTables(SchemaDefinition schema);
/**
* 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.
*/
TableDefinition getTable(SchemaDefinition schema, Name name);
/**
* Get a table in this database by name.
*/
TableDefinition getTable(SchemaDefinition schema, Name name, boolean ignoreCase);
/**
* Get all embeddables.
*/
List getEmbeddables();
/**
* Get all embeddables for a given defining schema.
*/
List getEmbeddables(SchemaDefinition schema);
/**
* Get all embeddables for a given defining table.
*/
List getEmbeddables(TableDefinition table);
/**
* Get all embeddables for a given referencing table.
*/
List getEmbeddablesByReferencingTable(TableDefinition table);
/**
* The enum UDTs defined in this database.
*/
List getEnums(SchemaDefinition schema);
/**
* 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.
*/
EnumDefinition getEnum(SchemaDefinition schema, Name name);
/**
* Get an enum UDT defined in this database by name.
*/
EnumDefinition getEnum(SchemaDefinition schema, Name name, boolean ignoreCase);
/**
* The domain UDTs defined in this database.
*/
List getDomains();
/**
* The domain UDTs defined in this database.
*/
List getDomains(SchemaDefinition schema);
/**
* 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.
*/
DomainDefinition getDomain(SchemaDefinition schema, Name name);
/**
* Get an domain UDT defined in this database by name.
*/
DomainDefinition getDomain(SchemaDefinition schema, Name name, boolean ignoreCase);
/**
* The UDTs defined in this database.
*/
List getUDTs();
/**
* The UDTs defined in this database.
*/
List getUDTs(SchemaDefinition schema);
/**
* 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.
*/
UDTDefinition getUDT(SchemaDefinition schema, Name name);
/**
* Get a UDT defined in this database by name.
*/
UDTDefinition getUDT(SchemaDefinition schema, Name name, boolean ignoreCase);
/**
* The UDTs defined in this database.
*/
List getUDTs(PackageDefinition pkg);
/**
* The Arrays defined in this database.
*/
List getArrays(SchemaDefinition schema);
/**
* 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.
*/
ArrayDefinition getArray(SchemaDefinition schema, Name name);
/**
* Get a ARRAY defined in this database by name.
*/
ArrayDefinition getArray(SchemaDefinition schema, Name name, boolean ignoreCase);
/**
* The stored routines (procedures and functions) contained in this
* database.
*/
List getRoutines(SchemaDefinition schema);
/**
* The packages contained in this database.
*/
List getPackages(SchemaDefinition schema);
/**
* Get a package defined in this database by name.
*/
PackageDefinition getPackage(SchemaDefinition schema, String inputName);
/**
* Initialise a connection to this database.
*/
void setConnection(Connection connection);
/**
* The database connection.
*/
Connection getConnection();
/**
* The input catalogs are the catalogs that jooq-meta is reading data from.
*/
List getInputCatalogs();
/**
* 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
* {@link #getInputSchemata(String)} instead to disambiguate schema names
* (e.g. in SQL Server, there are multiple "dbo" schemas).
*/
List getInputSchemata();
/**
* The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
*/
List getInputSchemata(CatalogDefinition catalog);
/**
* The input schemata are the schemata from a given catalog that jooq-meta is reading data from.
*/
List getInputSchemata(String catalog);
/**
* The output catalog is the catalog used by jooq-codegen in class names.
*
* @deprecated - 2.0.5 - This will be implemented in each
* {@link Definition#getOutputName()}
*/
@Deprecated
String getOutputCatalog(String inputCatalog);
/**
* The output schema is the schema used by jooq-codegen in class names.
*
* @deprecated - 2.0.5 - This will be implemented in each
* {@link Definition#getOutputName()}
*/
@Deprecated
String getOutputSchema(String inputSchema);
/**
* The output schema is the schema used by jooq-codegen in class names.
*
* @deprecated - 2.0.5 - This will be implemented in each
* {@link Definition#getOutputName()}
*/
@Deprecated
String getOutputSchema(String inputCatalog, String inputSchema);
/**
* The input and output catalogs.
*/
void setConfiguredCatalogs(List catalogs);
/**
* The input and output schemata.
*/
void setConfiguredSchemata(List schemata);
/**
* Database objects matching any of these regular expressions will not be
* generated.
*/
void setExcludes(String[] excludes);
/**
* Database objects matching any of the regular expressions produced by this
* SQL query will not be generated, in addition to the ones specified by
* {@link #getExcludes()}.
*/
void setExcludeSql(String sql);
/**
* Database objects matching any of these regular expressions will not be
* generated.
*/
String[] getExcludes();
/**
* Database objects matching any of the regular expressions produced by this
* SQL query will not be generated, in addition to the ones specified by
* {@link #getExcludes()}.
*/
String getExcludeSql();
/**
* Only database objects matching any of these regular expressions will be
* generated.
*/
void setIncludes(String[] includes);
/**
* Only database objects matching any of the regular expressions produced by
* this SQL query will be generated, in addition to the ones specified by
* {@link #getIncludes()}.
*/
void setIncludeSql(String sql);
/**
* Only database objects matching any of these regular expressions will be
* generated.
*/
String[] getIncludes();
/**
* Only database objects matching any of the regular expressions produced by
* this SQL query will be generated, in addition to the ones specified by
* {@link #getIncludes()}.
*/
String getIncludeSql();
/**
* Indicate whether include / exclude regular expression shall also match
* database columns.
*/
void setIncludeExcludeColumns(boolean includeExcludeColumns);
/**
* Indicate whether include / exclude regular expression shall also match
* database columns.
*/
boolean getIncludeExcludeColumns();
/**
* Indicate whether include / exclude regular expression shall also match
* package routines.
*/
void setIncludeExcludePackageRoutines(boolean includeExcludePackageRoutines);
/**
* Indicate whether include / exclude regular expression shall also match
* package routines.
*/
boolean getIncludeExcludePackageRoutines();
/**
* whether foreign key relationships should be included.
*/
void setIncludeForeignKeys(boolean includeForeignKeys);
/**
* whether foreign key relationships should be included.
*/
boolean getIncludeForeignKeys();
/**
* whether unique keys should be included.
*/
void setIncludeUniqueKeys(boolean includeUniqueKeys);
/**
* whether unique keys should be included.
*/
boolean getIncludeUniqueKeys();
/**
* whether primary keys should be included.
*/
void setIncludePrimaryKeys(boolean includePrimaryKeys);
/**
* whether primary keys should be included.
*/
boolean getIncludePrimaryKeys();
/**
* whether check constraints should be included.
*/
void setIncludeCheckConstraints(boolean checkConstraints);
/**
* whether check constraints should be included.
*/
boolean getIncludeCheckConstraints();
/**
* whether system generated tables should be included.
*/
void setIncludeSystemTables(boolean systemTables);
/**
* whether system generated tables should be included.
*/
boolean getIncludeSystemTables();
/**
* whether system generated indexes should be included.
*/
void setIncludeSystemIndexes(boolean systemIndexes);
/**
* whether system generated indexes should be included.
*/
boolean getIncludeSystemIndexes();
/**
* whether system generated check constraints should be included.
*/
void setIncludeSystemCheckConstraints(boolean systemCheckConstraints);
/**
* whether system generated check constraints should be included.
*/
boolean getIncludeSystemCheckConstraints();
/**
* whether system generated sequences should be included.
*/
void setIncludeSystemSequences(boolean systemSequences);
/**
* whether system generated sequences should be included.
*/
boolean getIncludeSystemSequences();
/**
* whether system generated UDTs should be included.
*/
void setIncludeSystemUDTs(boolean systemUDTs);
/**
* whether system generated UDTs should be included.
*/
boolean getIncludeSystemUDTs();
/**
* whether indexes should be included.
*/
void setIncludeIndexes(boolean includeIndexes);
/**
* whether indexes should be included.
*/
boolean getIncludeIndexes();
/**
* whether domains should be included.
*/
void setIncludeDomains(boolean includeDomains);
/**
* whether domains should be included.
*/
boolean getIncludeDomains();
/**
* whether sequences should be included.
*/
void setIncludeSequences(boolean includeSequences);
/**
* whether sequences should be included.
*/
boolean getIncludeSequences();
/**
* whether XML schema collections should be included.
*/
boolean getIncludeXMLSchemaCollections();
/**
* whether XML schema collections should be included.
*/
void setIncludeXMLSchemaCollections(boolean includeXMLSchemaCollections);
/**
* whether user defined types should be included.
*/
void setIncludeUDTs(boolean includeUDTs);
/**
* whether user defined types should be included.
*/
boolean getIncludeUDTs();
/**
* whether packages should be included.
*/
void setIncludePackages(boolean includePackages);
/**
* whether packages should be included.
*/
boolean getIncludePackages();
/**
* whether package routines should be included.
*/
void setIncludePackageRoutines(boolean includePackageRoutines);
/**
* whether package routines should be included.
*/
boolean getIncludePackageRoutines();
/**
* whether package UDTs should be included.
*/
void setIncludePackageUDTs(boolean includePackageUDTs);
/**
* whether package UDTs should be included.
*/
boolean getIncludePackageUDTs();
/**
* whether package constants should be included.
*/
void setIncludePackageConstants(boolean includePackageConstants);
/**
* whether package constants should be included.
*/
boolean getIncludePackageConstants();
/**
* whether routines should be included.
*/
void setIncludeRoutines(boolean includeRoutines);
/**
* whether routines should be included.
*/
boolean getIncludeRoutines();
/**
* whether trigger routines should be included.
*/
void setIncludeTriggerRoutines(boolean includeTriggerRoutines);
/**
* whether trigger routines should be included.
*/
boolean getIncludeTriggerRoutines();
/**
* Whether tables (and views) should be included.
*/
void setIncludeTables(boolean includeTables);
/**
* Whether tables (and views) should be included.
*/
boolean getIncludeTables();
/**
* Whether embeddable types should be included.
*/
void setIncludeEmbeddables(boolean includeEmbeddables);
/**
* Whether embeddable types should be included.
*/
boolean getIncludeEmbeddables();
/**
* Whether invisible columns should be included.
*/
void setIncludeInvisibleColumns(boolean includeInvisibleColumns);
/**
* Whether invisible columns should be included.
*/
boolean getIncludeInvisibleColumns();
/**
* Whether zero-scale decimal types should be treated as their most
* appropriate, corresponding integer type.
*/
void setForceIntegerTypesOnZeroScaleDecimals(boolean forceIntegerTypesOnZeroScaleDecimals);
/**
* Whether zero-scale decimal types should be treated as their most
* appropriate, corresponding integer type.
*/
boolean getForceIntegerTypesOnZeroScaleDecimals();
/**
* The behaviour when errors are encountered.
*/
void setOnError(OnError onError);
/**
* The behaviour when errors are encountered.
*/
OnError onError();
/**
* [#3488] Add an additional filter to the database that is applied in
* addition to include / exclude.
*/
void addFilter(Filter filter);
/**
* [#3488] The filters that are applied in addition to include / exclude.
*/
List getFilters();
/**
* Filter a list of definitions according to the exclude / include / and filter settings of this database.
*/
List filterExcludeInclude(List definitions);
/**
* Sort a list of definitions according to the {@link #getOrderProvider()} defined in this database.
*/
List sort(List definitions);
/**
* Retrieve all included objects.
*/
List getIncluded();
/**
* Retrieve all excluded objects.
*/
List getExcluded();
/**
* Retrieve all objects.
*/
List getAll();
/**
* The regular expression flags that should be applied when using regular expressions.
*/
void setRegexFlags(List regexFlags);
/**
* The regular expression flags that should be applied when using regular expressions.
*/
List getRegexFlags();
/**
* Whether the regular expressions matching database objects should match
* partially qualified names as well as fully qualified and unqualified
* names.
*/
void setRegexMatchesPartialQualification(boolean regexMatchesPartialQualification);
/**
* Whether the regular expressions matching database objects should match
* partially qualified names as well as fully qualified and unqualified
* names.
*/
boolean getRegexMatchesPartialQualification();
/**
* Whether the SQL statements matching database objects should match
* partially qualified names as well as fully qualified and unqualified
* names.
*/
void setSqlMatchesPartialQualification(boolean sqlMatchesPartialQualification);
/**
* Whether the SQL statements matching database objects should match
* partially qualified names as well as fully qualified and unqualified
* names.
*/
boolean getSqlMatchesPartialQualification();
/**
* Table columns matching these regular expressions will be considered as
* record version fields in generated code.
*/
void setRecordVersionFields(String[] recordVersionFields);
/**
* Table columns matching these regular expressions will be considered as
* record version fields in generated code.
*/
String[] getRecordVersionFields();
/**
* Table columns matching these regular expressions will be considered as
* record timestamp fields in generated code.
*/
void setRecordTimestampFields(String[] recordTimestampFields);
/**
* Table columns matching these regular expressions will be considered as
* record timestamp fields in generated code.
*/
String[] getRecordTimestampFields();
/**
* Columns matching these regular expressions will be considered as members
* of synthetic primary keys in generated code.
*
* @deprecated - 3.14.0 - [#10588] - Use
* {@link #setConfiguredSyntheticObjects(SyntheticObjectsType)}
* instead.
*/
@Deprecated
void setSyntheticPrimaryKeys(String[] primaryKeys);
/**
* Columns matching these regular expressions will be considered as members
* of synthetic primary keys in generated code.
*
* @deprecated - 3.14.0 - [#10588] - Use
* {@link #getConfiguredSyntheticPrimaryKeys()} instead.
*/
@Deprecated
String[] getSyntheticPrimaryKeys();
/**
* Unique keys matching these regular expressions will be considered as
* primary keys in generated code.
*
* @deprecated - 3.14.0 - [#10588] - Use
* {@link #setConfiguredSyntheticObjects(SyntheticObjectsType)}
* instead.
*/
@Deprecated
void setOverridePrimaryKeys(String[] primaryKeys);
/**
* Unique keys matching these regular expressions will be considered as
* primary keys in generated code.
*
* @deprecated - 3.14.0 - [#10588] - Use
* {@link #getConfiguredSyntheticPrimaryKeys()} instead.
*/
@Deprecated
String[] getOverridePrimaryKeys();
/**
* Columns matching these regular expressions will be considered as identity
* columns in generated code.
*
* @deprecated - 3.14.0 - [#10588] - Use
* {@link #setConfiguredSyntheticObjects(SyntheticObjectsType)}
* instead.
*/
@Deprecated
void setSyntheticIdentities(String[] syntheticIdentities);
/**
* Columns matching these regular expressions will be considered as identity
* columns in generated code.
*
* @deprecated - 3.14.0 - [#10588] - Use
* {@link #getConfiguredSyntheticIdentities()} instead.
*/
@Deprecated
String[] getSyntheticIdentities();
/**
* Database objects matching any of these field names will be generated as
* custom types.
*
* @deprecated - 3.10.0 - [#5750] - Use {@link #getConfiguredForcedTypes()} only.
*/
@Deprecated
void setConfiguredCustomTypes(List types);
/**
* Database objects matching any of these field names will be generated as
* custom types.
*
* @deprecated - 3.10.0 - [#5750] - Use {@link #getConfiguredForcedTypes()} only.
*/
@Deprecated
List getConfiguredCustomTypes();
/**
* Get a specific configured custom type by its name.
*
* @deprecated - 3.10.0 - [#5750] - Use {@link #getConfiguredForcedTypes()} only.
*/
@Deprecated
CustomType getConfiguredCustomType(String name);
/**
* Database objects matching any of these field names will be generated as
* enum types.
*/
void setConfiguredEnumTypes(List types);
/**
* Database objects matching any of these field names will be generated as
* enum types.
*/
List getConfiguredEnumTypes();
/**
* Database objects matching any of these field names will be generated as
* forced types.
*/
void setConfiguredForcedTypes(List types);
/**
* Whether some additional forced types for built in data type extensions,
* such as the ones from jooq-codegen-postgres should be added.
*/
boolean getForcedTypesForBuiltinDataTypeExtensions();
/**
* Whether some additional forced types for built in data type extensions,
* such as the ones from jooq-codegen-postgres should be added.
*/
void setForcedTypesForBuiltinDataTypeExtensions(boolean forcedTypesForBuiltinDataTypeExtensions);
/**
* Whether some additional forced types for
* {@link XMLSchemaCollectionDefinition} types should be created
* automatically for columns that have non-ambiguous references to an
* {@link XMLTypeDefinition}.
*
* This feature is available in the commercial distribution only.
*/
boolean getForcedTypesForXMLSchemaCollections();
/**
* Whether some additional forced types for
* {@link XMLSchemaCollectionDefinition} types should be created
* automatically for columns that have non-ambiguous references to an
* {@link XMLTypeDefinition}.
*
* This feature is available in the commercial distribution only.
*/
void setForcedTypesForXMLSchemaCollections(boolean forcedTypesForXMLSchemaCollections);
/**
* Log slow queries after this amount of seconds.
*/
int getLogSlowQueriesAfterSeconds();
/**
* Log slow queries after this amount of seconds.
*/
void setLogSlowQueriesAfterSeconds(int logSlowQueriesAfterSeconds);
/**
* Log slow results after this amount of seconds.
*/
int getLogSlowResultsAfterSeconds();
/**
* Log slow results after this amount of seconds.
*/
void setLogSlowResultsAfterSeconds(int logSlowResultsAfterSeconds);
/**
* The database's schema version provider.
*/
SchemaVersionProvider getSchemaVersionProvider();
/**
* The database's schema version provider.
*/
void setSchemaVersionProvider(SchemaVersionProvider provider);
/**
* The database's catalog version provider.
*/
CatalogVersionProvider getCatalogVersionProvider();
/**
* The database's catalog version provider.
*/
void setCatalogVersionProvider(CatalogVersionProvider provider);
/**
* The database's order provider.
*/
Comparator getOrderProvider();
/**
* The database's order provider.
*/
void setOrderProvider(Comparator provider);
/**
* Mark a forced type as used.
*/
void markUsed(ForcedType forcedType);
/**
* Retrieve the not-yet used forced types.
*/
List getUnusedForcedTypes();
/**
* Database objects matching any of these field names will be generated as
* forced types.
*/
List getConfiguredForcedTypes();
/**
* Get the configured forced type object for any given {@link Definition},
* or null if no {@link ForcedType} matches the definition.
*/
ForcedType getConfiguredForcedType(Definition definition);
/**
* Get the configured forced type object for any given {@link Definition},
* or null if no {@link ForcedType} matches the definition.
*/
ForcedType getConfiguredForcedType(Definition definition, DataTypeDefinition definedType);
/**
* Configure the embeddable types.
*/
void setConfiguredEmbeddables(List configuredEmbeddables);
/**
* Get the configured embeddable type definitions for any given
* {@link Definition}.
*/
List getConfiguredEmbeddables();
/**
* Mark an embeddable as used.
*/
void markUsed(EmbeddableDefinitionType embeddable);
/**
* Retrieve the not-yet used embeddables.
*/
List getUnusedEmbeddables();
/**
* A regular expression matching primary keys for which embeddable types should be generated.
*
* This feature is available in the commercial distribution only.
*/
String embeddablePrimaryKeys();
/**
* A regular expression matching primary keys for which embeddable types should be generated.
*
* This feature is available in the commercial distribution only.
*/
void setEmbeddablePrimaryKeys(String embeddablePrimaryKeys);
/**
* A regular expression matching unique keys for which embeddable types should be generated.
*
* This feature is available in the commercial distribution only.
*/
String embeddableUniqueKeys();
/**
* A regular expression matching unique keys for which embeddable types should be generated.
*
* This feature is available in the commercial distribution only.
*/
void setEmbeddableUniqueKeys(String embeddableUniqueKeys);
/**
* A regular expression matching domain type definitions for which embeddable types should be generated.
*
* This feature is available in the commercial distribution only.
*/
String embeddableDomains();
/**
* A regular expression matching domain type definitions for which embeddable types should be generated.
*
* This feature is available in the commercial distribution only.
*/
void setEmbeddableDomains(String embeddableDomains);
/**
* Whether identity columns should expose {@link DataType#readonly()}
* behaviour.
*
* This feature is available in the commercial distribution only.
*/
boolean readonlyIdentities();
/**
* Whether identity columns should expose {@link DataType#readonly()}
* behaviour.
*
* This feature is available in the commercial distribution only.
*/
void setReadonlyIdentities(boolean readonlyIdentities);
/**
* Whether computed columns columns should expose
* {@link DataType#readonly()} behaviour.
*
* This feature is available in the commercial distribution only.
*/
boolean readonlyComputedColumns();
/**
* Whether computed columns columns should expose
* {@link DataType#readonly()} behaviour.
*
* This feature is available in the commercial distribution only.
*/
void setReadonlyComputedColumns(boolean readonlyComputedColumns);
/**
* Whether columns that are known not to be updatable (e.g. in views) should
* expose {@link DataType#readonly()} behaviour.
*
* This feature is available in the commercial distribution only.
*/
boolean readonlyNonUpdatableColumns();
/**
* Whether columns that are known not to be updatable (e.g. in views) should
* expose {@link DataType#readonly()} behaviour.
*
* This feature is available in the commercial distribution only.
*/
void setReadonlyNonUpdatableColumns(boolean readonlyNonUpdatableColumns);
/**
* Configure the comments.
*/
void setConfiguredComments(List configuredComments);
/**
* Get the configured comments.
*/
List getConfiguredComments();
/**
* Mark a comment as used.
*/
void markUsed(CommentType comment);
/**
* Retrieve the not-yet used comments.
*/
List getUnusedComments();
/**
* Configure the synthetic objects.
*/
void setConfiguredSyntheticObjects(SyntheticObjectsType configuredSyntheticObjects);
/**
* Get the configured synthetic columns.
*/
List getConfiguredSyntheticColumns();
/**
* Get the configured synthetic readonly columns.
*/
List getConfiguredSyntheticReadonlyColumns();
/**
* Get the configured synthetic readonly rowids.
*/
List getConfiguredSyntheticReadonlyRowids();
/**
* Get the configured synthetic identities.
*/
List getConfiguredSyntheticIdentities();
/**
* Get the configured synthetic enums.
*/
List getConfiguredSyntheticEnums();
/**
* Get the configured forced type object for any given {@link Definition},
* or null if no {@link SyntheticEnumType} matches the definition.
*/
SyntheticEnumType getConfiguredSyntheticEnum(Definition definition);
/**
* Get the configured synthetic primary keys.
*/
List getConfiguredSyntheticPrimaryKeys();
/**
* Get the configured synthetic unique keys.
*/
List getConfiguredSyntheticUniqueKeys();
/**
* Get the configured synthetic foreign keys.
*/
List getConfiguredSyntheticForeignKeys();
/**
* Get the configured synthetic views.
*/
List getConfiguredSyntheticViews();
/**
* Get the configured synthetic DAOs.
*/
List getConfiguredSyntheticDaos();
/**
* Mark a synthetic column as used.
*/
void markUsed(SyntheticColumnType readonlyColumn);
/**
* Retrieve the not-yet used synthetic columns.
*/
List getUnusedSyntheticColumns();
/**
* Mark a synthetic readonly column as used.
*/
void markUsed(SyntheticReadonlyColumnType readonlyColumn);
/**
* Retrieve the not-yet used synthetic readonly columns.
*/
List getUnusedSyntheticReadonlyColumns();
/**
* Mark a synthetic readonly rowids as used.
*/
void markUsed(SyntheticReadonlyRowidType readonlyRowid);
/**
* Retrieve the not-yet used synthetic readonly rowids.
*/
List getUnusedSyntheticReadonlyRowids();
/**
* Mark a synthetic identity as used.
*/
void markUsed(SyntheticIdentityType identity);
/**
* Retrieve the not-yet used synthetic identities.
*/
List getUnusedSyntheticIdentities();
/**
* Mark a synthetic enum as used.
*/
void markUsed(SyntheticEnumType e);
/**
* Retrieve the not-yet used synthetic enums.
*/
List getUnusedSyntheticEnums();
/**
* Mark a synthetic primary key as used.
*/
void markUsed(SyntheticPrimaryKeyType primaryKey);
/**
* Retrieve the not-yet used synthetic primary keys.
*/
List getUnusedSyntheticPrimaryKeys();
/**
* Mark a synthetic unique key as used.
*/
void markUsed(SyntheticUniqueKeyType uniqueKey);
/**
* Retrieve the not-yet used synthetic unique keys.
*/
List getUnusedSyntheticUniqueKeys();
/**
* Mark a synthetic foreign key as used.
*/
void markUsed(SyntheticForeignKeyType foreignKey);
/**
* Retrieve the not-yet used synthetic foreign keys.
*/
List getUnusedSyntheticForeignKeys();
/**
* Mark a synthetic view as used.
*/
void markUsed(SyntheticViewType view);
/**
* Retrieve the not-yet used synthetic views.
*/
List getUnusedSyntheticViews();
/**
* Get the dialect for this database.
*/
SQLDialect getDialect();
/**
* Set the dialect for this database.
*/
void setDialect(SQLDialect dialect);
/**
* Create the factory for this database.
*/
DSLContext create();
/**
* Check whether a type is an array type.
*/
boolean isArrayType(String dataType);
/**
* Whether this database supports unsigned types.
*/
void setSupportsUnsignedTypes(boolean supportsUnsignedTypes);
/**
* Whether this database supports unsigned types.
*/
boolean supportsUnsignedTypes();
/**
* Whether this database includes integer display widths in metadata, where
* applicable.
*/
void setIntegerDisplayWidths(boolean integerDisplayWidths);
/**
* Whether this database includes integer display widths in metadata, where
* applicable.
*/
boolean integerDisplayWidths();
/**
* Whether this database should ignore procedure return values.
*/
void setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues);
/**
* Whether this database should ignore procedure return values.
*/
boolean ignoreProcedureReturnValues();
/**
* Whether DATE columns should be treated as TIMESTAMP columns.
*/
void setDateAsTimestamp(boolean dateAsTimestamp);
/**
* Whether DATE columns should be treated as TIMESTAMP columns.
*/
boolean dateAsTimestamp();
/**
* Whether java.time types are used, as opposed to
* java.sql types.
*/
void setJavaTimeTypes(boolean javaTimeTypes);
/**
* Whether java.time types are used, as opposed to
* java.sql types.
*/
boolean javaTimeTypes();
/**
* [#3559] Whether relations (i.e. constraints) should be included in this database.
*/
void setIncludeRelations(boolean includeRelations);
/**
* [#3559] Whether relations (i.e. constraints) should be included in this database.
*/
boolean includeRelations();
/**
* [#4838] Whether table-valued functions should be reported as tables.
*/
void setTableValuedFunctions(boolean tableValuedFunctions);
/**
* [#4838] Whether table-valued functions should be reported as tables.
*/
boolean tableValuedFunctions();
/**
* Check for the existence of a table field in the dictionary views.
*/
boolean exists(TableField field);
/**
* Check for the existence of several table fields in the dictionary views.
*/
boolean existAll(TableField... fields);
/**
* Check for the existence of a table in the dictionary views.
*/
boolean exists(Table table);
/**
* Check for the existence of several tables in the dictionary views.
*/
boolean existAll(Table... tables);
/**
* 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.
*/
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.
*/
Properties getProperties();
/**
* The basedir that can be used by file based implementations to resolve
* relative paths.
*/
void setBasedir(String basedir);
/**
* The basedir that can be used by file based implementations to resolve
* relative paths.
*/
String getBasedir();
/**
* Release any resources that this Database may have allocated.
*/
@Override
void close();
/**
* A filter type that can be used with {@link Database#addFilter(Filter)}
*/
public interface Filter {
/**
* Whether to include an object in this database.
*/
boolean exclude(Definition definition);
}
}