Google Cloud Data Agent Kit IDE 拡張機能の統合 SQL エディタを使用すると、IDE から直接 Google Cloud データに対して SQL クエリを実行できます。
サポートされているコーディング エージェントで Data Agent Kit プラグインを使用している場合は、エージェントで SQL クエリを実行したり、自然言語プロンプトを使用して SQL クエリを生成したりできます。
サポートされるデータソース
Data Agent Kit を使用すると、次のGoogle Cloud データ サービスでテーブルとビューに対してクエリを実行できます。
- BigQuery
- Bigtable
- Spanner
- AlloyDB for PostgreSQL
- Cloud SQL for MySQL
- Cloud SQL for PostgreSQL
Cloud SQL では、Identity and Access Management(IAM)データベース認証と組み込みのデータベース認証(パスワードが Secret Manager のリージョン シークレットとして保存されている)を使用するクエリがサポートされています。Cloud SQL が Secret Manager を使用して組み込みユーザーを認証する方法の詳細については、Cloud SQL for MySQL と Cloud SQL for PostgreSQL の Data API を使用して SQL ステートメントを実行するをご覧ください。AlloyDB では、IAM データベース認証を使用するクエリのみがサポートされています。
始める前に
データをクエリする前に、次の操作を行います。
- 拡張機能をインストールします。
- 拡張機能の設定を構成します。
- データを見つけて探索するのガイダンスを確認します。
新しい SQL ファイルを作成する
SQL エディタは複数の方法で開くことができます。
[ファイル] メニューから新しい SQL ファイルを作成する
- VS Code のメニューバーで、[File]、[New Text File] の順にクリックします。エディタに無題のファイルが表示されます。
- 新しいファイルを
.sql拡張子で保存します。 - エディタのタブで [Select Connection] をクリックします。
- クエリの設定を構成するの手順を完了します。
カタログから新しいクエリを作成する
- アクティビティ バーの [Google Cloud Data Agent Kit] タブで、[カタログ] を開いて、クエリするデータセットを見つけます。
- データセットの名前を右クリックまたは Ctrl+クリックして、[クエリ] を選択し、そのデータセット用に事前構成された新しい SQL ファイルを開きます。
BigQuery セクションから新しいクエリを作成する
- アクティビティ バーの [Google Cloud Data Agent Kit] タブで、[BigQuery] を開きます。
- [+ 新しいクエリ] をクリックします。BigQuery をデータソースとして構成した、無題の SQL ファイルがエディタに表示されます。
クエリ設定を構成する
SQL クエリに必要な設定は、 Google Cloud サービスによって異なります。
AlloyDB
- SQL エディタで、[クエリ設定を開く] をクリックします。
- [データベース] を選択します。
- [AlloyDB] を選択します。
- クラスタを選択します。
- インスタンスを選択します。クエリはこのインスタンスに転送されます。
- データベースを選択します。
- [保存] をクリックします。
BigQuery
- SQL エディタで、[クエリ設定を開く] をクリックします。
- [BigQuery] を選択します。
- [保存] をクリックします。
Bigtable
- SQL エディタで、[クエリ設定を開く] をクリックします。
- [データベース] を選択します。
- [Bigtable] を選択します。
- インスタンスを選択します。
- 省略可: デフォルトのアプリ プロファイル以外のアプリ プロファイルを使用するには、そのアプリ プロファイルを選択します。
- クエリを作成します。
- [保存] をクリックします。
Cloud SQL
- SQL エディタで、[クエリ設定を開く] をクリックします。
- [データベース] を選択します。
- [Cloud SQL] を選択します。
- インスタンスを選択します。クエリはこのインスタンスに転送されます。
- クエリするデータベースを選択します。
[認証方法] で、認証方法を選択します。
- IAM データベース認証: Google Cloud アカウントを使用して認証します。
組み込みデータベース認証: パスワードが Secret Manager のリージョン シークレットとして保存されている組み込みデータベース ユーザーとして認証します。
- [ユーザー] リストで、データベース ユーザーを選択します。リストを読み込めない場合は、[ユーザー] フィールドにユーザー名を入力します。Cloud SQL for MySQL では、デフォルトの
rootユーザーはサポートされていません。 - [パスワード(Secret Manager に保存)] リストで、ユーザーのパスワードを保存するリージョン シークレットを選択します。シークレットがまだない場合は、[リージョン REGION に新しいシークレットを作成] を選択し、名前とパスワードを入力して、[シークレットを作成] をクリックします。シークレットは、インスタンスと同じリージョンに作成されます。
- 省略可: [シークレット バージョン] リストで、特定のバージョンを選択します。デフォルトでは latest が選択され、常に最新バージョンのシークレットが使用されます。
組み込みユーザーとリージョン シークレットの要件の詳細については、Cloud SQL for MySQL と Cloud SQL for PostgreSQL の Data API を使用して SQL ステートメントを実行するをご覧ください。
- [ユーザー] リストで、データベース ユーザーを選択します。リストを読み込めない場合は、[ユーザー] フィールドにユーザー名を入力します。Cloud SQL for MySQL では、デフォルトの
[保存] をクリックします。
Spanner
- SQL エディタで、[クエリ設定を開く] をクリックします。
- [データベース] を選択します。
- [Spanner] を選択します。
- インスタンスを選択します。クエリはこのインスタンスに転送されます。
- クエリするデータベースを選択します。
- [保存] をクリックします。
クエリの設定を変更する
クエリ設定は SQL ファイルごとに異なります。SQL ファイルを開いた後、設定を変更できます。
- エディタで、表示されているデータソースをクリックします。Query Settings エディタが表示されます。
- クエリの設定を構成するの手順を完了します。
クエリの実行
クエリファイルを作成してクエリを作成したら、[▷ クエリを実行] をクリックします。
[クエリ結果] ペインの [結果] タブに、クエリの結果が表示されます。
クエリエディタで SQL ステートメントのサブセットを実行するには、サブセットをハイライト表示してから、[▷ クエリを実行] をクリックします。
SQL エディタの機能
SQL エディタのすべての機能が、すべてのデータソース タイプでサポートされているわけではありません。次の表に、プレビュー期間中にデータソース タイプごとにサポートされている SQL エディタの機能を示します。
機能 |
BigQuery |
Bigtable |
Spanner |
Cloud SQL |
AlloyDB for PostgreSQL |
クエリ結果 |
✅ |
✅ |
✅ |
✅ |
✅ |
ジョブ情報 |
該当なし |
該当なし |
該当なし |
該当なし |
該当なし |
実行の詳細 |
✅ |
✅ 経過時間 |
❌ 非対応 |
❌ 非対応 |
❌ 非対応 |
可視化 |
✅ |
✅ |
✅ |
✅ |
✅ |
クエリの設定 |
✅ |
✅ |
✅ |
✅ |
✅ |
複数ステートメント クエリのサポート |
✅ |
✅ |
✅ |
✅ |
✅ |
カタログ: エディタにリソース名を挿入 |
✅ |
✅ |
✅ |
✅ |
✅ |