Skip to content

Commit

Permalink
ok
Browse files Browse the repository at this point in the history
  • Loading branch information
xpc committed Jan 26, 2024
1 parent d86b575 commit 5deb7af
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
29 changes: 20 additions & 9 deletions docs/10.v2.x文档/010.快速入门/080.注解.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ permalink: /pages/ac41f0/

> 注解类包源码:👉 [easy-es-annotation](https://gitee.com/dromara/easy-es/tree/master/easy-es-annotation)
## [@EsMapperScan](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/EsMapperScan.java)
## [@EsMapperScan](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/EsMapperScan.java)

- 描述:mapper扫描注解,功能与MP的@MapperScan一致

Expand All @@ -29,7 +29,7 @@ public class Application{

:::

## [@IndexName](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexName.java)
## [@IndexName](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexName.java)

- 描述:索引名注解,标识实体类对应的索引 对应MP的@TableName注解,在v0.9.40之前此注解为@TableName.

Expand Down Expand Up @@ -74,7 +74,7 @@ public class Document {
- WAIT_UNTIL 请求提交数据后,等待数据完成刷新(约1s),再结束请求 性能损耗适中 属于折中方案
:::

## [@IndexId](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexId.java)
## [@IndexId](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexId.java)

- 描述:ES主键注解
- 使用位置:实体类中被作为ES主键的字段, 对应MP的@TableId注解
Expand Down Expand Up @@ -104,7 +104,7 @@ public class Document {
:::


## [@IndexField](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexField.java)
## [@IndexField](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/IndexField.java)

- 描述:ES字段注解, 对应MP的@TableField注解
- 使用位置:实体类中被作为ES索引字段的字段
Expand Down Expand Up @@ -189,7 +189,7 @@ public class Document {
其中场景四和场景五仅在索引自动托管模式下生效,如果开启了手动处理索引模式,则需要用户通过手动调用我提供的API传入相应的分词器及日期格式化参数进行索引的创建/更新.
:::

## [@MultiIndexField](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/MultiIndexField.java)
## [@MultiIndexField](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/MultiIndexField.java)

- 描述:多字段注解
- 使用位置:实体类中单个字段期望用多种分词器或多种字段类型的字段上
Expand All @@ -200,7 +200,7 @@ public class Document {
|mainIndexField|@IndexField||-|主字段必须指定,用法可以参考上面的@IndexField|
|InnerIndexField|@InnerIndexField[]||{}|内部字段,可以为空数组,当内部字段不指定时,则此注解降级为@IndexField,与@IndexField注解效果一致|

## [@InnerIndexField](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/InnerIndexField.java)
## [@InnerIndexField](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/InnerIndexField.java)

- 描述:内部字段注解
- 使用位置:@MultiIndexField内部
Expand Down Expand Up @@ -246,7 +246,7 @@ public class Document {
> 上述使用案例中,开启了驼峰自动转下划线,因此字段名为"multi_field",实际上在查询中用户只需要用"字段名.suffix"组合,即可确定当前启用哪个内部字段,当查询主字段时,则无需指定suffix,直接字段名即可.

## [@HighLight](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/HighLight.java)
## [@HighLight](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/HighLight.java)

- 描述:高亮注解
- 使用位置:实体类中需要高亮的被查询字段
Expand All @@ -262,7 +262,7 @@ public class Document {
|highLightType|HighLightTypeEnum||UNIFIED|高亮类型|


## [@Score](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/Score.java)
## [@Score](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/Score.java)

- 描述:得分注解
- 使用位置:实体类中被作为ES查询得分返回的字段
Expand All @@ -273,7 +273,7 @@ public class Document {
|decimalPlaces|int||0|得分保留小数位,默认不处理,保持es返回的得分值|


## [@Distance](https://gitee.com/dromara/easy-es/blob/mastereasy-es-annotation/src/main/java/org/dromara/easyes/annotation/Distance.java)
## [@Distance](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/Distance.java)

- 描述:距离注解
- 使用位置:实体类中被作为ES地理位置排序距离值的返回字段
Expand All @@ -283,6 +283,17 @@ public class Document {
|---|---|---|---|---|
|decimalPlaces|int||0|距离保留小数位,默认不处理,保持es返回的距离值|

## [@EsDS](https://gitee.com/dromara/easy-es/blob/master/easy-es-annotation/src/main/java/org/dromara/easyes/annotation/EsDS.java)

- 描述:多数据源注解
- 使用位置:继承自BaseEsMapper的自定义的Mapper
- 使用场景举例:比如有多个ES,想让不同的Mapper连不同的ES,用法和Mybatis-Plus中的@DS是一样的
- 更多使用介绍可前往核心功能 -> 多数据源支持 章节进行学习

| 属性 | 类型 | 必须指定|默认值 | 描述 |
|-------|--------|---|---|------------------|
| value | String ||""| 数据源名称,与配置文件中指定的一致 |


## 其它注解

Expand Down
2 changes: 1 addition & 1 deletion docs/whats new/090.whats new in v2.0.0-beta.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ permalink: /pages/2934a3/
- 提供多数据源功能(重大特性),此功能由社区Liyy贡献,老汉合并并优化
- 提供https连接ES方式,可免SSL验证,此功能由社区开发者"杨忠成"贡献并验证,老汉合并并优化
- @IndexField新增dense_vector和dims指定,并兼容各种索引模式自动创建,以此支撑向量类型数据检索 由社区zhangsan@alona贡献,老汉合并并优化
- 提供小黑子模式,提升编码趣味性,默认关闭,可通过配置开启,仅供娱乐,切勿用户其它用途,后果自负...
- 提供小黑子模式,提升编码趣味性,默认关闭,可通过配置开启,仅供娱乐,切勿用于其它用途,后果自负...
- 修复#I7T1A6 bete4引入的实体类不加@IndexName注解时出现NPE问题
- 修复#I8XZGP @MultiField标记的场景下,高亮注解未生效问题 由社区lym贡献,老汉合并并优化
- 修复#I8XZID 调整批量刷新api接口返回类型为成功刷新的分片数,解决部分场景下,有分片刷新失败时刷新状态返回有误的问题
Expand Down

1 comment on commit 5deb7af

@vercel
Copy link

@vercel vercel bot commented on 5deb7af Jan 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.