SQL プロジェクトのプロパティ

適用対象:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceMicrosoft Fabric プレビューの SQL データベース

SQL データベース プロジェクトには、個々の .sql ファイルの内容に加えて、プロジェクトの動作とデータベース レベルの設定を定義するプロパティが含まれています。 これらのプロパティは、 .sqlproj ファイルに格納され、 .sqlproj ファイルを直接編集して設定できます。 Visual Studio や VS Code などの一部の SQL プロジェクト ツールでは、グラフィカル ユーザー インターフェイスのプロジェクト プロパティの一部または多くを編集できます。 この記事では、SQL データベース プロジェクトに設定できるプロパティの概要について説明します。

一般的に使用される SQL プロジェクトのプロパティは次のとおりです。

• ターゲット プラットフォーム (DSP)
• Code analysis
• DacApplicationName と DacVersion
• Default schema
• TreatTSqlWarningsAsErrors

データベース オプションの変更を無効にする

SQL プロジェクトの発行時に、データベース オプションに対する変更は、プロジェクトのプロパティで定義されている値と既定のプロジェクト値に基づいてスクリプト化されます。 SqlPackage CLI や Visual Studio などのツールを使用して、発行中にデータベース オプションが変更されないようにするには、発行プロパティを ScriptDatabaseOptions false に設定します。 この設定は、発行プロファイルに組み込むこともできます。

一般的なプロジェクト プロパティ

ターゲット プラットフォーム プロパティは、プロジェクトが対象とする SQL Server のバージョンを指定します。 DSP プロパティは、SQL プロジェクトのターゲット プラットフォームを設定するために使用されます。 ターゲット プラットフォームの詳細については、 ターゲット プラットフォーム に関する記事を参照してください。

コード分析では、開発ライフサイクルの早い段階で潜在的な問題をキャッチすることで、継続的インテグレーションとデプロイ プロセスを大幅に改善できます。 コード分析を有効にし、カスタム 規則を含める方法の詳細については、 SQL コード分析 の記事を参照してください。

データ層アプリケーションのプロパティ

SQL プロジェクトのビルド時に作成されるデータ層アプリケーション (DAC) を定義するには、次のプロパティを使用します。

• DacApplicationName: データ層アプリケーション .dacpacの名前。 既定値はプロジェクト名です。
• DacDescription: データ層アプリケーション .dacpacの説明 (省略可能)。
• DacVersion: データ層アプリケーションのバージョン .dacpac。 既定値は 1.0.0.0 です。

Default schema

DefaultSchema プロパティは、SQL プロジェクトの既定のスキーマを設定します。 このプロパティは、1 部構成の名前付きオブジェクトに適用されます。 既定値は dbo です。

T-SQL warnings

SuppressTSqlWarningsプロパティとTreatTSqlWarningsAsErrors プロパティは、プロジェクトのビルド中に T-SQL 警告を処理する方法を制御します。 SuppressTSqlWarnings プロパティは、エラー番号のコンマ区切りリストとして指定された、プロジェクトビルド中の T-SQL 警告を抑制します。

TreatTSqlWarningsAsErrors プロパティは T-SQL 警告をエラーとして扱い、T-SQL 警告がビルドに失敗します。 TreatTSqlWarningsAsErrors の既定値は False です。

プロジェクト プロパティの使用例

次の例は、SQL プロジェクト ファイルで CompatibilityMode、 IsChangeTrackingOn、および TreatTSqlWarningsAsErrors プロパティを設定する方法を示しています。 CompatibilityMode プロパティは 130 に設定され、IsChangeTrackingOn プロパティは True に設定され、TreatTSqlWarningsAsErrors プロパティは True に設定されます。 TreatSqlWarningsAsErrors プロパティは、Release ビルド構成でTrueのみに設定されます。

<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="Build">
  <Sdk Name="Microsoft.Build.Sql" Version="1.0.0-rc1" />
  <PropertyGroup>
    <Name>AdventureWorks</Name>
    <DSP>Microsoft.Data.Tools.Schema.Sql.Sql160DatabaseSchemaProvider</DSP>
    <ModelCollation>1033, CI</ModelCollation>
    <ProjectGuid>{00000000-0000-0000-0000-000000000000}</ProjectGuid>
    <RunSqlCodeAnalysis>true</RunSqlCodeAnalysis>
    <CompatibilityMode>130</CompatibilityMode>
    <IsChangeTrackingOn>True</IsChangeTrackingOn>
  </PropertyGroup>
  <PropertyGroup Condition="'$(Configuration)'=='Release'">
    <TreatTSqlWarningsAsErrors>True</TreatTSqlWarningsAsErrors>
  </PropertyGroup>
</Project>

すべてのプロジェクト プロパティ

一部のプロジェクト プロパティは、SQL Server データベースまたは特定のバージョンの SQL Server にのみ適用されるデータベース オプションに関連付けられています。 プロジェクトにプロジェクト プロパティを含める前に、データベース オプションの関連ドキュメントを確認して、プロパティとデータベースの要件の動作を理解してください。

1. 既定値は、エンジンのエディションとサーバーの設定によって異なります。
2. データベース スコープの構成 オプション。
3. AUTO は 0 の値で設定されます。
4. CREATE DATABASE オプションとしてのみ適用されます。

Related content

• ターゲット プラットフォームの概要
• コード品質を向上させるための SQL コード分析
• SQL プロジェクトのツール
• ALTER DATABASE SET オプション (Transact-SQL)