使用PHP操做ElasticSearch

時間  2019-12-10
標籤 使用 php elasticsearch 欄目 PHP 简体版
原文   原文鏈接

如何搭建ES環境和使用CURL操做能夠參考個人另外一篇文章：ElasticSearch嘗試
php

網上不少關於ES的例子都過期了，版本好久，這篇文章的測試環境是ES6.5html

經過composer 安裝數據庫

composer require 'elasticsearch/elasticsearch'

在代碼中引入網絡

require 'vendor/autoload.php';

use Elasticsearch\ClientBuilder;

$client = ClientBuilder::create()->setHosts(['172.16.55.53'])->build();

下面按部就班完成一個簡單的添加和搜索的功能。app

首先要新建一個 index：composer

index 對應關係型數據（如下簡稱MySQL）裏面的數據庫，而不是對應MySQL裏面的索引，這點要清楚elasticsearch

$params = [
    'index' => 'myindex', #index的名字不能是大寫和下劃線開頭
    'body' => [
        'settings' => [
            'number_of_shards' => 2,
            'number_of_replicas' => 0
        ]
    ]
];
$client->indices()->create($params);

在MySQL裏面，光有了數據庫還不行，還須要創建表，ES也是同樣的，ES中的type對應MySQL裏面的表。ide

注意：ES6之前，一個index有多個type,就像MySQL中一個數據庫有多個表同樣天然，可是ES6之後，每一個index只容許一個type,在往之後的版本中極可能會取消type。測試

type不是單獨定義的，而是和字段一塊兒定義ui

$params = [
    'index' => 'myindex',
    'type' => 'mytype',
    'body' => [
        'mytype' => [
            '_source' => [
                'enabled' => true
            ],
            'properties' => [
                'id' => [
                    'type' => 'integer'
                ],
                'first_name' => [
                    'type' => 'text',
                    'analyzer' => 'ik_max_word'
                ],
                'last_name' => [
                    'type' => 'text',
                    'analyzer' => 'ik_max_word'
                ],
                'age' => [
                    'type' => 'integer'
                ]
            ]
        ]
    ]
];
$client->indices()->putMapping($params);

在定義字段的時候，能夠看出每一個字段能夠定義單獨的類型，在first_name中還自定義了 分詞器 ik,

這個分詞器是一個插件，須要單獨安裝的，參考另外一篇文章：ElasticSearch基本嘗試

如今 數據庫和表都有了，能夠往裏面插入數據了

概念：這裏的 數據 在ES中叫 文檔

$params = [
    'index' => 'myindex',
    'type' => 'mytype',
    //'id' => 1, #能夠手動指定id，也能夠不指定隨機生成
    'body' => [
        'first_name' => '張',
        'last_name' => '三',
        'age' => 35
    ]
];
$client->index($params);

多插入一點數據，而後來看看怎麼把數據取出來：

經過id取出單條數據：

插曲：若是你以前添加文檔的時候沒有傳入id，ES會隨機生成一個id，這個時候怎麼經過id查？id是多少都不知道啊。

因此這個插入一個簡單的搜索，最簡單的，一個搜索條件都不要，返回全部index下全部文檔：

$data = $client->search();

如今能夠去找一找id了，不過你會發現id可能長這樣：zU65WWgBVD80YaV8iVMk，不要驚訝，這是ES隨機生成的。

如今能夠經過id查找指定文檔了：

$params = [
    'index' => 'myindex',
    'type' => 'mytype',
    'id' =>'zU65WWgBVD80YaV8iVMk'
];
$data = $client->get($params);

最後一個稍微麻煩點的功能：

注意：這個例子我不打算在此詳細解釋，看不懂不要緊，這篇文章主要的目的是基本用法，並無涉及到ES的精髓地方，

ES精髓的地方就在於搜索，後面的文章我會繼續深刻分析

$query = [
    'query' => [
        'bool' => [
            'must' => [
                'match' => [
                    'first_name' => '張',
                ]
            ],
            'filter' => [
                'range' => [
                    'age' => ['gt' => 76]
                ]
            ]
        ]

    ]
];
$params = [
    'index' => 'myindex',
//  'index' => 'm*', #index 和 type 是能夠模糊匹配的，甚至這兩個參數都是可選的
    'type' => 'mytype',
    '_source' => ['first_name','age'], // 請求指定的字段
    'body' => array_merge([
        'from' => 0,
        'size' => 5
    ],$query)
];
$data = $this->EsClient->search($params);

 

上面的是一個簡單的使用流程，可是不夠完整，只講了添加文檔，沒有說怎麼刪除文檔，

下面我貼出完整的測試代碼，基於Laravel環境，固然環境隻影響運行，不影響理解，包含基本的經常使用操做：

<?php

use Elasticsearch\ClientBuilder;
use Faker\Generator as Faker;

/**
 * ES 的 php 實測代碼
 */
class EsDemo
{
    private $EsClient = null;
    private $faker = null;
    /**
     * 爲了簡化測試，本測試默認只操做一個Index，一個Type，
     * 因此這裏固定爲 megacorp和employee
     */
    private $index = 'megacorp';
    private $type = 'employee';
    public function __construct(Faker $faker)
    {
        /**
         * 實例化 ES 客戶端
         */
        $this->EsClient = ClientBuilder::create()->setHosts(['172.16.55.53'])->build();
        /**
         * 這是一個數據生成庫，詳細信息能夠參考網絡
         */
        $this->faker = $faker;
    }
    
