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.
COMMENT ON TABLE
Applies to ✅ Open Source Edition ✅ Express Edition ✅ Professional Edition ✅ Enterprise Edition
commentOnTable("table").is("the comment")
Translates to the following dialect specific expressions:
-- AURORA_MYSQL, MARIADB, MEMSQL, MYSQL ALTER TABLE table COMMENT = 'the comment' -- AURORA_POSTGRES, COCKROACHDB, DB2, EXASOL, FIREBIRD, H2, HANA, HSQLDB, ORACLE, POSTGRES, TERADATA, TRINO, VERTICA, -- YUGABYTEDB COMMENT ON TABLE table IS 'the comment' -- BIGQUERY ALTER TABLE table SET OPTIONS (DESCRIPTION = 'the comment') -- SNOWFLAKE ALTER TABLE table SET COMMENT = 'the comment' -- SQLSERVER BEGIN TRY DECLARE @u varchar(max) = schema_name(); EXEC sp_addextendedproperty 'MS_Description', 'the comment', 'schema', @u, 'table', 'table', DEFAULT, DEFAULT END TRY BEGIN CATCH EXEC sp_updateextendedproperty 'MS_Description', 'the comment', 'schema', @u, 'table', 'table', DEFAULT, DEFAULT END CATCH -- ACCESS, ASE, DERBY, DUCKDB, INFORMIX, REDSHIFT, SQLDATAWAREHOUSE, SQLITE, SYBASE /* UNSUPPORTED */
(These are currently generated with jOOQ 3.19, see #10141), or translate your own on our website
Feedback
Do you have any feedback about this page? We'd love to hear it!