cn.zhangfusheng.elasticsearch.template

接口 TemplateDynamicStrApi

所有超级接口:

ElasticSearchTemplateApi

所有已知子接口:

TemplateDynamicSqlApi

所有已知实现类:

AbstractElasticSearchRestTemplate, ElasticSearchRestTemplate

public interface TemplateDynamicStrApi
extends ElasticSearchTemplateApi

动态字符串解析

作者:

fusheng.zhang

字段概要

字段

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

方法概要

限定符和类型	方法和说明
default boolean	bulkRequest(org.elasticsearch.action.bulk.BulkRequest request) 批量执行写请求
default void	createIndexMapping(String indexName, String mapping, String setting) 新建索引 以及 mapping
default boolean	delete(org.elasticsearch.action.delete.DeleteRequest request) 删除
default boolean	delete(String index, String routing, String id) 删除
default long	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)
org.elasticsearch.action.bulk.BulkProcessor	getBulkProcessor()
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 void	reindex(String targetIndex, String... sourceIndex) 将文档从一个或多个索引复制到目标索引中 TODO reindex 的作用理解不到位,描述存在问题,需要重新理解
org.elasticsearch.client.RestHighLevelClient	restHighLevelClient()
default void	rethrottle() 节流请求 TODO 未明白作用
default Object	runDynamicDsl(ElasticSearchEntityRepositoryDetail entityRepositoryDetail, Method method, Object[] args, String routing, String index, DyanmicExecuteResult dyanmicExecuteResult) 按照 es 的 query dsl 执行
default Object	runDynamicSql(ElasticSearchEntityRepositoryDetail entityRepositoryDetail, Method method, Object[] args, String routing, String index, DyanmicExecuteResult execute) 按照 sql 方式执行
default Object	runDynamicStr(ElasticSearchEntityRepositoryDetail entityRepositoryDetail, Method method, Object[] args, String routing, String index) 执行动态字符串
default boolean	update(String index, String routing, String id, org.elasticsearch.common.xcontent.XContentBuilder xContentBuilder) 更新
default boolean	update(org.elasticsearch.action.update.UpdateRequest request)
default long	updateByQuery(org.elasticsearch.index.query.QueryBuilder query, org.elasticsearch.script.Script script, String routing, String... index) 根据查询条件更新

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

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

字段详细资料

log

static final org.slf4j.Logger log

方法详细资料

runDynamicStr

default Object runDynamicStr(ElasticSearchEntityRepositoryDetail entityRepositoryDetail,
                             Method method,
                             Object[] args,
                             String routing,
                             String index)

执行动态字符串

参数:

entityRepositoryDetail -

method -

args -

routing -

index -

返回:

抛出:

IOException

runDynamicDsl

default Object runDynamicDsl(ElasticSearchEntityRepositoryDetail entityRepositoryDetail,
                             Method method,
                             Object[] args,
                             String routing,
                             String index,
                             DyanmicExecuteResult dyanmicExecuteResult)
                      throws IOException

按照 es 的 query dsl 执行

参数:

entityRepositoryDetail -

method -

args -

routing -

index -

dyanmicExecuteResult -

返回:

抛出:

IOException

runDynamicSql

default Object runDynamicSql(ElasticSearchEntityRepositoryDetail entityRepositoryDetail,
                             Method method,
                             Object[] args,
                             String routing,
                             String index,
                             DyanmicExecuteResult execute)
                      throws IOException

按照 sql 方式执行

参数:

entityRepositoryDetail -

method -

args -

routing -

index -

execute -

返回:

抛出:

IOException

index

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

保存一条数据

参数:

id - 数据id

routing - routing

indexName - 索引

xContentBuilder -

返回:

index

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

保存一条数据

参数:

id - 数据id

routing - routing

indexName - 索引

sourceMap -

返回:

index

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

执行 indexRequest
只能create

参数:

request -

返回:

get

default 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

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

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

参数:

index -

routing -

id -

返回:

delete

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

删除

参数:

index -

routing -

id -

返回:

delete

default boolean delete(org.elasticsearch.action.delete.DeleteRequest request)

删除

参数:

request -

返回:

update

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

更新

参数:

index -

routing -

id -

xContentBuilder -

返回:

update

default boolean update(org.elasticsearch.action.update.UpdateRequest request)

bulkRequest

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

批量执行写请求

参数:

request -

reindex

default void reindex(String targetIndex,
                     String... sourceIndex)

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

updateByQuery

default long updateByQuery(org.elasticsearch.index.query.QueryBuilder query,
                           org.elasticsearch.script.Script script,
                           String routing,
                           String... index)

根据查询条件更新

参数:

query - 查询条件

script - 更新内容

routing - routing

index - index

deleteByQuery

default long deleteByQuery(org.elasticsearch.index.query.QueryBuilder query,
                           String routing,
                           String... index)

根据查询条件删除

参数:

query - 查询条件

routing - routing

index - index

rethrottle

default void rethrottle()

节流请求 TODO 未明白作用

createIndexMapping

default void createIndexMapping(String indexName,
                                String mapping,
                                String setting)

新建索引 以及 mapping

参数:

indexName - 索引名称

mapping - 映射文档

setting - setting配置

抛出:

IOException

putMapping

default void putMapping(String indexName,
                        String mapping)

更新或创建 mapping

抛出:

IOException

exists

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

判断索引是否存在

参数:

getIndexRequest -

返回:

restHighLevelClient

org.elasticsearch.client.RestHighLevelClient restHighLevelClient()

getBulkProcessor

org.elasticsearch.action.bulk.BulkProcessor getBulkProcessor()