通过 Unix 套接字使用 Python 连接到 Cloud SQL for PostgreSQL

使用 Unix 套接字建立与 Cloud SQL for PostgreSQL 实例的数据库连接。它利用 SQLAlchemy 库创建专门为 pg8000 驱动程序配置的连接引擎。该脚本从环境变量中检索必要的连接参数，例如数据库用户、密码、数据库名称和 Unix 套接字路径。此方法对于与 Cloud SQL 实例在同一 Google Cloud 区域中运行的应用特别有用，可提供一种安全高效的方式来与数据库通信，而无需为 TCP 连接配置 IP 许可名单。

深入探索

如需查看包含此代码示例的详细文档，请参阅以下内容：

代码示例

Python

如需向 Cloud SQL for PostgreSQL 进行身份验证，请设置应用默认凭据。如需了解详情，请参阅为本地开发环境设置身份验证。 

import os

import sqlalchemy


def connect_unix_socket() -> sqlalchemy.engine.base.Engine:
    """Initializes a Unix socket connection pool for a Cloud SQL instance of Postgres."""
    # Note: Saving credentials in environment variables is convenient, but not
    # secure - consider a more secure solution such as
    # Cloud Secret Manager (https://cloud.google.com/secret-manager) to help
    # keep secrets safe.
    db_user = os.environ["DB_USER"]  # e.g. 'my-database-user'
    db_pass = os.environ["DB_PASS"]  # e.g. 'my-database-password'
    db_name = os.environ["DB_NAME"]  # e.g. 'my-database'
    unix_socket_path = os.environ[
        "INSTANCE_UNIX_SOCKET"
    ]  # e.g. '/cloudsql/project:region:instance'

    pool = sqlalchemy.create_engine(
        # Equivalent URL:
        # postgresql+pg8000://<db_user>:<db_pass>@/<db_name>
        #                         ?unix_sock=<INSTANCE_UNIX_SOCKET>/.s.PGSQL.5432
        # Note: Some drivers require the `unix_sock` query parameter to use a different key.
        # For example, 'psycopg2' uses the path set to `host` in order to connect successfully.
        sqlalchemy.engine.url.URL.create(
            drivername="postgresql+pg8000",
            username=db_user,
            password=db_pass,
            database=db_name,
            query={"unix_sock": f"{unix_socket_path}/.s.PGSQL.5432"},
        ),
        # ...
    )
    return pool

后续步骤

如需搜索和过滤其他 Google Cloud 产品的代码示例，请参阅Google Cloud 示例浏览器。