ASP.NETWeb开发框架之六数据库文档方法

随着项目的进度推进，数据库的表越来越多，字段也频繁的变更。如何对这些变更作出文档说明，既要方便，又要有可维护性。比如，可以为所有的表创建WORD文档来说明，各个表的含义和字段的意义，但是如果数据库表或字段变更频繁的话，更新WORD文档是个相对麻烦的工作。在博客园中曾经有技术人员专门创建文档生成工具，以程序的方式直接生成WORD文档，使为数据库创建文档的可行性提高很多，轻松点击鼠标就可以做完的工作，非常容易。

创新互联自2013年起，先为温江等服务建站，温江等地企业，进行企业商务咨询服务。为温江企业网站制作PC+手机+微官网三网同步一站式服务解决您的所有建站问题。

SQL Doc

推荐给各位的数据库文档工具箱中，排名第一的是RedGate公司的SQL Doc。

创建新项目，连接数据库服务器，选择数据库，在右边的窗格中为表或它的字段创建描述信息。

使用SQL Profiler查询跟踪器，检测到它进行如下的SQL语句

  
 
 
 
    
   
  
  
  
  1. exec sp_executesql N'if (SELECT count(*)  
    2. 
   
  
  
  
  2. FROM ::fn_listextendedproperty (@propertyName, @myLevel0Type, @myLevel0Name, @myLevel1Type, @myLevel1Name, @myLevel2Type, @myLevel2Name))> 0  
    3. 
   
  
  
  
  3. begin  
    4. 
   
  
  
  
  4.     EXEC sp_updateextendedproperty  @propertyName, @propertyValue, @myLevel0Type, @myLevel0Name, @myLevel1Type, @myLevel1Name, @myLevel2Type, @myLevel2Name;  
    5. 
   
  
  
  
  5. end  
    6. 
   
  
  
  
  6. else  
    7. 
   
  
  
  
  7. begin  
    8. 
   
  
  
  
  8.     EXEC sp_addextendedproperty @propertyName, @propertyValue, @myLevel0Type, @myLevel0Name, @myLevel1Type, @myLevel1Name, @myLevel2Type, @myLevel2Name;  
    9. 
   
  
  
  
  9. end',N'@propertyName nvarchar(14),@myLevel0Type nvarchar(6),@myLevel0Name nvarchar(3),@myLevel1Type nvarchar(5),@myLevel1Name nvarchar(10),@myLevel2Type nvarchar(6),@myLevel2Name nvarchar(6),@propertyValue nvarchar(4)',@propertyName=N'MS_Description',@myLevel0Type=N'SCHEMA',@myLevel0Name=N'dbo',@myLevel1Type=N'TABLE',@myLevel1Name=N'ADBBSYSMSG',@myLevel2Type=N'COLUMN',@myLevel2Name=N'RECNUM',@propertyValue=N'记录编号'
    10.

它使用附加属性的方式，为表或字段创建备注信息，直接存放在数据库中。

回到SQL Server Management Studio中查看，看到它直接附加在字段的扩展属性中。

方便的地方不仅仅在这里，当你右键点击表，以Script Table As生成表的创建脚本时，它的最后一行，会添加属性

  
 
 
 
    
   
  
  
  
  1. CREATE TABLE [dbo].[ADBBSYSMSG]( 
    2. 
   
  
  
  
  2.     [RECNUM] [int] IDENTITY(1,1) NOT NULL, 
    3. 
   
  
  
  
  3.     [SYSMSG_ID] [nvarchar](16) NOT NULL, 
    4. 
   
  
  
  
  4.     [MESSAGE] [nvarchar](255) NOT NULL, 
    5. 
   
  
  
  
  5.     [CREATED_DATE] [datetime] NOT NULL, 
    6. 
   
  
  
  
  6.     [CREATED_BY] [nvarchar](10) NOT NULL, 
    7. 
   
  
  
  
  7.     [REVISED_DATE] [datetime] NOT NULL, 
    8. 
   
  
  
  
  8.     [REVISED_BY] [nvarchar](10) NOT NULL, 
    9. 
   
  
  
  
  9.  CONSTRAINT [PK_ADBBSYSMSG] PRIMARY KEY CLUSTERED  
    10. 
   
  
  
  
  10. ( 
    11. 
   
  
  
  
  11.     [SYSMSG_ID] ASC
    12. 
   
  
  
  
  12. )WITH (PAD_INDEX  = OFF, STATISTICS_NORECOMPUTE  = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS  = ON, ALLOW_PAGE_LOCKS  = ON, FILLFACTOR = 70) ON [PRIMARY] 
    13. 
   
  
  
  
  13. ) ON [PRIMARY] 
    14. 
   
  
  
  
  14. GO 
    15. 
   
  
  
  
  15. EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'记录编号' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'ADBBSYSMSG', @level2type=N'COLUMN',@level2name=N'RECNUM'
    16. 
   
  
  
  
  16. GO
    17.

到目前为止，这是我发现的最优秀的数据库文档工具。新的2.1版本支持SQL Server 2008 R2。

Management Table Description

在没有找到SQL Doc之前，我一直寻找一种方法能为数据库创建文档，又便于维护。经过摸索，自己创建了如下工具，以维护数据库文档。

