cn.easyes.core.toolkit

类 IndexUtils

java.lang.Object

cn.easyes.core.toolkit.IndexUtils

public class IndexUtils
extends Object

索引工具类

Copyright © 2022 xpc1024 All Rights Reserved

构造器概要

构造器

构造器和说明
IndexUtils()

方法概要

限定符和类型	方法和说明
static void	activeReleaseIndex(org.elasticsearch.client.RestHighLevelClient client, Class<?> entityClass, int maxRetry) 激活最新索引
static Boolean	addAliases(org.elasticsearch.client.RestHighLevelClient client, String indexName, String... aliases) 添加别名
static void	addDefaultAlias(org.elasticsearch.client.RestHighLevelClient client, String indexName) 添加默认索引别名
static boolean	changeAliasAtomic(org.elasticsearch.client.RestHighLevelClient client, String oldIndexName, String releaseIndexName) 原子操作: 删除旧索引别名,将旧索的引别名添加至新索引
static boolean	createEmptyIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName) 创建空索引,不含字段,仅框架内部使用
static boolean	createIndex(org.elasticsearch.client.RestHighLevelClient client, EntityInfo entityInfo, CreateIndexParam indexParam) 创建索引
static boolean	deleteIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName) 删除索引
static boolean	existsIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName) 是否存在索引
static boolean	existsIndexWithRetry(EntityInfo entityInfo, org.elasticsearch.client.RestHighLevelClient client) 追加后缀重试是否存在索引
static boolean	existsIndexWithRetryAndSetActiveIndex(EntityInfo entityInfo, org.elasticsearch.client.RestHighLevelClient client) 追加后缀重试是否存在索引,若存在,则更新当前被激活的索引名
static CreateIndexParam	getCreateIndexParam(EntityInfo entityInfo) 根据配置生成创建索引参数
static String	getEsFieldType(cn.easyes.annotation.rely.FieldType fieldType, String typeName) 根据注解/字段类型名称获取在es中的索引类型
static org.elasticsearch.client.indices.GetIndexResponse	getIndex(org.elasticsearch.client.RestHighLevelClient client, String indexName) 获取索引信息
static EsIndexInfo	getIndexInfo(org.elasticsearch.client.RestHighLevelClient client, String indexName) 获取索引信息
static List<EsIndexParam>	initIndexParam(EntityInfo entityInfo, List<EntityFieldInfo> fieldList, boolean isNested) 初始化索引参数
static Map<String,Object>	initMapping(EntityInfo entityInfo, List<EsIndexParam> indexParamList) 初始化索引mapping
static boolean	isIndexNeedChange(EsIndexInfo esIndexInfo, EntityInfo entityInfo) 判断索引是否需要变更
static EsIndexInfo	parseGetIndexResponse(org.elasticsearch.client.indices.GetIndexResponse getIndexResponse, String indexName) 解析索引信息
static boolean	reindex(org.elasticsearch.client.RestHighLevelClient client, String oldIndexName, String releaseIndexName) 重建索引时的数据迁移,从旧索引迁移至新索引
static void	saveReleaseIndex(String releaseIndexName, org.elasticsearch.client.RestHighLevelClient client) 保存最新索引
static void	supplyAsync(java.util.function.BiFunction<Class<?>,org.elasticsearch.client.RestHighLevelClient,Boolean> biFunction, Class<?> entityClass, org.elasticsearch.client.RestHighLevelClient client) 异步执行索引托管操作

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

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

构造器详细资料

IndexUtils

public IndexUtils()

方法详细资料

existsIndex

public static boolean existsIndex(org.elasticsearch.client.RestHighLevelClient client,
                                  String indexName)

是否存在索引

参数:

client - RestHighLevelClient

indexName - 索引名

返回:

是否存在

createIndex

public static boolean createIndex(org.elasticsearch.client.RestHighLevelClient client,
                                  EntityInfo entityInfo,
                                  CreateIndexParam indexParam)

创建索引

参数:

client - RestHighLevelClient

entityInfo - 实体信息

indexParam - 创建索引参数

返回:

是否创建成功

createEmptyIndex

public static boolean createEmptyIndex(org.elasticsearch.client.RestHighLevelClient client,
                                       String indexName)

创建空索引,不含字段,仅框架内部使用

参数:

client - RestHighLevelClient

indexName - 索引名

返回:

是否创建成功

getIndexInfo

public static EsIndexInfo getIndexInfo(org.elasticsearch.client.RestHighLevelClient client,
                                       String indexName)

获取索引信息

参数:

client - RestHighLevelClient

indexName - 索引名

返回:

索引信息

getIndex

public static org.elasticsearch.client.indices.GetIndexResponse getIndex(org.elasticsearch.client.RestHighLevelClient client,
                                                                         String indexName)

获取索引信息

参数:

client - RestHighLevelClient

