README

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

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

特性

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

版本矩阵

由于 Elasticsearch 1.0（及其发布时的 2.0）有破坏性更改，因此您需要将 Elasticsearch 的版本与库的适当版本相匹配。

如果您正在使用 Elasticsearch 1.0+，则必须安装 1.0 Elasticsearch-PHP 分支。
如果您使用的是低于 1.0 的版本，则必须安装 0.4 Elasticsearch-PHP 分支。由于 ES 0.90.x 及以下版本现已停用，相应的 0.4 分支将不再接收任何开发或错误修复。请升级。
您永远不应使用 Elasticsearch-PHP Master 分支，因为它跟踪 Elasticsearch master，可能包含不完整的功能或向后兼容性中断。只有在您有某种原因针对 ES master 开发时，才应使用 ES-PHP master。

v2.0 测试版

您知道现在有一个全新的 Elasticsearch-PHP 测试版吗？如果您目前正在使用 ES-PHP，您应该尝试它并发送反馈！如果您是 Elasticsearch-PHP 的新用户，您应该使用 v2.0 开始您的项目，因为代码库正朝着这个方向发展。

v2.0 特性

基于 RingPHP 的新 HTTP 核心，这是 Guzzle5 的内部 HTTP 核心
由于 RingPHP，我们现在可以公开一个可选的异步模式（基于 futures），允许并行执行 curl 请求，从而获得更好的吞吐量
依赖项更少，使得发行版更小，冲突更少
简化了架构，使整个代码库更小，更可插拔，开销更少

在此处查看文档。破坏性更改在此处。

今天就在您的项目中试用它！

{
    "require": {
       "elasticsearch/elasticsearch": "~2.0@beta"
   }
}

文档

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

通过 Composer 安装

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

下载并安装 Composer for Linux/Unix/OSX 或 Windows。

安装最新稳定版

    php composer.phar require elasticsearch/elasticsearch

需要Composer的自动加载器

Composer还准备了一个可以自动加载它下载的任何库中所有类的自动加载文件。要使用它，只需将以下行添加到您代码的引导过程中
```
    <?php
    require 'vendor/autoload.php';

    $client = new Elasticsearch\Client();
```

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

您会注意到安装命令指定了 --no-dev。这防止Composer安装各种测试和开发依赖项。对于普通用户来说，没有必要安装测试套件（该测试套件还包括Elasticsearch的完整源代码）。如果您想为开发做出贡献，只需省略 --no-dev 标志，以便运行测试。

PHP版本要求

此库支持的最低PHP版本是5.3.9。有关为什么是这样，请参阅最小PHP版本要求文档。

索引一个文档

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

要索引一个文档，我们只需指定一个包含要索引的文档的 body。文档中的每个字段都由关联数组中的不同键/值对表示。

索引、类型和ID也指定在参数关联数组中

    $params = array();
    $params['body']  = array('testField' => 'abc');
    $params['index'] = 'my_index';
    $params['type']  = 'my_type';
    $params['id']    = 'my_id';
    $ret = $client->index($params);

获取一个文档

让我们获取我们刚刚索引的文档

    $getParams = array();
    $getParams['index'] = 'my_index';
    $getParams['type']  = 'my_type';
    $getParams['id']    = 'my_id';
    $retDoc = $client->get($getParams);

搜索一个文档

搜索是Elasticsearch的标志（不足为奇！），因此让我们执行一个基本的搜索。我们将使用Match查询进行演示

    $searchParams['index'] = 'my_index';
    $searchParams['type']  = 'my_type';
    $searchParams['body']['query']['match']['testField'] = 'abc';
    $queryResponse = $client->search($searchParams);

    echo $queryResponse['hits']['hits'][0]['_id']; // Outputs 'abc'

更新一个文档

让我们更新我们已索引的文档

    $updateParams['index']          = 'my_index';
    $updateParams['type']           = 'my_type';
    $updateParams['id']             = 'my_id';
    $updateParams['body']['doc']    = array('my_key' => 'new_value');

    $retUpdate = $client->update($updateParams);

删除一个文档

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

    $deleteParams = array();
    $deleteParams['index'] = 'my_index';
    $deleteParams['type'] = 'my_type';
    $deleteParams['id'] = 'my_id';
    $retDelete = $client->delete($deleteParams);

删除一个索引

由于Elasticsearch的动态性，我们添加的第一个文档自动创建了一个具有一些默认设置的索引。让我们删除这个索引，因为我们想稍后指定自己的设置

    $deleteParams['index'] = 'my_index';
    $client->indices()->delete($deleteParams);

创建一个索引

好，现在我们从头开始，让我们添加一个新的索引并使用一些自定义设置

    $indexParams['index'] = 'my_index';
    $indexParams['body']['settings']['number_of_shards'] = 2;
    $indexParams['body']['settings']['number_of_replicas'] = 0;
    $client->indices()->create($indexParams);

总结

这只是对客户端及其语法的快速概述。如果您熟悉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-2014 Elasticsearch

根据Apache License，版本2.0（“许可证”）；除非您遵守许可证，否则不得使用此文件。您可以在以下位置获得许可证副本：

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

除非适用法律要求或书面同意，否则根据许可证分发的软件按照“原样”基础分发，不提供任何形式（明示或暗示）的保证或条件。有关许可证的具体语言，请参阅许可证。

LGPL v2.1 通告

版权（C）2013-2014 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

mertyildiran / elasticsearch

维护者

详细信息