數據庫表結構文檔查看器 基於netcore

前言

日常開發業務代碼，新接手一塊不熟悉的業務時需要頻繁的查看對應業務的數據庫表設計文檔。相比於直接翻看業務代碼，有必要提供一個數據庫表結構文檔查看器來解決這些繁瑣的問題。

CML.SqlDoc

CML.SqlDoc 是基於netcore開發的數據庫表結構文檔查看器，通過簡單的配置部署即使用， 數據庫表結構文檔查看器支持MSSql MySql多數據庫

界面呈現

 

　　

如何部署

*appsettings.json 數據庫連接以及庫名寫入配置文件 格式如下

 {
  "ConnectionStrings": {
    "SqlDoc.Reader": {
      "ConnectionString": "Min Pool Size=10;Max Pool Size=500;Connection Timeout=50;Data Source=127.0.0.1;Initial Catalog=Demo;Persist Security Info=True;User ID=sa;Password=123123",
      "providerName": "System.Data.SqlClient"
    },
    "SqlDoc.Writer": {
      "ConnectionString": "Min Pool Size=10;Max Pool Size=500;Connection Timeout=50;Data Source=127.0.0.1;Initial Catalog=Demo;Persist Security Info=True;User ID=sa;Password=123123",
      "providerName": "System.Data.SqlClient"
    }
  },
  "DataBaseConfig": [
    {
      "Id": "1",
      "Title": "XX系統",
      "DbName": "DBName2",
      "ConnectionString": "Min Pool Size=10;Max Pool Size=500;Connection Timeout=50;Data Source=xxxx;Initial Catalog=xxxx;Persist Security Info=True;User ID=xxxx;Password=xxxxx!",
      "DbType": "MSSQLServer"
    },
    {
      "Id": "2",
      "Title": "YY系統",
      "DbName": "DbName1",
      "ConnectionString": "Server=xxxxxx;Port=3306;Database=bt_hyaline;Uid=xxxx;Pwd=xxxxx;Charset=utf8;",
      "DbType": "MySql"
    }
  ]
}

　　

技術棧

• 基於.Net Core 2.1開發；

• 后端采用 asp.net mvc core 2.1 + Dapper + autofac

補充

Git源碼：https://github.com/willianchen/CML.SqlDoc

項目引用CML.Lib CML.DataAccess 兩個包已發布至nuget，源碼請見 [git]https://github.com/willianchen/CML.NetCore

Sqlserver 表注釋sql語句

 -- 表加注釋
 EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'注釋內容' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'表名'
 --例如：
 EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'系統設置表' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'CM01_SYSTEM'
 -- 字段加注釋
 EXEC sys.sp_addextendedproperty @name=N'MS_Description', @value=N'注釋內容' , @level0type=N'SCHEMA',@level0name=N'dbo', @level1type=N'TABLE',@level1name=N'表名', @level2type=N'COLUMN',@level2name=N'字段名'

　　

有問題反饋

在使用中有任何問題，歡迎反饋給我，可以用以下聯系方式跟我交流

• 郵件(willianli#126.com, 把#換成@)
• QQ: 474852546