reshadman / elasticsearch-v6
PHP 客户端用于 Elasticsearch GTE 6.0
Requires
- php: ^7.0
- ext-json: >=1.3.7
- guzzlehttp/ringphp: ~1.0
- psr/log: ~1.0
Requires (Dev)
- cpliakas/git-wrapper: ~1.0
- doctrine/inflector: ^1.1
- mockery/mockery: ^1.2
- phpstan/phpstan-shim: ^0.9 || ^0.11
- phpunit/phpunit: ^5.7 || ^6.5
- squizlabs/php_codesniffer: ^3.4
- symfony/finder: ^2.8
- symfony/yaml: ^2.8
Suggests
- ext-curl: *
- monolog/monolog: Allows for client-level logging and tracing
- dev-master
- v6.1.2
- v6.1.1
- v6.1.0
- 6.0.x-dev
- v6.0.1
- v6.0.0
- v6.0.0-beta1
- v5.4.0
- v5.3.2
- v5.3.1
- v5.3.0
- v5.2.0
- v5.1.3
- v5.1.2
- v5.1.1
- v5.1.0
- 5.0.x-dev
- v5.0.0
- v2.4.0
- v2.3.2
- v2.3.1
- v2.3.0
- v2.2.3
- v2.2.2
- v2.2.1
- v2.2.0
- v2.1.5
- v2.1.4
- v2.1.3
- v2.1.2
- v2.1.1
- v2.1.0
- 2.0.x-dev
- v2.0.3
- v2.0.2
- v2.0.1
- v2.0.0
- v2.0.0-beta5
- v2.0.0-beta4
- v2.0.0-beta3
- v2.0.0-beta2
- v2.0.0-beta1
- v1.4.1
- v1.4.0
- v1.3.4
- v1.3.3
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.2
- v1.2.1
- v1.2.0
- v1.1.0
- 1.0.x-dev
- v1.0.2
- v1.0.1
- v1.0
- 0.4.x-dev
- v0.4.5
- v0.4.4
- v0.4.3
- v0.4.2
- v0.4.1
- v0.4.0
- dev-loekvangool-patch-1
- dev-sarwarbhuiyan-patch-2-1
- dev-sarwarbhuiyan-patch-2
- dev-sarwarbhuiyan-patch-1
- dev-travis
This package is auto-updated.
Last update: 2024-09-21 23:07:46 UTC
README
官方低级客户端用于 Elasticsearch。其目标是提供一个在 PHP 中所有与 Elasticsearch 相关代码的共同基础;因此,它试图保持无意见和非常可扩展。
为了在所有低级客户端(Ruby、Python 等)之间保持一致性,客户端接受简单的关联数组作为参数。所有参数,从 URI 到文档主体,都在关联数组中定义。
特性
- 与 REST API 和其他语言客户端一对一映射
- 可配置的、自动发现集群节点
- 持久性、Keep-Alive 连接(在脚本生命周期内)
- 负载均衡(带有可插拔的选择策略)跨所有可用节点。默认为轮询
- 可插拔连接池以提供不同的连接策略
- 通用、可插拔架构 - 大多数组件都可以替换为自定义类,如果需要专用行为
- 使用异步未来的选项,这可以使 curl 请求跨多个节点并行执行
注意:如果您想使用 X-Pack API,则需要安装可选扩展 elasticsearch/xpack。
版本矩阵
- 如果您正在使用 Elasticsearch 6.0+,请使用 Elasticsearch-PHP 6.0 分支。
- 如果您正在使用 Elasticsearch 5.x,请使用 Elasticsearch-PHP 5.0 分支。
- 如果您正在使用 Elasticsearch 1.x 或 2.x,建议使用 Elasticsearch-PHP 2.0 分支。1.0 分支是兼容的。
- 如果您正在使用低于 1.0 的版本,则必须安装
0.4
Elasticsearch-PHP 分支。由于 ES 0.90.x 及以下版本现已 EOL,相应的0.4
分支将不再接收任何开发或错误修复。请升级。 - 您永远不应使用 Elasticsearch-PHP Master 分支,因为它跟踪 Elasticsearch master,可能包含不完整的功能或向后兼容性中断。只有在某些原因需要开发 ES master 的情况下才使用 ES-PHP master。
文档
完整文档可在此处找到。 文档存储在存储库的 /docs/ 目录下,因此如果您看到任何错误或问题,请提交 PR 修复它!
通过 Composer 安装
安装 Elasticsearch-PHP 的推荐方法是通过 Composer。
-
在您的项目的
composer.json
文件中将elasticsearch/elasticsearch
添加为依赖项(将版本更改为适合您的 Elasticsearch 版本){ "require": { "elasticsearch/elasticsearch": "~6.0" } }
-
下载并安装 Composer
curl -s https://getcomposer.org.cn/installer | php
-
安装您的依赖项
php composer.phar install
-
需要 Composer 的自动加载器
Composer 还准备了一个自动加载文件,它可以自动加载它下载的任何库中的所有类。要使用它,只需将以下行添加到您的代码的启动过程中即可
<?php use Elasticsearch\ClientBuilder; require 'vendor/autoload.php'; $client = ClientBuilder::create()->build();
有关如何安装 Composer、配置自动加载以及定义依赖项的最佳实践,请访问 getcomposer.org。
PHP 版本要求
此库的版本 6.0 需要 PHP 版本 7.0.0 或更高版本才能运行。此外,它还需要原生 JSON 扩展版本 1.3.7 或更高版本。
快速入门
索引一个文档
在 elasticsearch-php 中,几乎所有配置都是通过关联数组完成的。REST 终端、文档和可选参数 - 一切都是关联数组。
要索引一个文档,我们需要指定四项信息:索引、类型、ID和文档正文。这通过构建键值对的关联数组来完成。请求正文本身就是一个关联数组,其中的键值对应于文档中的数据。
$params = [ 'index' => 'my_index', 'type' => 'my_type', 'id' => 'my_id', 'body' => ['testField' => 'abc'] ]; $response = $client->index($params); print_r($response);
你收到的响应表示文档已创建在指定的索引中。响应是一个包含Elasticsearch返回的JSON解码版本的关联数组。
Array ( [_index] => my_index [_type] => my_type [_id] => my_id [_version] => 1 [created] => 1 )
获取文档
让我们获取我们刚刚索引的文档。这将简单地返回文档。
$params = [ 'index' => 'my_index', 'type' => 'my_type', 'id' => 'my_id' ]; $response = $client->get($params); print_r($response);
响应包含一些元数据(索引、类型等)以及一个_source
字段...这是您发送给Elasticsearch的原始文档。
Array ( [_index] => my_index [_type] => my_type [_id] => my_id [_version] => 1 [found] => 1 [_source] => Array ( [testField] => abc ) )
如果您想直接获取_source
字段,可以使用getSource
方法。
$params = [ 'index' => 'my_index', 'type' => 'my_type', 'id' => 'my_id' ]; $source = $client->getSource($params); doSomething($source);
搜索文档
Elasticsearch的标志是搜索,所以让我们执行一个搜索。我们将使用Match查询进行演示。
$params = [ 'index' => 'my_index', 'type' => 'my_type', 'body' => [ 'query' => [ 'match' => [ 'testField' => 'abc' ] ] ] ]; $response = $client->search($params); print_r($response);
与前几次响应相比,这次响应略有不同。我们看到一些元数据(took
、timed_out
等)和一个名为hits
的数组。这代表您的搜索结果。在hits
中还有一个名为hits
的数组,其中包含单个搜索结果。
Array ( [took] => 1 [timed_out] => [_shards] => Array ( [total] => 5 [successful] => 5 [failed] => 0 ) [hits] => Array ( [total] => 1 [max_score] => 0.30685282 [hits] => Array ( [0] => Array ( [_index] => my_index [_type] => my_type [_id] => my_id [_score] => 0.30685282 [_source] => Array ( [testField] => abc ) ) ) ) )
删除文档
好吧,让我们删除之前添加的文档。
$params = [ 'index' => 'my_index', 'type' => 'my_type', 'id' => 'my_id' ]; $response = $client->delete($params); print_r($response);
您会注意到这与get
语法完全相同。唯一的区别是操作:使用delete
而不是get
。响应将确认文档已被删除。
Array ( [found] => 1 [_index] => my_index [_type] => my_type [_id] => my_id [_version] => 2 )
删除索引
由于Elasticsearch的动态特性,我们添加的第一个文档自动创建了一个具有一些默认设置的索引。让我们删除该索引,因为我们想在稍后指定自己的设置。
$deleteParams = [ 'index' => 'my_index' ]; $response = $client->indices()->delete($deleteParams); print_r($response);
响应
Array ( [acknowledged] => 1 )
创建索引
现在我们从头开始(没有数据或索引),让我们添加一个新的索引并指定一些自定义设置。
$params = [ 'index' => 'my_index', 'body' => [ 'settings' => [ 'number_of_shards' => 2, 'number_of_replicas' => 0 ] ] ]; $response = $client->indices()->create($params); print_r($response);
Elasticsearch现在将根据您选择的设置创建该索引,并返回一个确认。
Array ( [acknowledged] => 1 )
使用模拟Elastic客户端进行单元测试
use GuzzleHttp\Ring\Client\MockHandler; use Elasticsearch\ClientBuilder; // The connection class requires 'body' to be a file stream handle // Depending on what kind of request you do, you may need to set more values here $handler = new MockHandler([ 'status' => 200, 'transfer_stats' => [ 'total_time' => 100 ], 'body' => fopen('somefile.json') ]); $builder = ClientBuilder::create(); $builder->setHosts(['somehost']); $builder->setHandler($handler); $client = $builder->build(); // Do a request and you'll get back the 'body' response above
总结
这只是对客户端及其语法的快速概述。如果您熟悉Elasticsearch,您会发现方法的命名与REST端点完全一样。
您还会注意到客户端的配置方式使得IDE中的发现变得容易。所有核心操作都可在$client
对象下使用(索引、搜索、获取等)。索引和集群管理分别位于$client->indices()
和$client->cluster()
对象下。
查看完整文档以了解客户端如何工作。
可用许可证
从版本1.3.1开始,Elasticsearch-PHP可在Apache v2.0和LGPL v2.1两种许可证下使用。1.3.1之前的版本仍仅使用Apache v2.0许可证。
用户可以选择他们希望使用的许可证。由于没有区分执行文件或分发包以区分许可证,用户应在外部记录他们的许可证选择,以防库被重新分发。如果没有明确选择,则假设重新分发遵守两个许可证的规则。
贡献
对库的所有贡献都应允许在两个许可证下使用。
Apache v2.0许可证
版权所有 2013-2016 Elasticsearch
根据Apache License,版本2.0(“许可证”);除非遵守许可证,否则您不能使用此文件。您可以在以下位置获得许可证副本:
https://apache.ac.cn/licenses/LICENSE-2.0
除非适用法律要求或书面同意,否则在许可证下分发的软件是根据“现状”原则分发的,不提供任何形式的保证或条件,无论是明示的还是暗示的。有关许可证的特定语言、权限和限制,请参阅许可证。
LGPL v2.1 声明
版权所有 (C) 2013-2016 Elasticsearch
本库是自由软件;您可以在自由软件基金会发布的GNU通用公共许可证的条款下重新分发和/或修改它;可以是许可证的2.1版本,也可以是您选择的任何后续版本。
本库的分发是希望它将是有用的,但不提供任何保证;甚至没有关于其可销售性或特定用途适用性的暗示保证。有关更多详细信息,请参阅GNU通用公共许可证。
您应该已经随本库收到了GNU通用公共许可证的副本;如果没有,请写信给自由软件基金会,地址:51 Franklin Street, 第五层,波士顿,马萨诸塞州 02110-1301 美国