这是一款简单的数据库文档生成工具,主要实现了SQlServer生成说明文档的小工具,目前不够完善,主要可以把数据库的表以及表的详细字段信息,导出到

Word中,可以方便开发人员了解数据库的信息或写技术说明文档。

技术上主要采用的 C#+Dapper+Npod ,开发工具为Vs2015,基于Net4.5框架。

操作Word代码

NPoi

  1. public void CreateToWord(List<string> list,string conStr,string db)
  2. {
  3. XWPFDocument doc = new XWPFDocument(); //创建新的word文档
  4.  
  5. XWPFParagraph p1 = doc.CreateParagraph(); //向新文档中添加段落
  6.  
  7. p1.Alignment = ParagraphAlignment.CENTER;
  8. XWPFRun r1 = p1.CreateRun();
  9. r1.FontFamily = "微软雅黑";
  10. r1.FontSize = ;
  11. r1.IsBold = true;
  12. //向该段落中添加文字
  13. r1.SetText(db+"数据库说明文档");
  14.  
  15. //XWPFParagraph p2 = doc.CreateParagraph();
  16. //XWPFRun r2 = p2.CreateRun();
  17. //r2.SetText("测试段落二");
  18.  
  19. #region 创建一个表格
  20. if (list.Count > )
  21. {
  22.  
  23. foreach (var item in list)
  24. {
  25.  
  26. XWPFParagraph p3 = doc.CreateParagraph(); //向新文档中添加段落
  27. p3.Alignment = ParagraphAlignment.LEFT;
  28. XWPFRun r3 = p3.CreateRun(); //向该段落中添加文字
  29. r3.FontFamily = "微软雅黑";
  30. r3.FontSize = ;
  31. r3.IsBold = true;
  32. r3.SetText("表名:"+item);
  33.  
  34. //从第二行开始 因为第一行是表头
  35. int i = ;
  36. var tabledetaillist = service.GetTableDetail(item, conStr);
  37. XWPFTable table = doc.CreateTable(tabledetaillist.Count + , );
  38. table.Width = ;
  39.  
  40. #region 设置表头
  41.  
  42. //table.GetRow(0).GetCell(0).SetText("数据库名称");
  43. XWPFParagraph pI = table.GetRow().GetCell().AddParagraph();
  44. XWPFRun rI = pI.CreateRun();
  45. rI.FontFamily = "微软雅黑";
  46. rI.FontSize = ;
  47. rI.IsBold = true;
  48. rI.SetText("序号");
  49.  
  50. XWPFParagraph pI1 = table.GetRow().GetCell().AddParagraph();
  51. XWPFRun rI1 = pI1.CreateRun();
  52. rI1.FontFamily = "微软雅黑";
  53. rI1.FontSize = ;
  54. rI1.IsBold = true;
  55. rI1.SetText("字段名称");
  56.  
  57. XWPFParagraph pI2 = table.GetRow().GetCell().AddParagraph();
  58. XWPFRun rI2 = pI2.CreateRun();
  59. rI2.FontFamily = "微软雅黑";
  60. rI2.FontSize = ;
  61. rI2.IsBold = true;
  62. rI2.SetText("标识");
  63.  
  64. XWPFParagraph pI3 = table.GetRow().GetCell().AddParagraph();
  65. XWPFRun rI3 = pI3.CreateRun();
  66. rI3.FontFamily = "微软雅黑";
  67. rI3.FontSize = ;
  68. rI3.IsBold = true;
  69. rI3.SetText("主键");
  70.  
  71. XWPFParagraph pI4 = table.GetRow().GetCell().AddParagraph();
  72. XWPFRun rI4 = pI4.CreateRun();
  73. rI4.FontFamily = "微软雅黑";
  74. rI4.FontSize = ;
  75. rI4.IsBold = true;
  76. rI4.SetText("字段类型");
  77.  
  78. XWPFParagraph pI5 = table.GetRow().GetCell().AddParagraph();
  79. XWPFRun rI5 = pI5.CreateRun();
  80. rI5.FontFamily = "微软雅黑";
  81. rI5.FontSize = ;
  82. rI5.IsBold = true;
  83. rI5.SetText("字段长度");
  84.  
  85. XWPFParagraph pI6 = table.GetRow().GetCell().AddParagraph();
  86. XWPFRun rI6 = pI6.CreateRun();
  87. rI6.FontFamily = "微软雅黑";
  88. rI6.FontSize = ;
  89. rI6.IsBold = true;
  90. rI6.SetText("允许空");
  91.  
  92. XWPFParagraph pI7 = table.GetRow().GetCell().AddParagraph();
  93. XWPFRun rI7 = pI7.CreateRun();
  94. rI7.FontFamily = "微软雅黑";
  95. rI7.FontSize = ;
  96. rI7.IsBold = true;
  97. rI7.SetText("字段默认值");
  98.  
  99. XWPFParagraph pI8 = table.GetRow().GetCell().AddParagraph();
  100. XWPFRun rI8 = pI8.CreateRun();
  101. rI8.FontFamily = "微软雅黑";
  102. rI8.FontSize = ;
  103. rI8.IsBold = true;
  104. rI8.SetText("字段说明");
  105.  
  106. #endregion
  107.  
  108. if (tabledetaillist != null && tabledetaillist.Count > )
  109. {
  110. foreach (var itm in tabledetaillist)
  111. {
  112. //第一列
  113. XWPFParagraph pIO = table.GetRow(i).GetCell().AddParagraph();
  114. XWPFRun rIO = pIO.CreateRun();
  115. //rIO.FontFamily = "微软雅黑";
  116. rIO.FontSize = ;
  117. rIO.IsBold = true;
  118. rIO.SetText(itm.index.ToString());
  119.  
  120. //第二列
  121. XWPFParagraph pIO2 = table.GetRow(i).GetCell().AddParagraph();
  122. XWPFRun rIO2 = pIO2.CreateRun();
  123. //rIO2.FontFamily = "微软雅黑";
  124. rIO2.FontSize = ;
  125. rIO2.IsBold = true;
  126. rIO2.SetText(itm.Title);
  127.  
  128. XWPFParagraph pIO3 = table.GetRow(i).GetCell().AddParagraph();
  129. XWPFRun rIO3 = pIO3.CreateRun();
  130. //rIO3.FontFamily = "微软雅黑";
  131. rIO3.FontSize = ;
  132. rIO3.IsBold = true;
  133. rIO3.SetText(itm.isMark.ToString());
  134.  
  135. XWPFParagraph pIO4 = table.GetRow(i).GetCell().AddParagraph();
  136. XWPFRun rIO4 = pIO4.CreateRun();
  137. //rIO4.FontFamily = "微软雅黑";
  138. rIO4.FontSize = ;
  139. rIO4.IsBold = true;
  140. rIO4.SetText(itm.isPK.ToString());
  141.  
  142. XWPFParagraph pIO5 = table.GetRow(i).GetCell().AddParagraph();
  143. XWPFRun rIO5 = pIO5.CreateRun();
  144. //rIO5.FontFamily = "微软雅黑";
  145. rIO5.FontSize = ;
  146. rIO5.IsBold = true;
  147. rIO5.SetText(itm.FieldType);
  148.  
  149. XWPFParagraph pIO6 = table.GetRow(i).GetCell().AddParagraph();
  150. XWPFRun rIO6 = pIO6.CreateRun();
  151. //rIO6.FontFamily = "微软雅黑";
  152. rIO6.FontSize = ;
  153. rIO6.IsBold = true;
  154. rIO6.SetText(itm.fieldLenth.ToString());
  155.  
  156. XWPFParagraph pIO7 = table.GetRow(i).GetCell().AddParagraph();
  157. XWPFRun rIO7 = pIO7.CreateRun();
  158. //rIO7.FontFamily = "微软雅黑";
  159. rIO7.FontSize = ;
  160. rIO7.IsBold = true;
  161. rIO7.SetText(itm.isAllowEmpty.ToString());
  162.  
  163. XWPFParagraph pIO8 = table.GetRow(i).GetCell().AddParagraph();
  164. XWPFRun rIO8 = pIO8.CreateRun();
  165. //rIO8.FontFamily = "微软雅黑";
  166. rIO8.FontSize = ;
  167. rIO8.IsBold = true;
  168. rIO8.SetText(itm.defaultValue.ToString());
  169.  
  170. XWPFParagraph pIO9 = table.GetRow(i).GetCell().AddParagraph();
  171. XWPFRun rIO9 = pIO9.CreateRun();
  172. //rIO9.FontFamily = "微软雅黑";
  173. rIO9.FontSize = ;
  174. rIO9.IsBold = true;
  175. rIO9.SetText(itm.fieldDesc);
  176.  
  177. i++;
  178. }
  179. }
  180.  
  181. }
  182.  
  183. }
  184.  
  185. #endregion
  186.  
  187. #region 存储过程
  188. XWPFParagraph p2 = doc.CreateParagraph();
  189. XWPFRun r2 = p2.CreateRun();
  190. r2.FontSize = ;
  191. r2.SetText("存储过程");
  192. List<ProcModel> proclist = new List<ProcModel>();
  193. proclist = service.GetProcList(conStr);
  194. if(proclist.Count>)
  195. {
  196. foreach(var item in proclist)
  197. {
  198. //存储过程名称
  199. XWPFParagraph pro1 = doc.CreateParagraph();
  200. XWPFRun rpro1 = pro1.CreateRun();
  201. rpro1.FontSize = ;
  202. rpro1.IsBold = true;
  203. rpro1.SetText("存储过程名称:"+item.procName);
  204. //存储过程 详情
  205. XWPFParagraph pro2 = doc.CreateParagraph();
  206. XWPFRun rpro2 = pro2.CreateRun();
  207. rpro2.FontSize = ;
  208. rpro2.SetText(item.proDerails);
  209. }
  210. }
  211. #endregion
  212.  
  213. #region 试图
  214. XWPFParagraph v2 = doc.CreateParagraph();
  215. XWPFRun vr2 = v2.CreateRun();
  216. vr2.FontSize = ;
  217. vr2.SetText("视图");
  218. List<ViewModel> viewlist = new List<ViewModel>();
  219. viewlist = service.GetViewList(conStr);
  220. if (proclist.Count > )
  221. {
  222. foreach (var item in viewlist)
  223. {
  224. //存储过程名称
  225. XWPFParagraph vro1 = doc.CreateParagraph();
  226. XWPFRun vpro1 = vro1.CreateRun();
  227. vpro1.FontSize = ;
  228. vpro1.IsBold = true;
  229. vpro1.SetText("视图名称:" + item.viewName);
  230. //存储过程 详情
  231. XWPFParagraph vro2 = doc.CreateParagraph();
  232. XWPFRun vpro2 = vro2.CreateRun();
  233. vpro2.FontSize = ;
  234. vpro2.SetText(item.viewDerails);
  235. }
  236. }
  237. #endregion
  238.  
  239. FileStream sw = File.Create("../../Doc/db.docx"); //...
  240. doc.Write(sw); //...
  241. sw.Close(); //在服务端生成文件
  242.  
  243. FileInfo file = new FileInfo("../../Doc/db.docx");//文件保存路径及名称
  244.  
  245. }

