如何使用PHP客户端更新和删除Elasticsearch文档

超、凢脫俗 2023-10-05 11:19 40阅读 0赞

**介绍：**

如果您正在寻找可扩展的全文本搜索引擎，那么Elasticsearch是自然的选择。Elasticsearch为用户提供了一些流行语言（包括PHP）的官方API。Elasticsearch的低级PHP客户端提供了简化的界面，可轻松与Elasticsearch进行通信。可以轻松快捷地完成索引，删除，更新和检索文档等常见任务。在本教程中，我们将说明如何使用PHP客户端库在PHP中更新Elasticsearch文档，并且还将向您展示如何以类似的方式删除文档。

**先决条件**

在我们尝试使用PHP更新或删除Elasticsearch文档之前，确保有一些前提条件很重要。此任务有许多系统要求：

*  首先，请确保在服务器上正确安装和配置了Elastic Stack以及Java。
 *  请记住，本教程中显示的示例假定您已收集了可以在演示期间进行修改的数据。
 *  您可以通过http://localhost:9200在浏览器中导航到本地是否运行Elasticsearch或https://\{YOUR\_DOMAIN\}:\{ELASTICSEARCH\_PORT\}在其他服务器上运行来查看Elasticsearch服务是否正在运行。您应该看到一个包含Elasticsearch集群信息的JSON对象响应：

**通过导航到9200浏览器中的端口，来自Elasticsearch集群的JSON响应：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70][]

*  确保正确安装了Elasticsearch PHP低级客户端（有关更多详细信息，请参见[Elastic的PHP客户端官方Git存储库][Elastic_PHP_Git]）。
 *  请记住，Elastic Stack的PHP客户端需要PHP 7.x或更高版本才能正常工作。要查看机器或服务器上正在运行哪个版本的PHP，请在终端中使用php带有\-v选项的命令：

php -v

*  如果您正在运行PHP 7，那么就可以继续前进了！ ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 1][]

**为Elasticsearch客户端创建一个新的PHP脚本**

我们需要做的第一件事是为Elasticsearch客户端创建一个新的PHP脚本。vendor使用cd终端中的命令导航到PHP客户端库所在的目录。进入该目录后，为您的API代码创建一个新的PHP脚本。您可以使用以下touch命令创建文件并为其命名：

sudo touch my-elastic.php  
您可以使用nano，vi或其他基于终端的文本编辑器来编辑你的脚本，该脚本将与Elasticsearch PHP库连接：

sudo nano my-elastic.php

**将PHP脚本连接到低级Elasticsearch客户端**

接下来，我们需要将脚本与Elasticsearch客户端连接。在我们的示例中，连接设置使用HTTPS。如果您使用的是HTTP，只需将$hosts阵列设置更改为http，并将端口设置为9200。所有其他设置可以保持不变。

您可以使用PHPrequire()函数来包含vendor目录的autoload.php脚本：

vendor我们之前提到的文件夹包含由Composer创建的整个Elasticsearch PHP库。该文件夹应与脚本位于同一目录中。如果不是，则[说明低级客户端未正确安装][Link 1]，或者Composer在其他目录中运行。

