次の方法で共有

SqlPackage CLI リファレンス

  • [アーティクル]

SqlPackage は、Windows、Linux、および macOS 環境でのデータベースの移植性とデプロイのためのコマンド ライン ユーティリティです。 SqlPackage コマンド ライン インターフェイス (CLI) は、パラメーター、プロパティ、および SQLCMD 変数の各呼び出しを解析します。

SqlPackage {parameters} {properties} {SQLCMD variables}
  • パラメーター は、実行するアクション、ソース データベースとターゲット データベース、およびその他の一般的な設定を指定するために使用されます。
  • プロパティ は、アクションの既定の動作を変更するために使用されます。
  • SQLCMD 変数 は、ソース ファイル内の SQLCMD 変数に値を渡すために使用されます。

SqlPackage コマンドを作成するには、アクションとその追加パラメーターを指定する必要があります。 必要に応じて、プロパティと SQLCMD 変数を追加して、コマンドをさらにカスタマイズすることもできます。

次の例では、SqlPackage を使用して、現在のデータベース スキーマの .dacpac ファイルを作成します。

SqlPackage /Action:Extract /TargetFile:"C:\sqlpackageoutput\output_current_version.dacpac" \
 /SourceServerName:"localhost" /SourceDatabaseName:"Contoso" \
 /p:IgnoreUserLoginMappings=True /p:Storage=Memory

この例では、パラメーターは次のとおりです。

  • /Action:Extract
  • /TargetFile:"C:\sqlpackageoutput\output_current_version.dacpac"
  • /SourceServerName:"localhost"
  • /SourceDatabaseName:"Contoso"

この例では、プロパティは次のとおりです。

  • /p:IgnoreUserLoginMappings=True
  • /p:Storage=Memory

SqlPackage アクション

  • バージョン: SqlPackage アプリケーションのビルド番号を返します。

  • の抽出: 接続された SQL データベースのスキーマまたはスキーマとユーザー データを含むデータ層アプリケーション (.dacpac) ファイルを作成します。

  • 発行: ソース .dacpac ファイルのスキーマと一致するようにデータベース スキーマを増分更新します。 データベースがサーバー上に存在しない場合は、発行操作によってデータベースが作成されます。 それ以外の場合は、既存のデータベースが更新されます。

  • のエクスポート: 接続された SQL データベース (データベース スキーマやユーザー データを含む) を BACPAC ファイル (.bacpac) にエクスポートします。

  • のインポート: BACPAC ファイルから新しいユーザー データベースにスキーマとテーブル のデータをインポートします。

  • DeployReport: 発行アクションが実行する変更を表す XML レポートを作成します。

  • DriftReport: 最後に登録されてからの登録済みデータベースに適用された変更を表す XML レポートを作成します。

  • スクリプト: ソースのスキーマと一致するようにターゲットのスキーマを更新する Transact-SQL 増分更新スクリプトを作成します。

手記

Microsoft Entra ID は Azure Active Directory (Azure AD) の新しい名前ですが、既存の環境の中断を防ぐために、Azure AD は引き続き UI フィールド、接続プロバイダー、エラー コード、コマンドレットなどのハードコーディングされた要素に残ります。 この記事では、2 つの名前を交換可能です。

パラメーター

一部のパラメーターは、SqlPackage アクション間で共有されます。 パラメーターを要約した表を次に示します。詳細については、特定のアクション ページをクリックしてください。

パラメーター 短いフォーム 抽出 発行 エクスポート インポート DeployReport DriftReport スクリプト
/AccessToken: で /を する x x x x x x x
/ClientId の : /cid を する x
/DeployScriptPath: /dsp を する x x
/DeployReportPath: /drp を する x x
/Diagnostics: /d を する x x x x x x x
/DiagnosticsFile: /df を する x x x x x x x
/DiagnosticsPackageFile: /dpf を する x x
/MaxParallelism: /mp を する x x x x x x x
/OutputPath: /op を する x x x
/OverwriteFiles: /of の x x x x x x
/Profile: /pr を する x x x
/Properties: /p を する x x x x x x
/Quiet: /q x x x x x x x
/Secret: /secr を する x
/SourceConnectionString: /scs を する x x x x x
/SourceDatabaseName: /sdn x x x x x
/SourceEncryptConnection: /sec を する x x x x x
/SourceFile: /sf を する x x x x
/SourcePassword: /sp を する x x x x x
/SourceServerName: /ssn を する x x x x x
/SourceTimeout: /st を する x x x x x
/SourceTrustServerCertificate: /stsc の x x x x x
/SourceUser: /su を する x x x x x
/TargetConnectionString: /tcs を する x x x x
/TargetDatabaseName: /tdn を する x x x x x
/TargetEncryptConnection: /tec を する x x x x x
/TargetFile の : /tf を する x x x x
/TargetPassword: /tp を する x x x x x
/TargetServerName: /tsn を する x x x x x
/TargetTimeout: /tt を する x x x x x
/TargetTrustServerCertificate: /ttsc を する x x x x x
/TargetUser: /tu を する x x x x x
/TenantId の : /tid を する x x x x x x x
/UniversalAuthentication: /ua x x x x x x x
/Variables: /v を する x x

プロパティ

SqlPackage アクションでは、アクションの既定の動作を変更するための多数のプロパティがサポートされています。 オプションでプロパティを使用するには、コマンド ラインに /p:PropertyName=Value を追加します。 複数のプロパティを指定でき、一部のプロパティを複数回指定できます (例: /p:TableData=Product /p:TableData=ProductCategory)。 プロパティの詳細については、特定のアクション ページを参照してください。

SQLCMD 変数

SQLCMD 変数は、SQL プロジェクトから .dacpac ファイルに組み込み、SqlPackage Publish または Scriptを使用してデプロイ中に設定できます。 SQL プロジェクトへの SQLCMD 変数の追加の詳細については、SQL プロジェクトのドキュメントを参照してください。

ユーティリティ コマンド

バージョン

sqlpackage バージョンをビルド番号として表示します。 対話型プロンプトや自動パイプライン で使用できます。

SqlPackage /Version

ヘルプ

/? または /help:Trueを使用して、SqlPackage の使用状況情報を表示できます。

SqlPackage /?

特定のアクションに固有のパラメーターとプロパティ情報については、そのアクションのパラメーターに加えてヘルプ パラメーターを使用します。

SqlPackage /Action:Publish /?

終了コード

SqlPackage コマンドは、次の終了コードを返します。

  • 0 = 成功
  • 0 以外 = 失敗

次の手順