DynamoDB Toolbox 中使用时间戳作为排序键的最佳实践

概述

在使用 DynamoDB Toolbox 进行数据建模时，时间戳作为排序键是一个常见需求。本文将详细介绍如何正确配置时间戳字段作为排序键，并自动生成默认值。

核心问题

当我们需要将时间戳字段设置为表的排序键时，通常会遇到以下挑战：

1. 需要确保每次插入记录时自动生成时间戳
2. 需要保证时间戳字段在更新操作时不会被意外修改
3. 需要正确处理排序键的默认值生成

解决方案

基础配置

在 DynamoDB Toolbox 中，我们可以通过以下方式配置时间戳排序键：

const StoryEntity = new Entity({
  table: AppTable,
  name: "STORY",
  schema: {
    id: string().transform(prefix("STORY")).savedAs("pk").key(),
    created_at: string()
      .key()
      .savedAs("sk")
      .default(() => new Date().toISOString())
  },
  timestamps: false
});

关键配置解析

1. .key() 方法：将字段标记为键属性（分区键或排序键）
2. .default() 方法：为键属性设置默认值生成函数
3. timestamps: false：禁用内置的时间戳功能，避免冲突

高级配置选项

对于更复杂的需求，可以使用完整配置对象：

created_at: string({
  required: "always",
  defaults: {
    key: () => new Date().toISOString(),
    put: undefined,
    update: undefined
  },
  savedAs: "sk",
  key: true
})

这种配置方式可以：

• 确保在插入和更新时都保留原始时间戳
• 明确区分键默认值和其他操作的默认值
• 提供更细粒度的控制

注意事项

1. 对于排序键，建议将 required 设置为 "always"，确保在更新操作时不会意外丢失
2. 使用 ISO 8601 格式的时间戳可以确保正确的排序行为
3. 禁用内置时间戳功能可以避免与自定义时间戳字段冲突

总结

通过合理配置 DynamoDB Toolbox 的 schema 定义，我们可以轻松实现时间戳作为排序键的需求。关键在于正确使用 .key() 和 .default() 方法，并根据实际业务需求选择适当的配置方式。这种方法不仅简化了开发流程，还能确保数据的一致性和正确性。