BaseEsMapperImpl (easy-es-core 2.0.0-beta1 API)

java.lang.Object
- cn.easyes.core.core.BaseEsMapperImpl<T>

所有已实现的接口:

BaseEsMapper<T>
```
public class BaseEsMapperImpl<T>
extends Object
implements BaseEsMapper<T>
```
核心所有支持方法接口实现类
内部实现: 核心网络请求类：RestHighLevelClient、动态封装request类：WrapperProcessor、查询类型枚举：EsQueryTypeEnum、
Copyright © 2021 xpc1024 All Rights Reserved

构造器概要

构造器
构造器和说明

BaseEsMapperImpl()

构造器
构造器和说明
`BaseEsMapperImpl()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Boolean`	`createIndex()` 创建索引,根据当前mapper对应实体类信息及其注解配置生成索引信息
`Boolean`	`createIndex(String indexName)` 创建索引,根据当前mapper对应实体类信息及其注解配置生成索引信息可指定索引名进行创建适用于定时任务按日期创建索引场景
`Boolean`	`createIndex(Wrapper<T> wrapper)` 创建索引
`Integer`	`delete(Wrapper<T> wrapper)` 根据 entity 条件，删除记录
`Integer`	`deleteBatchIds(Collection<? extends Serializable> idList)` 删除（根据ID 批量删除）
`Integer`	`deleteBatchIds(Collection<? extends Serializable> idList, String... indexNames)` 删除（根据ID 批量删除）
`Integer`	`deleteById(Serializable id)` 根据 ID 删除
`Integer`	`deleteById(Serializable id, String... indexNames)` 根据 ID 删除
`Boolean`	`deleteIndex(String... indexNames)` 删除指定索引
`String`	`executeDSL(String dsl)` 执行静态dsl语句不传索引名,默认为当前mapper对应索引
`String`	`executeDSL(String dsl, String indexName)` 执行静态dsl语句可指定作用的索引
`String`	`executeSQL(String sql)` 执行SQL语句
`Boolean`	`existsIndex(String indexName)` 是否存在索引
`org.elasticsearch.client.indices.GetIndexResponse`	`getIndex()` 获取当前索引信息
`org.elasticsearch.client.indices.GetIndexResponse`	`getIndex(String indexName)` 获取指定索引信息
`org.elasticsearch.search.builder.SearchSourceBuilder`	`getSearchSourceBuilder(Wrapper<T> wrapper)` 获取SearchSourceBuilder,可用于本框架生成基础查询条件,不支持的高阶语法用户可通过SearchSourceBuilder 进一步封装
`String`	`getSource(Wrapper<T> wrapper)` 获取通过本框架生成的查询参数,可用于检验本框架生成的查询参数是否正确
`Integer`	`insert(T entity)` 插入一条记录
`Integer`	`insert(T entity, String... indexNames)` 插入一条记录,可指定多索引插入
`Integer`	`insertBatch(Collection<T> entityList)` 批量插入
`Integer`	`insertBatch(Collection<T> entityList, String... indexNames)` 批量插入
`EsPageInfo<T>`	`pageQuery(Wrapper<T> wrapper, Integer pageNum, Integer pageSize)` 指定返回类型及分页参数
`Boolean`	`refresh()` 刷新索引
`Boolean`	`refresh(String... indexNames)` 刷新指定索引
`org.elasticsearch.action.search.SearchResponse`	`scroll(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest, org.elasticsearch.client.RequestOptions requestOptions)` es原生滚动查询
`org.elasticsearch.action.search.SearchResponse`	`search(org.elasticsearch.action.search.SearchRequest searchRequest, org.elasticsearch.client.RequestOptions requestOptions)` es原生查询
`org.elasticsearch.action.search.SearchResponse`	`search(Wrapper<T> wrapper)` 混合查询
`SAPageInfo<T>`	`searchAfterPage(Wrapper<T> wrapper, List<Object> searchAfter, Integer pageSize)` searchAfter类型分页
`List<T>`	`selectBatchIds(Collection<? extends Serializable> idList)` 查询（根据ID 批量查询）
`List<T>`	`selectBatchIds(Collection<? extends Serializable> idList, String... indexNames)` 查询（根据ID 批量查询）
`T`	`selectById(Serializable id)` 根据 ID 查询
`T`	`selectById(Serializable id, String... indexNames)` 根据 ID 查询
`Long`	`selectCount(Wrapper<T> wrapper)` 获取总数(智能推断:若wrapper中指定了去重字段则去重,若未指定则不去重推荐使用)
`Long`	`selectCount(Wrapper<T> wrapper, boolean distinct)` 无论wrapper中是否指定去重字段,都以用户传入的distinct布尔值作为是否去重的条件
`List<T>`	`selectList(Wrapper<T> wrapper)` 根据 entity 条件，查询全部记录
`T`	`selectOne(Wrapper<T> wrapper)` 根据 entity 条件，查询一条记录
`Boolean`	`setCurrentActiveIndex(String indexName)` 设置当前Mapper默认激活的全局索引名称务必谨慎操作,设置后全局生效,永驻jvm,除非项目重启
`Integer`	`update(T entity, Wrapper<T> updateWrapper)` 根据 whereEntity 条件，更新记录
`Integer`	`updateBatchByIds(Collection<T> entityList)` 根据ID 批量更新
`Integer`	`updateBatchByIds(Collection<T> entityList, String... indexNames)` 根据ID 批量更新
`Integer`	`updateById(T entity)` 根据 ID 更新
`Integer`	`updateById(T entity, String... indexNames)` 根据 ID 更新
`Boolean`	`updateIndex(Wrapper<T> wrapper)` 更新索引

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - BaseEsMapperImpl
```
public BaseEsMapperImpl()
```
- 方法详细资料
  - existsIndex
