Elasticsearch使用update_by_query

    elasticsearch中有一个方法是批量修改,就是先查询出需要修改的索引记录,然后批量修改。这个本来没什么,但是使用过的都知道,用java来调用这个方法很别扭。

    一般来说,我们使用elasticsearch,都建议使用Java Rest Client,就是RestHighLevelClient这个api。这里得从Java Client和Java Rest Client说起了,低版本的elasticsearch提供了ElasticsearchClient的实现,TransportClient,一个传输客户端。在6.4.x 版本中,需要用TransportClient来构建ElasticsearchClient,并且这个client才是实现本文update_by_query所需的client。

    因为我们要使用UpdateByQueryRequestBuilder,所以必须使用ElasticsearchClient,而这个client只能通过TransportClient来构建,在6.4.x版本中,我们还需要引入transport依赖:

<dependency>
  <groupId>org.elasticsearch.client</groupId>
  <artifactId>transport</artifactId>
  <version>6.4.0</version>
</dependency>

    因为RestClient无法满足构建条件。transportclient连接elasticsearch,使用的端口是9300,而不是和restclient一样使用的是http连接的9200。

    对比一下restclient构建:

    elasticsearch开启了两种不同类型的服务端口,transportclient与elasticsearch更加的解耦合。

    前面提到了要使用UpdateByQueryRequestBuilder,就必须使用transport依赖。而改依赖里面就是一个简单的实现类PreBuiltTransportClient。

    前面废话这么多,无非就是现在elasticsearch版本多,依赖版本也多,而且有的api被丢弃,有的api发生了改变,让我们很难捉摸。

    下面我们通过一个简单的示例,了解一下update_by_query,首先通过工具以命令的方式看看执行结果:这里构建一个index=students,type=student的索引,有3条记录,每条记录有一个age字段均为18。

    这里通过执行查询然后修改操作,将student的age全部修改为32:

    操作执行成功,受影响的记录有3条。再次查看所有的索引记录:

    以上这个步骤是通过命令的方式验证了_update_by_query的可行性,我们现在通过java代码的方式来实现这种操作,前面说了,这个操作需要用到ElasticsearchClient,而ElasticsearchClient需要通过TransportClient来构建。这里直接给出源代码,我的pom.xml依赖是这样的:

    java代码:

package com.xxx.elasticsearch;
import java.net.InetAddress;
import java.util.HashMap;
import java.util.Map;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.elasticsearch.client.ElasticsearchClient;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.transport.TransportAddress;
import org.elasticsearch.index.query.QueryBuilders;
import org.elasticsearch.index.reindex.BulkByScrollResponse;
import org.elasticsearch.index.reindex.UpdateByQueryAction;
import org.elasticsearch.index.reindex.UpdateByQueryRequestBuilder;
import org.elasticsearch.script.Script;
import org.elasticsearch.script.ScriptType;
import org.elasticsearch.transport.client.PreBuiltTransportClient;

@SuppressWarnings("unchecked")
public class UpdateByQueryApp {
	
	private static final Logger log = LogManager.getLogger(UpdateByQueryApp.class);

	private static ElasticsearchClient client = null;
	
