Class Database

    • Field Detail

      • 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
      • 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
    • Constructor Detail

      • Database

        public Database()
    • Method Detail

      • getName

        public String getName()
        The database dialect from jooq-meta. Available dialects are named org.util.[database].[database]Database.

        Natively supported values are:

        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 named org.util.[database].[database]Database.

        Natively supported values are:

        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 set method 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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() and UpdatableRecord.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() and UpdatableRecord.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() and UpdatableRecord.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() and UpdatableRecord.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.

      • isDateAsTimestamp

        public Boolean isDateAsTimestamp()
        Generate Timestamp fields 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 is Boolean
      • 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 any getCatalogs() 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 any getCatalogs() 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 is Boolean
      • 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 any getSchemata() 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 any getSchemata() 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 if isOutputSchemaToDefault() 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 if isOutputSchemaToDefault() 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 is Boolean
      • getSchemaVersionProvider

        public String getSchemaVersionProvider()
        A custom version number that, if available, will be used to assess whether the getInputSchema() 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 Generated annotation on generated artefacts.

      • setSchemaVersionProvider

        public void setSchemaVersionProvider​(String value)
        A custom version number that, if available, will be used to assess whether the getInputSchema() 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 Generated annotation on generated artefacts.

      • getCatalogVersionProvider

        public String getCatalogVersionProvider()
        A custom version number that, if available, will be used to assess whether the getInputCatalog() 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 Generated annotation on generated artefacts.

      • setCatalogVersionProvider

        public void setCatalogVersionProvider​(String value)
        A custom version number that, if available, will be used to assess whether the getInputCatalog() 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 Generated annotation on generated artefacts.

      • getOrderProvider

        public String getOrderProvider()
        A custom Comparator that can compare two Definition objects 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 custom Comparator that can compare two Definition objects 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 actual getForcedTypes(), 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 is Boolean
      • 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 is Boolean
      • 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.
      • setProperties

        public void setProperties​(List<Property> properties)
      • setForcedTypes

        public void setForcedTypes​(List<ForcedType> forcedTypes)
      • withName

        public Database withName​(String value)
        The database dialect from jooq-meta. Available dialects are named org.util.[database].[database]Database.

        Natively supported values are:

        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 set method 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 set method 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.

      • withIncludeExcludeColumns

        public Database withIncludeExcludeColumns​(Boolean value)
      • withIncludeExcludePackageRoutines

        public Database withIncludeExcludePackageRoutines​(Boolean value)
      • withIncludeEmbeddables

        public Database withIncludeEmbeddables​(Boolean value)
      • withIncludeRoutines

        public Database withIncludeRoutines​(Boolean value)
      • withIncludeTriggerRoutines

        public Database withIncludeTriggerRoutines​(Boolean value)
      • withIncludePackages

        public Database withIncludePackages​(Boolean value)
      • withIncludePackageRoutines

        public Database withIncludePackageRoutines​(Boolean value)
      • withIncludePackageUDTs

        public Database withIncludePackageUDTs​(Boolean value)
      • withIncludePackageConstants

        public Database withIncludePackageConstants​(Boolean value)
      • withIncludeDomains

        public Database withIncludeDomains​(Boolean value)
      • withIncludeSequences

        public Database withIncludeSequences​(Boolean value)
      • withIncludeIndexes

        public Database withIncludeIndexes​(Boolean value)
      • withIncludePrimaryKeys

        public Database withIncludePrimaryKeys​(Boolean value)
      • withIncludeUniqueKeys

        public Database withIncludeUniqueKeys​(Boolean value)
      • withIncludeForeignKeys

        public Database withIncludeForeignKeys​(Boolean value)
      • withIncludeCheckConstraints

        public Database withIncludeCheckConstraints​(Boolean value)
      • withIncludeSystemTables

        public Database withIncludeSystemTables​(Boolean value)
      • withIncludeSystemIndexes

        public Database withIncludeSystemIndexes​(Boolean value)
      • withIncludeSystemCheckConstraints

        public Database withIncludeSystemCheckConstraints​(Boolean value)
      • withIncludeSystemSequences

        public Database withIncludeSystemSequences​(Boolean value)
      • withIncludeSystemUDTs

        public Database withIncludeSystemUDTs​(Boolean value)
      • withIncludeInvisibleColumns

        public Database withIncludeInvisibleColumns​(Boolean value)
      • 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() and UpdatableRecord.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() and UpdatableRecord.delete() for details about optimistic locking.

      • 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.

      • withDateAsTimestamp

        public Database withDateAsTimestamp​(Boolean value)
      • withIgnoreProcedureReturnValues

        public Database withIgnoreProcedureReturnValues​(Boolean value)
      • withIntegerDisplayWidths

        public Database withIntegerDisplayWidths​(Boolean value)
      • 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 any getCatalogs() 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

      • withOutputCatalogToDefault

        public Database withOutputCatalogToDefault​(Boolean value)
      • 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 any getSchemata() 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 if isOutputSchemaToDefault() is set to true

      • withOutputSchemaToDefault

        public Database withOutputSchemaToDefault​(Boolean value)
      • withSchemaVersionProvider

        public Database withSchemaVersionProvider​(String value)
        A custom version number that, if available, will be used to assess whether the getInputSchema() 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 Generated annotation on generated artefacts.

      • withCatalogVersionProvider

        public Database withCatalogVersionProvider​(String value)
        A custom version number that, if available, will be used to assess whether the getInputCatalog() 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 Generated annotation on generated artefacts.

      • withOrderProvider

        public Database withOrderProvider​(String value)
        A custom Comparator that can compare two Definition objects 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)
      • withTableValuedFunctions

        public Database withTableValuedFunctions​(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.
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object