前言
在开发 Web 应用程序时,数据库是不可避免的一部分。而使用 TypeORM 作为 ORM 工具可以帮助我们更轻松地与数据库进行交互。TypeORM 的官方文档中支持大量关系型数据库,但却没有针对 Amazon Aurora Serverless 数据库提供驱动。本篇文章将介绍如何使用 npm 包 typeorm-aurora-data-api-driver
驱动 TypeORM 连接 Aurora Serverless 数据库。
准备工作
在开始使用 typeorm-aurora-data-api-driver
之前,需要先对其进行安装。打开终端并输入以下命令即可:
npm install typeorm-aurora-data-api-driver reflect-metadata
此外,在使用该包前,还需要确认以下内容:
- 拥有 Amazon 关系型数据库服务(RDS)帐户。
- 已启用并配置了 Amazon RDS 的 Aurora Serverless 数据库集群。
- 已准备好 cluster endpoint,用于将您的应用程序连接到您的 Aurora Serverless 数据库集群。
使用方法
根据 typeorm-aurora-data-api-driver
的文档,只需简单几步即可启用此驱动程序。下面我们一步步来实现。
第一步:创建 TypeORM 配置
在项目中的 ormconfig.json
文件中,我们需要配置连接到 Aurora Serverless 数据库集群所需的信息。以下是一个示例配置:
-- -------------------- ---- ------- - ------- ------------------ --------- ------------ ------------ --------------- -------------- ----------------- ----------- ------------------ -------------- ----- ----------- - --------------------------- - -
其中,我们需要填写以下必要字段:
type
: 指定数据库类型,此处填写aurora-data-api
。region
: 数据库所在的 AWS 区域。secretArn
: 数据库的凭证 ARN(Amazon 资源名称),用于在您的应用程序中使用 IAM role 访问 Amazon RDS 数据库。resourceArn
: 数据库集群的 ARN。database
: 数据库名称。synchronize
: 是否进行数据库实体同步。entities
: 数据库实体所在的路径。
第二步:配置 AWS 访问凭证
在使用驱动程序之前,我们需要对 AWS 的访问凭证进行配置,以便允许应用程序访问 Aurora Serverless 数据库集群。以下是一个示例代码:
import { RdsData } from 'aws-sdk'; const client = new RdsData({ region: 'eu-west-1', // 数据库所在的 AWS 区域。 accessKeyId: 'your-access-key-id', secretAccessKey: 'your-secret-access-key', });
第三步:创建数据库实体
在 TypeORM 中,数据库实体用于映射对象模型(ORM)到数据库表。以下是一个示例代码:
-- -------------------- ---- ------- ------ - ------- ------- ---------------------- - ---- ---------- --------- ------ ----- ------- - ------------------------- --- ------- --------- ----- ---------- ------- --- -- ----- ------- --------- ----- ----- -- ------ ------- --------- ----- ---------- ------- ---- --------- ---- -- ------------ ------- --------- ----- ----------- -------- -- -- ------------------- -- ---------- ----- --------- ----- ----------- -------- -- -- -------------------- --------- ------------------- -- ---------- ----- -
第四步:初始化 TypeORM
在使用 typeorm-aurora-data-api-driver
驱动程序之前,我们需要启用 TypeORM 并传入配置项。以下是一个示例代码:
-- -------------------- ---- ------- ------ - ---------------- - ---- ---------- ------ - ------- - ---- ------------------- ------------------ ----------- ------------ -- - -- -------- ----- ------------------------- -- -------- ----- ------- - --- ---------- ------------ - -------- ----- ------------- - ----- ------------------- - -- -------- ---------- ----- --------------------------------- -- -------- ----- ------------------- -- -------------- -- --------------------
在上面的示例代码中,我们通过 createConnection()
方法创建数据库连接。之后进行实体同步和数据库操作,并最后关闭数据库连接。
结论
本文介绍了如何使用 npm 包 typeorm-aurora-data-api-driver
驱动 TypeORM 连接到 Aurora Serverless 数据库。通过了解这个过程,您可以更加轻松地使用此包来操作您的数据库。希望这篇文章对您有所帮助!
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5eedb66bb5cbfe1ea061152a