sqlcmd ユーティリティ

[アーティクル]
03/03/2023

適用対象:SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics Analytics Platform System (PDW)

Note

SQL Server 2014 以前については、「sqlcmd ユーティリティ」を参照してください。

Linux 上で sqlcmd を使用する場合は、Linux への sqlcmd と bcp のインストールに関する記事を参照してください。

sqlcmd ユーティリティを使用すると、Transact-SQL ステートメントやシステムプロシージャ、スクリプトファイルを使用可能なさまざまなモードで入力できます。

コマンドプロンプト。
クエリエディターでの SQLCMD モード。
Windows スクリプトファイル。
SQL Server エージェントジョブのオペレーティングシステム (Cmd.exe) ジョブステップ。

このユーティリティでは、ODBC を使用して、Transact-SQL バッチを実行します。

sqlcmd のダウンロードとインストール

Windows

Microsoft Command Line Utilities 15 for SQL Server (x64) (2.6 MB) のダウンロード
Microsoft Command Line Utilities 15 for SQL Server (x86) (2.3 MB) のダウンロード

コマンドラインツールは一般提供 (GA) ですが、SQL Server 2019 (15.x) のインストーラーパッケージと共にリリースされています。

バージョン情報

リリース番号:15.0.2
ビルド番号:15.0.2000.5
リリース日: 2020 年 9 月 11 日

新しいバージョンの SQLCMD では、SQL Database、Azure Synapse Analytics、Always Encrypted 機能の Multi-Factor Authentication (MFA) のサポートを含め、Azure AD 認証がサポートされています。新しい BCP では、SQL Database と Azure Synapse Analytics の Multi-Factor Authentication (MFA) のサポートを含め、Azure AD 認証がサポートされています。

システム要件: Windows 11、Windows 10、Windows 7、Windows 8、Windows 8.1、Windows Server 2008 - 2022。

このコンポーネントには、組み込みの Windows インストーラー 5 と Microsoft ODBC Driver 17 for SQL Server の両方が必要です。

Linux/macOS

Linux および macOS に sqlcmd をインストールする手順については、Linux への sqlcmd と bcp のインストールに関する記事を参照してください。

バージョンの確認

SQLCMD のバージョンを確認するには、sqlcmd -? コマンドを実行し、15.0.2000.5 以降のバージョンが使用されていることを確認します。

Note

Always Encrypted (-g) と Azure Active Directory 認証 (-G) を利用するには、バージョン 13.1 以降が必要です。お使いのコンピューターに複数のバージョンの sqlcmd.exe がインストールされている可能性があります。必ず正しいバージョンを使用してください。バージョンを確認するには、sqlcmd -? を実行してください。

プレインストール済み

Azure Cloud Shell

sqlcmd ユーティリティは既定でプレインストールされているため、Azure Cloud Shell から試してみることができます。Cloud Shell の起動

Azure Data Studio

Azure Data Studio で sqlcmd ステートメントを実行するには、エディターのツールバーで [sqlcmd を有効にする] を選択します。

SQL Server Management Studio (SSMS)

SSMS で sqlcmd ステートメントを実行するには、上部のナビゲーションの [クエリ] メニューのドロップダウンリストから SQLCMD モードを選択します。

重要

SQL Server Management Studio (SSMS) では、クエリエディターの標準モードと SQLCMD モードでの実行に Microsoft .NET Framework SqlClient を使用します。コマンドラインから sqlcmd を実行する場合、sqlcmd では ODBC ドライバーが使用されます。同じクエリでも、 SQL Server Management Studio の SQLCMD モードで実行する場合と sqlcmd ユーティリティで実行する場合とでは、適用される既定のオプションが異なるので、動作も異なる可能性があります。

構文

現在、sqlcmd ではコマンドラインオプションと値の間に空白を入れる必要はありません。ただし、将来のリリースでは、コマンドラインオプションと値の間に空白が必要になる可能性があります。

Sqlcmd 構文の詳細と使用方法については、以下を参照してください。

sqlcmd
   -a packet_size
   -A (dedicated administrator connection)
   -b (terminate batch job if there is an error)
   -c batch_terminator
   -C (trust the server certificate)
   -d db_name
   -D
   -e (echo input)
   -E (use trusted connection)
   -f codepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]
   -g (enable column encryption)
   -G (use Azure Active Directory for authentication)
   -h rows_per_header
   -H workstation_name
   -i input_file
   -I (enable quoted identifiers)
   -j (Print raw error messages)
   -k[1 | 2] (remove or replace control characters)
   -K application_intent
   -l login_timeout
   -L[c] (list servers, optional clean output)
   -m error_level
   -M multisubnet_failover
   -N (encrypt connection)
   -o output_file
   -p[1] (print statistics, optional colon format)
   -P password
   -q "cmdline query"
   -Q "cmdline query" (and exit)
   -r[0 | 1] (msgs to stderr)
   -R (use client regional settings)
   -s col_separator
   -S [protocol:]server[instance_name][,port]
   -t query_timeout
   -u (unicode output file)
   -U login_id
   -v var = "value"
   -V error_severity_level
   -w screen_width
   -W (remove trailing spaces)
   -x (disable variable substitution)
   -X[1] (disable commands, startup script, environment variables, optional exit)
   -y variable_length_type_display_width
   -Y fixed_length_type_display_width
   -z new_password
   -Z new_password (and exit)
   -? (usage)

コマンドラインオプション

ログイン関連のオプション

-A
専用管理者接続 (DAC) を使用して SQL Server にサインインします。この種類の接続は、サーバーのトラブルシューティングで使用されます。この接続は、DAC をサポートしているサーバーコンピューターでのみ機能します。 DAC を使用できない場合は、sqlcmd はエラーメッセージを生成して終了します。 DAC の詳細については、「データベース管理者用の診断接続」を参照してください。 -A オプションは -G オプションではサポートされていません。 -A を使用して SQL Database に接続する場合は、SQL Server 管理者である必要があります。 Azure Active Directory 管理者は DAC を使用できません。

-C
クライアントでこのスイッチを使用して、サーバーの証明書を検証せずに暗黙的に信頼するようにクライアントを構成できます。このオプションは、ADO.NET オプションの TRUSTSERVERCERTIFICATE = trueと同等です。

-ddb_name
sqlcmd の開始時に USEdb_name ステートメントを実行します。このオプションにより、 sqlcmd スクリプト変数 SQLCMDDBNAME が設定されます。このパラメーターにより初期データベースが指定されます。既定値は、ログインの既定データベースのプロパティです。データベースが存在しない場合は、エラーメッセージが生成され、sqlcmd は終了します。

-D
-S に指定されたサーバー名を、ホスト名としてではなく、DSN として解釈します。詳細については、「sqlcmd による接続」の「sqlcmd および bcp の DSN サポート」を参照してください。

