Basic usage of PHP Elasticsearch

For the installation of Elasticsearch and Elasticsearch-php, there are many tutorials on the Internet, so I won’t repeat them here. Just pay attention to the versions of Elasticsearch, Elasticsearch-php and php. Here the author is using Elasticsearch 5.6.8 windows version, php 5.6, php onethink framework (hereinafter referred to as ot), and Elasticsearch-php composer as follows: (PHP Composer Video Tutorial)

{  
    "require":{  
        "elasticsearch/elasticsearch" : "~5.0"  
    }  
}

Course Recommendation →: "Elasticsearch Full-text Search Practical Combat" (Practical Video)

From the Course "Ten Million Level Data Concurrency Solution (Theory + Actual combat)》

1. Connect to Elasticsearch:

1. After Elasticsearch is opened, you can directly access it through http://127.0.0.1:9200 /View basic information.

2. Copy the files under composer vendor to the ot ThinkPHP\Library\Vendor\elasticsearch directory.

3. Connect to Elasticsearch,

    public $es;

    /**
     * 初始化
     */
    public function _initialize()
    {
        Vendor('elasticsearch.autoload');
        //host数组可配置多个节点
        $params = array(
            '127.0.0.1:9200'
        );
        $this->es = \Elasticsearch\ClientBuilder::create()->setHosts($params)->build();
    }

The build() method will convert the ClientBuilder object into a Client object.

2. Elasticsearch-php usage:

1. Create index:

Regarding index and type, here is a special correction. Index is like The database and type in the relational database are just like the table in the database. This understanding is wrong.

    /**
     * 创建索引
     */
    public function createIndex(){
        $params = [
            'index' => 'test', //索引名称
            'body' => [
                'settings'=> [ //配置
                    'number_of_shards'=> 3,//主分片数
                    'number_of_replicas'=> 1 //主分片的副本数
                ],
                'mappings'=> [  //映射
                    '_default_' => [ //默认配置，每个类型缺省的配置使用默认配置
                        '_all'=>[   //  关闭所有字段的检索
                            'enabled' => 'false'
                        ],
                        '_source'=>[   //  存储原始文档
                            'enabled' => 'true'
                        ],
                        'properties'=> [ //配置数据结构与类型
                            'name'=> [ //字段1
                                'type'=>'string',//类型 string、integer、float、double、boolean、date
                                'index'=> 'analyzed',//索引是否精确值  analyzed not_analyzed
                            ],
                            'age'=> [ //字段2
                                'type'=>'integer',
                            ],
                            'sex'=> [ //字段3
                                'type'=>'string',
                                'index'=> 'not_analyzed', 
                            ],
                        ]
                    ],
                    'my_type' => [ 
                        'properties' => [
                            'phone'=> [ 
                                'type'=>'string',
                            ],                            
                        ]
                    ],
                ],
            ]
        ];

        $res = $this->es->indices()->create($params);
    }

When using the Elasticsearch-php API, the parameter $params is usually an array, because the array structure can be easily converted to json. Among them,

_default_ is the default configuration, and the default values ​​of other configurations are the same as _default_.

_all Setting true will splice all original documents together for additional storage. Setting

_source to true will store the original documents. Setting false is generally used when only the title or URL of the document needs to be indexed. Scenarios where documents are accessed through Url without saving a copy of the document content in ES.

Finally, note that the data type and configuration of fields with the same name in different types under the same index must also be the same!

2. Delete index:

    /**
     * 删除索引
     */
     public function deleteIndex(){
        $params = [
            'index' => 'test'
        ];

        $res = $this->es->indices()->delete($params);
     }

3. View Mappings:

    public function getMappings(){
        $params = [
            'index' => 'test'
        ];

        $res = $this->es->indices()->getMapping($params);
    }

4. Modify Mappings:

    public function putMappings(){
        $params = [           
            'index' => 'test',
            'type' => 'my_type',
            'body' => [
                'my_type' => [
                    'properties' => [
                        'idcard' => [
                            'type' => 'integer'
                        ]
                    ]
                ]
            ]
        ]; 

        $res = $this->es->indices()->putMapping($params);      
    }

Note: The API for modifying Mappings must be Specify the type and can only add, existing attributes cannot be modified.

5. Insert a single Document:

    public function postSinDoc(){
        $params = [
            'index' => 'test',
            'type' => 'my_type',
            'body' => [ 
                'age' => 17,
                'name' => 'saki',
                'sex' => '女性',
                'idcard' => 1112,
                'phone' => '1245789',
            ]
        ];

        $res = $this->es->index($params);
    }

6. Insert multiple Documents:

    public function postBulkDoc(){
        for($i = 0; $i < 5; $i++) {
            $params[&#39;body&#39;][] = [
                &#39;index&#39; => [
                    &#39;_index&#39; => &#39;test&#39;,
                    &#39;_type&#39; => &#39;my_type&#39;,
                ]
            ];

            $params[&#39;body&#39;][] = [
                &#39;age&#39; => 17+$i,
                &#39;name&#39; => &#39;reimu&#39;.$i,
                &#39;sex&#39; => &#39;女性&#39;,
                &#39;idcard&#39; => 1112+$i,
                &#39;phone&#39; => &#39;1245789&#39;.$i,
            ];
        }

        $res = $this->es->bulk($params);
    }

7. Get the Document by id:

    public function getDocById(){
        $params = [
            'index' => 'test',
            'type' => 'my_type',
            'id' => 'AWIDV5l2A907wJBVKu6k'
        ];

        $res = $this->es->get($params);
    }

8. Pass Update Document by id:

    public function updateDocById(){
        $params = [
            'index' => 'test',
            'type' => 'my_type',
            'id' => 'AWIDV5l2A907wJBVKu6k',
            'body' => [
                'doc' => [ //将doc中的文档与现有文档合并
                    'name' => 'marisa'
                ]
            ]
        ];

        $res = $this->es->update($params);
    }

9. Delete Document by id:

    public function deleteDocById(){
        $params = [
            'index' => 'test',
            'type' => 'my_type',
            'id' => 'AWIDV5l2A907wJBVKu6k'
        ];

        $res = $this->es->delete($params);
    }

Note: For the above three operations by id, if the id is not found, Elasticsearch-php will directly report an error!

10. Search Document:

    public function searchDoc(){
        $params = [
            'index' => 'test',
            'type' => 'my_type',
            'body' => [
                'query' => [
                    'constant_score' => [ //非评分模式执行
                        'filter' => [ //过滤器，不会计算相关度，速度快
                            'term' => [ //精确查找，不支持多个条件
                                'name' => 'reimu0'
                            ]
                        ]
                        
                    ]
                ]
            ]
        ];

        $res = $this->es->search($params);

This is just an example of search.

Related recommendations:

Detailed examples of the data asymmetry problem between MySQL and Elasticsearch

What is Elasticsearch? Where can Elasticsearch be used?

Elasticsearch index and document operation example tutorial

The above is the detailed content of Basic usage of PHP Elasticsearch. For more information, please follow other related articles on the PHP Chinese website!