Manage context sets in AlloyDB Studio

This document describes how to create context sets in AlloyDB for PostgreSQL Studio using a context set file. Context set names must be unique within a project.

To learn about context sets, see Context sets overview.

Before you begin

Complete the following prerequisites before creating an agent.

Enable required services

Enable the following services for your project:

Prepare an AlloyDB for PostgreSQL cluster, instance, and database

Make sure that you have access to an existing AlloyDB cluster and instance or create a new one.
This tutorial requires you to have a database in your AlloyDB instance. For more information, see Create a database.

Required roles and permissions

  • Add an Identity and Access Management (IAM) user or service account to the cluster at the database level. For more information, see Manage database users.
  • Grant the alloydb.databaseUser, the serviceusage.serviceUsageConsumer, and the geminidataanalytics.queryDataUser roles to the IAM user at the project level. For more information, see Add IAM policy binding for a project.
  • To create, upload, and manage context sets, grant the Dataplex Catalog Editor (roles/dataplex.catalogEditor) or Dataplex Catalog Admin (roles/dataplex.catalogAdmin) role to the IAM user at the project level. For more information, see Context sets permissions.

Grant executesql permission to AlloyDB for PostgreSQL instance

To grant the executesql permission to the AlloyDB for PostgreSQL instance and set the data_api_access instance setting to the value ALLOW_DATA_API, use the following curl command: 
   curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json" \
     https://alloydb.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/clusters/CLUSTER_ID/instances/INSTANCE_ID?updateMask=dataApiAccess \
     -d '{
       "dataApiAccess": "ENABLED",
     }'
Replace the following:
  • PROJECT_ID: The ID of your Google Cloud project.
  • LOCATION: The region where your AlloyDB cluster is located.
  • CLUSTER_ID: The ID of your AlloyDB cluster.
  • INSTANCE_ID: The ID of your AlloyDB instance.
To perform steps in this tutorial, sign in to Google Cloud, and then authenticate to the database using IAM authentication.

Create a context set

To create a context set, perform the following steps:

  1. In the Google Cloud console, go to the AlloyDB page.

    Go to AlloyDB

  2. Select a cluster from the list.

  3. In the navigation menu, click AlloyDB Studio.

  4. Sign in to Studio using IAM authentication.

  5. In the Explorer pane, next to Context sets, click View actions.

  6. Click Create context set.

  7. In Context set name, provide a unique context set name. The context set name is case-sensitive and can contain letters, numbers, hyphens, and underscores. Names must be 4-30 characters.

    The context set ID is derived from the context set name but is not necessarily identical. For the context set ID, the context set name is converted to lowercase and non-alphanumeric characters are replaced with the - character. For example, the context set name querydata_e2e_test has the context set ID querydata-e2e-test.

  8. Optional. In Context set description, add a description for your context set.

  9. Optional. To upload a context set file, click Browse in the Upload context set file section, and select the context set file.

  10. Click Create.

Build context sets

After creating a context set, follow the steps in Build contexts using Gemini CLI to create a context set file. You can then edit your context set to upload the context set file.

Edit a context set

To edit a context set, perform the following steps:

  1. In the Google Cloud console, go to the AlloyDB page.

    Go to AlloyDB

  2. Select a cluster from the list.

  3. In the navigation menu, click AlloyDB Studio.

  4. Sign in to Studio using IAM authentication.

  5. Click View actions next to the context set you want to edit.

  6. Click Edit context set.

  7. Optional. Edit Context set description.

  8. Click Browse in the Upload context set file section, and select the context set file.

  9. Click Save.

Delete a context set

To delete a context set, perform the following steps:

  1. In the Google Cloud console, go to the AlloyDB page.

    Go to AlloyDB

  2. Select a cluster from the list.

  3. In the navigation menu, click AlloyDB Studio.

  4. Sign in to Studio using IAM authentication.

  5. Click View actions next to the context set you want to delete.

  6. Click Delete context set.

  7. In the Delete context set confirmation dialog, enter the ID of the context set.

  8. Click Confirm to delete the context set.

What's next