betalabs / amazon-es-php
支持使用 IAM 认证与官方 Elasticsearch PHP 客户端
0.3.0
2019-07-20 01:13 UTC
Requires
- aws/aws-sdk-php: ^3.0
- elasticsearch/elasticsearch: ^2.1|^5.0|^6.0|^7.0
Requires (Dev)
- phpunit/phpunit: ^4.8.35|^5.4.0|^6.0.0|^7.0.0|^8.0.0
This package is auto-updated.
Last update: 2024-09-15 02:13:00 UTC
README
此软件包为官方 Elasticsearch-PHP (elasticsearch/elasticsearch
) 客户端提供签名处理程序。默认情况下,处理程序将从环境加载 AWS 凭据,并使用 RingPHP cURL 处理程序发送请求。
基本用法
Aws\ElasticsearchService\ElasticsearchPhpHandler
的实例是可调用的,它们满足 Elasticsearch-PHP 的处理程序合约。可以将它们传递给 Elasticsearch\ClientBuilder
的 setHandler
方法
use Aws\ElasticsearchService\ElasticsearchPhpHandler; use Elasticsearch\ClientBuilder; // Create a handler (with the region of your Amazon Elasticsearch Service domain) $handler = new ElasticsearchPhpHandler('us-west-2'); // Use this handler to create an Elasticsearch-PHP client $client = ClientBuilder::create() ->setHandler($handler) ->setHosts(['https://search-foo-3gn4utxfus5cqpn89go4z5lbsm.us-west-2.es.amazonaws.com:443']) ->build(); // Use the client as you normally would $client->index([ 'index' => $index, 'type' => $type, 'id' => $id, 'body' => [$key => $value] ]);
使用自定义凭证
默认情况下,处理程序将尝试从环境源获取凭证,如 在 AWS SDK for PHP 文档中所述。要使用自定义凭证,请传递一个 凭证提供者
use Aws\Credentials\CredentialProvider; use Aws\Credentials\Credentials; use Aws\ElasticsearchService\ElasticsearchPhpHandler; $provider = CredentialProvider::fromCredentials( new Credentials('foo', 'bar', 'baz') ); $handler = new ElasticsearchPhpHandler('us-west-2', $provider);
使用自定义 HTTP 处理程序
默认情况下,处理程序将使用 Elasticsearch\ClientBuilder::defaultHandler()
来派发 HTTP 请求,但可以通过可选的构造函数参数进行自定义。例如,此存储库的测试使用自定义处理程序来模拟网络流量
class ElasticsearchPhpHandlerTest extends \PHPUnit_Framework_TestCase { public function testSignsRequestsPassedToHandler() { $toWrap = function (array $ringRequest) { $this->assertArrayHasKey('X-Amz-Date', $ringRequest['headers']); $this->assertArrayHasKey('Authorization', $ringRequest['headers']); $this->assertStringStartsWith( 'AWS4-HMAC-SHA256 Credential=', $ringRequest['headers']['Authorization'][0] ); return $this->getGenericResponse(); }; $handler = new ElasticsearchPhpHandler('us-west-2', null, $toWrap); $client = \Elasticsearch\ClientBuilder::create() ->setHandler($handler) ->build(); $client->get([ 'index' => 'index', 'type' => 'type', 'id' => 'id', ]); } ... }
安装
Composer
composer require jsq/amazon-es-php