您还可以指定路径，或通过附加\_\_DIR\_\_常量使用脚本的当前工作路径： \`php require **DIR** . ‘/vendor/autoload.php’

**配置PHP$hosts数组以匹配Elasticsearch配置**

下一步将配置$hosts阵列，使其与服务器或计算机elasticsearch.yml文件中的设置一致：

$hosts = \[  
'host' => 'localhost',  
'port' => '9200',  
'scheme' => 'https',  
'user' => 'username',  
'pass' => 'password!\#$?\*yeshua'  
\];

一旦你的$hosts阵列配置正确，你可以用它来创建一个新的$client客户端库的实例。

**注意：**如果尚未配置数组中的某些选项（例如user和password），则可能不需要。

**创建Elasticsearch PHP库的新客户端实例**

您可以通过调用库中的create()方法，为Elasticsearch创建PHP低级客户端的新客户端实例ClientBuilder：

$client = Elasticsearch\\ClientBuilder::create()  
\->setHosts($hosts)  
\->build();

该$client对象的内置方法可用于更改Elasticsearch文档。

**创建一个$paramsPHP对象数组以选择Elasticsearch索引的文档**

您可以创建一个$paramsPHP对象数组，该数组用于通过将索引名和文档的"\_id"作为参数传递来在Elasticsearch索引中选择文档：

$params = \[  
'index' => 'index\_name',  
'type' => 'doc\_type',  
'id' => '1'  
\];

创建此对象数组时，请确保正确传递值，因为它们区分大小写。还请记住，文档'id'必须作为字符串而不是整数传递。

**在PHP中更新Elasticsearch文档**

*  **警告：**更新文档将**覆盖以前**文档中的**旧信息**。

让我们看一下更新PHP中的Elasticsearch文档所需的代码示例。要做到这一点，你需要指定index，type以及id确定哪些文件得到更新。您在任何字段和值doc，这是内部的body参数，将被合并到更新的文档。在此示例中，我们将值设置age为7：

$params = \[  
'index' => 'children',  
'type' => 'child',  
'id' => 'child2'  
'body' => \[  
'doc' => \[  
'age' => 7  
\]  
\]  
\];

如上例所示，更新文档时可以传递整数和字符串。只要确保索引\_mapping将要更新的字段定义为整数类型即可。

**得到Elasticsearch的回应**

您可以使用tryandcatch块通过update()在try方括号内调用方法来捕获Elasticsearch异常：

try\{   
// Calling the update method  
$response = $client\->update($params);  
\} catch (Exception $e) \{   
// var\_dump will serialize the error message response  
// and display it on the webpage  
[var\_dump][var_dump]($e\->getMessage());  
\}

**使用Kibana验证API调用是否成功**

您还可以使用Kibana控制台来验证更新是否成功。只需GET在Kibana控制台用户界面中进行请求：

GET children/child/child2

您应该在Kibana的结果窗格中看到类似于下图的图像：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 2][]

更新Elasticsearch文档的另一种方法是在文档中添加一个新字段。在此示例中，我们添加了一个名为的字段complexion：

$params = \[  
'index' => 'children',  
'type' => 'child',  
'id' => 'child2',  
'body' => \[  
'doc' => \[  
'complexion' => "Moreno"  
// new field with value  
\]  
\]  
\];

try\{   
$response = $client\->update($params); // Calling the update method.  
\} catch (Exception $e) \{   
[var\_dump][var_dump]($e\->getMessage());  
\}

与之前的更新一样，我们可以使用Kibana控制台来验证更新操作是否成功：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 3][]

**使用PHP客户端删除Elasticsearch文档**

您不仅可以在PHP中更新Elasticsearch文档，还可以使用PHP客户端删除文档。要删除一个文件，你需要指出的index，type和id作为参数：

$params = \[  
'index' => 'children',  
'type' => 'child',  
'id' => 'child2',  
  
\];  
  
  
$response = $client\->delete($params);

在上面所示的例子中，与文档id的child2将被删除。这意味着该文档将不再可搜索。

您可以使用下面显示的命令来验证在Kibana中的删除：

GET children/child/child2

如果删除成功，您将在Kibana的结果窗格中看到以下内容：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 4][] \*注意它返回了found : false。

**结论**

在Elasticsearch中处理数据时，更新和删除文档是常见的任务。幸运的是，Elasticsearch PHP客户端提供了一个简单的界面来执行这些操作。按照本教程中提供的说明，使用Elasticsearch PHP客户端可以轻松地从Elasticsearch索引更新和删除文档。

尽管在本教程中我们一次只检查了一段代码，但是您可以在下面完整地检查PHP脚本：

require 'vendor/autoload.php'; \# include client library  
  
// or uncomment this to specify the current directory:  
//require \_\_DIR\_\_ . '/vendor/autoload.php'\`  
  
// create a "hosts" array with the Elasticsearch  
// cluster's configuration passed as parameters  
$hosts = \[  
'host' => 'localhost',  
'port' => '9200',  
'scheme' => 'https',  
'user' => 'username',  
'pass' => 'password!\#$?\*yeshua'  
\];  
  
// create a new client instance  
$client = Elasticsearch\\ClientBuilder::create()  
\->setHosts($hosts)  
\->build();  
  
  
/\* GETTING AN ELASTICSEARCH DOCUMENT  
pass the index name and doc id as parameters  
in a PHP associative array  
\*/  
  
/\*  
$params = \[  
'index' => 'index\_name',  
'type' => 'doc\_type',  
'id' => '1'  
\];  
\*/  
  
// update a document in the parameters  
$params = \[  
'index' => 'children',  
'type' => 'child',  
'id' => 'child2'  
'body' => \[  
'doc' => \[  
'age' => 7  
// changes the age to 7  
// when passed to client  
\]  
\]  
\];  
  
// use a try and catch block to pass the parameters to  
// the PHP client library to make a request to Elasticsearch  
try\{   
// Calling the update method  
$response = $client\->update($params);  
\} catch (Exception $e) \{   
// var\_dump will serialize the error message response  
// and display it on the webpage  
[var\_dump][var_dump]($e\->getMessage());  
\}

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20201008184745103.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[Elastic_PHP_Git]: https://github.com/elastic/elasticsearch-php
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20201008184745111.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[Link 1]: https://github.com/elastic/elasticsearch-php#installation-via-composer
[var_dump]: http://www.php.net/var_dump
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20201008184745112.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20201008184745124.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20201008184745128.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2FsbHdheTI=,size_16,color_FFFFFF,t_70

发表评论取消回复

表情：

评论列表（有 0 条评论，40人围观）

还没有评论，来说两句吧...

相关阅读

相关 Elasticsearch--客户端

[Es客户端][Es] 语言无关 ![ac8909b1738a4ea1ad21a7f1058b538c.png][] java最常用的客户端是Java Client、

墨蓝/ 2024年03月17日 20:05/ 0 赞/ 42 阅读

相关 ElasticSearch6.x 基于SpringBoot 实现ElasticSearch的文档查询、更新和删除管理

SpringBoot 功能封装涉及ElasticSearch的文档查询、更新和删除方法约定如下： public BulkByScrollResponse deleteDocu

ゝ一纸荒年。/ 2023年10月18日 22:23/ 0 赞/ 119 阅读

相关如何使用PHP客户端更新和删除Elasticsearch文档

介绍：如果您正在寻找可扩展的全文本搜索引擎，那么Elasticsearch是自然的选择。Elasticsearch为用户提供了一些流行语言（包括PHP）的官方API。Ela

超、凢脫俗/ 2023年10月05日 11:19/ 0 赞/ 41 阅读

相关 Elasticsearch Java REST高级客户端删除索引

Elasticsearch Java REST高级客户端删除索引版本：Elasticsearch 7.2.0 1、索引是否存在 2、删除索引 3、创建客户端

比眉伴天荒/ 2023年06月15日 11:17/ 0 赞/ 5 阅读

相关使用java客户端操作elasticsearch

使用java客户端操作elasticsearch 本文主要参考： https://www.elastic.co/guide/en/elasticsearch/clien

爱被打了一巴掌/ 2022年09月30日 12:58/ 0 赞/ 249 阅读

相关 SVN客户端使用文档

一、安装svn客户端，对应windows系统分别安装32位或64位 1、点击计算机右键选择属性，也可以打开控制面板\--->系统和安全\--->系统，如下图： ![70][

阳光穿透心脏的1/2处/ 2022年05月22日 08:40/ 0 赞/ 281 阅读

相关 Elasticsearch：替换、更新和删除性能分析

替换、更新和删除在使用ES的时候，如果你认真观察了，你会发现，替换、更新和更新都是有蛮大的区别的。虽然说结果是一样的，但是原理还是不同的。这一点一定要明确。一、看

港控/mmm°/ 2022年05月19日 05:12/ 0 赞/ 550 阅读

相关 Java ElasticSearch 客户端和工具 wES

wES 详细介绍 wES 是一组开源的Java ElasticSearch客户端和工具; 简洁但是很勥 :) wES = Java Retrofit2/OkHttp版本的客

ゝ一纸荒年。/ 2022年05月16日 21:30/ 0 赞/ 177 阅读

相关 Elasticsearch Java REST高级客户端条件更新 updateQuery

Elasticsearch Java REST高级客户端条件更新 updateQuery Elasticsearch 7.2.0 1.条件更新 2.客户端创建 3

忘是亡心i/ 2021年11月05日 23:08/ 0 赞/ 1247 阅读

相关 Elasticsearch Java REST高级客户端条件删除 DeleteByQuery

Elasticsearch Java REST高级客户端条件删除 DeleteByQuery Elasticsearch 7.2.0 1.条件删除 2.客户端创建

野性酷女/ 2021年11月05日 22:58/ 0 赞/ 927 阅读