Introduction to Elasticsearch-PHP api

The content of this article is an introduction to the Elasticsearch-PHP api. Now I share it with you. Friends in need can refer to it

Elasticsearch is currently popular One of the big data processing frameworks, detailed instructions can be found on Baidu, etc.
The following articles use the abbreviation of es as representative of Elasticsearch

es has official The PHP api interface can be downloaded from github or composer.

#1. Create index ($client->indices()->create())

      $params = [                'index' => 'user_index',  //索引名（相当于mysql的数据库）
                'body' => [                    'mappings' => [                        'normal_type' => [ //类型名（相当于mysql的表）
                            '_all'=>[   //  是否开启所有字段的检索
                                'enabled' => 'false'
                            ],                            'properties' => [ //文档类型设置（相当于mysql的数据类型）
                                'uid' => [                                    'type' => 'integer' // 字段类型为整型
                                ],                                'username' => [                                    'type' => 'keyword' // 字段类型为关键字,如果需要全文检索,则修改为text,注意keyword字段为整体查询,不能作为模糊搜索
                                ],                                'platform' => [                                    'type' => 'keyword'
                                ],                                'mobile' => [                                    'type' => 'integer'
                                ],                                'sex' => [                                    'type' => 'integer'
                                ],                                'source' => [                                    'type' => 'keyword'
                                ],                                'province' => [                                    'type' => 'keyword'
                                ],                                'city' => [                                    'type' => 'keyword'
                                ],                              'tag' =>   [                                'properties'    =>  [                                    'tagName'   =>[                                        'type' => 'text'
                                    ],                                    'tagWeight'   => [                                        'type' => 'integer',
                                    ]
                                ]
                            ],
                            ]
                        ]
                    ]
                ]
            ];
            $data = $client->indices()->create($params);

The simple index has been created, and now we can obtain the newly created index information.

2. Get index information

2.1 Get index information ($client->indices()->getSettings())

     $params = [                'index' => 'user_index',                'client' => [                    'ignore' => 404
                ]
            ];
    $res = $client->indices()->getSettings($params);//获取库索引设置信息

The returned results are as follows:

  array (    'user_index' => 
    array (    'settings' => 
    array (      'index' => 
      array (        'creation_date' => '1498116455327',        'number_of_shards' => '5',        'number_of_replicas' => '1',        'uuid' => '8pkONoI7RAuw5HjnFa4UaQ',        'version' => 
        array (          'created' => '5020299',
        ),        'provided_name' => 'user_index',
        ),
      ),
    ),
 )

2.2 Get Mapping information

• Interface:$client->indices()->getMapping

$params = [                'index' => 'user_index',                'client' => [                    'ignore' => 404
                ]
            ];
$res = $client->indices()->getMapping($params);   //获取mapping信息

Return The results are as follows:

array (  'user_index' => 
  array (    'mappings' => 
    array (      'normal_type' => 
      array (        '_all' => 
        array (          'enabled' => false,
        ),        'properties' => 
        array (          'city' => 
          array (            'type' => 'keyword',
          ),          'mobile' => 
          array (            'type' => 'integer',
          ),          'platform' => 
          array (            'type' => 'keyword',
          ),          'province' => 
          array (            'type' => 'keyword',
          ),          'sex' => 
          array (            'type' => 'integer',
          ),          'source' => 
          array (            'type' => 'keyword',
          ),          'uid' => 
          array (            'type' => 'integer',
          ),          'username' => 
          array (            'type' => 'keyword',
          ),
        ),
      ),
    ),
  ),
)

The relevant information obtained here is that the index es we just created can be dynamically modified and added with relevant information.

2.3 Modify/add mapping information

• Note: The established field type cannot be changed!!

• Interface: $client->indices()->putMapping() ;

        $params = [            'index' => 'user_index',  //索引名（相当于mysql的数据库）
            'type'  => 'normal_type',            'body'  =>  [                'normal_type' => [                    'properties'    =>[                        'tag'   =>[                            'type'  => 'text'
                        ]
                    ]
                ]
            ]
        ];
$client->indices()->putMapping($params);

2.4 Delete index

• Interface:$client->indices()->delete($params);

        $params = [            'index' => 'user_index',  //索引名（相当于mysql的数据库）
        ];

3 es addition, deletion and modification check

3.1 Adding data

• Single data insertion

• Interface:$client->index()

$params = [    'index' => 'my_index',    'type' => 'my_type',    'id' => 'my_id', // 不填则es会自动生成唯一的id
    'body' => [ 'testField' => 'abc']
];
$response = $client->index($params);

• Batch data insertion

