Transact-SQL スニペットの追加

  • [アーティクル]

適用対象:SQL ServerAzure SQL DatabaseAzure SQL Managed InstanceAzure Synapse AnalyticsAnalytics Platform System (PDW)

SQL Serverには、定義済みの Transact-SQL コード スニペット一式が同梱されていますが、それ以外にも、独自のスニペットを追加することができます。

Transact-SQL スニペット ファイルの作成

Transact-SQL コード スニペットを作成するには、まず、目的のコード スニペットのテキストを含んだ XML ファイルを作成します。 このファイルは、拡張子を .snippet とし、 コード スニペット スキーマの要件を満たしている必要があります。 スニペットの言語は SQL に設定します。

SQL Server に付属する定義済みのスニペットが参考になります。 定義済みのスニペットを探すには、SQL Server Management Studio を開いて [ツール] メニューを選択し、 [コード スニペット マネージャー] をクリックします。 [言語] ボックスの一覧の [SQL] をクリックすると、 Transact-SQL スニペットのパスが [場所] ボックスに表示されます。

コード スニペットの登録

スニペット ファイルを作成したら、コード スニペット マネージャーを使用して、SQL Server Management Studio にスニペットを登録します。 複数のスニペットを含んだフォルダーを追加するか、個々のスニペットを [マイ コード スニペット] フォルダーにインポートすることができます。

手順

スニペット フォルダーの追加

  1. SQL Server Management Studio を開きます。

  2. [ツール] メニューを選択し、 [コード スニペット マネージャー] をクリックします。

  3. [追加] をクリックします。

  4. コード スニペットがあるフォルダーに移動し、 [フォルダーの選択] をクリックします。

スニペットのインポート

  1. SQL Server Management Studio を開きます。

  2. [ツール] メニューを選択し、 [コード スニペット マネージャー] をクリックします。

  3. [Import](インポート) ボタンをクリックします。

  4. スニペットがあるフォルダーに移動し、.snippet ファイルをクリックして、 [開く] をクリックします。

例

次の例では、TRY-CATCH ブロックの挿入スニペットを作成し、SQL Server Management Studio にインポートします。

  1. 次のコードをメモ帳に貼り付け、TryCatch.snippet というファイル名で保存します。

    <?xml version="1.0" encoding="utf-8" ?>  
<CodeSnippets  xmlns="http://schemas.microsoft.com/VisualStudio/2005/CodeSnippet">  
<_locDefinition xmlns="urn:locstudio">  
    <_locDefault _loc="locNone" />  
    <_locTag _loc="locData">Title</_locTag>  
    <_locTag _loc="locData">Description</_locTag>  
    <_locTag _loc="locData">Author</_locTag>  
    <_locTag _loc="locData">ToolTip</_locTag>  
   <_locTag _loc="locData">Default</_locTag>  
</_locDefinition>  
<CodeSnippet Format="1.0.0">  
<Header>  
<Title>TryCatch</Title>  
                        <Shortcut></Shortcut>  
<Description>Example Snippet for Try-Catch.</Description>  
<Author>SQL Server Books Online Example</Author>  
<SnippetTypes>  
                                <SnippetType>SurroundsWith</SnippetType>  
</SnippetTypes>  
</Header>  
<Snippet>  
<Declarations>  
                                <Literal>  
                                <ID>CatchCode</ID>  
                                <ToolTip>Code to handle the caught error</ToolTip>  
                                <Default>CatchCode</Default>  
                                </Literal>  
</Declarations>  
<Code Language="SQL"><![CDATA[  
BEGIN TRY  

$selected$ $end$  

END TRY  
BEGIN CATCH  

$CatchCode$  

END CATCH;  
]]>  
</Code>  
</Snippet>  
</CodeSnippet>  
</CodeSnippets>

  2. SQL Server Management Studio を開きます。

  3. [ツール] メニューを選択し、 [コード スニペット マネージャー] をクリックします。

  4. [Import](インポート) ボタンをクリックします。

  5. TryCatch.snippet があるフォルダーに移動し、TryCatch.snippet ファイルをクリックして、 [開く] をクリックします。 これで [マイ コード スニペット] フォルダーに既存の TryCatch スニペットが追加されるはずです。

参照

ブロックの挿入 Transact-SQL スニペットの挿入