cn.zhangfusheng.elasticsearch.template

类 ElasticSearchRestTemplate

java.lang.Object

cn.zhangfusheng.elasticsearch.template.AbstractElasticSearchRestTemplate

cn.zhangfusheng.elasticsearch.template.ElasticSearchRestTemplate

所有已实现的接口:

ElasticSearchTemplateApi, TemplageIngestApi, TemplateDynamicSqlApi, TemplateJpaApi

public class ElasticSearchRestTemplate
extends AbstractElasticSearchRestTemplate

作者:

fusheng.zhang

字段概要

字段

限定符和类型	字段和说明
static org.slf4j.Logger	log
static org.slf4j.Logger	log

从接口继承的字段 cn.zhangfusheng.elasticsearch.template.TemplageIngestApi

log

从接口继承的字段 cn.zhangfusheng.elasticsearch.template.TemplateDynamicSqlApi

log

构造器概要

构造器

构造器和说明
ElasticSearchRestTemplate(org.elasticsearch.client.RestHighLevelClient restHighLevelClient)

方法概要

限定符和类型	方法和说明
default void	buildSearch(org.elasticsearch.index.query.BoolQueryBuilder boolQueryBuilder, org.elasticsearch.action.search.SearchRequest searchRequest, Field declaredField, Object value) DslSearch 注解的解析
default org.elasticsearch.index.query.BoolQueryBuilder	buildSearchWithEntity(org.elasticsearch.action.search.SearchRequest searchRequest, Field declaredField, Object value) 实体解析成查询语句
default void	buildSort(org.elasticsearch.action.search.SearchRequest searchRequest, Field declaredField, Object value) DslSortOrder 排序注解的解析
default boolean	bulkRequest(org.elasticsearch.action.bulk.BulkRequest request) 批量执行写请求
default void	createIndexMapping(String indexName, String mapping) 新建索引 以及 mapping
default boolean	delete(String index, String routing, String id) 删除
default void	deleteByQuery(org.elasticsearch.index.query.QueryBuilder query, String routing, String... index) 根据查询条件删除
default boolean	exists(org.elasticsearch.client.indices.GetIndexRequest getIndexRequest) 判断索引是否存在
default boolean	exists(String index, String routing, String id) 如果文档存在，exists API将返回true，否则返回false。
default org.elasticsearch.action.get.GetResponse	get(String index, String routing, String id, List<String> includes, List<String> excludes)
default org.elasticsearch.action.search.SearchRequest	getSearchRequest(Object[] args, String routing, String... indices)
default boolean	index(org.elasticsearch.action.index.IndexRequest request) 执行 indexRequest 只能create
default boolean	index(String id, String routing, String indexName, Map<String,Object> sourceMap) 保存一条数据
default boolean	index(String id, String routing, String indexName, org.elasticsearch.common.xcontent.XContentBuilder xContentBuilder) 保存一条数据
default void	putMapping(String indexName, String mapping) 更新或创建 mapping
default boolean	reindex(String targetIndex, String... sourceIndex) 将文档从一个或多个索引复制到目标索引中 TODO reindex 的作用理解不到位,描述存在问题,需要重新理解
default void	rethrottle() 节流请求 TODO 未明白作用
default Object	runIbatis(ElasticSearchEntityRepositoryDetail entityRepositoryDetail, Method method, Object[] args, Map<String,Object> params, String routing, DslWithMybatis dslWithMybatis, org.apache.ibatis.session.Configuration configuration, String index) 通过 mybatis 的xml 方式解析出 dsl 语句,执行货返回结果
default List<org.elasticsearch.search.SearchHit>	search(Object[] args, ElasticSearchEntityRepositoryDetail elasticSearchEntityRepositoryDetail) 查询
default List<org.elasticsearch.search.SearchHit>	search(Object[] args, String routing, String... indices) 查询 多条数据 默认查询 10000 条,当数据超过 10000 启用滚动查询,查询全部
default org.elasticsearch.action.search.SearchResponse	searchWithPage(Consumer<org.elasticsearch.search.SearchHit[]> consumer, PageRequest pageRequest, Object[] args, String routing, String... indices) 分页查询
default PageResponse<org.elasticsearch.search.SearchHit>	searchWithPage(Object[] args, ElasticSearchEntityRepositoryDetail elasticSearchEntityRepositoryDetail, PageRequest pageRequest) 查询
default PageResponse<org.elasticsearch.search.SearchHit>	searchWithPage(Object[] args, String routing, PageRequest pageRequest, String... indices) 分页查询
default org.elasticsearch.index.query.BoolQueryBuilder	setQueryBuilder(DslSearch dslSearch, org.elasticsearch.index.query.QueryBuilder queryBuilder, org.elasticsearch.index.query.BoolQueryBuilder boolQueryBuilder)
default boolean	update(String index, String routing, String id, org.elasticsearch.common.xcontent.XContentBuilder xContentBuilder) 更新
default void	updateByQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.script.Script script, String routing, String... index) 根据查询条件更新

