Rafy 框架 - 为数据库生成注释

简介:

当开发者使用 CodeFirst 开发模式,编写了大量的实体类,在代码中编写了完整的类型注释和属性注释,并自动生成数据库后,往往需要把实体类型和实体属性上的注释同时生成到对应的数据库表及字段上。这样,即方便在查看数据库时能清晰地看到每一个表及字段的含义,也方便使用一些第三方的工具(如 PowerDesigner 等)为数据库生成较为全面的文档。

 

使用方法


  1. 在为数据库生成注释之前,需要保证数据库已经全部生成成功(即和实体保持一致)。否则更新字段的注释时,可能因为字段不存在而导致执行失败。

  2. 需要在编译领域实体所在的程序集时,同时生成对应的 XML 注释文件。否则,程序会找不到需要编写的注释。

    打开方法:在领域实体项目上点击右键->属性->编译->输出->在“XML document file”前打勾。

  3. 打开后,重新编译整个解决方案。

  4. 编写以下代码来生成数据库的注释。(只需要执行一次即可)

 

using (var context = new RafyDbMigrationContext(JXCEntityRepositoryDataProvider.DbSettingName))
{
    context.RefreshComments();
}

 

注意

目前为数据库生成注释的功能,只支持 Oracle 和 SqlServer 两个数据库。

 

PS:该文已经纳入《 Rafy 用户手册》中。

目录
相关文章
|
Oracle 关系型数据库 MySQL
不同数据库注释方法的随记
oracle、mysql、postgresql、Microsoft的注释方法
79 2
|
7月前
|
数据库 Python
在数据库中的规范设计
【5月更文挑战第16天】关系数据库规范化理论涉及函数依赖和超键概念。函数依赖如X->Y表示X能唯一确定Y。超键是能唯一标识元组的属性集合,候选键是最小超键,无冗余。主键是用户选定的候选键,外键关联不同表的主键。Armstrong公理用于推导函数依赖。数据库范式从1NF到5NF,消除部分和传递依赖,确保数据完整性。实际操作中,反规范化有时用于优化,如增加冗余列、派生列、重组表和分表策略,以提升查询效率和性能。
224 51
在数据库中的规范设计
|
7月前
|
SQL JavaScript Java
闲不住,手写了数据库生成工具
`shigen`是一个擅长多种编程语言的博主,分享技术成长和认知。最近,他制作了一个数据库表结构导出工具,支持生成MD和DOCX文档。程序通过SQL(如`show tables`和`desc`)获取信息,展示包括字段注释在内的表详情。代码已分享,可用于学习交流。一起学习,每天进步!
42 0
闲不住,手写了数据库生成工具
|
关系型数据库 MySQL 数据库
数据库学习-事务管理作业示例【带源码】
MySQL数据库事务管理习题示例,包含源码,能建立起基本概念
213 0
数据库学习-事务管理作业示例【带源码】
|
SQL Oracle 关系型数据库
如何使用powerdesigner管理设计数据库
如何使用powerdesigner管理设计数据库
205 0
如何使用powerdesigner管理设计数据库
|
存储 程序员 数据库
【自然框架】元数据的数据库结构的详细说明和示例(二):数据库描述部分
1、Manage_Table(表、视图、存储过程、函数的信息) 字段名 中文名 类型 大小 默认值 说明 TableName 表名 nvarchar 60 _ 表名 PKColumnID 主键字段的编号 int 4 1 主键字段的编号 Ty...
877 0