操作Word

  1. /// <summary>
  2. /// 测试连接数据库是否成功
  3. /// </summary>
  4. /// <returns></returns>
  5. public bool ConnectionTest(string conStr)
  6. {
  7. //创建连接对象
  8. mySqlConnection = new SqlConnection(conStr);
  9. try
  10. {
  11. //Open DataBase
  12. //打开数据库
  13. mySqlConnection.Open();
  14. IsCanConnectioned = true;
  15. }
  16. catch
  17. {
  18. //Can not Open DataBase
  19. //打开不成功 则连接不成功
  20. IsCanConnectioned = false;
  21. }
  22. finally
  23. {
  24. //Close DataBase
  25. //关闭数据库连接
  26. mySqlConnection.Close();
  27. }
  28. //mySqlConnection is a SqlConnection object
  29. if (mySqlConnection.State == ConnectionState.Closed || mySqlConnection.State == ConnectionState.Broken)
  30. {
  31. //Connection is not available
  32. return IsCanConnectioned;
  33. }
  34. else
  35. {
  36. //Connection is available
  37. return IsCanConnectioned;
  38. }
  39. }

测试服务器是否连接成功

  1. /// <summary>
  2. /// 获取数据库列表
  3. /// </summary>
  4. /// <param name="conStr"></param>
  5. /// <returns></returns>
  6. public List<string> GetDBNameList(string conStr)
  7. {
  8. //List<DBName> list =new List<DBName>();
  9. string sql = "select [name] from master.dbo.sysdatabases where DBId>6 Order By [Name] ";
  10. try
  11. {
  12. using (SqlConnection connection = new SqlConnection(conStr))
  13. {
  14. var list = connection.Query<string>(sql).ToList();
  15. return list;
  16. }
  17. }
  18. catch
  19. {
  20. return null;
  21. }
  22.  
  23. }

