Elasticsearch PHP 客户端使用教程

Elasticsearch PHP 客户端使用教程

elasticsearch-phpOfficial PHP client for Elasticsearch.项目地址:https://gitcode.com/gh_mirrors/el/elasticsearch-php

1. 项目的目录结构及介绍

Elasticsearch PHP 客户端的目录结构如下：

elasticsearch-php/
├── composer.json
├── LICENSE
├── README.md
├── src/
│   ├── Elasticsearch/
│   │   ├── ClientBuilder.php
│   │   ├── ...
│   ├── ...
├── tests/
│   ├── Elasticsearch/
│   │   ├── ClientBuilderTest.php
│   │   ├── ...
│   ├── ...

主要目录和文件介绍：

• composer.json: Composer 配置文件，定义了项目的依赖关系。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• src/: 源代码目录，包含了 Elasticsearch PHP 客户端的核心代码。
  • Elasticsearch/: Elasticsearch 客户端的主要实现代码。
    • ClientBuilder.php: 用于构建 Elasticsearch 客户端实例的类。
• tests/: 测试代码目录，包含了项目的单元测试和功能测试。
  • Elasticsearch/: Elasticsearch 客户端的测试代码。
    • ClientBuilderTest.php: 针对 ClientBuilder.php 的单元测试。

2. 项目的启动文件介绍

Elasticsearch PHP 客户端的启动文件是 ClientBuilder.php，位于 src/Elasticsearch/ 目录下。

ClientBuilder.php 主要功能：

• 构建客户端实例: 提供了一系列方法用于配置和构建 Elasticsearch 客户端实例。
• 设置节点: 可以设置 Elasticsearch 集群的节点地址。
• 设置连接参数: 可以设置连接超时、重试次数等参数。
• 设置日志: 可以配置日志记录器。

示例代码：

require 'vendor/autoload.php';

use Elasticsearch\ClientBuilder;

$client = ClientBuilder::create()
    ->setHosts(['http://localhost:9200'])
    ->build();

3. 项目的配置文件介绍

Elasticsearch PHP 客户端的配置主要通过 ClientBuilder.php 进行。以下是一些常见的配置选项：

配置选项：

• setHosts: 设置 Elasticsearch 集群的节点地址。
• setRetries: 设置请求失败后的重试次数。
• setLogger: 设置日志记录器。
• setConnectionParams: 设置连接参数，如连接超时时间。

示例配置：

$client = ClientBuilder::create()
    ->setHosts(['http://localhost:9200'])
    ->setRetries(2)
    ->setLogger(new MyLogger())
    ->setConnectionParams([
        'timeout' => 10
    ])
    ->build();

通过以上配置，可以灵活地调整 Elasticsearch PHP 客户端的行为，以适应不同的应用场景。

elasticsearch-phpOfficial PHP client for Elasticsearch.项目地址:https://gitcode.com/gh_mirrors/el/elasticsearch-php