チュートリアル:Transact-SQL エディターを使用してデータベースオブジェクトを作成する - Azure Data Studio

[アーティクル]
10/19/2023

クエリ、ストアドプロシージャ、スクリプトなどの作成と実行は、データベースプロフェッショナルの中心的な仕事です。このチュートリアルでは、データベースオブジェクトを作成するための T-SQL の主な機能について説明します。

このチュートリアルでは、次の目的で Azure Data Studio を使用する方法について説明します。

データベースオブジェクトを検索する
テーブルデータを編集する
スニペットを利用して T-SQL を簡単に記述する
[定義をここに表示] と [定義へ移動] を使用し、データベースオブジェクトの詳細を表示する

前提条件

このチュートリアルには、SQL Server か Azure SQL Database TutorialDB が必要です。 TutorialDB データベースを作成するには、次のクイックスタートのいずれかを実行します。

データベースオブジェクトを簡単に見つけ、一般的タスクを実行する

Azure Data Studio には、データベースオブジェクトを簡単に見つけるための検索ウィジェットが用意されています。結果一覧からは、テーブルのデータ編集など、選択したオブジェクトに関連する一般的タスクのコンテキストメニューが与えられます。

[サーバー] サイドバーを開き (Ctrl + G)、 [データベース] を展開し、 [TutorialDB] を選択します。
[TutorialDB] を右クリックし、コンテキストメニューから [管理] を選択することで [TutorialDB ダッシュボード] を開きます。
ダッシュボードで (検索ウィジェットで) [dbo.Customers] を右クリックし、 [データの編集] を選択します。

ヒント

オブジェクトがたくさん含まれるデータベースの場合、検索ウィジェットを使用することで、探しているテーブルやビューなどが簡単に見つかります。
最初の行で [電子メール] 列を編集し、「orlando0@adventure-works.com」と入力し、Enter を押して変更内容を保存します。

T-SQL スニペットを使用し、ストアドプロシージャを作成する

Azure Data Studio には、ステートメントを簡単に作成するための組み込みの T-SQL スニペットが多数用意されています。

Ctrl + N を押し、新しいクエリエディターを開きます。
エディターに「sql」と入力し、矢印を下に押して [sqlCreateStoredProcedure] を見つけ、Tab キー (または Enter) を押して create ストアドプロシージャスニペットを読み込みます。
create ストアドプロシージャには、簡単に編集するためのフィールドが 2 つ設定されています。StoredProcedureName と SchemaName です。 [StoredProcedureName] を選択し、右クリックし、 [すべての出現箇所を変更] を選択します。ここで「getCustomer」と入力すると、StoredProcedureName エントリがすべて、getCustomer に変わります。
SchemaName が出現する箇所をすべて dbo に変更します。

このスニペットには、更新を必要とするプレースホルダーパラメーターと本文テキストが含まれています。 EXECUTE ステートメントには、プレースホルダーテキストも含まれています。プロシージャに与えられるパラメーターの数がわからないためです。このチュートリアルのために、次のコードのようになるようにスニペットを更新します。

-- Create a new stored procedure called 'getCustomer' in schema 'dbo'
-- Drop the stored procedure if it already exists
IF EXISTS (
SELECT *
FROM INFORMATION_SCHEMA.ROUTINES
WHERE SPECIFIC_SCHEMA = N'dbo'
AND SPECIFIC_NAME = N'getCustomer'
)
DROP PROCEDURE dbo.getCustomer
GO
-- Create the stored procedure in the specified schema
CREATE PROCEDURE dbo.getCustomer
@ID int
-- add more stored procedure parameters here
AS
-- body of the stored procedure
SELECT  c.CustomerId, 
c.Name, 
c.Location, 
c.Email
FROM dbo.Customers c
WHERE c.CustomerId = @ID
FOR JSON PATH

GO
-- example to execute the stored procedure we just created
EXECUTE dbo.getCustomer 1
GO

ストアドプロシージャを作成し、テスト実行するには、F5 を押します。

これでストアドプロシージャが作成され、 [結果] ペインに返された顧客が JSON で表示されます。書式設定された JSON を表示するには、返されたレコードをクリックします。

[定義をここに表示] を使用する

Azure Data Studio では、[定義をここに表示] 機能を使用して、オブジェクトの定義を表示できます。このセクションでは、2 つ目のストアドプロシージャを作成します。[定義をここに表示] を使用してテーブルに入っている列を表示し、ストアドプロシージャの本文を簡単に作成します。

Ctrl + N を押し、新しいエディターを開きます。
エディターに「sql」と入力し、矢印を下に押して [sqlCreateStoredProcedure] を見つけ、Tab キー (または Enter) を押して create ストアドプロシージャスニペットを読み込みます。
[StoredProcedureName] に「setCustomer」と入力し、 [SchemaName] に「dbo」と入力します。
@param プレースホルダーを次のパラメーター定義に置き換えます。
```
@json_val nvarchar(max)
```
ストアドプロシージャの本文を次のコードに置き換えます。
```
INSERT INTO dbo.Customers
```
追加したばかりの [INSERT] 行で、 [dbo.Customers] を右クリックし、 [定義をここに表示] を選択します。
テーブルの定義が表示されるので、テーブルに入っている列を簡単に確認できます。列の一覧を参照することで、ストアドプロシージャのステートメント入力が簡単になります。前に追加した INSERT ステートメントを作成してストアドプロシージャの本文を完了し、[定義をここに表示] ウィンドウを閉じます。
```
INSERT INTO dbo.Customers (CustomerId, Name, Location, Email)
    SELECT CustomerId, Name, Location, Email
    FROM OPENJSON (@json_val)
    WITH(   CustomerId int, 
            Name nvarchar(50), 
            Location nvarchar(50), 
            Email nvarchar(50)
 )
```
クエリの一番下にある EXECUTE コマンドを削除します (または、コメントアウトします)。