Note

-D オプションは、Linux および MacOS クライアントでのみ使用できます。これは、Windows クライアントでは以前、廃止済みオプションとされていましたが、これまでに削除され、現在は無視されています。

-llogin_timeout
サーバーに接続を試みたときに、 sqlcmd が ODBC ドライバーにログインするまでのタイムアウトを秒数で指定します。このオプションにより、 sqlcmd スクリプト変数 SQLCMDLOGINTIMEOUT が設定されます。 sqlcmd でのログインに関する既定のタイムアウトは 8 秒です。 -G オプションを使用して、SQL Database または Azure Synapse Analytics に接続し、Azure Active Directory で認証する場合は、タイムアウト値を 30 秒以上にすることをお勧めします。ログインタイムアウトは、0 ～ 65,534 の数値にする必要があります。指定した値が数値以外の場合、またはその範囲外の場合、sqlcmd によりエラーメッセージが生成されます。この値に 0 を指定すると、タイムアウトは無制限になります。

-E
ユーザー名とパスワードを使用せずにセキュリティ接続を使用して SQL Server にサインインします。既定では、 -E を指定しないと、 sqlcmd ではセキュリティ接続オプションが使用されます。

-E オプションを使用すると、SQLCMDPASSWORD などのユーザー名とパスワード用に使用できる環境変数の設定が無視されます。 -E オプションが -U オプションまたは -P オプションと共に使用されると、エラーメッセージが生成されます。

-g
列の暗号化設定を Enabledに設定します。詳細については、「 Always Encrypted」を参照してください。 Windows 証明書ストアに格納されているマスターキーのみがサポートされます。 -g スイッチには、 sqlcmd バージョン 13.1以上が必要です。バージョンを判断するには、 sqlcmd -?を実行します。

-G
このスイッチは、SQL Database または Azure Synapse Analytics に接続し、Azure Active Directory 認証を使用してユーザーを認証するように指定する場合に、クライアントによって使用されます。このオプションにより、 sqlcmd スクリプト変数 SQLCMDUSEAAD = true が設定されます。 -G スイッチには、 sqlcmd バージョン 13.1以上が必要です。バージョンを判断するには、 sqlcmd -?を実行します。詳細については、Azure Active Directory 認証を使用した SQL Database または Azure Synapse Analytics への接続に関する記事を参照してください。 -A オプションは -G オプションではサポートされていません。

重要

-G オプションは、Azure SQL Database と Azure Synapse Analytics にのみ適用されます。現在、Azure AD 対話型認証は、Linux または macOS 上でサポートされていません。 Azure AD 統合認証には、Microsoft ODBC Driver 17 for SQL Server バージョン 17.6.1 以降と、適切に構成された Kerberos 環境が必要です。

Azure Active Directory のユーザー名とパスワード:

Azure Active Directory のユーザー名とパスワードを使用には、 -G オプションを指定します。ユーザー名とパスワードは、 -U オプションと -P オプションを指定する方法でも使用できます。
```
Sqlcmd -S testsrv.database.windows.net -d Target_DB_or_DW -U bob@contoso.com -P MyAADPassword -G
```
-G パラメーターにより、バックエンドで次の接続文字列が生成されます。
```
  SERVER = Target_DB_or_DW.testsrv.database.windows.net;UID= bob@contoso.com;PWD=MyAADPassword;AUTHENTICATION = ActiveDirectoryPassword
```
Azure Active Directory 統合

Azure Active Directory 統合認証の場合、ユーザー名とパスワードなしで -G オプションを指定します。 AAD 統合認証には、Microsoft ODBC Driver 17 for SQL Server バージョン 17.6.1 以降と、適切に構成された Kerberos 環境が必要です。

Sqlcmd -S Target_DB_or_DW.testsrv.database.windows.net -G

これにより、バックエンドで次の接続文字列が生成されます。

SERVER = Target_DB_or_DW.testsrv.database.windows.net Authentication = ActiveDirectoryIntegrated; Trusted_Connection=NO

Note

-E オプション (Trusted_Connection) と -G オプションを共に使用することはできません。

Azure Active Directory 対話型

Azure SQL Database と Azure Synapse Analytics の Azure AD 対話型認証では、多要素認証をサポートする対話的な方法を使用できます。詳細については、「Azure Active Directory 対話型認証」を参照してください。

Azure AD 対話型には、sqlcmdバージョン 15.0.1000.34 以降と ODBC バージョン 17.2 以降が必要です。

対話型認証を有効にするには、-G オプションにパスワードを指定せず、ユーザー名 (-U) のみを指定します。

次の例では、Azure AD 対話型モードを使い、ユーザー名 (ユーザーは Azure AD アカウントを表します) を指定してデータをエクスポートします。これは、前のセクション、「Azure Active Directory のユーザー名とパスワード」で使用したのと同じ例です。

対話モードでは、パスワードを手動で入力する必要があります。また、多要素認証が有効なアカウントの場合は、構成された MFA 認証方法を完了します。
```
sqlcmd -S testsrv.database.windows.net -d Target_DB_or_DW -G -U alice@aadtest.onmicrosoft.com
```
上記のコマンドにより、バックエンドで次の接続文字列が生成されます。
```
SERVER = Target_DB_or_DW.testsrv.database.windows.net;UID=alice@aadtest.onmicrosoft.com; AUTHENTICATION = ActiveDirectoryInteractive
```
Azure AD ユーザーが Windows アカウントを使用するドメインフェデレーションユーザーの場合、コマンドラインで必要なユーザー名には (たとえば、以下の joe@contoso.com のように) そのドメインアカウントが含まれます。
```
sqlcmd -S testsrv.database.windows.net -d Target_DB_or_DW -G -U joe@contoso.com
```
ゲストユーザーが特定の Azure AD に存在し、SQL Database に存在するグループに属し、そのグループが sqlcmd コマンドを実行するデータベースアクセス許可を持つ場合、ゲストユーザーの別名が使用されます (たとえば、 keith0@adventureworks.com )。

重要

SQLCMD で -G および -U オプションを使用する場合、既知の問題として、-G オプションの前に -U オプションを指定すると、認証が失敗する可能性があります。常に -G オプションから始め、-U オプションがその後になるようにします。

-Hworkstation_name
ワークステーション名です。このオプションにより、 sqlcmd スクリプト変数 SQLCMDWORKSTATION が設定されます。ワークステーション名は sys.sysprocesses カタログビューの sys.sysprocesses 列に一覧表示され、ストアドプロシージャ sp_whoを使用して取得できます。このオプションが指定されていない場合の既定値は、現在のコンピューター名になります。この名前は、異なる

sqlcmd セッションを識別する場合に使用できます。