	static{
		try {
			client = new PreBuiltTransportClient(Settings.EMPTY)
					.addTransportAddress(
							new TransportAddress(InetAddress.getByName("127.0.0.1"),9300)
					);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
	
	public static void update(){
		UpdateByQueryRequestBuilder updateByQuery = UpdateByQueryAction
				.INSTANCE.newRequestBuilder(client);
		Map<String, Object> params = new HashMap<String, Object>();
		params.put("age", 18);
		ScriptType type = ScriptType.INLINE;
		String lang = "painless";
		String code = "ctx._source.age=params.age";
		Script script = new Script(type, lang, code, params);
		BulkByScrollResponse response = updateByQuery.source("students").script(script)
				.filter(QueryBuilders.termQuery("age", "32"))
				.abortOnVersionConflict(false)
				.get();
		log.info("update : "+response.getUpdated());
	}
	
	public static void main(String[] args) {
		update();
	}

}

    前面我们通过命令的方式将所有students索引记录的age修改为了32,这里我们就将所有age=32的记录,全部修改为age=18。运行程序,控制台打印信息如下:

2019-09-04 21:15:02 - org.elasticsearch.plugins.PluginsService.logPluginInfo [main] [INFO ] - no modules loaded
2019-09-04 21:15:02 - org.elasticsearch.plugins.PluginsService.logPluginInfo [main] [INFO ] - loaded plugin [org.elasticsearch.index.reindex.ReindexPlugin]
2019-09-04 21:15:02 - org.elasticsearch.plugins.PluginsService.logPluginInfo [main] [INFO ] - loaded plugin [org.elasticsearch.join.ParentJoinPlugin]
2019-09-04 21:15:02 - org.elasticsearch.plugins.PluginsService.logPluginInfo [main] [INFO ] - loaded plugin [org.elasticsearch.percolator.PercolatorPlugin]
2019-09-04 21:15:02 - org.elasticsearch.plugins.PluginsService.logPluginInfo [main] [INFO ] - loaded plugin [org.elasticsearch.script.mustache.MustachePlugin]
2019-09-04 21:15:02 - org.elasticsearch.plugins.PluginsService.logPluginInfo [main] [INFO ] - loaded plugin [org.elasticsearch.transport.Netty4Plugin]
2019-09-04 21:15:05 - com.xxx.elasticsearch.UpdateByQueryApp.update [main] [INFO ] - update : 3

    表明批量修改成功,可以查看记录:

    需要注意的是,transportclient和restclient他们构建时所需的端口是不一样的,分别是9300和9200。

<think>首先,用户的问题是关于Elasticsearch的_update_by_queryAPI的,他们想要示例和使用方法。我需要参考系统指令和提供的引用来构建我的回答。系统指令:-所有行内数学表达式用$...$格式。但在这个上下文中,可能不涉及数学,所以我应该避免不必要的数学。-独立公式用$$...$$并单独成段。同样,可能不需要。-LaTeX语法正确:确保任何数学表达正确。-使用中文回答:整个回答必须用中文。-生成相关问题:在回答末尾,添加相关问题。-引用的段落末尾添加引用标识,如[^1]。用户可见层指令:-回答结构清晰,逐步解决问题。-保证回答真实可靠。-参考站内引用:引用[1]和引用[2]是关于_update_by_query的示例,我需要基于这些来回答。用户的问题:"我想查找如何使用Elasticsearch的_update_by_queryAPI来修改数据的方法或示例请问Elasticsearch_update_by_query修改数据示例使用方法"所以,我的回答应该:1.解释_update_by_query是什么。2.提供使用方法的步骤。3.展示示例代码,基于引用。4.确保结构清晰。5.末尾添加相关问题。从引用:-引用[1]:展示了一个简单的_update_by_query请求,更新userid字段。-引用[2]:展示了更复杂的脚本,包括条件检查和日期格式化。我应该整合这些示例。回答结构:-简介:简述_update_by_query的作用。-使用方法:步骤说明。-示例:提供简单和复杂的例子。-注意事项:可能包括性能、错误处理等。-相关问题:生成3个相关问题。由于系统指令说"回答中引用的段落末尾自然地添加引用标识",所以在描述引用内容时添加引用。最终回答用中文。</think>### Elasticsearch _update_by_query API 使用方法与示例 Elasticsearch 的 `_update_by_query` API 用于批量修改索引中的数据,特别适合基于查询条件更新文档。它结合查询(query)和脚本(script)来实现高效的数据操作。下面我将逐步解释其使用方法,并提供实际示例,确保内容真实可靠(基于官方文档和常见实践)。 #### 1. **API 基本介绍** - `_update_by_query` 允许你执行一个查询,然后对匹配的文档运行脚本进行修改。它常用于批量更新字段值、添加新字段或删除特定数据。 - 核心组件: - `query`:定义要更新的文档筛选条件(如 ID、字段值)。 - `script`:使用 Painless 脚本语言(Elasticsearch 默认脚本引擎)执行修改逻辑,支持条件判断和变量。 - 优点:原子性操作,减少多次请求的开销;缺点:大规模更新时需注意性能影响(如分片处理)。 #### 2. **使用方法步骤** 以下是使用 `_update_by_query` 的通用步骤: 1. **定义索引**:指定要更新的索引名称,如 `POST /your_index/_update_by_query`。 2. **构建查询条件**:在 `query` 中使用 Elasticsearch 查询 DSL(如 `match`、`term`)过滤文档。 3. **编写脚本**:在 `script` 中: - `source`:定义修改逻辑(例如,更新字段值、添加新字段)。 - `lang`:指定脚本语言(默认为 `painless`)。 - `params`:传递动态参数,避免硬编码。 4. **执行请求**:发送 POST 请求到 Elasticsearch,API 返回更新统计信息(如匹配文档数)。 5. **处理结果**:检查响应中的 `updated` 字段确认成功文档数;错误可通过 `conflicts` 处理。 注意: - **性能优化**:对于大型索引,添加 `?conflicts=proceed` 参数避免冲突中断。 - **安全**:脚本中避免无限循环,使用参数化防止注入。 #### 3. **实际示例** 基于您提供的引用内容,以下是常见场景的示例代码(引用来源已标注): **示例 1: 简单字段更新** 更新索引 `test1` 中 ID 为 "1" 的文档,将 `userid` 字段改为 5。 ```json POST /test1/_update_by_query { "query": { "match": { "_id": "1" } }, "script": { "source": "ctx._source.userid = params.userid", "params": { "userid": 5 } } } ``` - **解释**:`query` 匹配 ID,`script` 使用 `params` 动态设置值,减少脚本重编译[^1]。 **示例 2: 复杂逻辑更新(条件检查与添加字段)** 更新索引 `test` 中指定 ID 的文档,修改 `k_VENDORID` 字段,并添加时间戳字段 `t_CLEANTIME`(仅当字段不存在时)。 ```json POST /test/_update_by_query { "script": { "source": "ctx._source.k_VENDORID = params.newValue; if (!ctx._source.containsKey('t_CLEANTIME')) { def dateFormat = new SimpleDateFormat('yyyy-MM-dd HH:mm:ss'); ctx._source.t_CLEANTIME = dateFormat.format(new Date()); }", "lang": "painless", "params": { "newValue": "6666666666666666666666666666666666" } }, "query": { "term": { "_id": { "value": "bg8lgooBm62Q6jNaiSK4" } } } } ``` - **解释**:脚本使用 `containsKey` 检查字段存在性,`SimpleDateFormat` 添加当前时间,确保灵活性[^2]。 **示例 3: 删除字段** 从索引 `test` 中移除指定文档的 `t_CLEANTIME` 字段。 ```json POST /test/_update_by_query { "query": { "term": { "_id": "bg8lgooBm62Q6jNaiSK4" } }, "script": { "source": "ctx._source.remove('t_CLEANTIME')" } } ``` - **解释**:`remove` 方法直接删除字段,适用于数据清理[^2]。 #### 4. **注意事项** - **错误处理**:如果更新失败(如脚本语法错误),检查 Elasticsearch 日志或响应中的 `failures` 字段。 - **性能建议**:大型更新时,分批处理(如使用 `scroll` 查询)或增加 `refresh_interval` 提升效率。 - **版本兼容**:确保脚本语法匹配 Elasticsearch 版本(如 Painless 脚本在 7.x+ 中强化)。 - **测试**:先在开发环境运行,使用 `_validate` API 验证脚本。 #### 5. **相关问题** 为了帮助您深入理解,以下是相关扩展问题: 1. 如何优化 `_update_by_query` 在大规模数据集上的性能? 2. `_update_by_query` 与 `_delete_by_query` API 在数据操作中有何异同? 3. 在 Painless 脚本中如何处理更新错误或回滚机制? [^1]: Elasticsearch 更新之update_by_query,展示了基于 ID 的简单字段更新示例。 [^2]: Elasticsearch实战-update_by_query使用,提供了包含条件逻辑和日期处理的复杂脚本示例。
评论 10
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

luffy5459

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值