奥罗拉 DSQL 节点张贴的连接器

Aurora DSQL 连接器用于节点-postgres是一个以节点为主的节点.js连接器 节点后置 用于连接 JavaScript/TypeScript 应用程序到 Amazon Aurora DSQL 集群的 IAM 认证.

Aurora DSQL 连接器被设计为一个认证插件,可以扩展该插件的功能 node-postgres的客户端和Pool,使应用程序能够使用IAM证书与Amazon Aurora DSQL认证.

关于连接器

Amazon Aurora DSQL是一个具有PostgreSQL相容性的云族分布式数据库. 虽然它需要IAM认证和有时间限制的符号,但传统的Node.js数据库驱动程序缺乏这种内置支持.

用于节点-postgres的Aurora DSQL Connector通过实施一个与节点-postgres无缝运行的认证中间软件来弥补这一缺口. 这种方法允许开发者在通过自动令牌管理获得基于IAM的安全访问Aurora DSQL集群的同时,维持其已存在的节点后置码.

什么是奥罗拉DSQL认证?

在Aurora DSQL中,认证涉及:

• IAM 认证 : 所有连接都使用基于 IAM 的有时间限制的符号认证
• 脚本生成 : 认证符使用 AWS 证书生成,并具有可配置的寿命

用于节点-postgres的Aurora DSQL连接器旨在理解这些要求,并在建立连接时自动生成IAM认证符.

特征

• 自动 IAM 认证 - 处理DSQL 令牌生成和刷新
• 建在节点上 - 为Node.js利用受欢迎的PostgreSQL客户端
• 无缝一体化 - 采用现有的节点后置连接模式
• 区域自动发现 - 从DSQL集群主机名中提取 AWS 区域
• 完整类型脚本支持 - 提供全套安全
• AWS 证书支持 - 支持各种 AWS 证书提供者(默认、基于配置文件、自定义)
• 连接集合兼容性 - 与内置连接集成无缝工作
• OCC 重试 - 自动重试,对乐观的货币冲突进行指数反转

示例应用程序

包含一个样本应用 实例 显示如何使用 Aurora DSQL 连接器进行节点连接。 要运行包含的例子,请参考示例 读取。 。 。 .

快速启动指南

所需资源

• 节点.js 20+
• 访问 Aurora DSQL 集群
• 设置适当的 IAM 权限允许您的应用程序连接到 Aurora DSQL.
• 配置 AWS 证书(通过 AWS CLI、环境变量或 IAM 角色)

重要吗

• 运行此代码可能导致向您的 AWS 账户收费 .
• 我们建议你给予你的代码最少的特权 最多只给予 执行任务所需的最小权限。 更多信息见 给予最少的特权。 。 。 .
• 这个代码并不是在每个AWS区域进行测试. 更多信息见 AWS 区域服务。 。 。 .

安装

npm install @aws/aurora-dsql-node-postgres-connector

同伴依赖关系

npm install @aws-sdk/credential-providers @aws-sdk/dsql-signer pg tsx
npm install --save-dev @types/pg

使用量

客户端连接

// src/index.ts
import { AuroraDSQLClient } from "@aws/aurora-dsql-node-postgres-connector";

const client = new AuroraDSQLClient({
  host: "<CLUSTER_ENDPOINT>",
  user: "admin",
});
await client.connect();
const result = await client.query("SELECT NOW()");
await client.end();

集合连接

// src/index.ts
import { AuroraDSQLPool } from "@aws/aurora-dsql-node-postgres-connector";

const pool = new AuroraDSQLPool({
  host: "<CLUSTER_ENDPOINT>",
  user: "admin",
  max: 3,
  idleTimeoutMillis: 60000,
});

const result = await pool.query("SELECT NOW()");

高级使用

// index.ts
import { fromNodeProviderChain } from "@aws-sdk/credential-providers";
import { AuroraDSQLClient } from "@aws/aurora-dsql-node-postgres-connector";

const client = new AuroraDSQLClient({
  host: "example.dsql.us-east-1.on.aws",
  user: "admin",
  customCredentialsProvider: fromNodeProviderChain(), // Optionally provide custom credentials provider
});

await client.connect();
const result = await client.query("SELECT NOW()");
await client.end();

OCC 重试

奥罗拉DSQL使用乐观的货币控制(OCC). 拒绝冲突的交易 输入错误代码的时间 OC000, (中文(简体) ), OC001,或 40001。连接器提供 transaction() 自动重复这些冲突的方法.

import { AuroraDSQLPool } from "@aws/aurora-dsql-node-postgres-connector";

const pool = new AuroraDSQLPool({
  host: "<CLUSTER_ENDPOINT>",
  user: "admin",
  retry: { maxRetries: 5 },
});

await pool.transaction(async (client) => {
  await client.query("INSERT INTO accounts(id, balance) VALUES($1, $2)", [1, 100]);
});

重试配置接受部分对象——未设置字段使用默认:

逐个调用覆盖 :

await pool.transaction(callback, { maxRetries: 0 }); // no retry for this call

配置选项

所有其他参数来自 客户端 编号 : 池头 被支持.

认证

连接器通过使用DSQL客户端符号生成器生成符来自动处理DSQL认证. 如果不提供AWS区域,它将从所提供的主机名中自动解析.

有关Aurora DSQL认证的更多信息,请参见: 用户指南。 。 。 .

管理员对正则用户

• 名为“ admin” 的用户自动使用管理员认证符
• 所有其他用户使用常规认证符
• 每个连接都动态生成插件

发展

# Install dependencies
npm install

# Build the project
npm run build

# Set a cluster for use in the tests
export CLUSTER_ENDPOINT=your-cluster.dsql.us-east-1.on.aws

# Run tests
npm run test

许可证

本软件以Apache 2.0许可发布.

版权:Amazon.com公司或其附属公司。 所有权利保留. SPDX - License - 标识符: Apache-2.0