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

修改 table_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


修改 column_sql  函数 后的代码效果图
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 226,333评论 6 524
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 97,345评论 3 411
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 173,869评论 0 370
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 61,897评论 1 305
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,790评论 6 404
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 54,288评论 1 318
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 42,449评论 3 433
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 41,579评论 0 282
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 48,092评论 1 329
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 40,080评论 3 352
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 42,192评论 1 362
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,767评论 5 354
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 43,491评论 3 342
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,860评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 35,070评论 1 278
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,793评论 3 385
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 47,218评论 2 369

推荐阅读更多精彩内容