跳到主要内容

主键生成

主键策略​

策略本数据源的用法
手工赋值映射主键作为 _id；省略时可能自动生成 ID。
自增不提供数值型自增主键；文档 ID 的生成与回填使用下文方式。
UUID字符主键使用 UUID32 或 UUID36。
序列不提供序列主键策略。
自定义可在插入前生成业务 ID；回调不能读取数值型自增主键。

使用自动生成 ID​

POST 请求不带文档 ID 时，Elasticsearch 生成 _id；它与 _source 中的 id、uid 等业务字段不是一回事。

UserInfo 提供可写的 String id 属性，下面的 Mapper 配置会在插入后回填该属性：

@Insert(value = "POST /user_info/_doc {\"name\": #{name}}",
        useGeneratedKeys = true, keyProperty = "id")
int insert(UserInfo item);

调用 mapper.insert(item) 后，通过 item.getId() 读取主键。这里使用单个实体参数，不额外加 @Param 包装。

注意

生成键列名为 _ID。需要指定 keyColumn 时使用 _ID，接收属性使用 String；Elasticsearch 不生成数值型自增主键。

使用已有 ID​

由应用指定 ID 时，将它放到请求路径中：

jdbc.executeUpdate(
        "PUT /user_info/_doc/{?}?refresh=wait_for {\"name\": ?}",
        new Object[] { "1001", "mali" });

相同文档 ID 再次写入会覆盖文档内容；只改部分字段使用 _update。

使用构造器 API 或 BaseMapper 时，已赋值的单个映射主键会同时作为 Elasticsearch 的 _id。未标记为主键的业务字段不影响 _id。

没有提供 ID 时，Elasticsearch 可以自动生成 _id，不会按关系表的“主键不能为空”约束拒绝写入。业务要求自行编号时，应在调用前检查 ID 是否已赋值。

插入策略同一主键已存在时
Into（默认）报主键冲突错误。
Ignore跳过该条，返回 0；其他错误仍抛出。
Update文档存在时只更新本次提供的字段；不存在时新增文档。

自定义主键生成器​

可以在 beforeApply 中生成业务编号并赋给实体，然后随插入请求写入。afterApply 回调也可使用，但 Elasticsearch 不提供数值型自增主键，不能用它回读这类编号。

例如，订单号由应用在插入前分配；若需要 Elasticsearch 自动生成的字符串 _id，使用上面的自动生成 ID。自定义生成器的配置见主键生成器。

选择回填来源​

方法注解和 Mapper 文件均使用 useGeneratedKeys，保持默认回填来源。生成键和命令本身的结果集不是同一个结果；这里的插入不要设置 generatedKeySource="resultSet"。

上面的例子展示了可用的生成键回填方式；需要指定返回列时使用 keyColumn。