ステートメント全体は次のコードのようになります。

-- Create a new stored procedure called 'setCustomer' in schema 'dbo'
-- Drop the stored procedure if it already exists
IF EXISTS (
SELECT *
    FROM INFORMATION_SCHEMA.ROUTINES
    WHERE SPECIFIC_SCHEMA = N'dbo'
    AND SPECIFIC_NAME = N'setCustomer'
)
DROP PROCEDURE dbo.setCustomer
GO
-- Create the stored procedure in the specified schema
CREATE PROCEDURE dbo.setCustomer
    @json_val nvarchar(max) 
AS
    -- body of the stored procedure
    INSERT INTO dbo.Customers (CustomerId, Name, Location, Email)
    SELECT CustomerId, Name, Location, Email
    FROM OPENJSON (@json_val)
    WITH(   CustomerId int, 
            Name nvarchar(50), 
            Location nvarchar(50), 
            Email nvarchar(50)
    )
GO

setCustomer ストアドプロシージャを作成するには、F5 を押します。

クエリ結果を JSON として保存し、setCustomer ストアドプロシージャをテストする

前のセクションで作成した setCustomer ストアドプロシージャでは、JSON データを @json_val パラメーターに渡す必要があります。このセクションでは、ストアドプロシージャをテストできるように、パラメーターに渡す目的で正しく書式設定した JSON を用意する方法について説明します。

[サーバー] サイドバーで、 [dbo.Customers] テーブルを右クリックし、 [SELECT TOP 1000 Rows](上位 1000 行を選択する) をクリックします。
結果ビューの最初の行を選択し、行全体が選択されるようにします (左端の列の番号 1 をクリックします)。それから [Save as JSON](JSON として保存) を選択します。
ファイルを後で削除できるように、覚えやすい場所にフォルダーを変更し (デスクトップなど)、 [保存] をクリックします。 JSON 形式のファイルが開きます。
エディターで JSON データを選択してコピーします。
Ctrl + N を押し、新しいエディターを開きます。
前の手順からは、setCustomer プロシージャを呼び出せるように正しく書式設定されたデータを簡単に得る方法がわかります。次のコードでは、新しい顧客詳細で同じ JSON フォーマットを使用しています。そのため、setCustomer プロシージャをテストできます。ステートメントには、パラメーターを宣言し、新しい get プロシージャと set プロシージャを実行する構文が含まれています。前のセクションからコピーしたデータを貼り付け、次の例と同じになるように編集できます。あるいは、クエリエディターに次のステートメントを単純に貼り付けてください。
```
-- example to execute the stored procedure we just created
declare @json nvarchar(max) =
N'[
    {
        "CustomerId": 5,
        "Name": "Lucy",
        "Location": "Canada",
        "Email": "lucy0@adventure-works.com"
    }
]'

EXECUTE dbo.setCustomer @json_val = @json
GO

EXECUTE dbo.getCustomer @ID = 5
```
F5 を押してスクリプトを実行します。このスクリプトにより、新しい顧客が挿入され、新しい顧客の情報が JSON 形式で返されます。結果をクリックし、書式設定されたビューを開きます。

次のステップ

このチュートリアルでは、以下の内容を学習しました。

スキーマオブジェクトをクイック検索する
テーブルデータを編集する
スニペットを使用して T-SQL スクリプトを記述する
[定義をここに表示] と [定義へ移動] を使用し、データベースオブジェクトの詳細を確認する

最低速 5 つのクエリを有効にする方法については、次のチュートリアルを完了してください。

最低速クエリのサンプル分析情報ウィジェットを有効にする

チュートリアル:Transact-SQL エディターを使用してデータベースオブジェクトを作成する - Azure Data Studio

前提条件

データベースオブジェクトを簡単に見つけ、一般的タスクを実行する

T-SQL スニペットを使用し、ストアドプロシージャを作成する

[定義をここに表示] を使用する

クエリ結果を JSON として保存し、setCustomer ストアドプロシージャをテストする

次のステップ

フィードバック

フィードバック

その他のリソース

チュートリアル:Transact-SQL エディターを使用してデータベース オブジェクトを作成する - Azure Data Studio

前提条件

データベース オブジェクトを簡単に見つけ、一般的タスクを実行する

T-SQL スニペットを使用し、ストアド プロシージャを作成する

[定義をここに表示] を使用する

クエリ結果を JSON として保存し、setCustomer ストアド プロシージャをテストする

次のステップ

フィードバック

フィードバック

その他のリソース

チュートリアル:Transact-SQL エディターを使用してデータベースオブジェクトを作成する - Azure Data Studio

データベースオブジェクトを簡単に見つけ、一般的タスクを実行する

T-SQL スニペットを使用し、ストアドプロシージャを作成する

クエリ結果を JSON として保存し、setCustomer ストアドプロシージャをテストする