Create and manage saved queries

Stay organized with collections Save and categorize content based on your preferences.

This page describes how to create and manage saved queries. When you write SQL scripts in Spanner Studio, you can save and manage those SQL scripts. For information, see Saved queries overview.

The saved queries capability is available only in the Google Cloud console.

Required roles

To get the permissions that you need to use saved queries, ask your administrator to grant you the following IAM roles on the project:

• To create and delete saved queries: Studio Query User (roles/databasesConsole.studioQueryUser)
• To manage all saved queries in a project, including access to the Saved queries page: Studio Query Admin (roles/databasesConsole.studioQueryAdmin)

For more information about granting roles, see Manage access to projects, folders, and organizations.

These predefined roles contain the permissions required to use saved queries. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to use saved queries:

• To create and delete saved queries:
  • databasesConsole.studioQuery.create
  • databasesConsole.studioQuery.update
  • databasesConsole.studioQuery.delete
  • databasesConsole.studioQuery.search
• To manage all saved queries in a project:
  • databasesConsole.studioQuery.create
  • databasesConsole.studioQuery.update
  • databasesConsole.studioQuery.delete
  • databasesConsole.studioQuery.search
  • databasesConsole.studioQuery.list
  • databasesConsole.studioQuery.get

You might also be able to get these permissions with custom roles or other predefined roles.

The Studio Query User (roles/databasesConsole.studioQueryUser) role provides create, view, and write saved queries access. It is sufficient for most users.

The Studio Query Admin (roles/databasesConsole.studioQueryAdmin) role should only be granted to administrators. For more information about Spanner Identity and Access Management (IAM), see IAM overview.

Permissions

To create saved queries, you need the following IAM permissions at the project level:

• databasesConsole.locations.get
• databasesConsole.locations.list
• databasesConsole.studioQueries.create

To view saved queries, you need the following permission at the project level:

• databasesConsole.studioQueries.search

To modify and delete saved queries, you need the following permission at the project level:

• databasesConsole.studioQueries.update

Permissions to execute queries are inherited from the database. It's possible that you might have permissions to view, but not execute a query.

Create a saved query

To create a saved query, follow these steps:

1. Go to the Spanner Instances page in the Google Cloud console.

   Instances

2. Select the instance in which you want to create a saved query.

3. Select the database in which you want to create a saved query.

4. In the navigation menu, click Spanner Studio.

   1. On the Spanner Studio page, click add New tab or use the empty editor tab.

5. In the query editor, enter a valid SQL query.

6. Click Save.

7. In the Save query dialog, type a name for the saved query.

8. Click Save.

Open and run a saved query

To open an existing saved query as a new query, follow these steps:

1. On the Spanner Studio page, click add New tab or use the empty editor tab.
2. In the Explorer pane, navigate to the Queries section. Click a saved query to open it in a new editor tab. Alternatively, click more_vert View actions next to a saved query. Then, click Open query to open it in a new editor tab.
3. Click Run.

Update a saved query

To update an existing saved query, follow these steps:

1. On the Spanner Studio page, click add New tab or use the empty editor tab.
2. In the Explorer pane, navigate to the Queries section. Click a saved query to open it in a new editor tab. Alternatively, click more_vert View actions next to a saved query. Then, click Open query to open it in a new editor tab.
3. Modify the query.
4. To save the modified query, click Save.

View and manage a list of all saved queries

To view a list of all saved queries in your project, follow these steps:

1. Go to the Spanner Instances page in the Google Cloud console.

   Instances

2. Select any instance. (Because a saved query is a child of a project, as long as you have the required role, you can view all saved queries in the project from any instance or database.)

3. Select any database.

4. On the Spanner Studio page, click add New tab or use the empty editor tab.

5. In the Explorer pane, navigate to the Queries section. Click more_vert View actions next to a saved query. Then, click Manage queries.

   The Saved queries page opens. It lists all the saved queries in this project (including saved queries for other Google Cloud products).

You can search, filter, view, and delete queries on the Saved queries page. You can't edit an existing query on the Saved queries page.

To delete a saved query on the Saved queries page, follow these steps:

1. Click more_vert View actions next to the saved query that you want to delete.
2. Click Delete query to delete the saved query.
3. In the Delete query dialog, click Delete.

Delete a saved query

1. On the Spanner Studio page, click add New tab or use the empty editor tab.
2. In the Explorer pane, expand the Queries folder. Click more_vert View actions next to the saved query that you want to delete. Then click Delete query to delete the saved query.
3. In the Delete query dialog, click Delete.

What's next

• Learn about saved queries.