从类继承的方法 cn.zhangfusheng.elasticsearch.template.AbstractElasticSearchRestTemplate

indicesClient, restHighLevelClient

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 cn.zhangfusheng.elasticsearch.template.TemplageIngestApi

delPipeline, getPipeline, putPipeline

从接口继承的方法 cn.zhangfusheng.elasticsearch.template.TemplateJpaApi

analysisJapSearchAnnotation, and, buildBoolQueryWithJap, buildSearch, create, from, or, runJpa

从接口继承的方法 cn.zhangfusheng.elasticsearch.template.TemplateDynamicSqlApi

runDynamicSql

从接口继承的方法 cn.zhangfusheng.elasticsearch.template.ElasticSearchTemplateApi

analysisIndex, analysisIndex, analysisIndex, clearScroll, count, search, search, searchWitchScroll, searchWithPage

字段详细资料

log

public static final org.slf4j.Logger log

log

public static final org.slf4j.Logger log

构造器详细资料

ElasticSearchRestTemplate

public ElasticSearchRestTemplate(org.elasticsearch.client.RestHighLevelClient restHighLevelClient)

方法详细资料

index

public boolean index(String id,
                     String routing,
                     String indexName,
                     org.elasticsearch.common.xcontent.XContentBuilder xContentBuilder)

保存一条数据

参数:

id - 数据id

routing - routing

indexName - 索引

xContentBuilder -

返回:

index

public boolean index(String id,
                     String routing,
                     String indexName,
                     Map<String,Object> sourceMap)

保存一条数据

参数:

id - 数据id

routing - routing

indexName - 索引

sourceMap -

返回:

index

public boolean index(org.elasticsearch.action.index.IndexRequest request)

执行 indexRequest
只能create

参数:

request -

返回:

get

public org.elasticsearch.action.get.GetResponse get(String index,
                                                    String routing,
                                                    String id,
                                                    List<String> includes,
                                                    List<String> excludes)

参数:

index - 索引 必填

routing - routing

id - id 必填

excludes - 要排除的字段

includes - 要查询的字段

返回:

exists

public boolean exists(String index,
                      String routing,
                      String id)

如果文档存在，exists API将返回true，否则返回false。

参数:

index -

routing -

id -

返回:

delete

public boolean delete(String index,
                      String routing,
                      String id)

删除

参数:

index -

routing -

id -

返回:

update

public boolean update(String index,
                      String routing,
                      String id,
                      org.elasticsearch.common.xcontent.XContentBuilder xContentBuilder)

更新

参数:

index -

routing -

id -

xContentBuilder -

返回:

bulkRequest

public boolean bulkRequest(org.elasticsearch.action.bulk.BulkRequest request)

批量执行写请求

参数:

request -

reindex

public boolean reindex(String targetIndex,
                       String... sourceIndex)

将文档从一个或多个索引复制到目标索引中 TODO reindex 的作用理解不到位,描述存在问题,需要重新理解

返回:

updateByQuery

public void updateByQuery(org.elasticsearch.index.query.QueryBuilder query,
                          org.elasticsearch.script.Script script,
                          String routing,
                          String... index)

根据查询条件更新

参数:

query - 查询条件

script - 更新内容

routing - routing

index - index

deleteByQuery

public void deleteByQuery(org.elasticsearch.index.query.QueryBuilder query,
                          String routing,
                          String... index)

根据查询条件删除

参数:

query - 查询条件

routing - routing

index - index

rethrottle

