脚手架使用SQL Server自助快速构建你的数据库

1. SQL Server脚手架简介

SQL Server脚手架是一个用于快速部署和构建数据库的工具。它使用SQL Server的官方库和模板，可以大大减少构建数据库的时间和工作量。它还具有更改跟踪和版本控制等功能，让数据库构建更加简单和现代化。

2. SQL Server脚手架安装

2.1 下载安装包

首先你需要下载SQL Server脚手架的安装包，可以在官方网站下载最新版本，也可以在NuGet上下载安装包。

2.2 安装

将下载的安装包解压到指定目录，或在Visual Studio中使用NuGet管理器或控制台安装。以下是NuGet控制台安装命令：

Install-Package SqlScaffold

3. SQL Server脚手架基础使用

3.1 初始化项目

运行以下命令来初始化数据库项目：

SqlScaffold init [-f|--force] [-t|--type <sqlserver|sqlite>]

其中-f或--force选项可以用来覆盖已存在的项目，-t或--type选项用于选择数据库类型。这会在当前目录下创建一个新的文件夹，其中包含了初始化的项目文件。

3.2 创建数据库表

运行以下命令创建一个新的数据库表：

SqlScaffold table [-n|--name <table>] [-f|--folder <folder>]

其中-n或--name选项用于指定表的名称，-f或--folder选项用于指定位置，默认为项目根目录下的Tables文件夹。

3.3 自定义表字段

运行以下命令创建一个新的字段：

SqlScaffold column [-t|--table <table>] [-n|--name <column>] [-k|--key] [-r|--required] [-p|--precision <precision>] [-s|--scale <scale>] [-l|--length <length>] [-f|--folder <folder>]

其中-t或--table选项用于指定表的名称，-n或--name选项用于指定字段名称，-k或--key选项用于指定主键，-r或--required选项用于指定是否为必填项，-p或--precision选项用于指定数字字段的精度，-s或--scale选项用于指定小数位数，-l或--length选项用于指定文本和字符字段的最大长度。

3.4 生成数据库脚本

运行以下命令生成数据库脚本：

SqlScaffold dbgen [-t|--type <create|update>] [-f|--folder <folder>]

其中-t或--type选项用于指定生成脚本的类型，create用于新建数据库，update用于更新数据库，-f或--folder选项用于指定生成脚本的存放位置，默认为项目根目录下的Scripts文件夹。

4. SQL Server脚手架高级使用

4.1 配置文件

SQL Server脚手架使用JSON格式的配置文件，文件名为.scaffoldrc或.scaffoldrc.json，位于项目根目录下。以下是常用的配置项：

{

  "database": {
    "provider": "SqlServer",
    "connectionString": "Data Source=127.0.0.1;Initial Catalog=TestDb;User ID=sa;Password=123456;"
  },
  "table": {
    "primaryKey": "Id",
    "createdAt": "CreatedAt",
    "updatedAt": "UpdatedAt"
  },
  "column": {
    "boolean": {
      "defaultValue": "0"
    },
    "number": {
      "precision": 18,
      "scale": 4,
      "defaultValue": "0.00"
    },
    "string": {
      "length": 100,
      "defaultValue": ""
    },
    "text": {
      "length": 65535,
      "defaultValue": ""
    },
    "datetime": {
      "defaultValue": "CURRENT_TIMESTAMP"
    }
  }
}

database中的provider配置项用于指定数据库类型，connectionString配置项用于指定连接字符串。table中的primaryKey、createdAt和updatedAt配置项用于指定主键、创建时间和更新时间字段的名称。column中的各项配置项用于指定各种字段类型的默认值、长度、精度等。

4.2 外键约束

运行以下命令创建一个外键约束：

SqlScaffold foreignkey [-t|--table <table>] [-n|--name <name>] [-c|--column <column>] [-r|--references <references>] [-rc|--referencescolumn <referencescolumn>] [-lt|--deletetype <deletetype>] [-f|--folder <folder>]

其中-t或--table选项用于指定表的名称，-n或--name选项用于指定外键约束的名称，-c或--column选项用于指定外键字段，-r或--references选项用于指定参照表的名称，-rc或--referencescolumn选项用于指定参照字段，-lt或--deletetype选项用于指定删除时的处理方式。默认为RESTRICT，还可以选择CASCADE、SET NULL和NO ACTION。

4.3 数据迁移

SQL Server脚手架使用FluentMigrator作为数据迁移工具，可通过以下命令生成数据迁移类：

SqlScaffold migration [-n|--name <name>] [-t|--table <table>] [-c|--column <column>] [-f|--folder <folder>]

其中-n或--name选项用于指定迁移类的名称，-t或--table选项用于指定表，-c或--column选项用于指定字段。运行以下命令执行迁移：

dotnet migrate

还可以使用单个参数来指定需要迁移到的版本号。例如：

dotnet migrate --version 3

4.4 版本控制

SQL Server脚手架使用Git作为版本控制系统，建议将数据库项目和应用程序项目放在一个Git仓库中。为了方便版本控制和追踪更改，SQL Server脚手架会在项目根目录下自动生成.gitignore和.gitattributes文件。.gitignore文件用于屏蔽不需要跟踪的文件，.gitattributes文件用于定义文件的行为，如文本文件和二进制文件的区别，编码格式等。

5. 总结

SQL Server脚手架是一个功能强大的工具，它大大简化了数据库的构建和维护工作。它提供了丰富的命令行工具和配置选项，使得数据库构建更加灵活和高效。并且它与FluentMigrator和Git等现代化工具紧密集成，使得数据库开发更加便捷和高效。