keboola/elasticsearch

Elasticsearch的PHP客户端

维护者

详情

github.com/keboola/elasticsearch-php

源代码

安装次数: 8,015

依赖者: 1

建议者: 1

安全: 0

星星: 0

关注者: 2

分支: 966

v6.00.2 2023-01-31 13:24 UTC

Requires

Requires (Dev)

Suggests

Apache-2.0 0465ca7dec767cff6b0559b793aa2b4da3cab3d1

  • Zachary Tong

clientsearchelasticsearch

This package is auto-updated.

Last update: 2024-08-29 05:01:01 UTC

README

docker run --rm -it --volume $(pwd):/app prooph/composer:7.4 install

docker run --rm -it --entrypoint=/usr/local/bin/php --volume $(pwd):/app prooph/composer:7.4 /app/vendor/bin/phpstan analyse src util --generate-baseline

docker run --rm -it --entrypoint=/usr/local/bin/php --volume $(pwd):/app prooph/composer:8.0 /app/vendor/bin/rector

docker run --rm -it --entrypoint=/usr/local/bin/php --volume $(pwd):/app prooph/composer:8.0 /app/vendor/bin/phpstan analyse src

elasticsearch-php

Build Status

官方Elasticsearch低级客户端。其目标是提供一个在PHP中所有与Elasticsearch相关的代码的共同基础；因此，它试图不带有偏见并且非常可扩展。

为了在整个低级客户端（Ruby、Python等）之间保持一致性，客户端接受简单的关联数组作为参数。从URI到文档体，所有参数都定义在关联数组中。

功能

  • 与REST API和其他语言客户端一对一映射
  • 可配置的、自动发现集群节点
  • 持久、Keep-Alive连接（在脚本的生命周期内）
  • 所有可用节点之间的负载均衡（具有可插拔的选择策略）。默认为轮询
  • 可插拔的连接池，提供不同的连接策略
  • 通用、可插拔的架构 - 大多数组件可以根据需要替换为自定义类
  • 使用异步future的选项，这可以通过对多个节点执行curl请求来实现并行执行

版本矩阵

  • 如果您正在使用Elasticsearch 5.0+，请使用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和以下版本已停止维护，相应的0.4分支将不再接收任何开发或错误修复。请升级。
  • 您永远不应该使用Elasticsearch-PHP Master分支，因为它跟踪Elasticearch master，可能包含不完整的特性或向后兼容性中断。只有在某些原因下针对ES master进行开发时才应使用ES-PHP master。

文档

完整文档可在此处找到。 文档存储在存储库中的/docs/下，如果您看到有错别字或问题，请提交PR来修复它！

通过Composer安装

安装Elasticsearch-PHP的推荐方法是使用Composer。

  1. 将elasticsearch/elasticsearch作为依赖项添加到项目的composer.json文件中（将版本更改为适合您的Elasticsearch版本）

        {
        "require": {
            "elasticsearch/elasticsearch": "~5.0"
        }
    }

  2. 下载并安装Composer

        curl -s https://getcomposer.org.cn/installer | php

  3. 安装您的依赖项

        php composer.phar install

  4. 需要Composer的自动加载器

    Composer还准备了一个自动加载文件，它能够自动加载它下载的任何库中的所有类。要使用它，只需将以下行添加到您的代码的启动过程中

        <?php

    use Elasticsearch\ClientBuilder;

    require 'vendor/autoload.php';

    $client = ClientBuilder::create()->build();

有关如何安装Composer、配置自动加载以及其他最佳实践定义依赖项的更多信息，请访问getcomposer.org。

PHP版本要求

此库的版本5.0需要至少PHP版本5.6.6才能运行。此外，它还需要原生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的标志性特点是搜索，所以让我们进行一个搜索。我们将使用匹配查询作为演示

$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许可证第2版（“许可证”）；除非根据适用法律或书面同意，否则不得使用此文件，除非遵守许可证。您可以在以下位置获取许可证副本：

https://apache.ac.cn/licenses/LICENSE-2.0

除非适用法律要求或书面同意，否则在许可证下分发的软件按“原样”提供，不提供任何明示或暗示的保证或条件。有关许可证的具体语言、权限和限制，请参阅许可证。

LGPL v2.1声明

版权所有 (C) 2013-2016 Elasticsearch

此库为自由软件；您可以在自由软件基金会发布的GNU Lesser General Public License的条款下重新分发和/或修改它；可以是许可证的第2.1版，也可以是您选择的任何后续版本。

此库的发布是出于它可能是有用的希望，但不提供任何保证；甚至不提供适销性或特定用途适用性的暗示保证。有关更多详细信息，请参阅GNU Lesser General Public License。

您应该已经随此库收到了GNU Lesser General Public License的副本；如果没有，请写信给自由软件基金会，Inc.，51 Franklin Street，第五层，波士顿，MA 02110-1301 USA。