IndexField (easy-es-annotation 3.0.0 API)

@Retention(value=RUNTIME)
 @Target(value={FIELD,ANNOTATION_TYPE})
public @interface IndexField

字段注解

可选元素概要

可选元素
限定符和类型	可选元素和说明
`String`	`analyzer` 索引文档时用的分词器
`String[]`	`copyTo` 用于将多个字段的值复制到一个新的字段中，以便在查询时可以简化查询语句，提高检索效率
`String`	`dateFormat` es索引中的日期格式
`int`	`dims` 向量的维度大小，不能超过2048 且非负字段类型为dense_vector时必须指定此字段值,否则索引无法正确创建
`boolean`	`exist` 是否为索引字段默认 true 存在，false 不存在
`boolean`	`fieldData` 设置text、keyword_text 可以进行聚合操作
`FieldType`	`fieldType` 字段在es索引中的类型,建议根据业务场景指定,若不指定则由本框架自动推断
`int`	`ignoreAbove` 长度超过ignore_above设置的字符串将不会被索引或存储 keyword_text默认值为256
`boolean`	`ignoreCase` 是否忽略大小写默认 false 不忽略，为true时则大小写不敏感，都可查
`Class<?>`	`nestedOrObjectClass` 默认嵌套类
`int`	`scalingFactor` 用于指定浮点数字段的缩放因子缩放因子用于将浮点数值映射到整数值以进行存储和索引,取值范围是 1 到 10000 针对BigDecimal类型字段,不指定时默认值为 100
`String`	`searchAnalyzer` 查询分词器
`FieldStrategy`	`strategy` 字段验证策略
`String`	`value` 自定义字段在es中的名称

- 元素详细资料
  - value
```
public abstract String value
```
    自定义字段在es中的名称
    
    返回:
    
    字段在es中的名称
    
    默认值:
    
    ""
- - exist
```
public abstract boolean exist
```
    是否为索引字段默认 true 存在，false 不存在
    
    返回:
    
    存在
    
    默认值:
    
    true
- - copyTo
```
public abstract String[] copyTo
```
    用于将多个字段的值复制到一个新的字段中，以便在查询时可以简化查询语句，提高检索效率
    
    返回:
    
    复制当前字段至指定字段中
    
    默认值:
    
    {}
- - fieldType
```
public abstract FieldType fieldType
```
    字段在es索引中的类型,建议根据业务场景指定,若不指定则由本框架自动推断
    
    返回:
    
    类型
    
    默认值:
    
    org.dromara.easyes.annotation.rely.FieldType.NONE
- - fieldData
```
public abstract boolean fieldData
```
    设置text、keyword_text 可以进行聚合操作
    
    返回:
    
    是否设置可聚合
    
    默认值:
    
    false
- - analyzer
```
public abstract String analyzer
```
    索引文档时用的分词器
    
    返回:
    
    分词器
    
    默认值:
    
    "none"
- - searchAnalyzer
```
public abstract String searchAnalyzer
```
    查询分词器
    
    返回:
    
    分词器
    
    默认值:
    
    "none"
- - strategy
```
public abstract FieldStrategy strategy
```
    字段验证策略
    
    返回:
    
    默认策略
    
    默认值:
    
    org.dromara.easyes.annotation.rely.FieldStrategy.DEFAULT
- - dateFormat
```
public abstract String dateFormat
```
    es索引中的日期格式
    
    返回:
    
    日期格式例如yyyy-MM-dd HH:mm:ss
    
    默认值:
    
    ""
- - ignoreCase
```
public abstract boolean ignoreCase
```
    是否忽略大小写默认 false 不忽略，为true时则大小写不敏感，都可查
    
    返回:
    
    是否忽略大小写
    
    默认值:
    
    false
- - ignoreAbove
```
public abstract int ignoreAbove
```
    长度超过ignore_above设置的字符串将不会被索引或存储 keyword_text默认值为256
    
    返回:
    
    索引字段最大长度
    
    默认值:
    
    -1
- - dims
```
public abstract int dims
```
    向量的维度大小，不能超过2048 且非负字段类型为dense_vector时必须指定此字段值,否则索引无法正确创建
    
    返回:
    
    向量的维度大小
    
    默认值:
    
    -1
- - scalingFactor
```
public abstract int scalingFactor
```
    用于指定浮点数字段的缩放因子缩放因子用于将浮点数值映射到整数值以进行存储和索引,取值范围是 1 到 10000 针对BigDecimal类型字段,不指定时默认值为 100
    
    返回:
    
    缩放因子
    
    默认值:
    
    -1
- - nestedOrObjectClass
```
public abstract Class<?> nestedOrObjectClass
```
    默认嵌套类
    
    返回:
    
    默认嵌套类
    
    默认值:
    
    org.dromara.easyes.annotation.rely.DefaultNestedOrObjectClass.class

注释类型 IndexField

可选元素概要

元素详细资料

value

exist

copyTo

fieldType

fieldData

analyzer

searchAnalyzer

strategy

dateFormat

ignoreCase

ignoreAbove

dims

scalingFactor

nestedOrObjectClass