Query your data

Google Cloud Data Agent Kit extension for Visual Studio Code unified SQL editor lets you run SQL queries against your Google Cloud data directly within Visual Studio Code.

Supported data sources

The extension lets you query tables and views in the following Google Cloud data services:

  • BigQuery
  • Spanner
  • AlloyDB for PostgreSQL
  • Cloud SQL for MySQL
  • Cloud SQL for PostgreSQL

For AlloyDB and Cloud SQL, queries using IAM authentication are supported. You can't query databases configured to use Auth Proxy or password-based authentication.

Before you begin

Before querying your data, do the following:

  1. Install the extension
  2. Configure extension settings.
  3. Review the guidance at Find and explore data.

Create a new SQL file

You can open the SQL editor in multiple ways.

Create a new SQL file from the File menu

  1. In the VS Code menu bar, click File and then New Text File. An untitled file appears in the editor.
  2. Save the new file with the .sql extension.
  3. Click Select Connection in the editor tab.
  4. Complete the steps in Configure query settings.

Create a new query from the Catalog

  1. In the Google Cloud Data Agent Kit tab in the activity bar, expand Catalog to find the dataset that you want to query.
  2. Right-click or ctrl+click the name of the dataset and then select Query to open a new SQL file preconfigured for that dataset.

Create a new query from the BigQuery section

  1. In the Google Cloud Data Agent Kit tab in the activity bar, expand BigQuery.
  2. Click + New Query. An untitled SQL file configured with BigQuery as its data source appears in the editor.

Configure query settings

The settings required for your SQL query vary by Google Cloud service.

AlloyDB

  1. In the SQL editor, click Open Query Settings.
  2. Select Databases.
  3. Select AlloyDB.
  4. Select a cluster.
  5. Select an instance. Your query is routed to this instance.
  6. Select a database.
  7. Click Save.

BigQuery

  1. In the SQL editor, click Open Query Settings.
  2. Select BigQuery.
  3. Click Save.

Cloud SQL

  1. In the SQL editor, click Open Query Settings.
  2. Select Databases.
  3. Select Cloud SQL.
  4. Select an instance. Your query is routed to this instance.
  5. Select a database to query.
  6. Click Save.

Spanner

  1. In the SQL editor, click Open Query Settings.
  2. Select Databases.
  3. Select Spanner.
  4. Select an instance. Your query is routed to this instance.
  5. Select a database to query.
  6. Click Save.

Change query settings

Query settings are specific to each SQL file. After you open a SQL file, you can change the settings.

  1. In the editor, click the displayed data source. The Query Settings editor appears.
  2. Complete the steps in Configure query settings.

Run a query

After you have created a query file and composed your query, click ▷ Run Query.

The Results tab of the Query Results pane shows the query results.

To run a subset of the SQL statements in the query editor, highlight the subset before clicking ▷ Run Query.

SQL editor features

Not all SQL editor features are supported for every data source type. The following table lists the SQL editor features that are supported per data source type during the Preview.

Feature

BigQuery

Spanner

Cloud SQL

AlloyDB for PostgreSQL

Query results pane tabs

Query results

✅

✅

✅

✅

Job information

✅

Not applicable

Not applicable

Not applicable

Execution details

✅

❌

Not supported

❌

Not supported

❌

Not supported

Visualization

✅

✅

✅

✅

SQL editor configuration

Query settings

✅

✅

✅

✅

Additional features

Multi-statement query support

✅

✅

✅

✅

Catalog: Insert resource name in editor

✅

✅

✅

✅

What's next