https://github.com/tuffnatty/django-sql-comment

Django management command to generate SQL for applying your models' and fields' verbose_name and help_text as PostgreSQL COMMENT statements.
https://github.com/tuffnatty/django-sql-comment

Last synced: 29 days ago
JSON representation

Django management command to generate SQL for applying your models' and fields' verbose_name and help_text as PostgreSQL COMMENT statements.

• Host: GitHub
• URL: https://github.com/tuffnatty/django-sql-comment
• Owner: tuffnatty
• Created: 2020-05-05T14:53:49.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-08-06T17:00:45.000Z (about 3 years ago)
• Last Synced: 2026-02-24T02:07:25.865Z (6 months ago)
• Language: Python
• Size: 7.81 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
Django SQL COMMENT

==================

Django management command to generate SQL for applying your models' and fields' ``verbose_name`` and ``help_text`` as PostgreSQL ``COMMENT`` statements.

Compatibility

-------------

Python 2.7–3.11.

Django 1.11–4.2.

Quickstart

----------

Install Django SQL COMMENT::

    pip install django-sql-comment

Add it to your ``INSTALLED_APPS``::

    INSTALLED_APPS = (

        ...

        'django_sql_comment',

        ...

    )

Run ``./manage.py sqlcomment myapp`` to look at SQL generated, or ``./manage.py sqlcomment myapp | ./manage.py dbshell`` to apply it to your database.

If you're brave enough to apply the comments automatically on every migration, you can take the risk to add to your ``AppConfig``::

    from django.db.models.signals import post_migrate

    from django_sql_comment import sqlcomment_post_migrate

    ...

    class MyAppConfig(AppConfig):

        def ready(self):

            post_migrate.connect(sqlcomment_post_migrate)