[Django] #18468: Define COMMENT in table / colomns
Django
----------------------------------------------+--------------------
Reporter: mrechte | Owner: nobody
Type: Uncategorized | Status: new
Component: Database layer (models, ORM) | Version: 1.4
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
----------------------------------------------+--------------------
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py 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
--
Ticket URL: <https://code.djangoproject.com/ticket/18468>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Type: Uncategorized | Status: new
(models, ORM) | Resolution:
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Changes (by niwi):
* cc: niwi@… (added)
* needs_docs: => 0
* has_patch: 0 => 1
* needs_tests: => 0
* needs_better_patch: => 0
Comment:
I've implemented initial implementatio for postgresql_psycopg2 backend:
https://github.com/niwibe/django/compare/issue_18468
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:1>
Django
Reporter: mrechte | Owner: nobody
Type: Uncategorized | Status: closed
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Changes (by aaugustin):
* status: new => closed
* resolution: => duplicate
Comment:
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
[https://docs.djangoproject.com/en/dev/internals/contributing/bugs-and-
features/#requesting-features 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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:2>
Django
Reporter: mrechte | Owner: nobody
Component: Database layer | Version: 1.4
(models, ORM) | Resolution: duplicate
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Comment (by niwi):
I understand your opinion! In any case, I'll write an email to the list
which I think is useful.
Thanks!
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:3>
Django
Reporter: mrechte | Owner: nobody
Type: Uncategorized | Status: closed
Component: Database layer | Version: 1.4
(models, ORM) | Resolution: duplicate
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by mrechte):
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:4>
Django
Reporter: mrechte | Owner: nobody
Type: Uncategorized | Status: closed
Component: Database layer | Version: 1.4
(models, ORM) | Resolution: duplicate
Severity: Normal | Triage Stage:
Keywords: | Unreviewed
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by lukeplant):
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:5>
Django
Reporter: mrechte | Owner: nobody
Type: Uncategorized | Status: new
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by mrechte):
* status: closed => new
* resolution: duplicate =>
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:6>
Django
-------------------------------------+-------------------------------------
Reporter: mrechte | Owner: nobody
Type: New feature | Status: closed
Component: Database layer | Version: 1.4
(models, ORM) |
Keywords: | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Changes (by timgraham):
* status: new => closed
* type: Uncategorized => New feature
* resolution: => duplicate
Comment:
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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:7>
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by Ivan Chernoff):
* status: closed => new
* cc: Ivan Chernoff (added)
* version: 1.4 => master
* has_patch: 1 => 0
* resolution: duplicate =>
* stage: Unreviewed => Accepted
Comment:
After discussion on mailing list, the feature is good and can be added.
(https://groups.google.com/forum/?nomobile=true#!topic/django-
developers/guVTzO3RhUs)
I'll prepare patch for review.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:8>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:9>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Ivan Chernoff):
Replying to [comment:9 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 schema.py
Which way is better?
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:10>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Ivan Chernoff):
Anyone?
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:11>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (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.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:12>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by MestreLion):
Replying to [comment:8 Ivan Chernoff]:
> After discussion on mailing list, the feature is good and can be added.
(https://groups.google.com/forum/?nomobile=true#!topic/django-
developers/guVTzO3RhUs)
> I'll prepare patch for review.
Any news on this patch? It looks like there is a green light for one, and
Tim already answered about the preferable approach. Do you need any help
on making this hapen? It would be a fantastic feature for Django!
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:13>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: nobody
Type: New feature | Status: new
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by Ivan Chernoff):
Replying to [comment:13 Rodrigo Silva]:
> Replying to [comment:8 Ivan Chernoff]:
> > After discussion on mailing list, the feature is good and can be
added. (https://groups.google.com/forum/?nomobile=true#!topic/django-
developers/guVTzO3RhUs)
> > I'll prepare patch for review.
>
> Any news on this patch? It looks like there is a green light for one,
and Tim already answered about the preferable approach. Do you need any
help on making this hapen? It would be a fantastic feature for Django!
I've a small library based on contenttype design: on post-migrate it
copies all comments to database (PostgreSQL only).
https://github.com/vanadium23/django-db-comments
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:14>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
Changes (by felixxm):
* status: new => assigned
* needs_better_patch: 0 => 1
* needs_tests: 0 => 1
* owner: nobody => KimSoungRyoul
* needs_docs: 0 => 1
* has_patch: 0 => 1
Comment:
[https://github.com/django/django/pull/12605 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:15>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py 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
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py 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
--
Comment (by KimSoungRyoul):
i assign it to me
i will close this pullRequest caused by imperfection
https://github.com/django/django/pull/12605
I will bring a new PullRequest as soon as possible.
in at least a week
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:16>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Description changed by KimSoungRyoul:
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py 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
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py option.
**new proposal**
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text", db_comment="i am
db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
--
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:17>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Description changed by KimSoungRyoul:
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py option.
>
>
> **new proposal**
>
> We will develop the code such as below
>
> {{{
>
> class AModel(models.Model):
> aaa = model.CharField(help_text="i am help_text", db_comment="i am
> db_comment",~~~)
>
> class Meta:
> db_table = "a_model_example_name"
> db_table_comment ="this is a_model comment ~~~~"
>
> }}}
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py option.
**new proposal** (kimsoungryoul : 2020.03.23)
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text", db_comment="i am
db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
--
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:18>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Description changed by KimSoungRyoul:
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py option.
>
>
> **new proposal** (kimsoungryoul : 2020.03.23)
>
> We will develop the code such as below
>
> {{{
>
> class AModel(models.Model):
> aaa = model.CharField(help_text="i am help_text", db_comment="i am
> db_comment",~~~)
>
> class Meta:
> db_table = "a_model_example_name"
> db_table_comment ="this is a_model comment ~~~~"
>
> }}}
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py option.
....
....
**new proposal** (kimsoungryoul : 2020.03.23)
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text", db_comment="i am
db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
--
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:19>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Description changed by KimSoungRyoul:
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py option.
>
> ....
> ....
>
> **new proposal** (kimsoungryoul : 2020.03.23)
>
> We will develop the code such as below
>
> {{{
>
> class AModel(models.Model):
> aaa = model.CharField(help_text="i am help_text", db_comment="i am
> db_comment",~~~)
>
> class Meta:
> db_table = "a_model_example_name"
> db_table_comment ="this is a_model comment ~~~~"
>
> }}}
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py option.
....
....
**new proposal** (kimsoungryoul : 2020.03.23)
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text",
db_column_comment="i am db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
{{{
default settings ENABLE_DB_COMMENT_WITH_HELP_TEXT = False
}}}
if it's True
help_text is used for db_column_comment
--
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:20>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Description changed by KimSoungRyoul:
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py option.
>
> ....
> ....
>
> **new proposal** (kimsoungryoul : 2020.03.23)
>
> We will develop the code such as below
>
> {{{
>
> class AModel(models.Model):
> aaa = model.CharField(help_text="i am help_text",
> db_column_comment="i am db_comment",~~~)
>
> class Meta:
> db_table = "a_model_example_name"
> db_table_comment ="this is a_model comment ~~~~"
>
> }}}
>
> {{{
>
> default settings ENABLE_DB_COMMENT_WITH_HELP_TEXT = False
>
> }}}
>
> if it's True
>
> help_text is used for db_column_comment
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py option.
....
....
**new proposal** (kimsoungryoul : 2020.03.23)
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text",
db_column_comment="i am db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
{{{
settings ENABLE_DB_COMMENT_WITH_HELP_TEXT = False # default
}}}
if it's True
help_text is used for db_column_comment
--
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:21>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Description changed by KimSoungRyoul:
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py option.
>
> ....
> ....
>
> **new proposal** (kimsoungryoul : 2020.03.23)
>
> We will develop the code such as below
>
> {{{
>
> class AModel(models.Model):
> aaa = model.CharField(help_text="i am help_text",
> db_column_comment="i am db_comment",~~~)
>
> class Meta:
> db_table = "a_model_example_name"
> db_table_comment ="this is a_model comment ~~~~"
>
> }}}
>
> {{{
>
> settings ENABLE_DB_COMMENT_WITH_HELP_TEXT = False # default
>
> }}}
>
> if it's True
>
> help_text is used for db_column_comment
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py option.
....
....
**new proposal** (kimsoungryoul : 2020.03.23)
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text",
db_column_comment="i am db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
settings .py
{{{
ENABLE_DB_COMMENT_WITH_HELP_TEXT = False # default
}}}
if it's True
help_text is used for db_column_comment
--
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:22>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Comment (by felixxm):
Adding a new setting is always a bit controversial. This should be
discussed first on DevelopersMailingList. Personally I don't think that we
need it.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:23>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Comment (by KimSoungRyoul):
i agree. your opinion.
i remove new settings. **ENABLE_DB_COMMENT_WITH_HELP_TEXT**
AND
i added few a more commit for support postgresql oracle
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:24>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Comment (by KimSoungRyoul):
here is mail list for this feature
https://groups.google.com/forum/?nomobile=true#!topic/django-
developers/guVTzO3RhUs
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:25>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py option.
>
> ....
> ....
>
> **new proposal** (kimsoungryoul : 2020.03.23)
>
> We will develop the code such as below
>
> {{{
>
> class AModel(models.Model):
> aaa = model.CharField(help_text="i am help_text",
> db_column_comment="i am db_comment",~~~)
>
> class Meta:
> db_table = "a_model_example_name"
> db_table_comment ="this is a_model comment ~~~~"
>
> }}}
>
> settings .py
> {{{
>
> ENABLE_DB_COMMENT_WITH_HELP_TEXT = False # default
>
> }}}
>
> if it's True
>
> help_text is used for db_column_comment
New description:
Hello,
That would be nice if it was possible to include comment on table /
columns at creation time with the syncdb manage.py option.
....
....
**new proposal** (kimsoungryoul : 2020.03.23)
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text",
db_column_comment="i am db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
--
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:26>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by KimSoungRyoul):
If you don't mind me asking...
could you give me a feedback to this feature?
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:27>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by KimSoungRyoul):
Hi felixxm
I want this feature to be reflected in Django.3.1
I know this feature that many people won't use.
but some people who communicate with DBA would be helpful this feature
sometimes ORM take control from DBA
like these situation...
{{{
DBAs: we want to know comment(help_text) not to *.py could you use
COMMENT SQL in migrationFile?
Developers: No, It's Impossible because django ORM does not support
COMMENT SQL
DBAs: ???? that means .. should we refer *.py file everytimes even though
COMMENT SQL exists but can't use?
DBAs: it's illogical!!!!
Developers: but if we use COMMENT SQL, we customize everytimes to generate
migrate files
Developers: it's inefficient!!!!
}}}
That's one of the reasons for avoiding ORM.
If you don't mind me asking...
could you give me a feedback to this feature?
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:28>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by felixxm):
This patch is not ready for a review. Docs and tests are still missing.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:29>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Damien):
Rebased a previous PR to add support to inspectdb here:
https://github.com/django/django/pull/13737
Still missing some tests and it looks like we would like it to be a
verbose_name field and not a comment
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:30>
Django
-------------------------------------+-------------------------------------
Type: New feature | Status: assigned
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* owner: KimSoungRyoul => jchubber
Comment:
Owner updated based on suggestion in django-developers group
https://groups.google.com/g/django-developers/c/guVTzO3RhUs
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:31>
Django
-------------------------------------+-------------------------------------
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Jared Chung):
Status update: KimSoungRyoul has created a new PR
([https://github.com/django/django/pull/14463/ here]) that addresses some
of the suggestions raised by atombrella in May 2020 on the previous PR
([https://github.com/django/django/pull/12605 here]). Huge thanks to
KimSoungRyoul for resuming work on this feature!
The new PR is not complete yet. Still needed:
1) Test coverage.
2) Additional changes to the proposed docs including further explanation,
a warning about lack of SQLite support, and a warning about overwriting
comments made by DBAs in the db, versionadded annotation, and a couple
other things.
3) Release note.
4) General code review, especially related to where sqlite warnings should
be triggered in the code to avoid having hard-coded vendor names in
django/db/models/base.py.
Next steps: I'll add some suggestions directly to the new PR and post
updates here as this PR progresses.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:32>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 1
Needs tests: 1 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Jared Chung):
Update: This feature is still being actively developed. KimSoungRyoul has
been leading the development, and we've received input as well from
knyghty on the PR. Docs and unit tests have been written, and right now we
are discussing edge cases that need to be properly handled or explicitly
"unsupported" (such as, for example, Django model classes or fields that
Django doesn't actually create in the db such as M2M fields, proxy models,
abstract base classes, and more).
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:33>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
* needs_tests: 1 => 0
* needs_docs: 1 => 0
Old description:
> Hello,
>
> That would be nice if it was possible to include comment on table /
> columns at creation time with the syncdb manage.py option.
>
> ....
> ....
>
> **new proposal** (kimsoungryoul : 2020.03.23)
>
> We will develop the code such as below
>
> {{{
>
> class AModel(models.Model):
> aaa = model.CharField(help_text="i am help_text",
> db_column_comment="i am db_comment",~~~)
>
> class Meta:
> db_table = "a_model_example_name"
> db_table_comment ="this is a_model comment ~~~~"
>
> }}}
New description:
Database-level comments are valuable for database administrators, data
analysts, data scientists, and others who are looking to consume data that
is managed by Django. Most Django-supported databases also support table-
level and column-level comments. This ticket would add functionality to
Django to allow Django users to specify comments for syncdb manage.py to
enter into the database.
....
....
**new proposal** (kimsoungryoul : 2020.03.23)
We will develop the code such as below
{{{
class AModel(models.Model):
aaa = model.CharField(help_text="i am help_text",
db_column_comment="i am db_comment",~~~)
class Meta:
db_table = "a_model_example_name"
db_table_comment ="this is a_model comment ~~~~"
}}}
--
Comment:
This patch is ready for review. It meets everything on the checklist. I'm
updating the status so it shows up in `Patches Needing Review` on the
Development Dashboard.
If you would like additional information about some of the design and
implementation decisions behind this patch, please refer to the Github
Pull Request conversation at https://github.com/django/django/pull/14463
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:34>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Jared Chung):
* stage: Accepted => Ready for checkin
Comment:
**Update:** This patch has been reviewed (refer to
[https://github.com/django/django/pull/14463#issuecomment-907692312 this
comment on the Github PR] for the details on the patch review checklist
for this patch). I have marked it "Ready for checkin"
**Note:** Although I am the owner of this ticket, I am NOT the author of
this patch. The author of the patch is KimSoungRyoul. Because I am not the
author, I conducted the patch review using
[https://docs.djangoproject.com/en/dev/internals/contributing/writing-code
/submitting-patches/#patch-review-checklist the patch review checklist].
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:35>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by KimSoungRyoul):
May I change assignee to me? perhaps is there any problem?
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:36>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
* stage: Ready for checkin => Accepted
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:37>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Jared Chung):
Status update: KSR has updated the patch on github
https://github.com/django/django/pull/14463 and there's continued
discussion there, including additional changes proposed by other community
members...
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:38>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by KimSoungRyoul):
Hi a few days ago I fix pullrequest to target release 4.2
Fixed an issue on the Oracle side
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:39>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 1 => 0
Comment:
After updating a patch, you can uncheck "Patch needs improvement" on the
ticket so that it appears in the review queue.
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:40>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner: Jared
| Chung
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* needs_better_patch: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:41>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* owner: Jared Chung => KimSoungRyoul
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:42>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* needs_better_patch: 1 => 0
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:43>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: assigned
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution:
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):
* stage: Accepted => Ready for checkin
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:44>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Component: Database layer | Version: dev
(models, ORM) |
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: assigned => closed
* resolution: => fixed
Comment:
In [changeset:"78f163a4fb3937aca2e71786fbdd51a0ef39629e" 78f163a]:
{{{
#!CommitTicketReference repository=""
revision="78f163a4fb3937aca2e71786fbdd51a0ef39629e"
Fixed #18468 -- Added support for comments on columns and tables.
Thanks Jared Chung, Tom Carrick, David Smith, Nick Pope, and Mariusz
Felisiak for reviews.
Co-authored-by: Mariusz Felisiak <felisiak...@gmail.com>
Co-authored-by: Nick Pope <ni...@nickpope.me.uk>
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:45>
Django
-------------------------------------+-------------------------------------
Reporter: Marc Rechté | Owner:
| KimSoungRyoul
Type: New feature | Status: closed
Component: Database layer | Version: dev
(models, ORM) |
Severity: Normal | Resolution: fixed
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by GitHub <noreply@…>):
In [changeset:"648005dee62481acc1784e5c9625e90f0fd6aab4" 648005d]:
{{{
#!CommitTicketReference repository=""
revision="648005dee62481acc1784e5c9625e90f0fd6aab4"
Refs #18468 -- Used obj_description() with a catalog name on PostgreSQL.
obj_description(object oid) without a catalog name is deprecated since
there is no guarantee that OIDs are unique across different system
catalogs.
Thanks Tim Graham for the report.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/18468#comment:46>