本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
数据类注释
下表列出了可用于数据类的注释,并提供了指向本指南中信息和示例的链接。该表按注释名称的字母升序排序。
注释名称 | 注释适用于 1 | 作用 | 本指南中显示的位置 |
---|---|---|---|
DynamoDbAtomicCounter | 属性 2 | 每次向数据库写入记录时都会增加一个带标签的数字属性。 | 介绍和讨论。 |
DynamoDbAttribute | 属性 | 定义或重命名映射到 DynamoDB 表属性的 Bean 属性。 | |
DynamoDbAutoGeneratedTimestampAttribute | 属性 | 每次成功将项目写入数据库时,都使用当前时间戳更新已标记的属性 | 介绍和讨论。 |
DynamoDbAutoGeneratedUuid | 属性 | 向数据库写入新记录时,为属性生成一个唯一UUID(通用唯一标识符)。 | 介绍和讨论。 |
DynamoDbBean | class | 将数据类标记为可映射到表架构。 | 第一次是在“入门”部分的 Customer 类上使用。本指南中展示了几种用法。 |
DynamoDbConvertedBy | 属性 | 将自定义 AttributeConverter 与带注释的属性相关联。 |
初步讨论和示例。 |
DynamoDbFlatten | 属性 | 扁平化单独的 DynamoDB 数据类的所有属性,并将它们作为顶级属性添加到从数据库读取的记录和写入数据库的记录中。 | |
DynamoDbIgnore | 属性 |
导致属性保持未映射状态。 |
|
DynamoDbIgnoreNulls | 属性 | 防止保存嵌套 DynamoDb 对象的空属性。 | 讨论和示例。 |
DynamoDbImmutable | class |
将不可变数据类标记为可映射到表架构。 |
|
DynamoDbPartitionKey | 属性 |
将属性标记为 DynamoDb表的主分区键(哈希键)。 |
|
DynamoDbPreserveEmptyObject | 属性 |
如果映射到带注释的属性的对象没有数据,则指定应使用所有空字段初始化该对象。 |
讨论和示例。 |
DynamoDbSecondaryPartitionKey | 属性 |
将属性标记为全局二级属性的分区键。 |
|
DynamoDbSecondarySortKey | 属性 |
将属性标记为全局或本地二级索引的可选排序键。 |
|
DynamoDbSortKey | 属性 |
将属性标记为可选的主排序键(范围键)。 |
|
DynamoDbUpdateBehavior | 属性 |
指定作为 “更新” 操作的一部分更新此属性时的行为,例如 UpdateItem。 |
简介和示例。 |
DynamoDbVersionAttribute | 属性 | 递增项目版本号。 | 介绍和讨论。 |
1 你可以对 getter 或 setter 应用属性级注释,但不能同时应用两者。本指南显示了 getter 上的注释。
2 该术语property
通常用于封装在数据类中的值。 JavaBean 但是,为了与 DynamoDB 使用的术语保持一致,本指南(英文版)改用术语 attribute
。(中文版中,两者的翻译均为“属性”。)