获取数据库列表

  1. /// <summary>
  2. /// 获取字段的信息
  3. /// </summary>
  4. /// <param name="tableName"></param>
  5. /// <param name="conStr"></param>
  6. /// <returns></returns>
  7. public List<TableDetail> GetTableDetail(string tableName, string conStr)
  8. {
  9. var list = new List<TableDetail>();
  10. StringBuilder sb = new StringBuilder();
  11. sb.Append("SELECT [index] = a.colorder, Title = a.name, isMark = CASE WHEN COLUMNPROPERTY(a.id, a.name, 'IsIdentity') = 1 THEN '1' ELSE '0' END, ");
  12. sb.Append("isPK = CASE WHEN EXISTS(SELECT 1 FROM sysobjects WHERE xtype = 'PK' AND parent_obj = a.id AND name IN(SELECT name FROM sysindexes WHERE indid IN(SELECT indid FROM sysindexkeys WHERE id = a.id AND colid = a.colid)) ) THEN '1' ELSE '0' END, ");
  13. sb.Append(" FieldType = b.name,fieldLenth = COLUMNPROPERTY(a.id, a.name, 'PRECISION'),isAllowEmpty = CASE WHEN a.isnullable = 1 THEN '1' ELSE '0' END, defaultValue = ISNULL(e.text, ''), fieldDesc = ISNULL(g.[value], '') ");
  14. sb.Append("FROM syscolumns a LEFT JOIN systypes b ON a.xusertype = b.xusertype INNER JOIN sysobjects d ON a.id = d.id AND d.xtype = 'U' AND d.name <> 'dtproperties' LEFT JOIN syscomments e ON a.cdefault = e.id ");
  15. sb.Append("LEFT JOIN sys.extended_properties g ON a.id = G.major_id AND a.colid = g.minor_id LEFT JOIN sys.extended_properties f ON d.id = f.major_id AND f.minor_id = 0");
  16. //--如果只查询指定表,加上此红色where条件,tablename是要查询的表名;去除红色where条件查询说有的表信息
  17. sb.Append("WHERE d.name = '"+ tableName + "' ORDER BY a.id, a.colorder, d.name");
  18. try
  19. {
  20. using (SqlConnection connection = new SqlConnection(conStr))
  21. {
  22. list = connection.Query<TableDetail>(sb.ToString()).ToList();
  23. }
  24. }
  25. catch
  26. { }
  27.  
  28. return list;
  29. }

