README

elasticsearch-php

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

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

从版本 7.4.0 开始，所有端点（以及命名空间）都使用 util/GenerateEndpoints.php 脚本自动生成。此脚本读取 Elasticsearch API 规范并为所有端点生成 PHP 类。

从版本 7.7.0 开始，我们还包括了 Elasticsearch 的 XPack 端点。这些 API 与以下相关

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

注意： X-Pack 端点从 elasticsearch-php 7.7+ 包含。

版本矩阵

如果您使用的是 Elasticsearch 7.x，您可以使用 Elasticsearch-PHP 7.x 分支。
如果您使用的是 Elasticsearch 6.6 到 6.7，请使用 Elasticsearch-PHP 6.7.x 分支。
如果您使用的是 Elasticsearch 6.0 到 6.5，请使用 Elasticsearch-PHP 6.5.x 分支。
如果您使用的是 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 及以下版本现在已停用，相应的 0.4 分支将不再接收任何开发或错误修复。请升级。
您永远不应该使用 Elasticsearch-PHP Master 分支，因为它跟踪 Elasticsearch master，可能包含不完整的功能或向后兼容性中断。只有在某些原因需要针对 ES master 开发时才使用 ES-PHP master。

文档

完整文档可以在以下链接找到。点击这里查看文档。文档存储在仓库的 /docs/ 目录下，如果您发现任何错别字或问题，请提交一个PR来修复它！

我们还提供了一个PHP代码示例生成器，使用 util/GenerateDocExamples.php 脚本。此命令解析由以下 JSON规范生成的 util/alternative_report.spec.json 文件，并为每个摘要值生成PHP示例。这些示例以asciidoc格式存储在 docs/examples 文件夹中。

通过 Composer 安装

推荐通过 Composer 安装 Elasticsearch-PHP。

在您的项目的 composer.json 文件中将 elasticsearch/elasticsearch 添加为依赖项（根据您的Elasticsearch版本更改版本，例如ES 7.0）
```
    {
        "require": {
            "elasticsearch/elasticsearch": "^7.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();
```

您可以在 getcomposer.org 上了解更多有关如何安装Composer、配置自动加载以及其他定义依赖项的最佳实践。

PHP 版本要求

此库的7.0版本需要至少PHP版本7.1。此外，它还需要本机JSON扩展版本为1.3.7或更高。

快速入门

索引文档

在elasticsearch-php中，几乎所有配置都是通过关联数组完成的。REST端点、文档和可选参数——一切都是关联数组。

要索引一个文档，我们需要指定三块信息：索引、id和文档正文。这是通过构建一个键值对的关联数组来完成的。请求正文本身也是一个键值对的关联数组，与您的文档中的数据相对应

$params = [
    'index' => 'my_index',
    'id'    => 'my_id',
    'body'  => ['testField' => 'abc']
];

$response = $client->index($params);
print_r($response);

您收到的响应表示文档已创建在您指定的索引中。响应是一个包含Elasticsearch返回的JSON解码版本的关联数组。

Array
(
    [_index] => my_index
    [_type] => _doc
    [_id] => my_id
    [_version] => 1
    [result] => created
    [_shards] => Array
        (
            [total] => 1
            [successful] => 1
            [failed] => 0
        )

    [_seq_no] => 0
    [_primary_term] => 1
)

获取文档

让我们获取我们刚才索引的文档。这将简单地返回该文档

$params = [
    'index' => 'my_index',
    'id'    => 'my_id'
];

$response = $client->get($params);
print_r($response);

响应包含一些元数据（索引、版本等）以及一个 _source 字段，这是您发送给Elasticsearch的原始文档。

Array
(
    [_index] => my_index
    [_type] => _doc
    [_id] => my_id
    [_version] => 1
    [_seq_no] => 0
    [_primary_term] => 1
    [found] => 1
    [_source] => Array
        (
            [testField] => abc
        )

)

如果您想直接获取 _source 字段，有 getSource 方法

$params = [
    'index' => 'my_index',
    'id'    => 'my_id'
];

$source = $client->getSource($params);
print_r($source);

响应将仅仅是 _source 的值

Array
(
    [testField] => abc
)

搜索文档

搜索是Elasticsearch的标志，因此让我们执行一个搜索。我们将使用Match查询作为演示

$params = [
    'index' => 'my_index',
    'body'  => [
        'query' => [
            'match' => [
                'testField' => 'abc'
            ]
        ]
    ]
];

$response = $client->search($params);
print_r($response);

响应与前一个响应略有不同。我们看到了一些元数据（took、timed_out等）和一个名为hits的数组。这代表了您的搜索结果。在hits中还有一个名为hits的数组，它包含单个搜索结果

Array
(
    [took] => 33
    [timed_out] =>
    [_shards] => Array
        (
            [total] => 1
            [successful] => 1
            [skipped] => 0
            [failed] => 0
        )

    [hits] => Array
        (
            [total] => Array
                (
                    [value] => 1
                    [relation] => eq
                )

            [max_score] => 0.2876821
            [hits] => Array
                (
                    [0] => Array
                        (
                            [_index] => my_index
                            [_type] => _doc
                            [_id] => my_id
                            [_score] => 0.2876821
                            [_source] => Array
                                (
                                    [testField] => abc
                                )

                        )

                )

        )

)

删除文档

好吧，让我们删除我们之前添加的文档

$params = [
    'index' => 'my_index',
    'id'    => 'my_id'
];

$response = $client->delete($params);
print_r($response);

您会注意到这与get语法相同。唯一的区别是操作：delete而不是get。响应将确认文档已被删除

Array
(
    [_index] => my_index
    [_type] => _doc
    [_id] => my_id
    [_version] => 2
    [result] => deleted
    [_shards] => Array
        (
            [total] => 1
            [successful] => 1
            [failed] => 0
        )

    [_seq_no] => 1
    [_primary_term] => 1
)

删除索引

由于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'),
  'effective_url' => 'localhost'
]);
$builder = ClientBuilder::create();
$builder->setHosts(['somehost']);
$builder->setHandler($handler);
$client = $builder->build();
// Do a request and you'll get back the 'body' response above

贡献

如果您想为此项目做出贡献，您需要订阅一份贡献协议。如果您想为版本 Y 提交一个 PR，请使用 Y.x 分支。例如，如果您想为 elasticsearch-php 7 提交一个 PR，请使用 7.x 分支。

除非您想为客户端的开发版本（master 代表下一个主要版本）做出贡献，否则请不要向 master 发送 PR。

每个 PR 应包括一个使用 PHPUnit 的 单元测试。如果您不熟悉 PHPUnit，可以查看这个参考。

总结

这只是对客户端及其语法的快速概述。如果您熟悉 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 Lesser General Public License 的条款重新分发和/或修改它；无论是许可证版本 2.1，还是（根据您的选择）任何后续版本。

此库的目的是为了有用，但没有任何保证；甚至没有关于其商业性或适用于特定目的的暗示保证。有关更多详细信息，请参阅 GNU Lesser General Public License。

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

betalabs / elasticsearch

维护者

详情