DynamoDB-Toolbox

DynamoDB-Toolbox

快速入门   •   文档   •   赞助   •   DynamoDB-Toolshack

---

💖 衷心感谢帮助我维护此仓库的赞助者：

功能

DynamoDB-Toolbox 是 DocumentClient 的轻量级抽象层，让你的 DynamoDB 之旅 ✨轻松愉快✨

🤗 更简单的查询：DynamoDB-Toolbox 帮你处理构建那些复杂 DynamoDB 请求的繁重工作，让代码更清晰、更简洁、更易维护。

📐 数据验证：写入和读取的项目都会根据你的架构进行验证，确保数据的一致性和代码的可靠性。

✨ 丰富的架构语法，支持默认值、组合、转换和多态等各类边缘情况。

🔄 可移植性：架构可从 Zod 和 JSON Schema 导入，也可导出到这两种格式，同时保留类型推断。

🌈 将类型安全发挥到极致：通过即时反馈和流畅的自动补全提升开发效率。

🌴 支持 Tree-shaking：只导入你需要的内容。

☝️ 单表设计：DynamoDB-Toolbox 让在同一张表中查询多个实体变得极其简单，当然，用于多张表也同样得心应手。

🪶 兼容 LLRT：DynamoDB-Toolbox 没有依赖，可用于 LLRT 函数。

查看 👉 官方文档 👈，立即开始！

提示

想让你的代码发挥更大作用？试试 DynamoDB-Toolshack 🙌

DynamoDB-Toolshack 是一款 SaaS，可连接到 DynamoDB-Toolbox，通过支持架构的 UI、表一致性检查和迁移系统，提升你的 DynamoDB 使用体验。

加入 Beta 版，只需点击几下即可开始使用！

为什么使用 DynamoDB-Toolbox？

如果你来到这里，我们认为你已经了解 DynamoDB。

如果还不了解，请查看 AWS 官方文档。

简而言之：DynamoDB 是一款键值型数据库，专为运行高性能应用而设计，可支持任意规模。它会根据当前流量自动扩缩容，无需维护连接，因此成为许多项目（包括但不限于无服务器应用）的首选数据库。

如果你用过官方的 Document Client，就会知道用起来很痛苦。

看看这个直接来自 AWS 文档的 UpdateCommand 示例：

await documentClient.send(
  new UpdateCommand({
    TableName: 'Music',
    Key: {
      // 👇 No type-safety on the Primary Key
      artist: 'Acme Band',
      songTitle: 'Happy Day'
    },
    // 👇 Complex string expressions (+ still no type-safety)
    UpdateExpression: 'SET #Y = :y, #AT = :t',
    // 👇 Attribute names provided separately
    ExpressionAttributeNames: {
      '#AT': 'albumTitle',
      '#Y': 'year'
    },
    // 👇 Attribute values as well
    ExpressionAttributeValues: {
      // 👇 No validation or type-safety to enforce DB schema
      ':t': 'Louder Than Ever',
      ':y': '2015'
    },
    ReturnValues: 'ALL_NEW'
  })
)

这是一个非常简单的示例（更新 Music 项目的两个字段），但已经很复杂了 😰

随着数据变得更复杂，情况只会更加棘手：如果项目有很多属性，其中一些还是嵌套很深或可选的，该怎么办？如果你需要根据项目的值为其建立索引，或处理不同类型的项目呢？多态又该如何处理？

在这些相当常见的情况下，生成这些请求所需的代码会变得非常难以维护。这时，DynamoDB-Toolbox 就能帮上忙 💪

下面快速预览一下使用 DynamoDB-Toolbox 实现上述 UpdateCommand 的方式：

// Validated AND type-safe syntax 🙌
await MusicEntity.build(UpdateItemCommand)
  .item({
    artist: 'Acme Band',
    songTitle: 'Happy Day',
    albumTitle: 'Louder Than Ever',
    year: '2015'
  })
  .options({ returnValues: 'ALL_NEW' })
  .send()

就这样，我们把晦涩难懂的 20 行代码，变成了清晰优雅的 10 行代码 🤩

还不错吧？开始使用吧！

成为赞助者！