Hidden columns
Applies to ❌ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
There are various reasons why a column could be hidden, including:
- The column is formally marked as
HIDDENorINVISIBLE, if the database product supports this. - A forced type marks the column as hidden.
jOOQ's code generator can detect some of these, and mark columns as hidden for you, meaning that the column will not be taken into consideration in default projections. For details about the runtime behaviour of such hidden columns, please see the relevant section about hidden columns.
Useful feature interactions
One of the primary use-cases of hidden columns is schema evolution, where deprecated columns and their data are kept around for historic purposes, but shouldn't be used ordinarily. In this case, the feature works very well together with our column deprecation support.
Limitations
Thehiddenflag is a property of the generatedorg.jooq.DataType. As such, the property can only be enforced on expressions which make this flag available to jOOQ. For example, if you're using plain SQL templates without passing along aDataTypewith thehiddenflag enabled to table meta data, then it cannot be enforced. See also features requiring code generation for more details.
Feedback
Do you have any feedback about this page? We'd love to hear it!