-j 画面に生のエラーメッセージを出力します。

-Kapplication_intent
アプリケーションがサーバーに接続するときのワークロードのタイプを宣言します。現在サポートされている値は、 ReadOnlyだけです。 -K を指定しない場合、sqlcmd ユーティリティでは Always On 可用性グループのセカンダリレプリカへの接続がサポートされません。詳細については、「アクティブなセカンダリ:読み取り可能なセカンダリレプリカ (AlwaysOn 可用性グループ)

-Mmultisubnet_failover
SQL Server 可用性グループまたは SQL Server フェールオーバークラスターインスタンスの可用性グループリスナーに接続する際には、必ず -M を指定してください。 -M を指定すると、(現在) アクティブなサーバーを迅速に検出して接続できます。 -M を指定しない場合、 -M はオフになります。詳細については、「リスナー、クライアント接続、アプリケーションのフェールオーバー」、「可用性グループの作成と構成 (SQL Server)」、「フェールオーバークラスタリングと Always On 可用性グループ (SQL Server)」、「アクティブなセカンダリ: 読み取り可能なセカンダリレプリカ (Always On 可用性グループ)」をご覧ください。

-N
クライアントでこのスイッチを使用して、暗号化された接続を要求できます。

-Ppassword
ユーザーが指定するパスワードです。パスワードでは大文字と小文字が区別されます。 -U オプションを使って -P オプションを使わず、SQLCMDPASSWORD 環境変数が設定されていない場合は、sqlcmd はユーザーにパスワードを要求します。 null パスワードは使わないことをお勧めしますが、パラメーター値に連続する二重引用符のペアを使って、null パスワードを指定できます。

重要

-P の使用は安全でないと見なす必要があります。コマンドラインでパスワードを指定しないようにしてください。または、SQLCMDPASSWORD 環境変数を使用するか、-P オプションを省略してパスワードを対話的に入力します。

強力なパスワードを使用することをお勧めします。

パスワードプロンプトは、次のようにパスワードプロンプトをコンソールに出力することによって表示されます。 Password:

ユーザーが行った入力は表示されません。つまり、入力時には何も表示されず、カーソルが移動しません。

SQLCMDPASSWORD 環境変数を使用して、現在のセッションに既定のパスワードを設定できます。したがって、パスワードをバッチファイルにハードコードする必要はありません。

次の例では、まずコマンドプロンプトで SQLCMDPASSWORD 変数を設定してから sqlcmd ユーティリティにアクセスします。コマンドプロンプトに、次のコマンドを入力します。

SET SQLCMDPASSWORD= p@a$$w0rd
次のコマンドプロンプトが表示されたら、次のように入力します:

sqlcmd

ユーザー名とパスワードの組み合わせが正しくない場合は、エラーメッセージが生成されます。

注意

OSQLPASSWORD 環境変数は旧バージョンとの互換性が維持されました。 SQLCMDPASSWORD 環境変数は OSQLPASSWORD 環境変数よりも優先されます。 OSQLPASSWORD が共有されなくなったため、sqlcmd ユーティリティと osql ユーティリティを競合することなく組み合わせて使用できます。以前のスクリプトは引き続き機能します。

-P オプションが -E オプションと共に使用されると、エラーメッセージが生成されます。

-P オプションの後に複数の引数があると、エラーメッセージが生成され、プログラムが終了します。

-S [protocol:]server[\instance_name][,port]
接続先となる SQL Server のインスタンスを指定します。このオプションにより、 sqlcmd スクリプト変数 SQLCMDSERVER が設定されます。

そのサーバーコンピューター上の SQL Server の既定のインスタンスに接続するには、server_name を指定します。そのサーバーコンピューター上の SQL Server の名前付きインスタンスに接続するには、server_name [ \instance_name ] を指定します。サーバーコンピューターを指定しない場合、sqlcmd は、ローカルコンピューター上にある SQL Server の既定のインスタンスに接続します。ネットワーク上のリモートコンピューターから sqlcmd を実行するときは、このオプションが必要です。

protocol には、 tcp (TCP/IP)、 lpc (共有メモリ)、または np (名前付きパイプ) を指定できます。

sqlcmd を実行するときに server_name [ \instance_name ] を指定しなかった場合は、SQL Server により SQLCMDSERVER 環境変数がチェックされ、その値が使われます。

Note

OSQLSERVER 環境変数は旧バージョンとの互換性を維持しています。 SQLCMDSERVER 環境変数は OSQLSERVER 環境変数よりも優先されます。これにより、 sqlcmd と osql を競合することなく組み合わせて使用でき、従来のスクリプトは引き続き機能を実行することができます。

ｰUlogin_id
ログイン名または包含データベースのユーザー名です。包含データベースのユーザーの場合、データベース名のオプション (-d) を指定する必要があります。

Note

OSQLUSER 環境変数は旧バージョンとの互換性を維持しています。 SQLCMDUSER 環境変数は OSQLUSER 環境変数よりも優先されます。これにより、 sqlcmd と osql を競合することなく組み合わせて使用できます。また、既存の osql スクリプトは引き続き実行することができます。

-U オプションも -P オプションも指定しないと、sqlcmd は Microsoft Windows 認証モードを使用して接続を試みます。認証は sqlcmdを実行しているユーザーの Windows アカウントに基づきます。

-U オプションが -E オプション (この記事の後半で説明) と同時に使用されると、エラーメッセージが生成されます。 -U オプションの後に複数の引数があると、エラーメッセージが生成され、プログラムが終了します。

-znew_password
パスワードの変更:

sqlcmd -U someuser -P s0mep@ssword -z a_new_p@a$$w0rd

-Znew_password

パスワードの変更と終了:

sqlcmd -U someuser -P s0mep@ssword -Z a_new_p@a$$w0rd

入力または出力のオプション
-fcodepage | i:codepage[,o:codepage] | o:codepage[,i:codepage]

入力と出力のコードページを指定します。コードページ番号は、インストールされた Windows コードページを指定する数値です。

コードページには次の変換規則があります。

コードページを指定しないと、入力ファイルが変換不要の Unicode ファイルでない限り、 sqlcmd では、入力ファイルと出力ファイルの両方に現在のコードページが使用されます。
sqlcmd では、ビッグエンディアンとリトルエンディアンの両方の Unicode 入力ファイルが自動的に認識されます。 -u オプションを指定すると、出力は常にリトルエンディアン Unicode になります。
出力ファイルを指定しないと、出力コードページはコンソールのコードページになります。この方法では、コンソールに出力が正しく表示されます。
複数の入力ファイルの場合、同じコードページが指定されているものと見なされます。 Unicode 入力ファイルと Unicode 以外の入力ファイルを混在させることができます。

Cmd.exe のコードページを確認するには、コマンドプロンプトに「 chcp 」と入力します。

