Django生成MySQL表的字段注释

原创已于 2022-06-21 00:01:18 修改 · 1.8k 阅读

8 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#Django #MySQL

收录于

于 2022-06-21 00:00:58 首次发布

Django 专栏收录该内容

5 篇文章

订阅专栏

在Django中，使用model的verbose_name属性为字段添加注释并不直接生成到数据库。为了解决这个问题，可以安装并使用'addcomments'应用。首先通过pip安装，然后在model中为每个字段指定verbose_name。接着，在settings.py中添加'addcomments'到INSTALLED_APPS。最后，运行'addcolumncomments'命令，为指定模型的字段添加注释。该方法适用于需要快速为Django模型字段生成数据库注释的情况。

在Django中，可以先定义model，然后很快就通过migrate命令生成好对应的表，但是却发现注释并没有生成，那么如何迅速解决呢？

安装addcomments

pip install addcomments

确认model的verbose_name

如果需要添加注释，需要给字段添加verbose_name属性

class Student(models.Model):

    name = models.CharField(max_length=200, verbose_name="名称", blank=True, default=None)
    age = models.SmallIntegerField(verbose_name="年龄", blank=True, default=None)

    class Meta:
        db_table = 'test_student'

settings.py中添加模块

INSTALLED_APPS += [
    'addcomments',
]

运行命令即可立即添加注释

python manage.py addcolumncomments

-- FOR test_student.name 
        ALTER TABLE test_student
        MODIFY COLUMN `name` varchar(200) COLLATE utf8mb4_bin NOT NULL  COMMENT '名称'
-- FOR test_student.age 
        ALTER TABLE test_student
        MODIFY COLUMN `age` smallint(6) NOT NULL  COMMENT '年龄'