public void rethrottle()

节流请求 TODO 未明白作用

createIndexMapping

public void createIndexMapping(String indexName,
                               String mapping)

新建索引 以及 mapping

抛出:

IOException

putMapping

public void putMapping(String indexName,
                       String mapping)

更新或创建 mapping

抛出:

IOException

exists

public boolean exists(org.elasticsearch.client.indices.GetIndexRequest getIndexRequest)

判断索引是否存在

参数:

getIndexRequest -

返回:

search

public List<org.elasticsearch.search.SearchHit> search(Object[] args,
                                                       ElasticSearchEntityRepositoryDetail elasticSearchEntityRepositoryDetail)

查询

参数:

args -

elasticSearchEntityRepositoryDetail -

返回:

search

public List<org.elasticsearch.search.SearchHit> search(Object[] args,
                                                       String routing,
                                                       String... indices)

查询 多条数据
默认查询 10000 条,当数据超过 10000 启用滚动查询,查询全部

参数:

args - 方法的参数列表

routing - routing

indices - 要查询的索引

返回:

searchWithPage

public PageResponse<org.elasticsearch.search.SearchHit> searchWithPage(Object[] args,
                                                                       ElasticSearchEntityRepositoryDetail elasticSearchEntityRepositoryDetail,
                                                                       PageRequest pageRequest)

查询

参数:

elasticSearchEntityRepositoryDetail -

pageRequest -

返回:

searchWithPage

public PageResponse<org.elasticsearch.search.SearchHit> searchWithPage(Object[] args,
                                                                       String routing,
                                                                       PageRequest pageRequest,
                                                                       String... indices)

分页查询

参数:

routing - routing

indices - 要查询的索引

返回:

集合

searchWithPage

public org.elasticsearch.action.search.SearchResponse searchWithPage(Consumer<org.elasticsearch.search.SearchHit[]> consumer,
                                                                     PageRequest pageRequest,
                                                                     Object[] args,
                                                                     String routing,
                                                                     String... indices)

分页查询

参数:

routing - routing

indices - 要查询的索引

返回:

集合

getSearchRequest

public org.elasticsearch.action.search.SearchRequest getSearchRequest(Object[] args,
                                                                      String routing,
                                                                      String... indices)
                                                               throws Exception

抛出:

Exception

buildSearch

public void buildSearch(org.elasticsearch.index.query.BoolQueryBuilder boolQueryBuilder,
                        org.elasticsearch.action.search.SearchRequest searchRequest,
                        Field declaredField,
                        Object value)
                 throws Exception

DslSearch 注解的解析

参数:

boolQueryBuilder -

searchRequest -

declaredField - 字段信息

value - 字段值

抛出:

Exception

buildSearchWithEntity

public org.elasticsearch.index.query.BoolQueryBuilder buildSearchWithEntity(org.elasticsearch.action.search.SearchRequest searchRequest,
                                                                            Field declaredField,
                                                                            Object value)
                                                                     throws Exception

实体解析成查询语句

参数:

searchRequest -

declaredField - 实体的字段

value - 实体

返回:

抛出:

Exception

buildSort

public void buildSort(org.elasticsearch.action.search.SearchRequest searchRequest,
                      Field declaredField,
                      Object value)
               throws Exception

DslSortOrder 排序注解的解析

参数:

searchRequest -

declaredField -

value -

抛出:

Exception

setQueryBuilder

public org.elasticsearch.index.query.BoolQueryBuilder setQueryBuilder(DslSearch dslSearch,
                                                                      org.elasticsearch.index.query.QueryBuilder queryBuilder,
                                                                      org.elasticsearch.index.query.BoolQueryBuilder boolQueryBuilder)

runIbatis

public Object runIbatis(ElasticSearchEntityRepositoryDetail entityRepositoryDetail,
                        Method method,
                        Object[] args,
                        Map<String,Object> params,
                        String routing,
                        DslWithMybatis dslWithMybatis,
                        org.apache.ibatis.session.Configuration configuration,
                        String index)

通过 mybatis 的xml 方式解析出 dsl 语句,执行货返回结果

参数:

params - 方法参数转换为map后的参数

routing - routing

dslWithMybatis - DslWithMybatis注解

configuration - mybatis config

indices - index

返回: