クエリ エディターを使用して SQLCMD スクリプトを編集する

SQL Server Management Studio (SSMS) のクエリ エディターを使用して、SQLCMD スクリプトとしてクエリを記述および編集します。 SQLCMD スクリプトを使用して、同じスクリプト内の Windows システム コマンドと Transact-SQL ステートメントを処理できます。

SQLCMD モードを有効にする

クエリ エディターを使用して SQLCMD スクリプトを記述または編集するには、SQLCMD スクリプト モードを有効にする必要があります。 SQLCMD モードは既定では有効になっていません。 スクリプト モードを有効にするには、ツール バーの [SQLCMD モード] アイコンを選択するか、[クエリ] メニューから [SQLCMD モード] を選択します。

クエリ エディターの SQLCMD スクリプトでは、すべての Transact-SQL スクリプトで使用されるのと同じ機能を使用できます。 次のような機能があります。

• 色分け
• スクリプトの実行
• ソース管理
• スクリプトの解析
• Showplan

クエリ エディターで SQLCMD スクリプトを有効にする

アクティブなクエリ エディター ウィンドウの SQLCMD スクリプトを有効にするには、次の手順に従います。

クエリ エディター ウィンドウを SQLCMD モードに切り替える

1. オブジェクト エクスプローラーでサーバーを右クリックし、[ 新しいクエリ ] を選択して新しいクエリ エディター ウィンドウを開きます。

2. [クエリ] メニューから [SQLCMD モード] を選びます。

   SQLCMD ステートメントは、クエリ エディターのコンテキストで実行されます。

3. [SQL エディター] ツール バーの [使用できるデータベース] の一覧で、[ AdventureWorks2025] データベースを選択します。

4. クエリ エディター ウィンドウで、次の Transact-SQL ステートメントと !!DIR SQLCMD ステートメントを入力します。

   SELECT DISTINCT Type FROM Sales.SpecialOffer;
   GO
   !!DIR
   GO
   SELECT ProductCategoryID, Name FROM Production.ProductCategory;
   GO
   

5. F5 キーを押して、Transact-SQL と MS-DOS のステートメントが混在するセクションを実行します。

   1 番目と 3 番目のステートメントにより、2 つの SQL 結果ペインが表示されます。

6. [結果] ペインの [メッセージ] タブを選び、3 つのステートメントすべてから取得されたメッセージを確認します。

   • (6 row(s) affected)
   • <The directory information>
   • (4 row(s) affected)

デフォルトで SQLCMD スクリプトを有効にする

SQLCMD スクリプト操作を既定で有効にするには、[ツール] メニューの [オプション] を選び、[クエリ実行]、[SQL Server] の順に展開して [全般] ページを選びます。[既定で、新しいクエリを SQLCMD モードで開始する] チェック ボックスをオンにします。

SQLCMD スクリプトの作成と編集

スクリプト モードを有効にした後は、SQLCMD コマンドと Transact-SQL ステートメントの両方を記述できます。 次の規則が適用されます。

• SQLCMD コマンドは行の最初のステートメントでなければなりません。

• 各行に 1 つの SQLCMD コマンドだけを記述できます。

• SQLCMD コマンドの前にコメントと空白を使用できます。

• コメント文字の間にはさまれた SQLCMD コマンドは実行されません。

• 1 行のコメント文字は 2 つのハイフン (--) であり、行の先頭に表示する必要があります。

• オペレーティング システム コマンドに 2 つの感嘆符 (!!) のプレフィックスを付けます。 2 つの感嘆符が付いたコマンドの場合は、感嘆符の後のステートメントが cmd.exe コマンド プロセッサによって実行されます。 !!の後のテキストは、cmd.exeするパラメーターとして渡されるため、最終的なコマンド ラインは次のように実行されます: "%SystemRoot%\system32\cmd.exe /c <text after !!>"。

• SQLCMD コマンドと Transact-SQL を明確に区別するには、すべての SQLCMD コマンドの前にコロン (:) を付けます。

• GO コマンドは、前置きまたは前に!!:を付けずに使用できます。

• クエリ エディターでは、SQLCMD スクリプトの一部として定義する環境変数と変数がサポートされていますが、組み込みの SQLCMD 変数や osql 変数はサポートされていません。 SSMS は、SQLCMD 変数を大文字と小文字を区別して処理します。 たとえば、 PRINT '$(COMPUTERNAME)' は正しい結果を生成しますが、 PRINT '$(ComputerName)' はエラーを返します。

サポートされている SQLCMD 構文

クエリ エディターでは、次の SQLCMD スクリプト キーワードがサポートされています。

• [!!:]GO[count]
• !! <command>
• :exit(statement)
• :Quit
• :r <filename>
• :setvar <var> <value>
• :connect server[\instance] [-l login_timeout] [-U user [-P password]] ¹
• :on error [ignore|exit]
• :error <filename>|stderr|stdout ²
• :out <filename>|stderr|stdout ²

¹:connect コマンドの詳細については、 sqlcmd ユーティリティーのコマンドを参照してください。

² クエリ エディターは、とstderrの [stdout] タブに出力を送信します。

クエリ エディターでは、前の一覧に含まれていない SQLCMD コマンドはサポートされていません。 サポートされていない SQLCMD キーワードを含むスクリプトを実行すると、クエリ エディターはコマンドを無視します。 サポートされていないキーワードごとに、クエリ エディターは次のメッセージを送信先に送信します。

Ignoring command <ignored_command>

SQLCMD スクリプトの色分け

SQLCMD スクリプトを有効にすると、スクリプトは色分けされます。 Transact-SQL キーワードの色分けは同じです。 SQLCMD コマンドは、影付きの背景で表示されます。

例示

次の例では、SQLCMD ステートメントを使用して、 testoutput.txtという名前の出力ファイルを作成します。 現在のディレクトリを出力する 2 つの Transact-SQL SELECT ステートメントと 1 つのオペレーティング システム コマンドを実行します。 結果のファイルには、 DIR ステートメントからのメッセージ出力と、Transact-SQL ステートメントからの結果の出力が含まれます。

:out C:\testoutput.txt
SELECT @@VERSION As 'Server Version';
!!DIR
!!:GO
SELECT @@SERVERNAME AS 'Server Name';
GO

関連コンテンツ

• sqlcmd ユーティリティ