跳转到主要内容

AWS Aurora Serverless 数据API的Python DB-API 2.0客户端。这是一个临时包,允许通过SQLAlchemy URI传递凭据

项目描述

安装

pip install aurora-data-api

先决条件

  • 设置一个AWS Aurora Serverless集群并为它启用数据API访问。如果您之前已设置Aurora Serverless集群,可以使用以下AWS CLI命令启用数据API

    aws rds modify-db-cluster --db-cluster-identifier DB_CLUSTER_NAME --enable-http-endpoint --apply-immediately
  • 使用数据API预期的格式(包含usernamepassword键的JSON对象)将数据库凭据保存在AWS Secrets Manager

    aws secretsmanager create-secret --secret-id rds-db-credentials/MY_DB
    aws secretsmanager put-secret-value --secret-id rds-db-credentials/MY_DB --secret-string "$(jq -n '.username=env.PGUSER | .password=env.PGPASSWORD')"
  • 使用标准AWS约定配置您的AWS命令行凭据。您可以通过运行AWS CLI中的测试查询来验证一切是否正确工作

    aws rds-data execute-statement --resource-arn RESOURCE_ARN --secret-arn SECRET_ARN --sql "select * from pg_catalog.pg_tables"
    • 在这里,RESOURCE_ARN指的是Aurora RDS数据库ARN,可以在AWS RDS控制台(点击您的数据库,然后“配置”)或通过运行aws rds describe-db-clusters在CLI中找到。SECRET_ARN指的是上面创建的AWS Secrets Manager密钥。

    • 在运行已部署的代码(在EC2实例、ECS/EKS容器或Lambda中)时,您可以使用管理的IAM策略AmazonRDSDataFullAccess来授予您的IAM角色访问RDS数据API的权限(尽管此策略方便测试,但我们建议您为生产应用程序创建自己的范围受限的最小权限策略)。

用法

就像使用任何与DB-API兼容的驱动模块一样使用此模块。 aurora_data_api.connect() 方法是标准的主要入口点,并接受两个特定实现的键控参数

  • aurora_cluster_arn(在数据API文档中也称为resourceArn

    • 如果没有作为键控参数提供,也可以使用 AURORA_CLUSTER_ARN 环境变量来指定

  • secret_arn(数据库凭证的秘密)

    • 如果没有作为键控参数提供,也可以使用 AURORA_SECRET_ARN 环境变量来指定

import aurora_data_api

cluster_arn = "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-serverless-cluster"
secret_arn = "arn:aws:secretsmanager:us-east-1:123456789012:secret:rds-db-credentials/MY_DB"
with aurora_data_api.connect(aurora_cluster_arn=cluster_arn, secret_arn=secret_arn, database="my_db") as conn:
    with conn.cursor() as cursor:
        cursor.execute("select * from pg_catalog.pg_tables")
        print(cursor.fetchall())

游标支持迭代(并自动在服务器端游标中包装查询,如果需要,则进行分页)

with conn.cursor() as cursor:
    for row in cursor.execute("select * from pg_catalog.pg_tables"):
        print(row)

动机

RDS数据API是AWS Lambda无服务器环境和由PostgreSQL和MySQL提供的复杂功能之间的链接。数据API通过HTTP隧道传输SQL,在AWS Lambda的上下文中具有优势

  • 它消除了打开数据库端口到AWS Lambda公共IP地址池的需求

  • 它使用无状态的HTTP连接,而不是大多数数据库驱动程序使用的有状态的内部TCP连接池(有状态的池在经过AWS Lambda冻结-解冻周期后变得无效,导致连接错误,并使数据库服务器负担废弃的无效连接)

  • 它使用AWS基于角色的身份验证,消除了Lambda直接处理数据库凭证的需求

许可协议

根据Apache License,版本2.0授权。

https://travis-ci.org/chanzuckerberg/aurora-data-api.png https://codecov.io/github/chanzuckerberg/aurora-data-api/coverage.svg?branch=master https://img.shields.io/pypi/v/aurora-data-api.svg https://img.shields.io/pypi/l/aurora-data-api.svg https://readthedocs.org/projects/aurora-data-api/badge/?version=latest

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

preset-aurora-data-api-0.2.8.tar.gz (28.6 kB 查看散列

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面