Duet AI アシスタンスで SQL を記述する

このドキュメントでは、Google Cloud の AI を活用したコラボレーターである Duet AI を使用して、Spanner で次のことを行う方法について説明します。

自然言語のプロンプトを使用して SQL クエリを生成します。
クエリエディタで SQL ステートメントを完成させます。
クエリエディタで SQL クエリを説明する。

Duet AI がプロンプトやそのレスポンスをデータとして使用してモデルをトレーニングすることはありせん。詳細については、Google Cloud の Duet AI がデータを使用する方法をご覧ください。

このドキュメントは、Spanner、SQL、データ分析に精通したデータベース管理者とデータエンジニアを対象としています。Spanner を初めて使用する場合は、Google Cloud コンソールを使用してデータベースを作成してクエリを実行するをご覧ください。

準備

Google Cloud ユーザーアカウントとプロジェクトに Duet AI が設定されていることを確認します。
このドキュメントのタスクを完了するには、必要な Identity and Access Management（IAM）権限があることを確認してください。
Google Cloud コンソールで、[Spanner] ページに移動します。

Spanner に移動
インスタンスをリストから選択します。
データベースを選択します。
ナビゲーションメニューで、[Spanner Studio] をクリックします。
タスクバーで [pen_spark] Duet AI をクリックして、Spanner の Duet AI 機能を表示します。
有効にする Duet AI 機能を選択します。たとえば、 SQL 補完およびコメントからクエリの生成。プロジェクトで作業している他の項目に影響を与えることなく、自分で機能を選択して試すことができます。
省略可: このドキュメントの例に従う場合は、まずデータベースのスキーマを作成するの説明に従って Singers テーブルを作成してください。

Spanner で Duet AI 機能を無効にするには、これらの手順を繰り返して、無効にする Duet AI 機能の選択を解除します。

必要なロール

このドキュメントのタスクを完了するのに必要な権限を取得するには、プロジェクトで Spanner データベースリーダー（roles/spanner.databaseReader）IAM ロールを付与するよう管理者に依頼します。ロールの付与の詳細については、アクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

自然言語のプロンプトを使用して SQL クエリを生成する

Duet AI の自然言語コメント（またはプロンプト）を付与して、スキーマに基づくクエリを生成できます。たとえば、次のプロンプトに対応して SQL を生成するように Duet AI に指示できます。

「顧客満足度調査の結果を追跡する表を作成します。」
「Singers テーブルに誕生日という日付列を追加します。」
「90 年代に生まれた歌手は何人ですか？」

Duet AI で Spanner に SQL を生成するには、次の手順に従います。

Google Cloud コンソールで、[Spanner] ページに移動します。

Spanner に移動
インスタンスをリストから選択します。
データベースを選択します。
ナビゲーションペインで [Spanner Studio] をクリックします。[エクスプローラ] ペインに、データベースにあるオブジェクトのリストが表示されます。
データベースに対してクエリを実行するには、 [新しい SQL エディタタブ] をクリックします。SQL の生成が有効になっていることを確認します。
SQL を生成するには、-- で始まり単一行コメントが続くコメントをクエリエディタに入力してから、Return を押します。

たとえば、プロンプト -- add a row to table singers を入力して Return を押すと、Duet AI によって次のような SQL が生成されます。
```
INSERT INTO Singers (SingerId, FirstName, LastName, BirthDate)
VALUES (1, Alex, 'M.', '1977-10-16');
```
Singers テーブルを使用して例を続行するには、プロンプト -- show all singers born in the 70s を入力すると、Duet AI によって次のような SQL が生成されます。
```
SELECT *
FROM Singers
WHERE Singers.BirthDate
BETWEEN '1970-01-01' AND '1979-12-31'
```
注: Duet AI は、同じプロンプトを入力するたびに異なる構文を提案する場合があります。
生成された SQL を確認し、次のいずれかの操作を行います。
- Duet AI によって生成された SQL を受け入れるには、Tab を押してから、[実行] をクリックして、推奨される SQL を実行します。
- Duet AI によって生成された SQL を編集するには、Tab を押し、SQL を編集してから、[実行] をクリックします。
- 提案を閉じるには、Esc を押すか、入力を続けます。

