DDC-747: Add support for table, column and indexes comments #919

New Issue

admin · 2026-01-22T12:55:33+01:00

admin commented

2026-01-22 12:55:33 +01:00

Originally created by @doctrinebot on GitHub (Aug 13, 2010).

Jira issue originally created by user s9e:

It would be nice to add support for table comments, column comments and indexes comments, i.e.

@Table(
    name="ecommerce_products",
    comment="Contains products",
    indexes={@index(name="search_idx", comment="Makes finding people by name easier", columns={"name", "email"})}
)

@Column(type="integer", comment="Stores the user's age, in years")

MySQL supports comments via ALTER TABLE since 4.1.
PostgreSQL support comments via COMMENT at least since 7.4.
SQLite doesn't appear to support table, column or indexes comments as of 3.7.
Oracle supports comments on tables and columns via COMMENT at least since 10.1. It doesn't appear to support comments on indexes.

For databases that don't support those persistent comments, you could use normal SQL comments in the table definition. Of course they wouldn't be stored by the database, but at least they would appear in the generated schema, that's better than nothing.

Originally created by @doctrinebot on GitHub (Aug 13, 2010). Jira issue originally created by user s9e: It would be nice to add support for table comments, column comments and indexes comments, i.e. ``` @Table( name="ecommerce_products", comment="Contains products", indexes={@index(name="search_idx", comment="Makes finding people by name easier", columns={"name", "email"})} ) @Column(type="integer", comment="Stores the user's age, in years") ``` MySQL supports comments via [ALTER TABLE](http://dev.mysql.com/doc/refman/4.1/en/create-table.html) since 4.1. PostgreSQL support comments via [COMMENT](http://www.postgresql.org/docs/7.4/static/sql-comment.html) at least since 7.4. SQLite [doesn't appear to support table, column or indexes comments](http://www.sqlite.org/cvstrac/wiki?p=UnsupportedSql) as of 3.7. Oracle supports comments on tables and columns via [COMMENT](http://download.oracle.com/docs/cd/B14117*01/server.101/b10759/statements*4009.htm#SQLRF01109) at least since 10.1. It doesn't appear to support comments on indexes. For databases that don't support those persistent comments, you could use normal SQL comments in the table definition. Of course they wouldn't be stored by the database, but at least they would appear in the generated schema, that's better than nothing.

admin added the New Feature label 2026-01-22 12:55:33 +01:00

admin referenced this issue

2026-01-22 16:02:13 +01:00

[PR #919] [CLOSED] tests for DDC-2890 #8900

admin referenced this issue

2026-01-22 16:02:14 +01:00

[PR #919] tests for DDC-2890 #8901

Sign in to join this conversation.