    /**
     * 批量生成文檔
     * @param $num
     */
    public function generateDoc($num = 100) {
        foreach (range(1,$num) as $item) {
            $this->putDoc([
                'first_name' => $this->faker->name,
                'last_name' => $this->faker->name,
                'age' => $this->faker->numberBetween(20,80)
            ]);
        }
    }
    /**
     * 刪除一個文檔
     * @param $id
     * @return array
     */
    public function delDoc($id) {
        $params = [
            'index' => $this->index,
            'type' => $this->type,
            'id' =>$id
        ];
        return $this->EsClient->delete($params);
    }
    /**
     * 搜索文檔，query是查詢條件
     * @param array $query
     * @param int $from
     * @param int $size
     * @return array
     */
    public function search($query = [], $from = 0, $size = 5) {
//        $query = [
//            'query' => [
//                'bool' => [
//                    'must' => [
//                        'match' => [
//                            'first_name' => 'Cronin',
//                        ]
//                    ],
//                    'filter' => [
//                        'range' => [
//                            'age' => ['gt' => 76]
//                        ]
//                    ]
//                ]
//
//            ]
//        ];
        $params = [
            'index' => $this->index,
//            'index' => 'm*', #index 和 type 是能夠模糊匹配的，甚至這兩個參數都是可選的
            'type' => $this->type,
            '_source' => ['first_name','age'], // 請求指定的字段
            'body' => array_merge([
                'from' => $from,
                'size' => $size
            ],$query)
        ];
        return $this->EsClient->search($params);
    }

    /**
     * 一次獲取多個文檔
     * @param $ids
     * @return array
     */
    public function getDocs($ids) {
        $params = [
            'index' => $this->index,
            'type' => $this->type,
            'body' => ['ids' => $ids]
        ];
        return $this->EsClient->mget($params);
    }

    /**
     * 獲取單個文檔
     * @param $id
     * @return array
     */
    public function getDoc($id) {
        $params = [
            'index' => $this->index,
            'type' => $this->type,
            'id' =>$id
        ];
        return $this->EsClient->get($params);
    }

    /**
     * 更新一個文檔
     * @param $id
     * @return array
     */
    public function updateDoc($id) {
        $params = [
            'index' => $this->index,
            'type' => $this->type,
            'id' =>$id,
            'body' => [
                'doc' => [
                    'first_name' => '張',
                    'last_name' => '三',
                    'age' => 99
                ]
            ]
        ];
        return $this->EsClient->update($params);
    }

    /**
     * 添加一個文檔到 Index 的Type中
     * @param array $body
     * @return void
     */
    public function putDoc($body = []) {
        $params = [
            'index' => $this->index,
            'type' => $this->type,
//            'id' => 1, #能夠手動指定id，也能夠不指定隨機生成
            'body' => $body
        ];
        $this->EsClient->index($params);
    }
    /**
     * 刪除全部的 Index
     */
    public function delAllIndex() {
        $indexList = $this->esStatus()['indices'];
        foreach ($indexList as $item => $index) {
            $this->delIndex();
        }
    }
    /**
     * 獲取 ES 的狀態信息，包括index 列表
     * @return array
     */
    public function esStatus() {
        return $this->EsClient->indices()->stats();
    }

    /**
     * 建立一個索引 Index （非關係型數據庫裏面那個索引，而是關係型數據裏面的數據庫的意思）
     * @return void
     */
    public function createIndex() {
        $this->delIndex();
        $params = [
            'index' => $this->index,
            'body' => [
                'settings' => [
                    'number_of_shards' => 2,
                    'number_of_replicas' => 0
                ]
            ]
        ];
        $this->EsClient->indices()->create($params);
    }

    /**
     * 檢查Index 是否存在
     * @return bool
     */
    public function checkIndexExists() {
        $params = [
            'index' => $this->index
        ];
        return $this->EsClient->indices()->exists($params);
    }

    /**
     * 刪除一個Index
     * @return void
     */
    public function delIndex() {
        $params = [
            'index' => $this->index
        ];
        if ($this->checkIndexExists()) {
            $this->EsClient->indices()->delete($params);
        }
    }

    /**
     * 獲取Index的文檔模板信息
     * @return array
     */
    public function getMapping() {
        $params = [
            'index' => $this->index
        ];
        return $this->EsClient->indices()->getMapping($params);
    }

    /**
     * 建立文檔模板
     * @return void
     */
    public function createMapping() {
        $this->createIndex();
        $params = [
            'index' => $this->index,
            'type' => $this->type,
            'body' => [
                $this->type => [
                    '_source' => [
                        'enabled' => true
                    ],
                    'properties' => [
                        'id' => [
                            'type' => 'integer'
                        ],
                        'first_name' => [
                            'type' => 'text',
                            'analyzer' => 'ik_max_word'
                        ],
                        'last_name' => [
                            'type' => 'text',
                            'analyzer' => 'ik_max_word'
                        ],
                        'age' => [
                            'type' => 'integer'
                        ]
                    ]
                ]
            ]
        ];
        $this->EsClient->indices()->putMapping($params);
        $this->generateDoc();
    }

}
View Code
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程