-iinput_file[」、「input_file2...]
SQL ステートメントまたはストアドプロシージャのバッチを含むファイルを指定します。複数のファイルを指定すると、それらのファイルは順番に読み取られて処理されます。ファイル名とファイル名の間には空白を使わないでください。 sqlcmd により、最初に、指定したすべてのファイルが存在しているかどうかがチェックされます。 1 つ以上のファイルが存在していない場合は、sqlcmd は終了します。 -i と -Q/-q オプションは同時に使用できません。

パスの例:

-i C:\<filename>
-i \\<Server>\<Share$>\<filename>
-i "C:\Some Folder\<file name>"

空白を含むファイルパスは、引用符で囲む必要があります。

このオプションは -iinput_file-II input_fileのように複数使用できます。

-ooutput_file
sqlcmdからの出力を受信するファイルを指定します。

-u が指定されている場合は、 output_file は Unicode 形式で格納されます。ファイル名が無効な場合は、エラーメッセージが生成され、sqlcmd が終了します。 sqlcmd は、同じファイルに対する複数の sqlcmd プロセスの同時書き込みはサポートしていません。出力ファイルが破損するか、または不適切なファイルになる可能性があります。 -f スイッチもファイル形式に関連します。このファイルが存在しない場合は作成されます。以前の sqlcmd セッションで同じ名前のファイルが作成されていた場合は、上書きされます。ここで指定するファイルは stdout ファイルではありません。 stdout ファイルを指定すると、このファイルは使われません。

パスの例:

-o C:< filename>
-o \\<Server>\<Share$>\<filename>
-o "C:\Some Folder\<file name>"

空白を含むファイルパスは、引用符で囲む必要があります。

-r[0 | 1]
エラーメッセージ出力を画面にリダイレクトします (stderr)。パラメーターを指定しない場合や、0を指定した場合は、重大度レベル 11 以上のエラーメッセージだけがリダイレクトされます。 1を指定した場合は、PRINT を含むすべてのエラーメッセージ出力がリダイレクトされます。 -o を使用しても効果はありません。既定では、メッセージは stdoutに送られます。

-R
sqlcmd により、クライアントのロケールに基づいて SQL Server から取得された数値、通貨、日付、および時刻の各列がローカライズされます。既定では、これらの列はサーバーの地域別設定を使用して表示されます。

-u
input_file の形式に関係なく、 output_fileを Unicode 形式で格納するように指定します。

クエリ実行オプション
-e
入力スクリプトを標準出力デバイス (stdout) に書き込みます。

-I
SET QUOTED_IDENTIFIER 接続オプションを ON に設定します。既定では、[オフ] に設定されています。詳細については、「SET QUOTED_IDENTIFIER (Transact-SQL)」をご覧ください。

-q "cmdline query"
sqlcmd の起動時にクエリを実行しますが、クエリの実行が完了しても sqlcmd は終了しません。セミコロンで区切られた複数のクエリを実行できます。次の例で示すように、クエリを引用符で囲みます。

コマンドプロンプトに、次のコマンドを入力します。

sqlcmd -d AdventureWorks2012 -q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"

sqlcmd -d AdventureWorks2012 -q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

重要

クエリでは GO ターミネータを使用しないでください。

このオプションと共に -b を指定すると、 sqlcmd はエラーで終了します。 -b オプションについては、この記事の後半で説明します。

-Q "cmdline query"
sqlcmd の起動時にクエリを実行し、 sqlcmdを即時終了します。セミコロンで区切られた複数のクエリを実行できます。

次の例で示すように、クエリを引用符で囲みます。

コマンドプロンプトに、次のコマンドを入力します。

sqlcmd -d AdventureWorks2012 -Q "SELECT FirstName, LastName FROM Person.Person WHERE LastName LIKE 'Whi%';"

sqlcmd -d AdventureWorks2012 -Q "SELECT TOP 5 FirstName FROM Person.Person;SELECT TOP 5 LastName FROM Person.Person;"

重要

クエリでは GO ターミネータを使用しないでください。

このオプションと共に -b を指定すると、 sqlcmd はエラーで終了します。 -b オプションについては、この記事の後半で説明します。

-tquery_timeout
コマンド (または SQL ステートメント) の実行待ち時間を秒単位で指定します。このオプションにより、 sqlcmd スクリプト変数 SQLCMDSTATTIMEOUT が設定されます。 time_out 値を指定しないと、コマンドはタイムアウトしません。querytime_out は、1 から 65,534 の数値にする必要があります。指定した値が数値以外の場合、または範囲外の場合、 sqlcmd はエラーメッセージを生成します。

Note

実際のタイムアウト値は、指定した time_out 値より数秒異なる場合があります。

-v var =value[ var =value...]
sqlcmdスクリプトで使用できる sqlcmd スクリプト変数を作成します。値に空白が含まれる場合は、値を引用符で囲みます。複数の var="values" の値を指定できます。指定した値にエラーが生じた場合は、 sqlcmd は、エラーメッセージを生成してから終了します。

sqlcmd -v MyVar1=something MyVar2="some thing"

sqlcmd -v MyVar1=something -v MyVar2="some thing"

-x
sqlcmd ではスクリプト変数が無視されます。このパラメーターは、標準変数と同じ形式の文字列 ($(variable_name) など) を含む INSERT ステートメントが、スクリプトに多数含まれている場合に便利です。

書式設定のオプション
-hheaders
列ヘッダーの間に出力する行数を指定します。既定では、各クエリの結果に対して、ヘッダーは 1 つだけ表示されます。このオプションにより、 sqlcmd スクリプト変数 SQLCMDHEADERS が設定されます。ヘッダーを出力しない場合は、 -1 を指定します。有効でない値があると、 sqlcmd はエラーメッセージを生成してから終了します。

-k [1 | 2]
タブ、改行文字などのすべての制御文字を出力から削除します。このパラメーターにより、データが返されたときの列の形式が維持されます。 1 を指定した場合、制御文字は 1 つの空白に置き換えられます。 2 を指定すると、連続する制御文字が 1 つの空白に置き換えられます。 -k は -k1と同じです。