クエリエディタで SQL ステートメントを完成する

SQL コードの記述に役立つように、Spanner の Duet AI には、AI が支援するコード完成の提案が提供されています。Duet AI を有効にすると、Spanner Studio のクエリエディタにテキストを入力すると、Duet AI が SQL コードを予測して自動入力します。

インラインコードの提案

インラインコードの提案を使用するには、次の手順に従います。

Google Cloud コンソールで、[Spanner] ページに移動します。

Spanner に移動
インスタンスをリストから選択します。
データベースを選択します。
ナビゲーションパネルで [Spanner Studio] をクリックします。
データベースに対してクエリを実行するには、 [新しい SQL エディタタブ] をクリックします。SQL 完成が有効になっていることを確認します。
行の末尾にクエリと、スペースまたは改行を入力します。テキストを入力すると、Duet AI が、選択したデータベースのスキーマでサポートされているオブジェクトに基づいた推奨の SQL を表示します。

たとえば、Singers テーブルに行を追加するには、次の SQL INSERT INTO Singers の書き込みを開始します。

Duet AI は、次のような SQL を提案します。
```
INSERT INTO Singers
(SingerId, FirstName, LastName, BirthDate)
VALUES
  (1, 'Marc', 'Singer', '1970-03-24')
```
注: Duet AI は、同じ SQL ステートメントを入力するたびに、異なる SQL 構文を提案する場合があります。
SQL の提案を確認し、次のいずれかの操作を行います。
- Duet AI によって生成された SQL を受け入れるには、Tab を押してから、[実行] をクリックして、推奨される SQL を実行します。
- Duet AI によって生成された SQL を編集するには、Tab を押し、SQL を編集してから、[実行] をクリックします。
- 提案を閉じるには、Esc を押すか、入力を続けます。

コーディングのサポートツール

コーディングのサポートツールを使用するには、次の手順を行います。

Google Cloud コンソールで、[Spanner] ページに移動します。

Spanner に移動
インスタンスをリストから選択します。
データベースを選択します。
ナビゲーションパネルで [Spanner Studio] をクリックします。
データベースにクエリを実行するには、 [新しいタブ] をクリックします。
クエリエディタの横にある pen_spark [コーディングをサポート] をクリックします。
[コーディングをサポート] ウィンドウで、プロンプトを入力します。たとえば、add a row to table singers を選択し、[生成] をクリックします。

Duet AI は次のような SQL を生成します。
```
INSERT INTO Singers (SingerId, FirstName, LastName, BirthDate)
VALUES (1, Alex, 'M.', '1977-10-16');
```
注: Duet AI は、同じプロンプトを入力するたびに異なる構文を提案する場合があります。
生成された SQL を確認し、次のいずれかの操作を行います。
- Duet AI によって生成された SQL を受け入れるには、[挿入] をクリックしてステートメントをクエリエディタに挿入します。次に [実行] をクリックして、提案された SQL を実行します。
- Duet AI に新しいクエリを生成するよう依頼するには、[編集] をクリックします。プロンプトを編集したら、[更新] をクリックします。その後、生成された新しいステートメントを受け入れるか、提案を閉じるを決定できます。
- 提案を閉じるには、[コーディングをサポート] ウィンドウを閉じます。

クエリエディタで SQL ステートメントを説明する

Spanner で Duet AI を使用すると、自然言語で SQL クエリを記述できます。この説明は、複雑なクエリや長いクエリの構文、基盤となるスキーマ、ビジネスコンテキストを理解するのに役立ちます。

Google Cloud コンソールで、[Spanner] ページに移動します。

Spanner に移動
インスタンスをリストから選択します。
データベースを選択します。
ナビゲーションパネルで [Spanner Studio] をクリックします。
データベースにクエリを実行するには、 [新しいタブ] をクリックします。
クエリエディタで、クエリを貼り付けます。
Duet AI に説明させるクエリをハイライト表示し、spark [このクエリを説明する] をクリックします。

SQL の説明が [Duet AI] ペインに表示されます。

次のステップ

Google Cloud の Duet AI の概要を確認する
Duet AI でデータを使用する方法について学習する。
Duet AI を使用して Google Cloud でデータを分析する方法を学習する。