comment

fun <T> Column<T>.comment(text: String): Column<T>

Adds a comment to this column that will be stored in the database schema.

The comment will be included in DDL generation and visible in database administration tools.

To remove a comment from an existing column, remove the .comment() call from the column definition. The schema migration will detect the change and remove the comment from the database.

Return

This column for method chaining

Parameters

text

The comment text to add to the column