这个工具的原理，和上面的SQL Doc一样，也是运用扩展属性。关键部分的C#代码如下所示

  
 
 
 
    
   
  
  
  
  1.    string tablesql = @"  if(select count(1) from fn_listextendedproperty(N'MS_Description'," + 
    2. 
   
  
  
  
  2.   "   N'SCHEMA',N'{2}',N'TABLE',N'{0}',NULL,NULL))>0 " + 
    3. 
   
  
  
  
  3.  "    EXEC sp_updateextendedproperty N'MS_Description',N'{1}', " + 
    4. 
   
  
  
  
  4.  "    N'SCHEMA',N'{2}', N'TABLE',N'{0}',NULL,NULL  " + 
    5. 
   
  
  
  
  5.  "   ELSE   " + 
    6. 
   
  
  
  
  6. "   EXEC sp_addextendedproperty  N'MS_Description',N'{1}', " + 
    7. 
   
  
  
  
  7. "  N'SCHEMA',N'{2}',N'TABLE',N'{0}'   "; 
    8. 
   
  
  
  
  8. 
   
  
  
  
  9.        //更新字段的描述 {2} 默认是dbo,但是AdventureWorks出现大量不是dbo的情况 
    10. 
   
  
  
  
  10.        string fieldSql=@"if(select count(1) from fn_listextendedproperty(N'MS_Description',N'SCHEMA', "+ 
    11. 
   
  
  
  
  11.       " N'{3}',N'TABLE',N'{0}',N'COLUMN', N'{1}'))>0   "+ 
    12. 
   
  
  
  
  12.       " EXEC sp_updateextendedproperty N'MS_Description',N'{2}',  "+ 
    13. 
   
  
  
  
  13.       "    N'SCHEMA',N'{3}', N'TABLE',N'{0}',N'COLUMN', N'{1}'  "+ 
    14. 
   
  
  
  
  14.       "  ELSE   "+ 
    15. 
   
  
  
  
  15.       "  EXEC sp_addextendedproperty  N'MS_Description',N'{2}', "+ 
    16. 
   
  
  
  
  16.        "      N'SCHEMA',N'{3}',N'TABLE',N'{0}',N'COLUMN', N'{1}'   "; 
    17. 
   
  
  
  
  17. 
   
  
  
  
  18.        //读取表的描述 
    19. 
   
  
  
  
  19.        string getTableDescription = " select value from  " + 
    20. 
   
  
  
  
  20.        " fn_listextendedproperty(N'MS_Description',N'SCHEMA',N'{1}',N'TABLE'," + 
    21. 
   
  
  
  
  21.        " N'{0}',NULL, NULL)  "; 
    22. 
   
  
  
  
  22. 
   
  
  
  
  23.        //读取字段的描述 
    24. 
   
  
  
  
  24.        string getFieldDescription=" select objname,value from  "+ 
    25. 
   
  
  
  
  25.        " fn_listextendedproperty(N'MS_Description',N'SCHEMA',N'{1}',N'TABLE',"+ 
    26. 
   
  
  
  
  26.        " N'{0}',N'COLUMN', NULL)  ";
    27.

tableSql是对表进行注释，添加扩展属性，fieldSql是对字段添加扩展属性，下面的两行分别用于读取。整个工具，最关键的部分也是这里，这些是我用查询跟踪器，跟踪出来的。尽管可以直接用SQL Server Management Studio直接完成这个工作，但是没有这个小工具直观，把这些做成工具，方便维护。

Custom Table 自定义表

这种方法比较保守，也很稳定。在数据库中专门创建数据表，来存放表及其字段的含义，再设计工具对此进行更新和维护。以金蝶系统为例子，它就是应用这个方法。

要查询表及其字段的文档信息，需要执行如下的语句

  
 
 
 
    
   
  
  
  
  1. select * from t_tabledescription  
    2. 
   
  
  
  
  2. select * from t_fielddescription 
    3.

--要查具体的某张表描述，执行该语句：

  
 
 
 
    
   
  
  
  
  1. select * from t_fielddescription where FTableID=(select FTableID from t_tabledescription where FTableName='t_Item') 
    2.

此外，金碟的辅助工具，查看表描述信息，也做的简单实用。

金碟的产品线众多，不同产品数据表的用途会有差异，比如这里的适用于服装鞋帽版。

这种方法简单直观，直接在表中存放描述信息。需要提供更新工具，读取查看工具，如果能导出成WORD/EXCEL那就更加完美了。

网页标题：ASP.NETWeb开发框架之六数据库文档方法
文章网址：http://www.mswzjz.cn/qtweb/news12/86162.html

攀枝花网站建设、攀枝花网站运维推广公司-贝锐智能，是专注品牌与效果的网络营销公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 贝锐智能

贝锐智能技术为您推荐以下文章

标签优化知识

分类信息网

机柜租用　　 　梦港之夜　　 　成都广告制作　　 　等级保护测评　　 　成都小程序开发　　 　成都品牌网站建设　　 　广安网站建设　　 　成都网站设计　　 　营山月子护理　　 　边坡防护网　　 　古巴雪茄　　 　抖音代运营　　 　开元建校　　 　云服务器　　 　子晨包装　　 　四川主机托管　　 　绵阳网站制作　　 　模板商城网站　　 　企业画册设计制作　　 　成都网站制作