```
public Boolean existsIndex(String indexName)
```
    从接口复制的说明: BaseEsMapper
    
    是否存在索引
    
    指定者:
    
    existsIndex 在接口中 BaseEsMapper<T>
    
    参数:
    
    indexName - 索引名称
    
    返回:
    
    返回是否存在的布尔值
  - getIndex
```
public org.elasticsearch.client.indices.GetIndexResponse getIndex()
```
    从接口复制的说明: BaseEsMapper
    
    获取当前索引信息
    
    指定者:
    
    getIndex 在接口中 BaseEsMapper<T>
    
    返回:
    
    当前索引信息
  - getIndex
```
public org.elasticsearch.client.indices.GetIndexResponse getIndex(String indexName)
```
    从接口复制的说明: BaseEsMapper
    
    获取指定索引信息
    
    指定者:
    
    getIndex 在接口中 BaseEsMapper<T>
    
    参数:
    
    indexName - 指定索引名
    
    返回:
    
    指定索引信息
  - createIndex
```
public Boolean createIndex()
```
    从接口复制的说明: BaseEsMapper
    
    创建索引,根据当前mapper对应实体类信息及其注解配置生成索引信息
    
    指定者:
    
    createIndex 在接口中 BaseEsMapper<T>
    
    返回:
    
    是否创建成功
  - createIndex
```
public Boolean createIndex(String indexName)
```
    从接口复制的说明: BaseEsMapper
    
    创建索引,根据当前mapper对应实体类信息及其注解配置生成索引信息可指定索引名进行创建适用于定时任务按日期创建索引场景
    
    指定者:
    
    createIndex 在接口中 BaseEsMapper<T>
    
    参数:
    
    indexName - 指定的索引名,会覆盖注解上指定的索引名
    
    返回:
    
    是否创建成功
  - createIndex
