PHPackages                             xiaosongshu/yii2-elasticsearch - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. xiaosongshu/yii2-elasticsearch

ActiveLibrary[Database & ORM](/categories/database)

xiaosongshu/yii2-elasticsearch
==============================

"elasticsearch client for YII2"

v0.0.5(2y ago)12mitPHPPHP >=7.4.1

Since Apr 23Pushed 2y ago1 watchersCompare

[ Source](https://github.com/2723659854/yii2-elasticsearch)[ Packagist](https://packagist.org/packages/xiaosongshu/yii2-elasticsearch)[ RSS](/packages/xiaosongshu-yii2-elasticsearch/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (3)Versions (5)Used By (0)

elasticsearch-YII客户端 elasticsearch client for YII
-------------------------------------------------

[](#elasticsearch-yii客户端-elasticsearch-client-for-yii)

### 安装 install

[](#安装-install)

```
composer require xiaosongshu/yii2-elasticsearch
```

### 配置 Configuration

[](#配置-configuration)

```
'components' => [
    'ESClient' => [
           'class' => \Xiaosongshu\Elasticsearch\ESClient::class,
           'node'=>['192.168.101.170:9200'],
           'username' => '',
           'password' => '',
       ],
]
```

### 基本用法 example

[](#基本用法-example)

```
$res = Yii::$app->ESClient->search('index','_doc','title','测试')['hits']['hits'];
```

### 客户端支持的所有方法

[](#客户端支持的所有方法)

```
创建索引：createIndex
创建表结构：createMappings
删除索引：deleteIndex
获取索引详情：getIndex
新增一行数据：create
批量写入数据：insert
根据id批量删除数据：deleteMultipleByIds
根据Id 删除一条记录：deleteById
获取表结构：getMap
根据id查询数据：find
根据某一个关键字搜索：search
使用原生方式查询es的数据：nativeQuerySearch
多个字段并列查询，多个字段同时满足需要查询的值：andSearch
or查询  多字段或者查询：orSearch
根据条件删除数据：deleteByQuery
根据权重查询：searchByRank
获取所有数据：all
添加脚本：addScript
获取脚本：getScript
使用脚本查询：searchByScript
使用脚本更新文档：updateByScript
索引是否存在：IndexExists
根据id更新数据：updateById

```

### 如果单独使用本插件，则需要实例化的时候传入elasticsearch的连接配置

[](#如果单独使用本插件则需要实例化的时候传入elasticsearch的连接配置)

##### elasticsearch客户端使用实例

[](#elasticsearch客户端使用实例)

```