-scol_separator
列の区切り文字を指定します。既定では、空白になっています。このオプションにより、 sqlcmd スクリプト変数 SQLCMDCOLSEP が設定されます。アンパサンド (&)、セミコロン (;) など、オペレーティングシステムで特別な意味を持つ文字を使用する場合は、その文字を引用符 (") で囲みます。列の区切り文字には、任意の 8 ビットの文字を指定できます。

-wscreen_width
出力用の画面幅を指定します。このオプションにより、 sqlcmd スクリプト変数 SQLCMDCOLWIDTH が設定されます。列幅は 8 よりも大きくかつ 65,536 よりも小さい値にする必要があります。指定した列幅が範囲外の場合、 sqlcmd はエラーメッセージを生成します。既定の幅は 80 文字です。指定した列幅を超えると、出力行は次の列に折り返されます。

-W
このオプションは、列から後続の空白を削除します。他のアプリケーションにエクスポートするデータを準備するときは、 -s オプションと同時にこのオプションを使用します。 -y または -Y オプションと共には使用できません。

-yvariable_length_type_display_width
sqlcmd スクリプト変数 SQLCMDMAXVARTYPEWIDTHを設定します。既定値は 256 です。長い可変長のデータ型に返される文字数を制限します。

varchar(max)
nvarchar(max)
varbinary(max)
xml
UDT (ユーザー定義のデータ型)
text
ntext
image

Note

UDT は実装によって固定長にもなります。固定長の UDT の長さが display_widthよりも短い場合は、返される UDT の値は影響を受けません。ただし、 display_widthよりも長い場合は、出力は切り捨てられます。

重要

返されるデータのサイズによって、サーバーとネットワークの両方に重大なパフォーマンスの問題が発生する可能性があるため、 -y 0 オプションは十分注意して使用してください。

-Yfixed_length_type_display_width
sqlcmd スクリプト変数 SQLCMDMAXFIXEDTYPEWIDTHを設定します。既定値は 0 (無制限) です。次のデータ型に返される文字数を制限します。

char(n)、ただし 1 <= n <= 8000
nchar(n)、ただし 1 <= n<= 4000
varchar(n)、ただし 1 <= n<= 8000
nvarchar(n)、ただし 1 <= n<= 4000
varbinary(n)、ただし 1 <= n<= 4000
sql_variant

エラー報告のオプション
-b
エラーが発生したときに、 sqlcmd を終了し、DOS ERRORLEVEL 値を返します。 SQL Server のエラーメッセージの重大度が 10 よりも高い場合、DOS ERRORLEVEL 変数に返される値は 1 です。それ以外の場合は、0 が返されます。 -V オプションが -bと共に設定されている場合、 -V . を使用して設定した値よりも重大度が低いときは、 sqlcmdはエラーを報告しません。コマンドプロンプトバッチファイルにより ERRORLEVEL の値をテストすることができ、エラーを適切に処理できます。 sqlcmd は重大度レベル 10 (情報メッセージ) に対してはエラーを報告しません。

sqlcmd スクリプトに正しくないコメントや構文エラーが含まれている場合やスクリプト変数が不足している場合、返される ERRORLEVEL は 1 です。

-merror_level
stdoutに送信されるエラーメッセージを制御します。重大度レベルがこのレベル以上のメッセージが送信されます。この値を -1に設定すると、情報メッセージを含めすべてのメッセージが送信されます。 -m と -1の間にスペースは使用できません。たとえば、-m-1 は有効で、-m-1 は有効でありません。

このオプションにより、 sqlcmd スクリプト変数 SQLCMDERRORLEVEL も設定されます。この変数の既定値は 0 です。

-Verror_severity_level
ERRORLEVEL 変数を設定するために使用される重大度レベルを制御します。重大度レベルがこの値以上のエラーメッセージによって、ERRORLEVEL が設定されます。 0 より小さい値は 0 と報告されます。バッチファイルおよび CMD ファイルを使用して、ERRORLEVEL 変数の値をテストできます。

その他のオプション
-apacket_size
異なるサイズのパケットを要求します。このオプションにより、 sqlcmd スクリプト変数 SQLCMDPACKETSIZE が設定されます。 packet_size には、512 ～ 32767 の値を指定する必要があります。既定値は 4096 です。大きなパケットサイズを指定すると、GO コマンド間に多数の SQL ステートメントが含まれているスクリプトの実行パフォーマンスが向上します。既定値よりも大きいパケットサイズを要求できます。ただし、要求が拒否された場合、 sqlcmd はサーバーの既定のパケットサイズを使用します。

-cbatch_terminator
バッチターミネータを指定します。既定では、"GO" だけが入力されている行があると、コマンドが終了したと見なされ、SQL Server に送られます。バッチターミネータをリセットする場合、Transact-SQL の予約キーワードやオペレーティングシステムで特別な意味を持つ文字は、先頭に円記号が付いているかどうかに関係なく、使わないでください。

-L[c]
ローカルに構成されたサーバーコンピューターと、ネットワーク上でブロードキャストしているサーバーコンピューター名の一覧を表示します。このパラメーターは、他のパラメーターと組み合わせて使うことはできません。一覧表示できるサーバーコンピューターの最大数は 3,000 です。バッファーのサイズが原因でサーバーの一覧が切り捨てられる場合は、警告メッセージが表示されます。

Note

ネットワーク上のブロードキャストの特性によっては、 sqlcmd は、一部のサーバーからタイムリーな応答を受信できない場合があります。そのため、返されるサーバーのリストは、このオプションの実行ごとに異なる可能性があります。

省略可能なパラメーター c を指定すると、出力結果には Servers: ヘッダー行が含まれません。このため、各サーバー行は、先頭に空白がない状態で一覧表示されます。この表示はクリーンアウトプットと呼ばれます。クリーンアウトプットを使用すると、スクリプト言語の処理パフォーマンスが向上します。

-p[1]
すべての結果セットのパフォーマンス統計を出力します。パフォーマンス統計の形式の例を次に示します。

Network packet size (bytes): n

x xact[s]:

Clock Time (ms.): total t1 avg t2 (t3 xacts per sec.)

各値の説明:

x = SQL Server によって処理されるトランザクション数。

t1 = すべてのトランザクションにかかる合計時間、

t2 = 単一のトランザクションにかかる平均時間。

t3 = 1 秒あたりの平均トランザクション数。

すべての時間はミリ秒単位です。

省略可能なパラメーター 1 を指定した場合は、統計の出力形式は、スプレッドシートへ容易にインポートできる、またはスクリプトによって処理できる、コロンで区切られた形式となります。

省略可能なパラメーターが 1以外の値の場合は、エラーが生成され、 sqlcmd は終了します。

-X[1]
sqlcmd がバッチファイルから実行される場合に、システムのセキュリティを損なう可能性のあるコマンドを無効にします。無効なコマンドも認識されます。 sqlcmd は警告メッセージを表示して継続します。省略可能なパラメーターを 1 に指定すると、 sqlcmd はエラーメッセージを生成して終了します。 -X オプションを使用した場合に無効になるコマンドは次のとおりです。

ED
!!コマンド

-X オプションを指定すると、環境変数が sqlcmdに渡されなくなります。また、SQLCMDINI スクリプト変数を使用して指定した、スタートアップスクリプトも実行できなくなります。 sqlcmd スクリプト変数の詳細については、「 sqlcmd でのスクリプト変数の使用」を参照してください。

-?
sqlcmd のバージョンと sqlcmd オプションの構文の概要を表示します。

解説

オプションは、構文の例に示されている順序に従って使う必要はありません。

複数の結果が返される場合は、 sqlcmd は同じバッチの各結果セットの間に空白行を 1 行ずつ出力します。また、<x> rows affected というメッセージは、そのメッセージが実行したステートメントに該当する場合にだけ表示されます。

sqlcmd を対話的に使用するには、コマンドプロンプトで、sqlcmd を、この記事で前に説明した各オプションと共に入力します。詳細については、「 sqlcmd ユーティリティの使用」を参照してください。

Note

-L、 -Q、 -Z 、または -i のオプションを使用すると、 sqlcmd は実行後に終了します。

コマンド環境 (Cmd.exe) での sqlcmd コマンドライン全体の長さは、すべての引数と拡張変数を含めて、オペレーティングシステムが Cmd.exe のために決めます。

変数の優先順位 (低から高)

システムレベル環境変数
ユーザーレベル環境変数
sqlcmd の実行前にコマンドプロンプトで行ったコマンドシェル ( SETX=Y) の設定
sqlcmd-v X=Y
:Setvar X Y

Note

環境変数を表示するには、[コントロールパネル] の [システム] アイコンを開き、[詳細設定] タブを選びます。

sqlcmd スクリプト変数

変数	関連スイッチ	R/W	Default
SQLCMDUSER	-U	R	""
SQLCMDPASSWORD	-P	--	""
SQLCMDSERVER	-S	R	"DefaultLocalInstance"
SQLCMDWORKSTATION	-H	R	"ComputerName"
SQLCMDDBNAME	-d	R	""
SQLCMDLOGINTIMEOUT	-l	R/W	"8" (秒)
SQLCMDSTATTIMEOUT	-t	R/W	"0" = 無制限に待機
SQLCMDHEADERS	-H	R/W	"0"
SQLCMDCOLSEP	-S	R/W	" "
SQLCMDCOLWIDTH	-w	R/W	"0"
SQLCMDPACKETSIZE	-a	R	"4096"
SQLCMDERRORLEVEL	-M	R/W	0
SQLCMDMAXVARTYPEWIDTH	-y	R/W	"256"
SQLCMDMAXFIXEDTYPEWIDTH	-y	R/W	"0" = 無制限
SQLCMDEDITOR		R/W	"edit.com"
SQLCMDINI		R	""
SQLCMDUSEAAD	-G	R/W	""

SQLCMDUSER、SQLCMDPASSWORD、および SQLCMDSERVER は、 :Connect が使用されるときに設定されます。

R は、その値がプログラムの初期化時に一度だけ設定できることを示します。

R/W は、 setvar コマンドを使用して値を変更できること、および後続のコマンドに新しい値が反映されることを示します。

sqlcmd コマンド

sqlcmd では、Transact-SQL ステートメントの他に次のコマンドも使用できます。

GO [count]

:List

[:]RESET

:Error

[:]ED

:Out

[:] !!

:Perftrace

[:]QUIT

:Connect

[:]EXIT

:On Error

:Help

:ServerList

:XML [ON | OFF]

:Setvar

:Listvar

sqlcmd コマンドを使用するときは、次の点に注意してください。

GO を除くすべての sqlcmd コマンドは、コロン (:) によってプレフィックス指定する必要があります。

重要

既存の osql スクリプトとの互換性を保つために、一部のコマンドはコロンなしで認識され、 [:] によって示されます。
sqlcmd コマンドが認識されるのは、コマンドが行の先頭にある場合のみです。
すべての sqlcmd コマンドには、大文字と小文字の区別はありません。
各コマンドは個別の行に指定する必要があります。コマンドの後には、Transact-SQL ステートメントや別のコマンドを指定できません。
コマンドは即座に実行されます。 Transact-SQL ステートメントのように、実行バッファーに配置されません。

編集コマンド
[:]ED
テキストエディターを開始します。このエディターは、現在の Transact-SQL バッチまたは最後に実行したバッチを編集する場合に使用できます。最後に実行したバッチを編集するには、最後のバッチの実行が完了した直後に ED コマンドを入力する必要があります。

テキストエディターは、SQLCMDEDITOR 環境変数で定義したエディターです。既定のエディターは "Edit" です。エディターを変更するには、SQLCMDEDITOR 環境変数を設定します。たとえば、エディターを Microsoft メモ帳に設定するには、コマンドプロンプトで次のように入力します。

SET SQLCMDEDITOR=notepad

[:]RESET
ステートメントキャッシュをクリアします。

:List
ステートメントキャッシュの内容を出力します。

変数
:Setvar<var> [ "value" ]
sqlcmd スクリプト変数を定義します。スクリプト変数は $(VARNAME)という形式になります。

変数名では大文字と小文字が区別されません。

スクリプト変数は次の方法で指定できます。

コマンドラインのオプションを暗黙的に使用します。たとえば、 -l オプションでは SQLCMDLOGINTIMEOUT という sqlcmd 変数が設定されます。
:Setvar コマンドを明示的に使用します。
sqlcmdの実行前に環境変数を定義します。

Note

-X オプションを使用すると、環境変数が sqlcmdに渡されなくなります。

:Setvar を使って定義した変数と環境変数が同じ名前の場合は、 :Setvar を使用して定義した変数が優先されます。

変数名には空白文字を含めることはできません。

また変数名には、$(var) のような変数表現と同じ形式を使うことはできません。

スクリプト変数の文字列値に空白文字が含まれる場合は、値を引用符で囲みます。スクリプト変数の値を設定していない場合は、そのスクリプト変数は削除されます。

:Listvar
現在設定されているスクリプト変数の一覧を表示します。

Note

sqlcmdによって設定されたスクリプト変数および :Setvar コマンドを使用して設定されたスクリプト変数のみが表示されます。

出力コマンド
:Error
<filename>| STDERR|STDOUT
すべてのエラー出力を、 file nameによって指定されたファイル、または stderr や stdoutにリダイレクトします。 Error コマンドは、スクリプト内で複数回使用できます。既定では、エラー出力は stderrに送られます。

ファイル名
出力を受信するファイルを作成して開きます。ファイルが既に存在している場合は、ファイルは 0 バイトに切り詰められます。権限またはその他の理由でファイルが使用できない場合は、出力は切り替えられず、最後に指定した出力先または既定の出力先に送信されます。

STDERR
エラー出力を stderr ストリームに切り替えます。ストリームがリダイレクトされている場合は、ストリームがリダイレクトされた対象がエラー出力を受信します。

STDOUT
エラー出力を stdout ストリームに切り替えます。ストリームがリダイレクトされている場合は、ストリームがリダイレクトされた対象がエラー出力を受信します。

:Out <filename>| STDERR| STDOUT
すべてのクエリ結果を、 file nameによって指定されたファイル、または stderr や stdoutに作成してリダイレクトします。既定では、出力は stdoutに送られます。ファイルが既に存在している場合は、ファイルは 0 バイトに切り詰められます。 Out コマンドは、スクリプト内で複数回使用できます。

:Perftrace <filename>| STDERR| STDOUT
すべてのパフォーマンストレース情報を、 file nameによって指定されたファイル、または stderr や stdoutに作成してリダイレクトします。既定では、パフォーマンストレース出力は stdoutに送られます。ファイルが既に存在している場合は、ファイルは 0 バイトに切り詰められます。 Perftrace コマンドは、スクリプト内で複数回使用できます。

実行制御コマンド
:On Error[ exit | ignore]
スクリプト実行中またはバッチ実行中のエラー発生時に対応するアクションを設定します。

exit オプションを使用した場合、 sqlcmd は該当するエラー値を表示して終了します。

ignore オプションを使用すると、 sqlcmd はエラーを無視し、バッチまたはスクリプトの実行を続行します。既定では、エラーメッセージが出力されます。

[:]QUIT
sqlcmd が終了します。

[:]EXIT[ (statement) ]
sqlcmdからの戻り値に、SELECT ステートメントの結果を使用できます。数値の場合、結果行の最終行の第 1 列は、4 バイトの (長) 整数に変換されます。 MS-DOS、Linux、および Mac は、下位バイトを親プロセスやオペレーティングシステムのエラーレベルに渡します。 Windows 200x では、4 バイトの整数全体を渡します。の構文は次のとおりです。

:EXIT(query)

次に例を示します。

:EXIT(SELECT @@ROWCOUNT)

バッチファイルの一部として、 EXIT パラメーターを使用することもできます。たとえば、コマンドプロンプトで次のように入力します。

sqlcmd -Q "EXIT(SELECT COUNT(*) FROM '%1')"

sqlcmd ユーティリティにより、かっこ () 内のすべての情報がサーバーに送信されます。システムストアドプロシージャで 1 つの値セットを選択し、値を返すように指定した場合、返されるのは選択した値のみです。かっこ内に何も指定せずに EXIT**()** ステートメントを指定すると、バッチ内のそのステートメントより前にあるものすべてを実行し、戻り値を返さずに終了します。

不適切なクエリを指定すると、 sqlcmd は戻り値を返さずに終了します。

EXIT の形式を次に示します。

:EXIT

バッチを実行せずに直ちに終了し、値を返しません。

:EXIT ( )

バッチを実行してから終了し、値を返しません。

:EXIT (query)

クエリを含むバッチを実行し、クエリの結果を返して終了します。

RAISERROR を sqlcmd スクリプトの中で使用し、状態 127 が発生すると、 sqlcmd は終了し、メッセージ ID をクライアントに返します。次に例を示します。

RAISERROR(50001, 10, 127)

このエラーが発生すると、 sqlcmd スクリプトは終了し、メッセージ ID 50001 がクライアントに返されます。

戻り値 -1 から -99 は SQL Server によって予約済みです。また、sqlcmd では次のような追加の戻り値を定義しています。

戻り値	説明
-100	戻り値を選択する前に、エラーが発生した。
-101	戻り値を選択するときに、行が見つからなかった。
-102	戻り値を選択するときに、変換エラーが発生した。

GO [count]
GO は、バッチの終わりとキャッシュされた Transact-SQL ステートメントの実行を知らせます。バッチは、個別のバッチとして複数回実行されます。 1 回のバッチで変数を複数回宣言することはできません。

その他のコマンド
:r <filename>
<filename> によって指定されたファイルを基に、追加の Transact-SQL ステートメントと sqlcmd コマンドを解析し、ステートメントキャッシュ内に登録します。

GO が最後に記述されていない Transact-SQL ステートメントがファイルに含まれている場合は、その行の :r の後に GO を入力する必要があります。

Note

<filename> は、sqlcmd が実行されたスタートアップディレクトリを基準にして読み取られます。

ファイルは、バッチターミネータが検出された後に読み取られ、実行されます。 :r コマンドは複数発行できます。ファイルには、どのような sqlcmd コマンドでも含めることができます。これには、バッチターミネータの GOも含まれます。

Note

対話モードで表示される行数は、:r コマンドが検出されるたびに、1 行ずつ増えます。 :r コマンドは、リストコマンドの出力に表示されます。

:Serverlist
ローカルに構成されたサーバーと、ネットワーク上でブロードキャストしているサーバー名の一覧を表示します。

:Connectserver_name[\instance_name] [-l timeout] [-U user_name [-P password]]
SQL Server のインスタンスに接続します。また、現在の接続を終了します。

タイムアウトオプション :

値	動作
0	待機状態を維持
n>0	n 秒間待機

SQLCMDSERVER スクリプト変数により、現在のアクティブな接続が反映されます。

timeout を指定しないと、SQLCMDLOGINTIMEOUT 変数の値が既定値になります。

user_name のみを指定した場合 (オプションとして指定した場合も、環境変数として指定した場合も)、ユーザーはパスワードの入力を要求されます。 SQLCMDUSER 環境変数または SQLCMDPASSWORD 環境変数が設定されている場合、ユーザーはパスワードを要求されません。オプションも環境変数も指定されない場合は、Windows 認証モードを使用してサインインします。たとえば、統合セキュリティを使用して、SQL Server myserver のインスタンス instance1 に接続するには、次のコマンドを使用します。

:connect myserver\instance1

スクリプト変数を使用して myserver の既定のインスタンスに接続するには、次を使用します。

:setvar myusername test

:setvar myservername myserver

:connect $(myservername) $(myusername)

[:]!!<command>
オペレーティングシステムのコマンドを実行します。オペレーティングシステムのコマンドを実行するには、行頭に 2 つの感嘆符 ( !! ) を入力し、続けてオペレーティングシステムのコマンドを入力します。次に例を示します。

:!! Dir

Note

コマンドは sqlcmd を実行中のコンピューター上で実行されます。

:XML [ON | OFF]
詳細については、このトピックの「XML 出力形式」と「JSON 出力形式」を参照してください。

:Help
sqlcmd コマンドと各コマンドの短い説明を一覧表示します。

sqlcmd のファイル名

sqlcmd の入力ファイルは -i オプションまたは :r コマンドで指定できます。出力ファイルは -o オプションまたは :Error、 :Out 、および :Perftrace コマンドで指定できます。指定するファイルについてのガイドラインを次に示します。

:Error、 :Out 、および :Perftrace を指定するときは、個別に <filename > を指定します。同じ <filename > を使用すると、各コマンドからの入力が混在する場合があります。
ローカルコンピューターの sqlcmd からリモートサーバー上の入力ファイルが呼び出され、ファイルに :Out c:\OutputFile.txt のようにドライブパスが含まれていると、出力ファイルはリモートサーバーではなく、ローカルコンピューター上に作成されます。
有効なファイルパスは、C:\<filename>、\\<Server>\<Share$>\<filename>、"C:\Some Folder\<file name>" などです。パスに空白が含まれる場合は、引用符を使用します。
各新規 sqlcmd セッションにより、同じ名前の既存のファイルが上書きされます。

情報メッセージ

sqlcmd は、サーバーから送信されたすべての情報メッセージを出力します。次の例では、Transact-SQL ステートメントが実行された後、情報メッセージが出力されます。

コマンドプロンプトで、次のコマンドを入力します。

sqlcmd

sqlcmd プロンプトで次のように入力します。

USE AdventureWorks2012;

GO

Enter キーを押すと、次の情報メッセージが出力されます。"データベースコンテキストが 'AdventureWorks2012' に変更されました。"

Transact-SQL クエリからの出力形式

まず、sqlcmd は SELECT リストで指定した列名を含む列ヘッダーを出力します。列名は、SQLCMDCOLSEP で指定された文字を使用して分割されます。既定では、空白です。列名が列幅よりも短い場合は、出力は次の列まで空白で埋められます。

この行の次には区切り行が出力されます。区切り行は、連続したダッシュ文字です。次に出力の例を示します。

sqlcmdを開始します。 sqlcmd コマンドプロンプトで次のクエリを入力します。

USE AdventureWorks2012;

SELECT TOP (2) BusinessEntityID, FirstName, LastName

FROM Person.Person;

GO

Enter キーを押すと、次の結果セットが返されます。

BusinessEntityID FirstName LastName

---------------- ------------ ----------

285 Syed Abbas

293 Catherine Abel

(2 row(s) affected)

BusinessEntityID 列には 4 文字分の幅しかありませんが、長い列名に合わせるため拡張されています。既定では、出力は 80 文字で終了します。この設定は、 -w オプションを使用するか、SQLCMDCOLWIDTH スクリプト変数を設定することで変更できます。

XML 出力形式

FOR XML 句からの結果である XML 出力は、連続するストリームでフォーマットされずに出力されます。

XML 出力を行うには、 :XML ONコマンドを使用します。

Note

sqlcmd は、通常の形式のエラーメッセージを返します。エラーメッセージが XML 形式の XML テキストストリームで出力されることにも注意してください。 :XML ONを使用すると、 sqlcmd は情報メッセージを表示しません。

XML モードをオフにするには、:XML OFF コマンドを使用します。

XML OFF コマンドは sqlcmd を行指向の出力に切り替えるので、XML OFF コマンドの実行前に GO コマンドは指定しないでください。

XML (ストリーム入力) データと行セットのデータを混在させることはできません。 XML ストリームを出力する Transact-SQL ステートメントの実行前に、XML ON コマンドが実行されていない場合は、正しく出力されません。 XML ON コマンドが実行されている場合、通常の行セットを出力する Transact-SQL ステートメントは実行できません。

Note

:XML コマンドは SET STATISTICS XML ステートメントをサポートしません。

JSON 出力形式

JSON 出力を行うには、 :XML ONコマンドを使用します。これを使用しないと、出力には、列名と JSON テキストの両方が含まれます。この出力は、有効な JSON ではありません。

XML モードをオフにするには、:XML OFF コマンドを使用します。

詳細については、この記事の「XML 出力形式」を参照してください。

Azure Active Directory 認証を使用する

Azure Active Directory 認証の利用例

sqlcmd -S Target_DB_or_DW.testsrv.database.windows.net  -G  -l 30
sqlcmd -S Target_DB_or_DW.testsrv.database.windows.net -G -U bob@contoso.com -P MyAADPassword -l 30

sqlcmd のベストプラクティス

次の説明を参考にして、セキュリティと効率を最大にしてください。

統合セキュリティを使用します。
自動化された環境では -X[1] を使用します。
適切な NTFS ファイルシステム権限を使用して、入力ファイルと出力ファイルのセキュリティを保護します。
パフォーマンスを向上させるには、複数のセッションではなく、1 つの sqlcmd セッションの中で、できるだけ作業するようにします。
バッチまたはクエリ実行のタイムアウト値を、推定所要時間よりも長めに設定します。

次の説明を参考にして、正確さを最大限に高めます。

-V16 を使用して、重大度 16 レベルのメッセージをログに記録します。重大度 16 のメッセージは、ユーザーが訂正できる一般的なエラーを示します。
プロセスが終了した後、終了コードと DOS ERRORLEVEL 変数を確認します。通常、sqlcmd からは 0 が返されます。それ以外の場合は、 -V によって構成された ERRORLEVEL が設定されます。つまり、ERRORLEVEL が SQL Server から報告されるエラー番号と同じ値であると想定しないでください。エラー番号は、システム関数 @@ERROR に対応する SQL Server 固有の値です。 ERRORLEVEL は、(SQLCMD が) 終了した理由を示す SQLCMD 固有の値であり、その値はコマンドライン引数 -b を指定することによって影響を受けます。

終了コードおよび DOS ERRORLEVEL のチェックと組み合わせて -V16 を使用すると、自動化された環境 (特に運用リリース前の品質ゲート) でエラーをキャッチできます。

sqlcmd ユーティリティ

sqlcmd のダウンロードとインストール

Windows

Linux/macOS

バージョンの確認

プレインストール済み

Azure Cloud Shell

Azure Data Studio

SQL Server Management Studio (SSMS)

構文

コマンドラインオプション

解説

変数の優先順位 (低から高)

sqlcmd スクリプト変数

sqlcmd コマンド

sqlcmd のファイル名

情報メッセージ

Transact-SQL クエリからの出力形式

XML 出力形式

JSON 出力形式

Azure Active Directory 認証を使用する

sqlcmd のベストプラクティス

次のステップ

その他のリソース

その他のリソース

sqlcmd ユーティリティ

sqlcmd のダウンロードとインストール

Windows

Linux/macOS

バージョンの確認

プレインストール済み

Azure Cloud Shell

Azure Data Studio

SQL Server Management Studio (SSMS)

構文

コマンド ライン オプション

解説

変数の優先順位 (低から高)

sqlcmd スクリプト変数

sqlcmd コマンド

sqlcmd のファイル名

情報メッセージ

Transact-SQL クエリからの出力形式

XML 出力形式

JSON 出力形式

Azure Active Directory 認証を使用する

sqlcmd のベスト プラクティス

次のステップ

その他のリソース

その他のリソース

コマンドラインオプション

sqlcmd のベストプラクティス