获取表字段详情

  1. /// <summary>
  2. /// 获取特定数据库里面的存储过程
  3. /// </summary>
  4. /// <param name="conStr"></param>
  5. /// <param name="db"></param>
  6. /// <returns></returns>
  7. public List<ProcModel> GetProcList(string conStr)
  8. {
  9. var list = new List<ProcModel>();
  10. string sql = @" select name as procName, (select text from syscomments where id=OBJECT_ID(name)) as proDerails
  11. from dbo.sysobjects o where OBJECTPROPERTY(id, N'IsProcedure') = 1 order by name ";
  12. try
  13. {
  14. // http://www.cnblogs.com/minideas/archive/2009/10/29/1591891.html
  15. using (SqlConnection connection = new SqlConnection(conStr))
  16. {
  17. list = connection.Query<ProcModel>(sql).ToList();
  18. }
  19. }
  20. catch
  21. {
  22.  
  23. }
  24. return list;
  25. }

获取特定数据库里面的存储过程

实现思路:

1、首先获取数据库的字符串,测试链接是否成功,

2、通过脚本获取该服务器的数据库列表。

3、根据数据库找到该数据库的所有数据表

4、通过脚本找到该数据表所有的字段信息

5、使用Npoi技术把信息导出到Word中去。

效果如下:

文档效果

目前功能比较简单,后续会慢慢完善,当然自己技术有限,欢迎高手多多指点!

Github地址:https://github.com/hgmsq/SqlToDocTool