indexName - 索引名

返回:

索引信息

addDefaultAlias

public static void addDefaultAlias(org.elasticsearch.client.RestHighLevelClient client,
                                   String indexName)

添加默认索引别名

参数:

client - RestHighLevelClient

indexName - 索引名

addAliases

public static Boolean addAliases(org.elasticsearch.client.RestHighLevelClient client,
                                 String indexName,
                                 String... aliases)

添加别名

参数:

client - RestHighLevelClient

indexName - 索引名

aliases - 别名数组，可以是单个

返回:

是否添加成功

reindex

public static boolean reindex(org.elasticsearch.client.RestHighLevelClient client,
                              String oldIndexName,
                              String releaseIndexName)

重建索引时的数据迁移,从旧索引迁移至新索引

参数:

client - RestHighLevelClient

oldIndexName - 旧索引名

releaseIndexName - 新索引名

返回:

是否操作成功

parseGetIndexResponse

public static EsIndexInfo parseGetIndexResponse(org.elasticsearch.client.indices.GetIndexResponse getIndexResponse,
                                                String indexName)

解析索引信息

参数:

getIndexResponse - es返回的response

indexName - 索引名

返回:

索引信息

getEsFieldType

public static String getEsFieldType(cn.easyes.annotation.rely.FieldType fieldType,
                                    String typeName)

根据注解/字段类型名称获取在es中的索引类型

参数:

fieldType - 注解中指定的es索引类型

typeName - 字段类型

返回:

推断出的es中的索引类型

initMapping

public static Map<String,Object> initMapping(EntityInfo entityInfo,
                                             List<EsIndexParam> indexParamList)

初始化索引mapping

参数:

entityInfo - 实体信息

indexParamList - 索引参数列表

返回:

索引mapping

changeAliasAtomic

public static boolean changeAliasAtomic(org.elasticsearch.client.RestHighLevelClient client,
                                        String oldIndexName,
                                        String releaseIndexName)

原子操作: 删除旧索引别名,将旧索的引别名添加至新索引

参数:

client - RestHighLevelClient

oldIndexName - 旧索引

releaseIndexName - 新索引

返回:

是否成功

deleteIndex

public static boolean deleteIndex(org.elasticsearch.client.RestHighLevelClient client,
                                  String indexName)

删除索引

参数:

client - RestHighLevelClient

indexName - 索引名

返回:

是否删除成功

getCreateIndexParam

public static CreateIndexParam getCreateIndexParam(EntityInfo entityInfo)

根据配置生成创建索引参数

参数:

entityInfo - 配置信息

返回:

创建索引参数

initIndexParam

public static List<EsIndexParam> initIndexParam(EntityInfo entityInfo,
                                                List<EntityFieldInfo> fieldList,
                                                boolean isNested)

初始化索引参数

参数:

entityInfo - 实体信息

fieldList - 字段列表

isNested - 是否嵌套

返回:

索引参数列表

isIndexNeedChange

public static boolean isIndexNeedChange(EsIndexInfo esIndexInfo,
                                        EntityInfo entityInfo)

判断索引是否需要变更

参数:

esIndexInfo - es中的索引信息

entityInfo - 配置中的索引信息

返回:

是否需要更新索引

existsIndexWithRetryAndSetActiveIndex

public static boolean existsIndexWithRetryAndSetActiveIndex(EntityInfo entityInfo,
                                                            org.elasticsearch.client.RestHighLevelClient client)

追加后缀重试是否存在索引,若存在,则更新当前被激活的索引名

参数:

entityInfo - 配置信息

client - RestHighLevelClient

返回:

是否存在索引

existsIndexWithRetry

public static boolean existsIndexWithRetry(EntityInfo entityInfo,
                                           org.elasticsearch.client.RestHighLevelClient client)

追加后缀重试是否存在索引

参数:

entityInfo - 配置信息

client - RestHighLevelClient

返回:

是否存在索引

saveReleaseIndex

public static void saveReleaseIndex(String releaseIndexName,
                                    org.elasticsearch.client.RestHighLevelClient client)

保存最新索引

参数:

releaseIndexName - 最新索引名称

client - RestHighLevelClient

activeReleaseIndex

public static void activeReleaseIndex(org.elasticsearch.client.RestHighLevelClient client,
                                      Class<?> entityClass,
                                      int maxRetry)

激活最新索引

参数:

client - RestHighLevelClient

entityClass - 实体类

maxRetry - 重试次数

supplyAsync

public static void supplyAsync(java.util.function.BiFunction<Class<?>,org.elasticsearch.client.RestHighLevelClient,Boolean> biFunction,
                               Class<?> entityClass,
                               org.elasticsearch.client.RestHighLevelClient client)

异步执行索引托管操作

参数:

biFunction - 索引变更方法

entityClass - 实体类

client - RestHighLevelClient