Opened 6 years ago

Last modified 4 weeks ago

#18468 new New feature

Add the ability to define comments in table / columns

Reported by: Marc Rechté Owned by: nobody
Component: Database layer (models, ORM) Version: master
Severity: Normal Keywords:
Cc: niwi@…, Ivan Chernoff Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no



That would be nice if it was possible to include comment on table / columns at creation time with the syncdb option.

There could be a new Model Meta option like:

comment = 'This table is for storing blabla"

And a new Field option like:

comment = 'This field is for ...'

Thanks a lot

Change History (11)

comment:1 Changed 6 years ago by Andrei Antoukh

Cc: niwi@… added
Has patch: set

Initial implementation for postgresql_psycopg2 backend:

Is only implemented the table comment sql.

If accepted as a new feature, would be nice to make design decisions. Today I put the comment for table in class "Meta", another option is to use the first line of the model docstrings.

For fields, is more simple, just add an optional parameter "comment" at the Field.

Last edited 6 years ago by Andrei Antoukh (previous) (diff)

comment:2 Changed 6 years ago by Aymeric Augustin

Resolution: duplicate
Status: newclosed

This is a duplicate of #13867, which lingered in DDN for two years until I wontfix'd it.

The only argument I've seen is "it'd be nice if...". But I'm against adding features to Django just because we can; there must be a use case.

Could you start a thread on the mailing-list, as recommended in the contributing guide, to see if there is support for this idea?

If there's a good explanation of why you need this, I can reconsider my decision.

comment:3 Changed 6 years ago by Andrei Antoukh

I understand your opinion! In any case, I'll write an email to the list which I think is useful.

comment:4 Changed 6 years ago by Marc Rechté

I assume that most databases have comment on fields / tables feature not just because it is nice. Accessing Django created tables from another tool (for instance pgAdmin) would just make the system more productive. Personally I never create SQL tables without proper comments in the database itself.

comment:5 Changed 6 years ago by Luke Plant

The reasons given on #13867 still stand — Django is not aiming to provide a wrapper for every SQL feature. For example, it also doesn't provide an easy way to create stored procedures, functions or views, but you can always execute the SQL manually to add these, or could add some additional Python code that executed the SQL — for example using a South migration — if you want to ensure it always happens.

In addition, if the audience of these comments is people administering the database without reading the Python source code, it doesn't make sense for these comments to be taking up space in the Python code, which has its own way of adding comments (docstrings and comment lines), which are targeted at programmers not DB admins.

comment:6 Changed 23 months ago by Marc Rechté

Resolution: duplicate
Status: closednew

Now that migration is built in Django, which can be used to create and administer the database, I again request this feature to be added. Thanks.

comment:7 Changed 23 months ago by Tim Graham

Resolution: duplicate
Status: newclosed
Summary: Define COMMENT in table / colomnsAdd the ability to define comments in table / columns
Type: UncategorizedNew feature

The correct way to reopen a ticket closed as "wontfix" is to start a discussion on the DevelopersMailingList. If there is consensus there to add the feature, then we reopen the ticket.

comment:8 Changed 6 weeks ago by Ivan Chernoff

Cc: Ivan Chernoff added
Has patch: unset
Resolution: duplicate
Status: closednew
Triage Stage: UnreviewedAccepted
Version: 1.4master

After discussion on mailing list, the feature is good and can be added. (!topic/django-developers/guVTzO3RhUs)
I'll prepare patch for review.

comment:9 Changed 6 weeks ago by Tim Graham

I guess the model field option could be called db_column_comment. I closed #28407 (introspecting column comments) as a duplicate since that should be implemented as part of this.

comment:10 in reply to:  9 Changed 5 weeks ago by Ivan Chernoff

Replying to Tim Graham:

I guess the model field option could be called db_column_comment. I closed #28407 (introspecting column comments) as a duplicate since that should be implemented as part of this.

I think that we don't need new param, because comment for django admin may be useful to store in database. But I can't decide on implementation, can you give me an advice?
Postgres and oracle have a syntax like comment on {table}.{column} for storing comments, so this needs to be done after table/column creation, so there are two ways:

  1. Add it to post migrate signal, as for content types. But I can implement it as a third-party lib
  2. Add this SQL after database creation in

Which way is better?

comment:12 Changed 4 weeks ago by Tim Graham

I'm not sure what you mean by "comment for django admin". There isn't an existing option with that name.

As for the implementation, the second approach sounds better.

Note: See TracTickets for help on using tickets.
Back to Top