- java.lang.Object
-
- org.jooq.meta.jaxb.Database
-
- All Implemented Interfaces:
Serializable,XMLAppendable
public class Database extends Object implements Serializable, XMLAppendable
Configuration of the database meta data source.- See Also:
- Serialized Form
-
-
Field Summary
-
Constructor Summary
Constructors Constructor Description Database()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidappendTo(XMLBuilder builder)booleanequals(Object that)List<CatalogMappingType>getCatalogs()StringgetCatalogVersionProvider()A custom version number that, if available, will be used to assess whether thegetInputCatalog()from a given catalog will need to be regenerated.List<CommentType>getComments()List<CustomType>getCustomTypes()Deprecated.StringgetEmbeddableDomains()A regular expression matching all domain type declarations for which wrapper types should be generated.StringgetEmbeddablePrimaryKeys()A regular expression matching all primary key declarations for which wrapper types should be generated, and for their referencing foreign keys.List<EmbeddableDefinitionType>getEmbeddables()StringgetEmbeddableUniqueKeys()A regular expression matching all unique key declarations for which wrapper types should be generated, and for their referencing foreign keys.List<EnumType>getEnumTypes()Deprecated.StringgetExcludes()All elements that are excluded from your schema.List<ForcedType>getForcedTypes()StringgetIncludes()All elements that are generated from your schema.StringgetInputCatalog()The catalog that is used locally as a source for meta information.StringgetInputSchema()The schema that is used locally as a source for meta information.IntegergetLogSlowQueriesAfterSeconds()The number of seconds that are considered "slow" before a query is logged to indicate a bug, 0 for not logging.IntegergetLogSlowResultsAfterSeconds()The number of seconds that are considered "slow" before a result set is logged to indicate a bug, 0 for not logging.StringgetName()The database dialect from jooq-meta.StringgetOrderProvider()A customComparatorthat can compare twoDefinitionobjects to determine their order.StringgetOutputCatalog()The catalog that is used in generated source code.StringgetOutputSchema()The schema that is used in generated source code.StringgetOverridePrimaryKeys()All (UNIQUE) key names that should be used instead of primary keys on generatedUpdatableRecord.List<Property>getProperties()StringgetRecordTimestampFields()All table and view columns that are used as "timestamp" fields for optimistic locking.StringgetRecordVersionFields()All table and view columns that are used as "version" fields for optimistic locking.List<RegexFlag>getRegexFlags()The flags that will be applied to all regular expressions from this configuration by default.List<SchemaMappingType>getSchemata()StringgetSchemaVersionProvider()A custom version number that, if available, will be used to assess whether thegetInputSchema()will need to be regenerated.StringgetSyntheticIdentities()A regular expression matching all columns that represent identities.SyntheticObjectsTypegetSyntheticObjects()The synthetic objects configuration.StringgetSyntheticPrimaryKeys()A regular expression matching all columns that participate in "synthetic" primary keys, which should be placed on generatedUpdatableRecordinthashCode()BooleanisDateAsTimestamp()GenerateTimestampfields for DATE columns.BooleanisForceIntegerTypesOnZeroScaleDecimals()Historically, zero-scale decimal types are generated as their most appropriate, corresponding integer type (e.g.BooleanisIgnoreProcedureReturnValues()Deprecated.This feature is deprecated as of jOOQ 3.6.0 and will be removed again in jOOQ 4.0.BooleanisIncludeCheckConstraints()This flag indicates whether check constraints should be included in output produced by this databaseBooleanisIncludeDomains()This flag indicates whether domains should be included in output produced by this databaseBooleanisIncludeEmbeddables()This flag indicates whether embeddable types should be included in output produced by this databaseBooleanisIncludeExcludeColumns()This flag indicates whether include / exclude patterns should also match columns within tables.BooleanisIncludeExcludePackageRoutines()This flag indicates whether include / exclude patterns should also match routines within packages.BooleanisIncludeForeignKeys()This flag indicates whether foreign keys should be included in output produced by this databaseBooleanisIncludeIndexes()This flag indicates whether indexes should be included in output produced by this databaseBooleanisIncludeInvisibleColumns()This flag indicates whether invisible columns should be included in output produced by this databaseBooleanisIncludePackageConstants()This flag indicates whether constants contained in packages should be included in output produced by this databaseBooleanisIncludePackageRoutines()This flag indicates whether routines contained in packages should be included in output produced by this databaseBooleanisIncludePackages()This flag indicates whether packages should be included in output produced by this databaseBooleanisIncludePackageUDTs()This flag indicates whether UDTs contained in packages should be included in output produced by this databaseBooleanisIncludePrimaryKeys()This flag indicates whether primary keys should be included in output produced by this databaseBooleanisIncludeRoutines()This flag indicates whether routines should be included in output produced by this databaseBooleanisIncludeSequences()This flag indicates whether sequences should be included in output produced by this databaseBooleanisIncludeSystemCheckConstraints()This flag indicates whether system generated check constraints should be included in output produced by this databaseBooleanisIncludeSystemIndexes()This flag indicates whether system generated indexes should be included in output produced by this databaseBooleanisIncludeSystemSequences()This flag indicates whether system generated sequences should be included in output produced by this databaseBooleanisIncludeSystemTables()This flag indicates whether system tables should be included in output produced by this databaseBooleanisIncludeSystemUDTs()This flag indicates whether system generated UDTs should be included in output produced by this databaseBooleanisIncludeTables()This flag indicates whether tables should be included in output produced by this databaseBooleanisIncludeTriggerRoutines()This flag indicates whether trigger implementation routines should be included in output produced by this database (e.g. in PostgreSQL)BooleanisIncludeUDTs()This flag indicates whether udts should be included in output produced by this databaseBooleanisIncludeUniqueKeys()This flag indicates whether unique keys should be included in output produced by this databaseBooleanisIntegerDisplayWidths()Include display width in type declaration.BooleanisOutputCatalogToDefault()A flag to indicate that the outputCatalog should be the "default" catalog, which generates catalog-less, unqualified tables, procedures, etc.BooleanisOutputSchemaToDefault()A flag to indicate that the outputSchema should be the "default" schema, which generates schema-less, unqualified tables, procedures, etc.BooleanisRegexMatchesPartialQualification()Whether regular expressions that match qualified object names also match partial qualifications (e.g.BooleanisSqlMatchesPartialQualification()Whether SQL queries that match qualified object names also match partial qualifications (e.g.BooleanisTableValuedFunctions()Whether table valued functions should be reported as tables.BooleanisUnsignedTypes()Generate jOOU data types for your unsigned data types, which are not natively supported in JavavoidsetCatalogs(List<CatalogMappingType> catalogs)voidsetCatalogVersionProvider(String value)A custom version number that, if available, will be used to assess whether thegetInputCatalog()from a given catalog will need to be regenerated.voidsetComments(List<CommentType> comments)voidsetCustomTypes(List<CustomType> customTypes)Deprecated.voidsetDateAsTimestamp(Boolean value)Sets the value of the dateAsTimestamp property.voidsetEmbeddableDomains(String value)A regular expression matching all domain type declarations for which wrapper types should be generated.voidsetEmbeddablePrimaryKeys(String value)A regular expression matching all primary key declarations for which wrapper types should be generated, and for their referencing foreign keys.voidsetEmbeddables(List<EmbeddableDefinitionType> embeddables)voidsetEmbeddableUniqueKeys(String value)A regular expression matching all unique key declarations for which wrapper types should be generated, and for their referencing foreign keys.voidsetEnumTypes(List<EnumType> enumTypes)Deprecated.voidsetExcludes(String value)All elements that are excluded from your schema.voidsetForcedTypes(List<ForcedType> forcedTypes)voidsetForceIntegerTypesOnZeroScaleDecimals(Boolean value)Sets the value of the forceIntegerTypesOnZeroScaleDecimals property.voidsetIgnoreProcedureReturnValues(Boolean value)Deprecated.voidsetIncludeCheckConstraints(Boolean value)Sets the value of the includeCheckConstraints property.voidsetIncludeDomains(Boolean value)Sets the value of the includeDomains property.voidsetIncludeEmbeddables(Boolean value)Sets the value of the includeEmbeddables property.voidsetIncludeExcludeColumns(Boolean value)Sets the value of the includeExcludeColumns property.voidsetIncludeExcludePackageRoutines(Boolean value)Sets the value of the includeExcludePackageRoutines property.voidsetIncludeForeignKeys(Boolean value)Sets the value of the includeForeignKeys property.voidsetIncludeIndexes(Boolean value)Sets the value of the includeIndexes property.voidsetIncludeInvisibleColumns(Boolean value)Sets the value of the includeInvisibleColumns property.voidsetIncludePackageConstants(Boolean value)Sets the value of the includePackageConstants property.voidsetIncludePackageRoutines(Boolean value)Sets the value of the includePackageRoutines property.voidsetIncludePackages(Boolean value)Sets the value of the includePackages property.voidsetIncludePackageUDTs(Boolean value)Sets the value of the includePackageUDTs property.voidsetIncludePrimaryKeys(Boolean value)Sets the value of the includePrimaryKeys property.voidsetIncludeRoutines(Boolean value)Sets the value of the includeRoutines property.voidsetIncludes(String value)All elements that are generated from your schema.voidsetIncludeSequences(Boolean value)Sets the value of the includeSequences property.voidsetIncludeSystemCheckConstraints(Boolean value)Sets the value of the includeSystemCheckConstraints property.voidsetIncludeSystemIndexes(Boolean value)Sets the value of the includeSystemIndexes property.voidsetIncludeSystemSequences(Boolean value)Sets the value of the includeSystemSequences property.voidsetIncludeSystemTables(Boolean value)Sets the value of the includeSystemTables property.voidsetIncludeSystemUDTs(Boolean value)Sets the value of the includeSystemUDTs property.voidsetIncludeTables(Boolean value)Sets the value of the includeTables property.voidsetIncludeTriggerRoutines(Boolean value)Sets the value of the includeTriggerRoutines property.voidsetIncludeUDTs(Boolean value)Sets the value of the includeUDTs property.voidsetIncludeUniqueKeys(Boolean value)Sets the value of the includeUniqueKeys property.voidsetInputCatalog(String value)The catalog that is used locally as a source for meta information.voidsetInputSchema(String value)The schema that is used locally as a source for meta information.voidsetIntegerDisplayWidths(Boolean value)Sets the value of the integerDisplayWidths property.voidsetLogSlowQueriesAfterSeconds(Integer value)The number of seconds that are considered "slow" before a query is logged to indicate a bug, 0 for not logging.voidsetLogSlowResultsAfterSeconds(Integer value)The number of seconds that are considered "slow" before a result set is logged to indicate a bug, 0 for not logging.voidsetName(String value)The database dialect from jooq-meta.voidsetOrderProvider(String value)A customComparatorthat can compare twoDefinitionobjects to determine their order.voidsetOutputCatalog(String value)The catalog that is used in generated source code.voidsetOutputCatalogToDefault(Boolean value)Sets the value of the outputCatalogToDefault property.voidsetOutputSchema(String value)The schema that is used in generated source code.voidsetOutputSchemaToDefault(Boolean value)Sets the value of the outputSchemaToDefault property.voidsetOverridePrimaryKeys(String value)All (UNIQUE) key names that should be used instead of primary keys on generatedUpdatableRecord.voidsetProperties(List<Property> properties)voidsetRecordTimestampFields(String value)All table and view columns that are used as "timestamp" fields for optimistic locking.voidsetRecordVersionFields(String value)All table and view columns that are used as "version" fields for optimistic locking.voidsetRegexMatchesPartialQualification(Boolean value)Sets the value of the regexMatchesPartialQualification property.voidsetSchemata(List<SchemaMappingType> schemata)voidsetSchemaVersionProvider(String value)A custom version number that, if available, will be used to assess whether thegetInputSchema()will need to be regenerated.voidsetSqlMatchesPartialQualification(Boolean value)Sets the value of the sqlMatchesPartialQualification property.voidsetSyntheticIdentities(String value)A regular expression matching all columns that represent identities.voidsetSyntheticObjects(SyntheticObjectsType value)The synthetic objects configuration.voidsetSyntheticPrimaryKeys(String value)A regular expression matching all columns that participate in "synthetic" primary keys, which should be placed on generatedUpdatableRecordvoidsetTableValuedFunctions(Boolean value)Sets the value of the tableValuedFunctions property.voidsetUnsignedTypes(Boolean value)Sets the value of the unsignedTypes property.StringtoString()DatabasewithCatalogs(Collection<CatalogMappingType> values)DatabasewithCatalogs(List<CatalogMappingType> catalogs)DatabasewithCatalogs(CatalogMappingType... values)DatabasewithCatalogVersionProvider(String value)A custom version number that, if available, will be used to assess whether thegetInputCatalog()from a given catalog will need to be regenerated.DatabasewithComments(Collection<CommentType> values)DatabasewithComments(List<CommentType> comments)DatabasewithComments(CommentType... values)DatabasewithCustomTypes(Collection<CustomType> values)Deprecated.DatabasewithCustomTypes(List<CustomType> customTypes)Deprecated.DatabasewithCustomTypes(CustomType... values)Deprecated.DatabasewithDateAsTimestamp(Boolean value)DatabasewithEmbeddableDomains(String value)A regular expression matching all domain type declarations for which wrapper types should be generated.DatabasewithEmbeddablePrimaryKeys(String value)A regular expression matching all primary key declarations for which wrapper types should be generated, and for their referencing foreign keys.DatabasewithEmbeddables(Collection<EmbeddableDefinitionType> values)DatabasewithEmbeddables(List<EmbeddableDefinitionType> embeddables)DatabasewithEmbeddables(EmbeddableDefinitionType... values)DatabasewithEmbeddableUniqueKeys(String value)A regular expression matching all unique key declarations for which wrapper types should be generated, and for their referencing foreign keys.DatabasewithEnumTypes(Collection<EnumType> values)Deprecated.DatabasewithEnumTypes(List<EnumType> enumTypes)Deprecated.DatabasewithEnumTypes(EnumType... values)Deprecated.DatabasewithExcludes(String value)All elements that are excluded from your schema.DatabasewithForcedTypes(Collection<ForcedType> values)DatabasewithForcedTypes(List<ForcedType> forcedTypes)DatabasewithForcedTypes(ForcedType... values)DatabasewithForceIntegerTypesOnZeroScaleDecimals(Boolean value)DatabasewithIgnoreProcedureReturnValues(Boolean value)DatabasewithIncludeCheckConstraints(Boolean value)DatabasewithIncludeDomains(Boolean value)DatabasewithIncludeEmbeddables(Boolean value)DatabasewithIncludeExcludeColumns(Boolean value)DatabasewithIncludeExcludePackageRoutines(Boolean value)DatabasewithIncludeForeignKeys(Boolean value)DatabasewithIncludeIndexes(Boolean value)DatabasewithIncludeInvisibleColumns(Boolean value)DatabasewithIncludePackageConstants(Boolean value)DatabasewithIncludePackageRoutines(Boolean value)DatabasewithIncludePackages(Boolean value)DatabasewithIncludePackageUDTs(Boolean value)DatabasewithIncludePrimaryKeys(Boolean value)DatabasewithIncludeRoutines(Boolean value)DatabasewithIncludes(String value)All elements that are generated from your schema.DatabasewithIncludeSequences(Boolean value)DatabasewithIncludeSystemCheckConstraints(Boolean value)DatabasewithIncludeSystemIndexes(Boolean value)DatabasewithIncludeSystemSequences(Boolean value)DatabasewithIncludeSystemTables(Boolean value)DatabasewithIncludeSystemUDTs(Boolean value)DatabasewithIncludeTables(Boolean value)DatabasewithIncludeTriggerRoutines(Boolean value)DatabasewithIncludeUDTs(Boolean value)DatabasewithIncludeUniqueKeys(Boolean value)DatabasewithInputCatalog(String value)The catalog that is used locally as a source for meta information.DatabasewithInputSchema(String value)The schema that is used locally as a source for meta information.DatabasewithIntegerDisplayWidths(Boolean value)DatabasewithLogSlowQueriesAfterSeconds(Integer value)The number of seconds that are considered "slow" before a query is logged to indicate a bug, 0 for not logging.DatabasewithLogSlowResultsAfterSeconds(Integer value)The number of seconds that are considered "slow" before a result set is logged to indicate a bug, 0 for not logging.DatabasewithName(String value)The database dialect from jooq-meta.DatabasewithOrderProvider(String value)A customComparatorthat can compare twoDefinitionobjects to determine their order.DatabasewithOutputCatalog(String value)The catalog that is used in generated source code.DatabasewithOutputCatalogToDefault(Boolean value)DatabasewithOutputSchema(String value)The schema that is used in generated source code.DatabasewithOutputSchemaToDefault(Boolean value)DatabasewithOverridePrimaryKeys(String value)All (UNIQUE) key names that should be used instead of primary keys on generatedUpdatableRecord.DatabasewithProperties(Collection<Property> values)DatabasewithProperties(List<Property> properties)DatabasewithProperties(Property... values)DatabasewithRecordTimestampFields(String value)All table and view columns that are used as "timestamp" fields for optimistic locking.DatabasewithRecordVersionFields(String value)All table and view columns that are used as "version" fields for optimistic locking.DatabasewithRegexFlags(Collection<RegexFlag> values)The flags that will be applied to all regular expressions from this configuration by default.DatabasewithRegexFlags(RegexFlag... values)The flags that will be applied to all regular expressions from this configuration by default.DatabasewithRegexMatchesPartialQualification(Boolean value)DatabasewithSchemata(Collection<SchemaMappingType> values)DatabasewithSchemata(List<SchemaMappingType> schemata)DatabasewithSchemata(SchemaMappingType... values)DatabasewithSchemaVersionProvider(String value)A custom version number that, if available, will be used to assess whether thegetInputSchema()will need to be regenerated.DatabasewithSqlMatchesPartialQualification(Boolean value)DatabasewithSyntheticIdentities(String value)A regular expression matching all columns that represent identities.DatabasewithSyntheticObjects(SyntheticObjectsType value)The synthetic objects configuration.DatabasewithSyntheticPrimaryKeys(String value)A regular expression matching all columns that participate in "synthetic" primary keys, which should be placed on generatedUpdatableRecordDatabasewithTableValuedFunctions(Boolean value)DatabasewithUnsignedTypes(Boolean value)
-
-
-
Field Detail
-
name
protected String name
-
regexMatchesPartialQualification
protected Boolean regexMatchesPartialQualification
-
sqlMatchesPartialQualification
protected Boolean sqlMatchesPartialQualification
-
includes
protected String includes
-
excludes
protected String excludes
-
includeExcludeColumns
protected Boolean includeExcludeColumns
-
includeExcludePackageRoutines
protected Boolean includeExcludePackageRoutines
-
includeTables
protected Boolean includeTables
-
includeEmbeddables
protected Boolean includeEmbeddables
-
includeRoutines
protected Boolean includeRoutines
-
includeTriggerRoutines
protected Boolean includeTriggerRoutines
-
includePackages
protected Boolean includePackages
-
includePackageRoutines
protected Boolean includePackageRoutines
-
includePackageUDTs
protected Boolean includePackageUDTs
-
includePackageConstants
protected Boolean includePackageConstants
-
includeUDTs
protected Boolean includeUDTs
-
includeDomains
protected Boolean includeDomains
-
includeSequences
protected Boolean includeSequences
-
includeIndexes
protected Boolean includeIndexes
-
includePrimaryKeys
protected Boolean includePrimaryKeys
-
includeUniqueKeys
protected Boolean includeUniqueKeys
-
includeForeignKeys
protected Boolean includeForeignKeys
-
includeCheckConstraints
protected Boolean includeCheckConstraints
-
includeSystemTables
protected Boolean includeSystemTables
-
includeSystemIndexes
protected Boolean includeSystemIndexes
-
includeSystemCheckConstraints
protected Boolean includeSystemCheckConstraints
-
includeSystemSequences
protected Boolean includeSystemSequences
-
includeSystemUDTs
protected Boolean includeSystemUDTs
-
includeInvisibleColumns
protected Boolean includeInvisibleColumns
-
recordVersionFields
protected String recordVersionFields
-
recordTimestampFields
protected String recordTimestampFields
-
syntheticObjects
protected SyntheticObjectsType syntheticObjects
-
syntheticIdentities
protected String syntheticIdentities
-
syntheticPrimaryKeys
protected String syntheticPrimaryKeys
-
overridePrimaryKeys
protected String overridePrimaryKeys
-
dateAsTimestamp
protected Boolean dateAsTimestamp
-
ignoreProcedureReturnValues
protected Boolean ignoreProcedureReturnValues
-
unsignedTypes
protected Boolean unsignedTypes
-
integerDisplayWidths
protected Boolean integerDisplayWidths
-
inputCatalog
protected String inputCatalog
-
outputCatalog
protected String outputCatalog
-
outputCatalogToDefault
protected Boolean outputCatalogToDefault
-
inputSchema
protected String inputSchema
-
outputSchema
protected String outputSchema
-
outputSchemaToDefault
protected Boolean outputSchemaToDefault
-
schemaVersionProvider
protected String schemaVersionProvider
-
catalogVersionProvider
protected String catalogVersionProvider
-
orderProvider
protected String orderProvider
-
embeddablePrimaryKeys
protected String embeddablePrimaryKeys
-
embeddableUniqueKeys
protected String embeddableUniqueKeys
-
embeddableDomains
protected String embeddableDomains
-
forceIntegerTypesOnZeroScaleDecimals
protected Boolean forceIntegerTypesOnZeroScaleDecimals
-
tableValuedFunctions
protected Boolean tableValuedFunctions
-
logSlowQueriesAfterSeconds
protected Integer logSlowQueriesAfterSeconds
-
logSlowResultsAfterSeconds
protected Integer logSlowResultsAfterSeconds
-
comments
protected List<CommentType> comments
-
catalogs
protected List<CatalogMappingType> catalogs
-
schemata
protected List<SchemaMappingType> schemata
-
embeddables
protected List<EmbeddableDefinitionType> embeddables
-
customTypes
protected List<CustomType> customTypes
-
forcedTypes
protected List<ForcedType> forcedTypes
-
-
Method Detail
-
getName
public String getName()
The database dialect from jooq-meta. Available dialects are namedorg.util.[database].[database]Database.Natively supported values are:
org.jooq.meta.ase.ASEDatabaseorg.jooq.meta.cockroachdb.CockroachDBDatabaseorg.jooq.meta.db2.DB2DatabaseDerbyDatabaseFirebirdDatabaseH2Databaseorg.jooq.meta.hana.HanaDatabaseHSQLDBDatabaseorg.jooq.meta.informix.InformixDatabaseorg.jooq.meta.ingres.IngresDatabaseMariaDBDatabaseMySQLDatabaseorg.jooq.meta.oracle.OracleDatabasePostgresDatabaseorg.jooq.meta.redshift.RedshiftDatabaseSQLiteDatabaseorg.jooq.meta.sqlserver.SQLServerDatabaseorg.jooq.meta.sybase.SybaseDatabaseorg.jooq.meta.vertica.VerticaDatabase
This value can be used to reverse-engineer generic JDBC DatabaseMetaData (e.g. for MS Access).
This value can be used to reverse-engineer standard jOOQ-meta XML formats.
This value can be used to reverse-engineer JPA annotated entities
org.jooq.meta.extensions.jpa.JPADatabase
You can also provide your own org.jooq.meta.Database implementation here, if your database is currently not supported
-
setName
public void setName(String value)
The database dialect from jooq-meta. Available dialects are namedorg.util.[database].[database]Database.Natively supported values are:
org.jooq.meta.ase.ASEDatabaseorg.jooq.meta.cockroachdb.CockroachDBDatabaseorg.jooq.meta.db2.DB2DatabaseDerbyDatabaseFirebirdDatabaseH2Databaseorg.jooq.meta.hana.HanaDatabaseHSQLDBDatabaseorg.jooq.meta.informix.InformixDatabaseorg.jooq.meta.ingres.IngresDatabaseMariaDBDatabaseMySQLDatabaseorg.jooq.meta.oracle.OracleDatabasePostgresDatabaseorg.jooq.meta.redshift.RedshiftDatabaseSQLiteDatabaseorg.jooq.meta.sqlserver.SQLServerDatabaseorg.jooq.meta.sybase.SybaseDatabaseorg.jooq.meta.vertica.VerticaDatabase
This value can be used to reverse-engineer generic JDBC DatabaseMetaData (e.g. for MS Access).
This value can be used to reverse-engineer standard jOOQ-meta XML formats.
This value can be used to reverse-engineer JPA annotated entities
org.jooq.meta.extensions.jpa.JPADatabase
You can also provide your own org.jooq.meta.Database implementation here, if your database is currently not supported
-
getRegexFlags
public List<RegexFlag> getRegexFlags()
The flags that will be applied to all regular expressions from this configuration by default.The default value is "COMMENTS CASE_INSENSITIVE"Gets the value of the regexFlags property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
setmethod for the regexFlags property.For example, to add a new item, do as follows:
getRegexFlags().add(newItem);Objects of the following type(s) are allowed in the list
RegexFlag
-
isRegexMatchesPartialQualification
public Boolean isRegexMatchesPartialQualification()
Whether regular expressions that match qualified object names also match partial qualifications (e.g. `table\.column` matches `schema.table.column`) or only full and/or no qualifications (e.g. `schema\.table\.column` and `column` match `schema.table.column`)- Returns:
- possible object is
Boolean
-
setRegexMatchesPartialQualification
public void setRegexMatchesPartialQualification(Boolean value)
Sets the value of the regexMatchesPartialQualification property.- Parameters:
value- allowed object isBoolean
-
isSqlMatchesPartialQualification
public Boolean isSqlMatchesPartialQualification()
Whether SQL queries that match qualified object names also match partial qualifications (e.g. `table\.column` matches `schema.table.column`) or only full and/or no qualifications (e.g. `schema\.table\.column` and `column` match `schema.table.column`)- Returns:
- possible object is
Boolean
-
setSqlMatchesPartialQualification
public void setSqlMatchesPartialQualification(Boolean value)
Sets the value of the sqlMatchesPartialQualification property.- Parameters:
value- allowed object isBoolean
-
getIncludes
public String getIncludes()
All elements that are generated from your schema.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
getRegexFlags().
-
setIncludes
public void setIncludes(String value)
All elements that are generated from your schema.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
getRegexFlags().
-
getExcludes
public String getExcludes()
All elements that are excluded from your schema.This is a Java regular expression. Use the pipe to separate several expressions. Excludes match before includes, i.e. excludes have a higher priority.
-
setExcludes
public void setExcludes(String value)
All elements that are excluded from your schema.This is a Java regular expression. Use the pipe to separate several expressions. Excludes match before includes, i.e. excludes have a higher priority.
-
isIncludeExcludeColumns
public Boolean isIncludeExcludeColumns()
This flag indicates whether include / exclude patterns should also match columns within tables.- Returns:
- possible object is
Boolean
-
setIncludeExcludeColumns
public void setIncludeExcludeColumns(Boolean value)
Sets the value of the includeExcludeColumns property.- Parameters:
value- allowed object isBoolean
-
isIncludeExcludePackageRoutines
public Boolean isIncludeExcludePackageRoutines()
This flag indicates whether include / exclude patterns should also match routines within packages.- Returns:
- possible object is
Boolean
-
setIncludeExcludePackageRoutines
public void setIncludeExcludePackageRoutines(Boolean value)
Sets the value of the includeExcludePackageRoutines property.- Parameters:
value- allowed object isBoolean
-
isIncludeTables
public Boolean isIncludeTables()
This flag indicates whether tables should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeTables
public void setIncludeTables(Boolean value)
Sets the value of the includeTables property.- Parameters:
value- allowed object isBoolean
-
isIncludeEmbeddables
public Boolean isIncludeEmbeddables()
This flag indicates whether embeddable types should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeEmbeddables
public void setIncludeEmbeddables(Boolean value)
Sets the value of the includeEmbeddables property.- Parameters:
value- allowed object isBoolean
-
isIncludeRoutines
public Boolean isIncludeRoutines()
This flag indicates whether routines should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeRoutines
public void setIncludeRoutines(Boolean value)
Sets the value of the includeRoutines property.- Parameters:
value- allowed object isBoolean
-
isIncludeTriggerRoutines
public Boolean isIncludeTriggerRoutines()
This flag indicates whether trigger implementation routines should be included in output produced by this database (e.g. in PostgreSQL)- Returns:
- possible object is
Boolean
-
setIncludeTriggerRoutines
public void setIncludeTriggerRoutines(Boolean value)
Sets the value of the includeTriggerRoutines property.- Parameters:
value- allowed object isBoolean
-
isIncludePackages
public Boolean isIncludePackages()
This flag indicates whether packages should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludePackages
public void setIncludePackages(Boolean value)
Sets the value of the includePackages property.- Parameters:
value- allowed object isBoolean
-
isIncludePackageRoutines
public Boolean isIncludePackageRoutines()
This flag indicates whether routines contained in packages should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludePackageRoutines
public void setIncludePackageRoutines(Boolean value)
Sets the value of the includePackageRoutines property.- Parameters:
value- allowed object isBoolean
-
isIncludePackageUDTs
public Boolean isIncludePackageUDTs()
This flag indicates whether UDTs contained in packages should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludePackageUDTs
public void setIncludePackageUDTs(Boolean value)
Sets the value of the includePackageUDTs property.- Parameters:
value- allowed object isBoolean
-
isIncludePackageConstants
public Boolean isIncludePackageConstants()
This flag indicates whether constants contained in packages should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludePackageConstants
public void setIncludePackageConstants(Boolean value)
Sets the value of the includePackageConstants property.- Parameters:
value- allowed object isBoolean
-
isIncludeUDTs
public Boolean isIncludeUDTs()
This flag indicates whether udts should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeUDTs
public void setIncludeUDTs(Boolean value)
Sets the value of the includeUDTs property.- Parameters:
value- allowed object isBoolean
-
isIncludeDomains
public Boolean isIncludeDomains()
This flag indicates whether domains should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeDomains
public void setIncludeDomains(Boolean value)
Sets the value of the includeDomains property.- Parameters:
value- allowed object isBoolean
-
isIncludeSequences
public Boolean isIncludeSequences()
This flag indicates whether sequences should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeSequences
public void setIncludeSequences(Boolean value)
Sets the value of the includeSequences property.- Parameters:
value- allowed object isBoolean
-
isIncludeIndexes
public Boolean isIncludeIndexes()
This flag indicates whether indexes should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeIndexes
public void setIncludeIndexes(Boolean value)
Sets the value of the includeIndexes property.- Parameters:
value- allowed object isBoolean
-
isIncludePrimaryKeys
public Boolean isIncludePrimaryKeys()
This flag indicates whether primary keys should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludePrimaryKeys
public void setIncludePrimaryKeys(Boolean value)
Sets the value of the includePrimaryKeys property.- Parameters:
value- allowed object isBoolean
-
isIncludeUniqueKeys
public Boolean isIncludeUniqueKeys()
This flag indicates whether unique keys should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeUniqueKeys
public void setIncludeUniqueKeys(Boolean value)
Sets the value of the includeUniqueKeys property.- Parameters:
value- allowed object isBoolean
-
isIncludeForeignKeys
public Boolean isIncludeForeignKeys()
This flag indicates whether foreign keys should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeForeignKeys
public void setIncludeForeignKeys(Boolean value)
Sets the value of the includeForeignKeys property.- Parameters:
value- allowed object isBoolean
-
isIncludeCheckConstraints
public Boolean isIncludeCheckConstraints()
This flag indicates whether check constraints should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeCheckConstraints
public void setIncludeCheckConstraints(Boolean value)
Sets the value of the includeCheckConstraints property.- Parameters:
value- allowed object isBoolean
-
isIncludeSystemTables
public Boolean isIncludeSystemTables()
This flag indicates whether system tables should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeSystemTables
public void setIncludeSystemTables(Boolean value)
Sets the value of the includeSystemTables property.- Parameters:
value- allowed object isBoolean
-
isIncludeSystemIndexes
public Boolean isIncludeSystemIndexes()
This flag indicates whether system generated indexes should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeSystemIndexes
public void setIncludeSystemIndexes(Boolean value)
Sets the value of the includeSystemIndexes property.- Parameters:
value- allowed object isBoolean
-
isIncludeSystemCheckConstraints
public Boolean isIncludeSystemCheckConstraints()
This flag indicates whether system generated check constraints should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeSystemCheckConstraints
public void setIncludeSystemCheckConstraints(Boolean value)
Sets the value of the includeSystemCheckConstraints property.- Parameters:
value- allowed object isBoolean
-
isIncludeSystemSequences
public Boolean isIncludeSystemSequences()
This flag indicates whether system generated sequences should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeSystemSequences
public void setIncludeSystemSequences(Boolean value)
Sets the value of the includeSystemSequences property.- Parameters:
value- allowed object isBoolean
-
isIncludeSystemUDTs
public Boolean isIncludeSystemUDTs()
This flag indicates whether system generated UDTs should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeSystemUDTs
public void setIncludeSystemUDTs(Boolean value)
Sets the value of the includeSystemUDTs property.- Parameters:
value- allowed object isBoolean
-
isIncludeInvisibleColumns
public Boolean isIncludeInvisibleColumns()
This flag indicates whether invisible columns should be included in output produced by this database- Returns:
- possible object is
Boolean
-
setIncludeInvisibleColumns
public void setIncludeInvisibleColumns(Boolean value)
Sets the value of the includeInvisibleColumns property.- Parameters:
value- allowed object isBoolean
-
getRecordVersionFields
public String getRecordVersionFields()
All table and view columns that are used as "version" fields for optimistic locking.This is a Java regular expression. Use the pipe to separate several expressions. See
UpdatableRecord.store()andUpdatableRecord.delete()for details about optimistic locking.
-
setRecordVersionFields
public void setRecordVersionFields(String value)
All table and view columns that are used as "version" fields for optimistic locking.This is a Java regular expression. Use the pipe to separate several expressions. See
UpdatableRecord.store()andUpdatableRecord.delete()for details about optimistic locking.
-
getRecordTimestampFields
public String getRecordTimestampFields()
All table and view columns that are used as "timestamp" fields for optimistic locking.This is a Java regular expression. Use the pipe to separate several expressions. See
UpdatableRecord.store()andUpdatableRecord.delete()for details about optimistic locking.
-
setRecordTimestampFields
public void setRecordTimestampFields(String value)
All table and view columns that are used as "timestamp" fields for optimistic locking.This is a Java regular expression. Use the pipe to separate several expressions. See
UpdatableRecord.store()andUpdatableRecord.delete()for details about optimistic locking.
-
getSyntheticObjects
public SyntheticObjectsType getSyntheticObjects()
The synthetic objects configuration.
-
setSyntheticObjects
public void setSyntheticObjects(SyntheticObjectsType value)
The synthetic objects configuration.
-
getSyntheticIdentities
public String getSyntheticIdentities()
A regular expression matching all columns that represent identities.To be used if columns are not detected as automatically as identities.
-
setSyntheticIdentities
public void setSyntheticIdentities(String value)
A regular expression matching all columns that represent identities.To be used if columns are not detected as automatically as identities.
-
getSyntheticPrimaryKeys
public String getSyntheticPrimaryKeys()
A regular expression matching all columns that participate in "synthetic" primary keys, which should be placed on generatedUpdatableRecordTo be used with:
Synthetic primary keys will override existing primary keys.
-
setSyntheticPrimaryKeys
public void setSyntheticPrimaryKeys(String value)
A regular expression matching all columns that participate in "synthetic" primary keys, which should be placed on generatedUpdatableRecordTo be used with:
Synthetic primary keys will override existing primary keys.
-
getOverridePrimaryKeys
public String getOverridePrimaryKeys()
All (UNIQUE) key names that should be used instead of primary keys on generatedUpdatableRecord.To be used with:
If several keys match, a warning is emitted and the first one encountered will be used.
This flag will also replace synthetic primary keys, if it matches.
-
setOverridePrimaryKeys
public void setOverridePrimaryKeys(String value)
All (UNIQUE) key names that should be used instead of primary keys on generatedUpdatableRecord.To be used with:
If several keys match, a warning is emitted and the first one encountered will be used.
This flag will also replace synthetic primary keys, if it matches.
-
isDateAsTimestamp
public Boolean isDateAsTimestamp()
GenerateTimestampfields for DATE columns. This is particularly useful for Oracle databases- Returns:
- possible object is
Boolean
-
setDateAsTimestamp
public void setDateAsTimestamp(Boolean value)
Sets the value of the dateAsTimestamp property.- Parameters:
value- allowed object isBoolean
-
isIgnoreProcedureReturnValues
@Deprecated public Boolean isIgnoreProcedureReturnValues()
Deprecated.This feature is deprecated as of jOOQ 3.6.0 and will be removed again in jOOQ 4.0.Ignore procedure return values in Transact-SQL generated code.In jOOQ 3.6.0, #4106 was implemented to support Transact-SQL's optional return values from stored procedures. This turns all procedures into Routine
(instead of Routine ). For backwards- compatibility reasons, users can suppress this change in jOOQ 3.x - Returns:
- possible object is
Boolean
-
setIgnoreProcedureReturnValues
@Deprecated public void setIgnoreProcedureReturnValues(Boolean value)
Deprecated.Sets the value of the ignoreProcedureReturnValues property.- Parameters:
value- allowed object isBoolean
-
isUnsignedTypes
public Boolean isUnsignedTypes()
Generate jOOU data types for your unsigned data types, which are not natively supported in Java- Returns:
- possible object is
Boolean
-
setUnsignedTypes
public void setUnsignedTypes(Boolean value)
Sets the value of the unsignedTypes property.- Parameters:
value- allowed object isBoolean
-
isIntegerDisplayWidths
public Boolean isIntegerDisplayWidths()
Include display width in type declaration. In some RDBMS (e.g. MariaDB, MySQL), fixed width integer types are optionally accompanied by a display width. This is sometimes abused to model BOOLEAN types via TINYINT(1). This flag allows for including that display width in the type declaration exposed by jOOQ-meta code, as if it were a numeric precision.- Returns:
- possible object is
Boolean
-
setIntegerDisplayWidths
public void setIntegerDisplayWidths(Boolean value)
Sets the value of the integerDisplayWidths property.- Parameters:
value- allowed object isBoolean
-
getInputCatalog
public String getInputCatalog()
The catalog that is used locally as a source for meta information.This cannot be combined with the
getCatalogs()configuration element. If left empty (and without anygetCatalogs()configuration element), jOOQ will generate all available catalogs.
-
setInputCatalog
public void setInputCatalog(String value)
The catalog that is used locally as a source for meta information.This cannot be combined with the
getCatalogs()configuration element. If left empty (and without anygetCatalogs()configuration element), jOOQ will generate all available catalogs.
-
getOutputCatalog
public String getOutputCatalog()
The catalog that is used in generated source code.Use this to override your local development catalog name for source code generation. If not specified, this will be the same as
getInputCatalog()This will be ignored if
isOutputCatalogToDefault()is set to true
-
setOutputCatalog
public void setOutputCatalog(String value)
The catalog that is used in generated source code.Use this to override your local development catalog name for source code generation. If not specified, this will be the same as
getInputCatalog()This will be ignored if
isOutputCatalogToDefault()is set to true
-
isOutputCatalogToDefault
public Boolean isOutputCatalogToDefault()
A flag to indicate that the outputCatalog should be the "default" catalog, which generates catalog-less, unqualified tables, procedures, etc.- Returns:
- possible object is
Boolean
-
setOutputCatalogToDefault
public void setOutputCatalogToDefault(Boolean value)
Sets the value of the outputCatalogToDefault property.- Parameters:
value- allowed object isBoolean
-
getInputSchema
public String getInputSchema()
The schema that is used locally as a source for meta information.This cannot be combined with the
getSchemata()configuration element. If left empty (and without anygetSchemata()configuration element), jOOQ will generate all available schemata.
-
setInputSchema
public void setInputSchema(String value)
The schema that is used locally as a source for meta information.This cannot be combined with the
getSchemata()configuration element. If left empty (and without anygetSchemata()configuration element), jOOQ will generate all available schemata.
-
getOutputSchema
public String getOutputSchema()
The schema that is used in generated source code.Use this to override your local development schema name for source code generation. If not specified, this will be the same as
getInputSchema(). This will be ignored ifisOutputSchemaToDefault()is set to true
-
setOutputSchema
public void setOutputSchema(String value)
The schema that is used in generated source code.Use this to override your local development schema name for source code generation. If not specified, this will be the same as
getInputSchema(). This will be ignored ifisOutputSchemaToDefault()is set to true
-
isOutputSchemaToDefault
public Boolean isOutputSchemaToDefault()
A flag to indicate that the outputSchema should be the "default" schema, which generates schema-less, unqualified tables, procedures, etc.- Returns:
- possible object is
Boolean
-
setOutputSchemaToDefault
public void setOutputSchemaToDefault(Boolean value)
Sets the value of the outputSchemaToDefault property.- Parameters:
value- allowed object isBoolean
-
getSchemaVersionProvider
public String getSchemaVersionProvider()
A custom version number that, if available, will be used to assess whether thegetInputSchema()will need to be regenerated.There are three operation modes for this element:
- The value is a class that can be found on the classpath and that implements
SchemaVersionProvider. Such classes must provide a default constructor - The value is a SELECT statement that returns one record with one column. The SELECT statement may contain a named variable called :schema_name
- The value is a constant, such as a Maven property
Schema versions will be generated into the
Generatedannotation on generated artefacts. - The value is a class that can be found on the classpath and that implements
-
setSchemaVersionProvider
public void setSchemaVersionProvider(String value)
A custom version number that, if available, will be used to assess whether thegetInputSchema()will need to be regenerated.There are three operation modes for this element:
- The value is a class that can be found on the classpath and that implements
SchemaVersionProvider. Such classes must provide a default constructor - The value is a SELECT statement that returns one record with one column. The SELECT statement may contain a named variable called :schema_name
- The value is a constant, such as a Maven property
Schema versions will be generated into the
Generatedannotation on generated artefacts. - The value is a class that can be found on the classpath and that implements
-
getCatalogVersionProvider
public String getCatalogVersionProvider()
A custom version number that, if available, will be used to assess whether thegetInputCatalog()from a given catalog will need to be regenerated.There are three operation modes for this element:
- The value is a class that can be found on the classpath and that implements
CatalogVersionProvider. Such classes must provide a default constructor - The value is a SELECT statement that returns one record with one column. The SELECT statement may contain a named variable called :catalog_name
- The value is a constant, such as a Maven property
Catalog versions will be generated into the
Generatedannotation on generated artefacts. - The value is a class that can be found on the classpath and that implements
-
setCatalogVersionProvider
public void setCatalogVersionProvider(String value)
A custom version number that, if available, will be used to assess whether thegetInputCatalog()from a given catalog will need to be regenerated.There are three operation modes for this element:
- The value is a class that can be found on the classpath and that implements
CatalogVersionProvider. Such classes must provide a default constructor - The value is a SELECT statement that returns one record with one column. The SELECT statement may contain a named variable called :catalog_name
- The value is a constant, such as a Maven property
Catalog versions will be generated into the
Generatedannotation on generated artefacts. - The value is a class that can be found on the classpath and that implements
-
getOrderProvider
public String getOrderProvider()
A customComparatorthat can compare twoDefinitionobjects to determine their order.This comparator can be used to influence the order of any object that is produced by jOOQ meta, and thus, indirectly, the order of declared objects in generated code.
-
setOrderProvider
public void setOrderProvider(String value)
A customComparatorthat can compare twoDefinitionobjects to determine their order.This comparator can be used to influence the order of any object that is produced by jOOQ meta, and thus, indirectly, the order of declared objects in generated code.
-
getEmbeddablePrimaryKeys
public String getEmbeddablePrimaryKeys()
A regular expression matching all primary key declarations for which wrapper types should be generated, and for their referencing foreign keys.This feature is available in the commercial distribution only.
-
setEmbeddablePrimaryKeys
public void setEmbeddablePrimaryKeys(String value)
A regular expression matching all primary key declarations for which wrapper types should be generated, and for their referencing foreign keys.This feature is available in the commercial distribution only.
-
getEmbeddableUniqueKeys
public String getEmbeddableUniqueKeys()
A regular expression matching all unique key declarations for which wrapper types should be generated, and for their referencing foreign keys.This feature is available in the commercial distribution only.
-
setEmbeddableUniqueKeys
public void setEmbeddableUniqueKeys(String value)
A regular expression matching all unique key declarations for which wrapper types should be generated, and for their referencing foreign keys.This feature is available in the commercial distribution only.
-
getEmbeddableDomains
public String getEmbeddableDomains()
A regular expression matching all domain type declarations for which wrapper types should be generated.This feature is available in the commercial distribution only.
-
setEmbeddableDomains
public void setEmbeddableDomains(String value)
A regular expression matching all domain type declarations for which wrapper types should be generated.This feature is available in the commercial distribution only.
-
isForceIntegerTypesOnZeroScaleDecimals
public Boolean isForceIntegerTypesOnZeroScaleDecimals()
Historically, zero-scale decimal types are generated as their most appropriate, corresponding integer type (e.g. NUMBER(2, 0) and less: Byte). This allows for turning off this feature. In case of conflict between this rule and actualgetForcedTypes(), the latter will win.- Returns:
- possible object is
Boolean
-
setForceIntegerTypesOnZeroScaleDecimals
public void setForceIntegerTypesOnZeroScaleDecimals(Boolean value)
Sets the value of the forceIntegerTypesOnZeroScaleDecimals property.- Parameters:
value- allowed object isBoolean
-
isTableValuedFunctions
public Boolean isTableValuedFunctions()
Whether table valued functions should be reported as tables.If this is deactivated, such functions are not generated as tables, but as ordinary routines. This is particularly useful for backwards- compatibility between jOOQ 3.8 and previous versions, when using TABLE and VARRAY types in Oracle.
While this flag defaults to true for most databases, it defaults to false for Oracle.
- Returns:
- possible object is
Boolean
-
setTableValuedFunctions
public void setTableValuedFunctions(Boolean value)
Sets the value of the tableValuedFunctions property.- Parameters:
value- allowed object isBoolean
-
getLogSlowQueriesAfterSeconds
public Integer getLogSlowQueriesAfterSeconds()
The number of seconds that are considered "slow" before a query is logged to indicate a bug, 0 for not logging.
-
setLogSlowQueriesAfterSeconds
public void setLogSlowQueriesAfterSeconds(Integer value)
The number of seconds that are considered "slow" before a query is logged to indicate a bug, 0 for not logging.
-
getLogSlowResultsAfterSeconds
public Integer getLogSlowResultsAfterSeconds()
The number of seconds that are considered "slow" before a result set is logged to indicate a bug, 0 for not logging.
-
setLogSlowResultsAfterSeconds
public void setLogSlowResultsAfterSeconds(Integer value)
The number of seconds that are considered "slow" before a result set is logged to indicate a bug, 0 for not logging.
-
getComments
public List<CommentType> getComments()
-
setComments
public void setComments(List<CommentType> comments)
-
getCatalogs
public List<CatalogMappingType> getCatalogs()
-
setCatalogs
public void setCatalogs(List<CatalogMappingType> catalogs)
-
getSchemata
public List<SchemaMappingType> getSchemata()
-
setSchemata
public void setSchemata(List<SchemaMappingType> schemata)
-
getEmbeddables
public List<EmbeddableDefinitionType> getEmbeddables()
-
setEmbeddables
public void setEmbeddables(List<EmbeddableDefinitionType> embeddables)
-
getCustomTypes
@Deprecated public List<CustomType> getCustomTypes()
Deprecated.
-
setCustomTypes
@Deprecated public void setCustomTypes(List<CustomType> customTypes)
Deprecated.
-
getEnumTypes
@Deprecated public List<EnumType> getEnumTypes()
Deprecated.
-
setEnumTypes
@Deprecated public void setEnumTypes(List<EnumType> enumTypes)
Deprecated.
-
getForcedTypes
public List<ForcedType> getForcedTypes()
-
setForcedTypes
public void setForcedTypes(List<ForcedType> forcedTypes)
-
withName
public Database withName(String value)
The database dialect from jooq-meta. Available dialects are namedorg.util.[database].[database]Database.Natively supported values are:
org.jooq.meta.ase.ASEDatabaseorg.jooq.meta.cockroachdb.CockroachDBDatabaseorg.jooq.meta.db2.DB2DatabaseDerbyDatabaseFirebirdDatabaseH2Databaseorg.jooq.meta.hana.HanaDatabaseHSQLDBDatabaseorg.jooq.meta.informix.InformixDatabaseorg.jooq.meta.ingres.IngresDatabaseMariaDBDatabaseMySQLDatabaseorg.jooq.meta.oracle.OracleDatabasePostgresDatabaseorg.jooq.meta.redshift.RedshiftDatabaseSQLiteDatabaseorg.jooq.meta.sqlserver.SQLServerDatabaseorg.jooq.meta.sybase.SybaseDatabaseorg.jooq.meta.vertica.VerticaDatabase
This value can be used to reverse-engineer generic JDBC DatabaseMetaData (e.g. for MS Access).
This value can be used to reverse-engineer standard jOOQ-meta XML formats.
This value can be used to reverse-engineer JPA annotated entities
org.jooq.meta.extensions.jpa.JPADatabase
You can also provide your own org.jooq.meta.Database implementation here, if your database is currently not supported
-
withRegexFlags
public Database withRegexFlags(RegexFlag... values)
The flags that will be applied to all regular expressions from this configuration by default.The default value is "COMMENTS CASE_INSENSITIVE"Gets the value of the regexFlags property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
setmethod for the regexFlags property.For example, to add a new item, do as follows:
getRegexFlags().add(newItem);Objects of the following type(s) are allowed in the list
RegexFlag
-
withRegexFlags
public Database withRegexFlags(Collection<RegexFlag> values)
The flags that will be applied to all regular expressions from this configuration by default.The default value is "COMMENTS CASE_INSENSITIVE"Gets the value of the regexFlags property.
This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a
setmethod for the regexFlags property.For example, to add a new item, do as follows:
getRegexFlags().add(newItem);Objects of the following type(s) are allowed in the list
RegexFlag
-
withRegexMatchesPartialQualification
public Database withRegexMatchesPartialQualification(Boolean value)
-
withSqlMatchesPartialQualification
public Database withSqlMatchesPartialQualification(Boolean value)
-
withIncludes
public Database withIncludes(String value)
All elements that are generated from your schema.This is a Java regular expression. Use the pipe to separate several expressions. Watch out for case-sensitivity. Depending on your database, this might be important!
You can create case-insensitive regular expressions using this syntax:
(?i:expr)Whitespace is ignored and comments are possible unless overridden in
getRegexFlags().
-
withExcludes
public Database withExcludes(String value)
All elements that are excluded from your schema.This is a Java regular expression. Use the pipe to separate several expressions. Excludes match before includes, i.e. excludes have a higher priority.
-
withRecordVersionFields
public Database withRecordVersionFields(String value)
All table and view columns that are used as "version" fields for optimistic locking.This is a Java regular expression. Use the pipe to separate several expressions. See
UpdatableRecord.store()andUpdatableRecord.delete()for details about optimistic locking.
-
withRecordTimestampFields
public Database withRecordTimestampFields(String value)
All table and view columns that are used as "timestamp" fields for optimistic locking.This is a Java regular expression. Use the pipe to separate several expressions. See
UpdatableRecord.store()andUpdatableRecord.delete()for details about optimistic locking.
-
withSyntheticObjects
public Database withSyntheticObjects(SyntheticObjectsType value)
The synthetic objects configuration.
-
withSyntheticIdentities
public Database withSyntheticIdentities(String value)
A regular expression matching all columns that represent identities.To be used if columns are not detected as automatically as identities.
-
withSyntheticPrimaryKeys
public Database withSyntheticPrimaryKeys(String value)
A regular expression matching all columns that participate in "synthetic" primary keys, which should be placed on generatedUpdatableRecordTo be used with:
Synthetic primary keys will override existing primary keys.
-
withOverridePrimaryKeys
public Database withOverridePrimaryKeys(String value)
All (UNIQUE) key names that should be used instead of primary keys on generatedUpdatableRecord.To be used with:
If several keys match, a warning is emitted and the first one encountered will be used.
This flag will also replace synthetic primary keys, if it matches.
-
withInputCatalog
public Database withInputCatalog(String value)
The catalog that is used locally as a source for meta information.This cannot be combined with the
getCatalogs()configuration element. If left empty (and without anygetCatalogs()configuration element), jOOQ will generate all available catalogs.
-
withOutputCatalog
public Database withOutputCatalog(String value)
The catalog that is used in generated source code.Use this to override your local development catalog name for source code generation. If not specified, this will be the same as
getInputCatalog()This will be ignored if
isOutputCatalogToDefault()is set to true
-
withInputSchema
public Database withInputSchema(String value)
The schema that is used locally as a source for meta information.This cannot be combined with the
getSchemata()configuration element. If left empty (and without anygetSchemata()configuration element), jOOQ will generate all available schemata.
-
withOutputSchema
public Database withOutputSchema(String value)
The schema that is used in generated source code.Use this to override your local development schema name for source code generation. If not specified, this will be the same as
getInputSchema(). This will be ignored ifisOutputSchemaToDefault()is set to true
-
withSchemaVersionProvider
public Database withSchemaVersionProvider(String value)
A custom version number that, if available, will be used to assess whether thegetInputSchema()will need to be regenerated.There are three operation modes for this element:
- The value is a class that can be found on the classpath and that implements
SchemaVersionProvider. Such classes must provide a default constructor - The value is a SELECT statement that returns one record with one column. The SELECT statement may contain a named variable called :schema_name
- The value is a constant, such as a Maven property
Schema versions will be generated into the
Generatedannotation on generated artefacts. - The value is a class that can be found on the classpath and that implements
-
withCatalogVersionProvider
public Database withCatalogVersionProvider(String value)
A custom version number that, if available, will be used to assess whether thegetInputCatalog()from a given catalog will need to be regenerated.There are three operation modes for this element:
- The value is a class that can be found on the classpath and that implements
CatalogVersionProvider. Such classes must provide a default constructor - The value is a SELECT statement that returns one record with one column. The SELECT statement may contain a named variable called :catalog_name
- The value is a constant, such as a Maven property
Catalog versions will be generated into the
Generatedannotation on generated artefacts. - The value is a class that can be found on the classpath and that implements
-
withOrderProvider
public Database withOrderProvider(String value)
A customComparatorthat can compare twoDefinitionobjects to determine their order.This comparator can be used to influence the order of any object that is produced by jOOQ meta, and thus, indirectly, the order of declared objects in generated code.
-
withEmbeddablePrimaryKeys
public Database withEmbeddablePrimaryKeys(String value)
A regular expression matching all primary key declarations for which wrapper types should be generated, and for their referencing foreign keys.This feature is available in the commercial distribution only.
-
withEmbeddableUniqueKeys
public Database withEmbeddableUniqueKeys(String value)
A regular expression matching all unique key declarations for which wrapper types should be generated, and for their referencing foreign keys.This feature is available in the commercial distribution only.
-
withEmbeddableDomains
public Database withEmbeddableDomains(String value)
A regular expression matching all domain type declarations for which wrapper types should be generated.This feature is available in the commercial distribution only.
-
withForceIntegerTypesOnZeroScaleDecimals
public Database withForceIntegerTypesOnZeroScaleDecimals(Boolean value)
-
withLogSlowQueriesAfterSeconds
public Database withLogSlowQueriesAfterSeconds(Integer value)
The number of seconds that are considered "slow" before a query is logged to indicate a bug, 0 for not logging.
-
withLogSlowResultsAfterSeconds
public Database withLogSlowResultsAfterSeconds(Integer value)
The number of seconds that are considered "slow" before a result set is logged to indicate a bug, 0 for not logging.
-
withProperties
public Database withProperties(Collection<Property> values)
-
withComments
public Database withComments(CommentType... values)
-
withComments
public Database withComments(Collection<CommentType> values)
-
withComments
public Database withComments(List<CommentType> comments)
-
withCatalogs
public Database withCatalogs(CatalogMappingType... values)
-
withCatalogs
public Database withCatalogs(Collection<CatalogMappingType> values)
-
withCatalogs
public Database withCatalogs(List<CatalogMappingType> catalogs)
-
withSchemata
public Database withSchemata(SchemaMappingType... values)
-
withSchemata
public Database withSchemata(Collection<SchemaMappingType> values)
-
withSchemata
public Database withSchemata(List<SchemaMappingType> schemata)
-
withEmbeddables
public Database withEmbeddables(EmbeddableDefinitionType... values)
-
withEmbeddables
public Database withEmbeddables(Collection<EmbeddableDefinitionType> values)
-
withEmbeddables
public Database withEmbeddables(List<EmbeddableDefinitionType> embeddables)
-
withCustomTypes
@Deprecated public Database withCustomTypes(CustomType... values)
Deprecated.
-
withCustomTypes
@Deprecated public Database withCustomTypes(Collection<CustomType> values)
Deprecated.
-
withCustomTypes
@Deprecated public Database withCustomTypes(List<CustomType> customTypes)
Deprecated.
-
withEnumTypes
@Deprecated public Database withEnumTypes(EnumType... values)
Deprecated.
-
withEnumTypes
@Deprecated public Database withEnumTypes(Collection<EnumType> values)
Deprecated.
-
withEnumTypes
@Deprecated public Database withEnumTypes(List<EnumType> enumTypes)
Deprecated.
-
withForcedTypes
public Database withForcedTypes(ForcedType... values)
-
withForcedTypes
public Database withForcedTypes(Collection<ForcedType> values)
-
withForcedTypes
public Database withForcedTypes(List<ForcedType> forcedTypes)
-
appendTo
public final void appendTo(XMLBuilder builder)
- Specified by:
appendToin interfaceXMLAppendable
-
-