原创SQlServer数据库生成简单的说明文档包含(存储过程、视图、数据库批量备份)小工具(附源码)的更多相关文章

  1. 原创SQlServer数据库生成简单的说明文档小工具(附源码)

    这是一款简单的数据库文档生成工具,主要实现了SQlServer生成说明文档的小工具,目前不够完善,主要可以把数据库的表以及表的详细字段信息,导出到 Word中,可以方便开发人员了解数据库的信息或写技术 ...

  2. 利用js编写一个简单的html表单验证,验证通过时提交数据(附源码)

    <!DOCTYPE html> <html lang="en"> <head>     <meta charset="UTF-8 ...

  3. (原创)通用查询实现方案(可用于DDD)[附源码] -- 简介

    [声明] 写作不易,转载请注明出处(http://www.cnblogs.com/wiseant/p/3985353.html).   [系列文章] 通用查询实现方案(可用于DDD)[附源码] -- ...

  4. 原创:用python把链接指向的网页直接生成图片的http服务及网站(含源码及思想)

    原创:用python把链接指向的网页直接生成图片的http服务及网站(含源码及思想) 总体思想:     希望让调用方通过 http调用传入一个需要生成图片的网页链接生成一个网页的图片并返回图片链接 ...

  5. H5类似易企秀/编辑器/页面制作/开发/生成工具/软件/源码/授权

    代码地址如下:http://www.demodashi.com/demo/14960.html 项目简介 H5DS (HTML5 Design software) 这是一款基于WEB的 H5制作工具. ...

  6. (原创)通用查询实现方案(可用于DDD)[附源码] -- 设计思路

    [声明] 写作不易,转载请注明出处(http://www.cnblogs.com/wiseant/p/3988592.html).   [系列文章] 通用查询实现方案(可用于DDD)[附源码] -- ...

  7. 极限挑战—C#100万条数据导入SQL SERVER数据库仅用4秒 (附源码)

    原文:极限挑战-C#100万条数据导入SQL SERVER数据库仅用4秒 (附源码) 实际工作中有时候需要把大量数据导入数据库,然后用于各种程序计算,本实验将使用5中方法完成这个过程,并详细记录各种方 ...

  8. 开源方案搭建可离线的精美矢量切片地图服务-8.mapbox 之sprite大图图标文件生成(附源码)

    项目成果展示(所有项目文件都在阿里云的共享云虚拟主机上,访问地图可以会有点慢,请多多包涵). 01:中国地图:http://test.sharegis.cn/mapbox/html/3china.ht ...

  9. PHP简单的长文章分页教程 附源码

    PHP简单的长文章分页教程 附源码.本文将content.txt里的内容分割成3页,这样浏览起来用户体验很好. 根据分页参数ipage,获取对应文章内容 include('page.class.php ...

随机推荐

  1. redis启动出现错误creating server tcp listening socket 127.0.0.1:6379: bind No error

    creating server tcp listening socket 127.0.0.1:6379: bind No error 的解决方案如下按顺序输入如下命令就可以连接成功 1. redis- ...

  2. Spark Programming--- Shuffle operations

    *:first-child { margin-top: 0 !important; } body > *:last-child { margin-bottom: 0 !important; } ...

  3. Javascript高级编程学习笔记(45)——DOM 操作表格及DOM动态集合

    操作DOM表格 早些时候,HTML 还是以表格布局为主, 所以DOM操作表格是比较重要的一点 但是现如今 有其它的选择,所以表格的操作也就慢慢地淡出了人们的视线 所以这里也就不过多去详细展开,这里也就 ...

  4. IDEA一定要懂的32条快捷键

    阅读本文大概需要 2 分钟.   作者:帝都羊 这些IntelliJ IDEA键盘快捷键可以让你专注于编写代码,让你的双手在键盘上起舞. 1.搜索文件名: ↑   Shift 快速连续按两下 2.显示 ...

  5. Day2:html和css

    Day2:html和css 表格是一种常用的标签,表格结构,做到能够合并单元格. 表格的属性: 属性名 说明 border 设置表格的边框 cellspacing 设置单元格与单元格边框之间的空白间距 ...

  6. Kali学习笔记18:OpenVAS使用

    上一篇讲了什么是OpenVAS以及如何安装: https://www.cnblogs.com/xuyiqing/p/9690373.html 接下来就是使用: 我先打开一台Metasploitable ...

  7. OAuth2简易实战(二)-模拟客户端调用

    1. OAuth2简易实战(二) 1.1. 目标 模拟客户端获取第三方授权,并调用第三方接口 1.2. 代码 1.2.1. 核心流程 逻辑就是从数据库读取用户信息,封装成UserDetails对象,该 ...

  8. Java 程序员必备的 15 个框架,前 3 个地位无可动摇!

    Java 程序员方向太多,且不说移动开发.大数据.区块链.人工智能这些,大部分 Java 程序员都是 Java Web/后端开发.那作为一名 Java Web 开发程序员必须需要熟悉哪些框架呢? 今天 ...

  9. NetStandard;.netCore;FX(.netFrameWork)之间引用关系

    .NetStandard;.netCore;FX(.NetFrameWork)之间引用关系   FX引用.NetCore:不通过 NetStandard引用.NetCore:不通过   .NetCor ...

  10. 使用一年ESB感受

    ESB(Enterprise service bus)-----企业服务总线的简写. 目前使用的是openESB,Sun公司的开源社区提供的,集成在netbean中,使用glassFish服务器. 先 ...