```
public Boolean createIndex(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    创建索引
    
    指定者:
    
    createIndex 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    是否成功
  - updateIndex
```
public Boolean updateIndex(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    更新索引
    
    指定者:
    
    updateIndex 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    是否成功
  - deleteIndex
```
public Boolean deleteIndex(String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    删除指定索引
    
    指定者:
    
    deleteIndex 在接口中 BaseEsMapper<T>
    
    参数:
    
    indexNames - 索引名称数组
    
    返回:
    
    是否成功
  - refresh
```
public Boolean refresh()
```
    从接口复制的说明: BaseEsMapper
    
    刷新索引
    
    指定者:
    
    refresh 在接口中 BaseEsMapper<T>
    
    返回:
    
    是否刷新成功
  - refresh
```
public Boolean refresh(String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    刷新指定索引
    
    指定者:
    
    refresh 在接口中 BaseEsMapper<T>
    
    参数:
    
    indexNames - 索引名称
    
    返回:
    
    是否刷新成功
  - executeSQL
```
public String executeSQL(String sql)
```
    从接口复制的说明: BaseEsMapper
    
    执行SQL语句
    
    指定者:
    
    executeSQL 在接口中 BaseEsMapper<T>
    
    参数:
    
    sql - 被执行的sql语句
    
    返回:
    
    执行结果 jsonString
  - executeDSL
```
public String executeDSL(String dsl)
```
    从接口复制的说明: BaseEsMapper
    
    执行静态dsl语句不传索引名,默认为当前mapper对应索引
    
    指定者:
    
    executeDSL 在接口中 BaseEsMapper<T>
    
    参数:
    
    dsl - dsl语句
    
    返回:
    
    执行结果 jsonString
  - executeDSL
```
public String executeDSL(String dsl,
                         String indexName)
```
    从接口复制的说明: BaseEsMapper
    
    执行静态dsl语句可指定作用的索引
    
    指定者:
    
    executeDSL 在接口中 BaseEsMapper<T>
    
    参数:
    
    dsl - dsl语句
    
    indexName - 作用的索引名
    
    返回:
    
    执行结果 jsonString
  - search
```
public org.elasticsearch.action.search.SearchResponse search(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    混合查询
    
    指定者:
    
    search 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    es标准结果
  - search
```
public org.elasticsearch.action.search.SearchResponse search(org.elasticsearch.action.search.SearchRequest searchRequest,
                                                             org.elasticsearch.client.RequestOptions requestOptions)
                                                      throws IOException
```
    从接口复制的说明: BaseEsMapper
    
    es原生查询
    
    指定者:
    
    search 在接口中 BaseEsMapper<T>
    
    参数:
    
    searchRequest - 查询请求参数
    
    requestOptions - 类型
    
    返回:
    
    es原生返回结果
    
    抛出:
    
    IOException - IO异常
  - scroll
```
public org.elasticsearch.action.search.SearchResponse scroll(org.elasticsearch.action.search.SearchScrollRequest searchScrollRequest,
                                                             org.elasticsearch.client.RequestOptions requestOptions)
                                                      throws IOException
```
    从接口复制的说明: BaseEsMapper
    
    es原生滚动查询
    
    指定者:
    
    scroll 在接口中 BaseEsMapper<T>
    
    参数:
    
    searchScrollRequest - 查询请求参数
    
    requestOptions - 类型
    
    返回:
    
    es原生返回结果
    
    抛出:
    
    IOException - IO异常
  - getSearchSourceBuilder
```
public org.elasticsearch.search.builder.SearchSourceBuilder getSearchSourceBuilder(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    获取SearchSourceBuilder,可用于本框架生成基础查询条件,不支持的高阶语法用户可通过SearchSourceBuilder 进一步封装
    
    指定者:
    
    getSearchSourceBuilder 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    查询参数
  - getSource
```
public String getSource(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    获取通过本框架生成的查询参数,可用于检验本框架生成的查询参数是否正确
    
    指定者:
    
    getSource 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    查询JSON格式参数
  - pageQuery
```
public EsPageInfo<T> pageQuery(Wrapper<T> wrapper,
                               Integer pageNum,
                               Integer pageSize)
```
    从接口复制的说明: BaseEsMapper
    
    指定返回类型及分页参数
    
    指定者:
    
    pageQuery 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    pageNum - 当前页
    
    pageSize - 每页条数
    
    返回:
    
    指定的返回类型
  - searchAfterPage
```
public SAPageInfo<T> searchAfterPage(Wrapper<T> wrapper,
                                     List<Object> searchAfter,
                                     Integer pageSize)
```
    从接口复制的说明: BaseEsMapper
    
    searchAfter类型分页
    
    指定者:
    
    searchAfterPage 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    searchAfter - 当前页第一页时为null
    
    pageSize - 每页条数
    
    返回:
    
    指定的返回类型
  - selectCount
```
public Long selectCount(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    获取总数(智能推断:若wrapper中指定了去重字段则去重,若未指定则不去重推荐使用)
    
    指定者:
    
    selectCount 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    总数
  - selectCount
```
public Long selectCount(Wrapper<T> wrapper,
                        boolean distinct)
```
    从接口复制的说明: BaseEsMapper
    
    无论wrapper中是否指定去重字段,都以用户传入的distinct布尔值作为是否去重的条件
    
    指定者:
    
    selectCount 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    distinct - 是否去重
    
    返回:
    
    总数
  - insert
```
public Integer insert(T entity)
```
    从接口复制的说明: BaseEsMapper
    
    插入一条记录
    
    指定者:
    
    insert 在接口中 BaseEsMapper<T>
    
    参数:
    
    entity - 插入的数据对象
    
    返回:
    
    成功条数
  - insert
```
public Integer insert(T entity,
                      String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    插入一条记录,可指定多索引插入
    
    指定者:
    
    insert 在接口中 BaseEsMapper<T>
    
    参数:
    
    entity - 插入的数据对象
    
    indexNames - 指定插入的索引名数组
    
    返回:
    
    总成功条数
  - insertBatch
```
public Integer insertBatch(Collection<T> entityList)
```
    从接口复制的说明: BaseEsMapper
    
    批量插入
    
    指定者:
    
    insertBatch 在接口中 BaseEsMapper<T>
    
    参数:
    
    entityList - 插入的数据对象列表
    
    返回:
    
    总成功条数
  - insertBatch
```
public Integer insertBatch(Collection<T> entityList,
                           String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    批量插入
    
    指定者:
    
    insertBatch 在接口中 BaseEsMapper<T>
    
    参数:
    
    entityList - 插入的数据对象列表
    
    indexNames - 指定插入的索引名数组
    
    返回:
    
    总成功条数
  - deleteById
```
public Integer deleteById(Serializable id)
```
    从接口复制的说明: BaseEsMapper
    
    根据 ID 删除
    
    指定者:
    
    deleteById 在接口中 BaseEsMapper<T>
    
    参数:
    
    id - 主键
    
    返回:
    
    成功条数
  - deleteById
```
public Integer deleteById(Serializable id,
                          String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    根据 ID 删除
    
    指定者:
    
    deleteById 在接口中 BaseEsMapper<T>
    
    参数:
    
    id - 主键
    
    indexNames - 指定删除的索引名数组
    
    返回:
    
    总成功条数
  - deleteBatchIds
```
public Integer deleteBatchIds(Collection<? extends Serializable> idList)
```
    从接口复制的说明: BaseEsMapper
    
    删除（根据ID 批量删除）
    
    指定者:
    
    deleteBatchIds 在接口中 BaseEsMapper<T>
    
    参数:
    
    idList - 主键列表
    
    返回:
    
    总成功条数
  - deleteBatchIds
```
public Integer deleteBatchIds(Collection<? extends Serializable> idList,
                              String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    删除（根据ID 批量删除）
    
    指定者:
    
    deleteBatchIds 在接口中 BaseEsMapper<T>
    
    参数:
    
    idList - 主键列表
    
    indexNames - 指定删除的索引名数组
    
    返回:
    
    总成功条数
  - delete
```
public Integer delete(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    根据 entity 条件，删除记录
    
    指定者:
    
    delete 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    总成功条数
  - updateById
```
public Integer updateById(T entity)
```
    从接口复制的说明: BaseEsMapper
    
    根据 ID 更新
    
    指定者:
    
    updateById 在接口中 BaseEsMapper<T>
    
    参数:
    
    entity - 更新对象
    
    返回:
    
    总成功条数
  - updateById
```
public Integer updateById(T entity,
                          String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    根据 ID 更新
    
    指定者:
    
    updateById 在接口中 BaseEsMapper<T>
    
    参数:
    
    entity - 更新对象
    
    indexNames - 指定更新的索引名称数组
    
    返回:
    
    总成功条数
  - updateBatchByIds
```
public Integer updateBatchByIds(Collection<T> entityList)
```
    从接口复制的说明: BaseEsMapper
    
    根据ID 批量更新
    
    指定者:
    
    updateBatchByIds 在接口中 BaseEsMapper<T>
    
    参数:
    
    entityList - 更新对象列表
    
    返回:
    
    总成功条数
  - updateBatchByIds
```
public Integer updateBatchByIds(Collection<T> entityList,
                                String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    根据ID 批量更新
    
    指定者:
    
    updateBatchByIds 在接口中 BaseEsMapper<T>
    
    参数:
    
    entityList - 更新对象列表
    
    indexNames - 指定更新的索引名称数组
    
    返回:
    
    总成功条数
  - update
```
public Integer update(T entity,
                      Wrapper<T> updateWrapper)
```
    从接口复制的说明: BaseEsMapper
    
    根据 whereEntity 条件，更新记录
    
    指定者:
    
    update 在接口中 BaseEsMapper<T>
    
    参数:
    
    entity - 更新对象
    
    updateWrapper - 条件
    
    返回:
    
    成功条数
  - selectById
```
public T selectById(Serializable id)
```
    从接口复制的说明: BaseEsMapper
    
    根据 ID 查询
    
    指定者:
    
    selectById 在接口中 BaseEsMapper<T>
    
    参数:
    
    id - 主键
    
    返回:
    
    指定的返回对象
  - selectById
```
public T selectById(Serializable id,
                    String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    根据 ID 查询
    
    指定者:
    
    selectById 在接口中 BaseEsMapper<T>
    
    参数:
    
    id - 主键
    
    indexNames - 指定查询的索引名数组
    
    返回:
    
    指定的返回对象
  - selectBatchIds
```
public List<T> selectBatchIds(Collection<? extends Serializable> idList)
```
    从接口复制的说明: BaseEsMapper
    
    查询（根据ID 批量查询）
    
    指定者:
    
    selectBatchIds 在接口中 BaseEsMapper<T>
    
    参数:
    
    idList - 主键列表
    
    返回:
    
    指定的返回对象列表
  - selectBatchIds
```
public List<T> selectBatchIds(Collection<? extends Serializable> idList,
                              String... indexNames)
```
    从接口复制的说明: BaseEsMapper
    
    查询（根据ID 批量查询）
    
    指定者:
    
    selectBatchIds 在接口中 BaseEsMapper<T>
    
    参数:
    
    idList - 主键列表
    
    indexNames - 指定查询的索引名数组
    
    返回:
    
    指定的返回对象列表
  - selectOne
```
public T selectOne(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    根据 entity 条件，查询一条记录
    
    指定者:
    
    selectOne 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    指定的返回对象
  - selectList
```
public List<T> selectList(Wrapper<T> wrapper)
```
    从接口复制的说明: BaseEsMapper
    
    根据 entity 条件，查询全部记录
    
    指定者:
    
    selectList 在接口中 BaseEsMapper<T>
    
    参数:
    
    wrapper - 条件
    
    返回:
    
    指定的返回对象列表
  - setCurrentActiveIndex
```
public Boolean setCurrentActiveIndex(String indexName)
```
    从接口复制的说明: BaseEsMapper
    
    设置当前Mapper默认激活的全局索引名称务必谨慎操作,设置后全局生效,永驻jvm,除非项目重启
    
    指定者:
    
    setCurrentActiveIndex 在接口中 BaseEsMapper<T>
    
    参数:
    
    indexName - 索引名称
    
    返回:
    
    是否成功

类 BaseEsMapperImpl<T>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

BaseEsMapperImpl

方法详细资料

existsIndex

getIndex

getIndex

createIndex

createIndex

createIndex

updateIndex

deleteIndex

refresh

refresh

executeSQL

executeDSL

executeDSL

search

search

scroll

getSearchSourceBuilder

getSource

pageQuery

searchAfterPage

selectCount

selectCount

insert

insert

insertBatch

insertBatch

deleteById

deleteById

deleteBatchIds

deleteBatchIds

delete

updateById

updateById

updateBatchByIds

updateBatchByIds

update

selectById

selectById

selectBatchIds

selectBatchIds

selectOne

selectList

setCurrentActiveIndex