• Interface:$ client->bulk();

                foreach($userList as $value){
                    $params['body'][] = [                        'index' => [                            '_index' => 'user_index',                            '_type' => 'normal_type',                            '_id'  =>$value['uid']
                        ]
                    ];
                    $params['body'][] = [                        'uid' => $value['uid'],                        'username' => $value['username'],                        'platform' => $value['platform'],                        'mobile' => $value['mobile'],                        'province' => $value['province'],                        'city' => $value['city'],                        'sex' => $value['gender '],                        'source'=>'xxx'
                    ];
                }
                $responses = $client->bulk($params);

• ps: When inserting a large amount of data in a loop, you need to pay attention to the problem that PHP's memory exceeds the limit. (Not clear yet Which part of this framework does not release memory after operation)

3.2 Search data

• Search for a single piece of data, but you need to know the id

• Interface:$client->get()

$params = [    'index' => 'my_index',    'type' => 'my_type',    'id' => 'my_id' // es 自动生成/自己录入的];
$response = $client->get($params);

• Batch search

• Interface:$client->search()

$params = [  
    'index' =>  'my_index',   //['my_index1', 'my_index2'],可以通过这种形式进行跨库查询  
    'type' => 'my_type',//['my_type1', 'my_type2'],  
    'body' => [  
        'query' => [  
            'match' => [  // 搜索条件
                'age' => '24' ,                'tag.tagName' =>'tag'  // 如果字段存储的是object.
                                       //这里搜索必须要这样才能搜索出结果.
            ]  
        ],  
        'from' => '0',  // 分页
        'size' => '200'  // 每页数量
        'sort' => [  // 排序
            'age' => 'desc'   //对age字段进行降序排序  
        ]  
    ]  
];  
$res = $client->search($params);

The data returned is roughly as follows:

array (size=4)  'took' => int 2
  'timed_out' => boolean false
  '_shards' => 
    array (size=3)      'total' => int 5
      'successful' => int 5
      'failed' => int 0
  'hits' =>  // 搜索到数据
    array (size=3)      'total' => int 2
      'max_score' => float 1
      'hits' => // 具体数据包
        array (size=1)          0 => 
            array (size=5)
              ...

• Many times you need to use something like mysql The and/or query es search can also be done.

• At this time we will use the es combination filter

• https: //www.elastic.co/guide/cn/elasticsearch/guide/current/combining-filters.html The official document is as follows

• The following is a tested example

{    "index": "xxx_index", 
    "type": "normal_type", 
    "body": {        "size": 20, 
        "from": 0, 
        "query": {            "bool": {                "must": [
                    {                        "match": {                            "tag.tagName": "xxxx"
                        }
                    }
                ]
            }
        }, 
        "sort": {            "uid": "desc"
        }
    }
}

3.3 Delete data

• Note: There is a certain cache update time when data is deleted, and it can still be searched when it is not updated.

• Interface:$client->delete();

$param = [                'index' => 'my_index',                'type' => 'my_type',                'id'    => 'my_id'
            ];
            $ret = $this->client->delete($param);

The returned data is as follows:

array (size=7)  'found' => boolean true
  '_index' => string 'user_index' (length=10)  '_type' => string 'normal_type' (length=11)  '_id' => string 'AVzh_QnIZvcaH3gE7MvE' (length=20)  '_version' => int 2
  'result' => string 'deleted' (length=7)  '_shards' => 
    array (size=3)      'total' => int 2
      'successful' => int 1
      'failed' => int 0

3.4 Update data

• Interface:$client->update()

$params = [  
    'index' => 'my_index',  
    'type' => 'my_type',  
    'id' => '3416a75f4cea9109507cacd8e2f2aefc',  
    'body' => [  
        'doc' => [  // 必须带上这个.表示是文档操作
            'age' => 150  
        ]  
    ]  
];  
$res = $client->update($params);

Return results

array (size=6)  '_index' => string 'user_index' (length=10)  '_type' => string 'normal_type' (length=11)  '_id' => string 'AVzh_QnIZvcaH3gE7Mw5' (length=20)  '_version' => int 2
  'result' => string 'updated' (length=7)  '_shards' => 
    array (size=3)      'total' => int 2
      'successful' => int 1 // 当数据没有发生变化时这里是为0
      'failed' => int 0

4. Reverse data between different indexes

• Note: When reversing data between different indexes, you need to pay attention to the type of fields. Different types will cause the import to fail. At this time, you can use script to process

• This interface cannot be run in phpapi and exists as a record

• Interface: POST _reindex

POST _reindex
{  "source": {    "index": "user_profile"
  },  "dest": {    "index": "user_prfile_v1"
  },  "script": {    "inline": " ctx._source.tag=params.new_tags",    "params": {      "new_tags":{        "tagName":null,        "tagWeight":0
      }
    }
  }
}

Author: Tang Minzheng
Link:
https://www.jianshu.com/p/a2837f487de6

Related recommendations:

php calling interface API methods

On the organization of Vue project api related code

The above is the detailed content of Introduction to Elasticsearch-PHP api. For more information, please follow other related articles on the PHP Chinese website!