django mysql Orm 创建表注释和字段注释增加注释到数据库

一、前言

Django 数据库迁移没有表注释和字段注释对多人协助开发的效率有影响，但是项目使用的django，定义的orm类生成migration，导入到数据库后没有注释信息，因此修改Django源代码，支持表注释和字段注释；也同时达到根据数据库中的注释信息可以自动导出文档。

以Django 2.2 为基础进行修改。

二、利用[model._meta.verbose_name]增加针对mysql表注释的处理

修改django/db/backends/base/schema.py 文件，table_sql 函数，如下：

步骤一：找到Python按照根目录；如：

D:\python\Python38-32

步骤二：找到需要修改的文件；如：

D:\python\Python38-32\Lib\site-packages\django\db\backends\base\schema.py 

步骤三：找到 table_sql 函数 的结尾处，大概 202 行，如下修改：

# 利用[model._meta.verbose_name]增加针对mysql表注释的处理

if self.connection.client.executable_name =='mysql' and model._meta.verbose_name:

sql +=" COMMENT '%s'" % model._meta.verbose_name

# Return the sql

三、利用[field.verbose_name]增加针对mysql字段注释的处理

修改django/db/backends/base/schema.py 文件，column_sql 函数，如下：

步骤一：找到Python按照根目录；如：

D:\python\Python38-32

步骤二：找到需要修改的文件；如：

D:\python\Python38-32\Lib\site-packages\django\db\backends\base\schema.py

步骤三：找到 column_sql 函数 的结尾处，大概 256 行，如下修改：

# 利用[field.verbose_name]增加针对mysql字段注释的处理

if self.connection.client.executable_name =='mysql' and field.verbose_name:

sql +=" COMMENT '%s'" % field.verbose_name

# Return the sql