AlloyDB for PostgreSQL Source

About

AlloyDB for PostgreSQL is a fully-managed, PostgreSQL-compatible database for demanding transactional workloads. It provides enterprise-grade performance and availability while maintaining 100% compatibility with open-source PostgreSQL.

If you are new to AlloyDB for PostgreSQL, you can create a free trial cluster.

Available Tools

{{< list-tools dirs="/integrations/postgres/tools" >}}

Pre-built Configurations

• AlloyDB using MCP Connect your IDE to AlloyDB using Toolbox.

• AlloyDB Admin API using MCP Create your AlloyDB database with MCP Toolbox.

Requirements

IAM Permissions

By default, AlloyDB for PostgreSQL source uses the AlloyDB Go Connector to authorize and establish mTLS connections to your AlloyDB instance. The Go connector uses your Application Default Credentials (ADC) to authorize your connection to AlloyDB.

In addition to setting the ADC for your server, you need to ensure the IAM identity has been given the following IAM roles (or corresponding permissions):

• roles/alloydb.client
• roles/serviceusage.serviceUsageConsumer

Networking

AlloyDB supports connecting over both from external networks via the internet (public IP), and internal networks (private IP). For more information on choosing between the two options, see the AlloyDB page Connection overview.

You can configure the ipType parameter in your source configuration to public or private to match your cluster's configuration. Regardless of which you choose, all connections use IAM-based authorization and are encrypted with mTLS.

Authentication

This source supports both password-based authentication and IAM authentication (using your Application Default Credentials).

Standard Authentication

To connect using user/password, create a PostgreSQL user and input your credentials in the user and password fields.

user: ${USER_NAME}
password: ${PASSWORD}

IAM Authentication

To connect using IAM authentication:

1. Prepare your database instance and user following this guide.
2. You could choose one of the two ways to log in:
   • Specify your IAM email as the user.
   • Leave your user field blank. Toolbox will fetch the ADC automatically and log in using the email associated with it.
3. Leave the password field blank.

Example

kind: source
name: my-alloydb-pg-source
type: alloydb-postgres
project: my-project-id
region: us-central1
cluster: my-cluster
instance: my-instance
database: my_db
user: ${USER_NAME}
password: ${PASSWORD}
# ipType: "public"

{{< notice tip >}} Use environment variable replacement with the format ${ENV_NAME} instead of hardcoding your secrets into the configuration file. {{< /notice >}}

Managed Connection Pooling

Toolbox automatically supports Managed Connection Pooling. If your AlloyDB instance has Managed Connection Pooling enabled, the connection will immediately benefit from increased throughput and reduced latency.

The interface is identical, so there's no additional configuration required on the client. For more information on configuring your instance, see the AlloyDB Managed Connection Pooling documentation.

Reference