SqlServer.Rules

SQL Server Datatools的另一个规则集

概述

它在框中所说的：SQL最佳实践库作为扩展数据库代码分析规则在构建中检查的。规则可以在本地以及构建服务器上安装。

有关当前规则的完整列表，我们在此处看到。示例代码请参阅此处

组织

• sqlserver.dac-此保留访问者和其他公用事业代码
• sqlserver.rules-符合从SqlCodeAnalysisRule得出的规则
• sqlserver.rules.Report-用于评估规则并序列化结果的库。
• sqlserver.rules.generator-快速控制台应用程序，可在SQL项目中报告所有规则。
• sqlserver.rules.solutiongenerator-快速进行构建并在SQL解决方案上评估规则。还将在HTML报告中输出违反规则。
• TestDatabase-一种小型SQL解决方案，用于测试

调试 /测试

1. 确保SqlServer.Rules.SolutionGenerator被“设置为启动项目”
2. 设置命令行参数：
   1. 打开SqlServer.Rules.SolutionGenerator项目的属性
   2. 选择“调试”选项卡
   3. 输入以下场景之一：
   4. 调试测试线束db： --build --reportDirectory ".Files" --solution "......TestDatabaseTestDatabase.sln"
   5. 调试SQL项目： --build --reportDirectory ".Files" --solution "{path}.sln"
3. 在您希望调试的任何规则中添加SqlServer.Rules项目中的断点

注意：如果您需要调试库的加载，请参见此处

安装

提供了一个install.bat，将将规则复制到所有适当的文件夹目的地。或者，您可以选择按照以下说明：

按照MS文档上的说明安装静态代码分析规则。

该构建应安装到模板路径%VSBIN%Common7IDEExtensionsMicrosoftSQLDBDAC{SqlEngine}Extensions因此对于带有DAC版本的Visual Studio 2017，DAC版本150可能是该路径。

C:Program Files (x86)Microsoft Visual Studio 2017 EnterpriseCommon7IDEExtensionsMicrosoftSQLDBDAC 150 ExtensionsSqlServer.Rules

笔记：

• 您需要将二进制文件复制到您希望使用规则的Visual Studio版本和DAC版本的所有置换术。
• 当您启用代码分析并编译了项目Visual Studio时，将二进制文件硬锁定。要更新它们或删除它们，您需要关闭Visual Studio。

项目配置

• Once the rules are compiled and installed to the appropriate directory then you can open up your SSDT project and enable code analysis by following these instructions: https://docs.microsoft.com/en-us/sql/ssdt/database-project-settings?view=sql-server-ver15#bkmk_code_analysis
• 启用代码分析后，进行重建。违反的任何规则都将显示为构建警告。
  • 您可以双击任何警告，要将其带到违反规则的代码位置。
• 您也可以选择：
  • 启用 /禁用规则。
  • 将某些规则设置为错误，以便实际上会丢弃构建错误。
  • 忽略SQL文件中的规则。看