This documentation is for the unreleased development version of jOOQ. Click on the above version links to get this documentation for a supported version of jOOQ.
The COMMENT statement
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
The COMMENT statement can be used to store a description for an object from the database catalog.
These comments will be picked up by the code generator and are generated as Javadoc on generated classes.
// Commenting a table
create.commentOnTable("table").is("a comment describing the table").execute();
// Commenting a view
create.commentOnView("view").is("a comment describing the view").execute();
// Commenting a column
create.commentOnColumn(name("table", "column")).is("a comment describing the column").execute();
Feedback
Do you have any feedback about this page? We'd love to hear it!