Azure Data Studio でコード スニペットを作成して使用し、Transact-SQL (T-SQL) スクリプトをすばやく作成するCreate and use code snippets to quickly create Transact-SQL (T-SQL) scripts in Azure Data Studio

Azure Data Studio のコード スニペットは、データベースおよびデータベース オブジェクトを簡単に作成できるようにするテンプレートです。Code snippets in Azure Data Studio are templates that make it easy to create databases and database objects.

Azure Data Studio には、適切な構文を迅速に生成するのに役立つ、複数の T-SQL スニペットが用意されています。Azure Data Studio provides several T-SQL snippets to assist you with quickly generating the proper syntax.

ユーザー定義のコード スニペットを作成することもできます。User-defined code snippets can also be created.

組み込みの T-SQL コード スニペットの使用Using built-in T-SQL code snippets

  1. 使用可能なスニペットにアクセスするには、クエリ エディターで「sql」と入力してリストを開きます。To access the available snippets, type sql in the query editor to open the list:


  2. 使用するスニペットを選択すると、T-SQL スクリプトが生成されます。Select the snippet you want to use, and it generates the T-SQL script. たとえば、sqlCreateTable を選択します。For example, select sqlCreateTable:

    テーブル スニペットの作成

  3. 強調表示されたフィールドを特定の値で更新します。Update the highlighted fields with your specific values. たとえば、TableNameSchema をデータベースの値に置き換えます。For example, replace TableName and Schema with the values for your database:


    変更するフィールドが強調表示されなくなった場合 (これは、エディターの周囲でカーソルを移動したときに発生します)、変更する単語を右クリックし、 [すべての出現箇所を変更] を選択します。If the field you want to change is no longer highlighted (this happens when moving the cursor around the editor), right-click the word you want to change, and select Change all occurrences:


  4. 選択したスニペットに必要な追加の T-SQL を更新または追加します。Update or add any additional T-SQL you need for the selected snippet. たとえば、Column1Column2 を更新し、さらに列を追加します。For example, update Column1, Column2, and add more columns.

SQL コード スニペットを作成するCreating SQL code snippets

独自のスニペットを定義できます。You can define your own snippets. 編集するために SQL スニペット ファイルを開くには、次の操作を行います。To open up the SQL snippet file for editing:

  1. コマンド パレット (Shift + Ctrl + P) を開き、「snip」と入力して、 [基本設定: ユーザー スニペットを開く] を選択します。Open the Command Palette (Shift+Ctrl+P), and type snip, and select Preferences: Open User Snippets:

    ユーザー スニペット

  2. [SQL] を選択します。Select SQL:


    Azure Data Studio では Visual Studio Code からそのコード スニペット機能を継承するため、この記事では SQL スニペットの使用について具体的に説明します。Azure Data Studio inherits its code snippet functionality from Visual Studio Code so this article specifically discusses using SQL snippets. 詳細については、Visual Studio Code ドキュメントの「独自のスニペットを作成する」を参照してください。For more detailed information, see Creating your own snippets in the Visual Studio Code documentation.

    Select SQL

  3. 次のコードを sql.json に貼り付けます。Paste the following code into sql.json:

     "Select top 5": {
    "prefix": "sqlSelectTop5",
    "body": "SELECT TOP 5 * FROM ${1:TableName}",
    "description": "User-defined snippet example 1"
    "Create Table snippet":{
    "prefix": "sqlCreateTable2",
    "body": [
    "-- Create a new table called '${1:TableName}' in schema '${2:SchemaName}'",
    "-- Drop the table if it already exists",
    "IF OBJECT_ID('$2.$1', 'U') IS NOT NULL",
    "DROP TABLE $2.$1",
    "-- Create the table in the specified schema",
    "CREATE TABLE $2.$1",
    "$1Id INT NOT NULL PRIMARY KEY, -- primary key column",
    "Column1 [NVARCHAR](50) NOT NULL,",
    "Column2 [NVARCHAR](50) NOT NULL",
    "-- specify more columns here",
       "description": "User-defined snippet example 2"
  4. sql.json ファイルを保存します。Save the sql.json file.

  5. Ctrl+N キーをクリックして、新しいクエリ エディター ウィンドウを開きます。Open a new query editor window by clicking Ctrl+N.

  6. sql」と入力すると、追加した 2 つのユーザー スニペット (sqlCreateTable2sqlSelectTop5) が表示されます。Type sql, and you see the two user snippets you just added; sqlCreateTable2 and sqlSelectTop5.

新しいスニペットの 1 つを選択し、テストを実行してみましょう。Select one of the new snippets and give it a test run!

次の手順Next steps

SQL エディターの詳細については、コード エディターのチュートリアルに関するページを参照してください。For information about the SQL editor, see Code editor tutorial.