Skip to main content

Set up AlloyDB for PostgreSQL

Configure authentication and connection settings for your AlloyDB (PostgreSQL) cluster to enable Atlan to crawl metadata and establish a secure connection.

Prerequisites​

Before you begin, make sure you have:

  • AlloyDB for PostgreSQL cluster and instance running in Google Cloud
  • Database administrator access to create users and grant permissions
  • Ability to run setup statements for each database and schema you want to crawl

Configure authentication​

Choose the authentication method that best fits your security requirements and infrastructure setup.

Create a username and password as described in the AlloyDB documentation for managing users and roles.

Create database role​

Create a dedicated role for Atlan and grant the necessary permissions to crawl metadata from your AlloyDB instance.

  1. Connect to your database instance (for example, using psql through the AlloyDB connectors or proxy) and run the following command to create the role:

    CREATE ROLE atlan_user_role;

  2. To crawl metadata from AlloyDB (PostgreSQL), Atlan requires USAGE privileges on the schemas. This permission enables Atlan to access schema objects and fetch technical metadata from the INFORMATION_SCHEMA.

    GRANT USAGE ON SCHEMA <schema> TO atlan_user_role;
    • Replace <schema> with the schema name to grant access. Repeat the GRANT statement for each additional schema you want Atlan to crawl.

  3. To preview and query data within Atlan's Insights module, grant SELECT privilege:

    GRANT SELECT, REFERENCES ON ALL TABLES IN SCHEMA schema_name TO atlan_user_role;
    • Replace schema_name with the name of the schema you want Atlan to access.
    • Replace atlan_user_role with the role assigned to Atlan in your database.

Assign role to users​

After you create the user (built-in or IAM-based) and the database role, assign the role to the user:

GRANT atlan_user_role TO <username>;
  • Replace <username> with the username you want to assign roles to.

Next steps​