eddie/elastic-search

dev-master 2019-06-15 02:30 UTC

Requires

• php: >=7.0
• eddie/elastic-search-core: dev-master

Requires (Dev)

• phpunit/phpunit: ^7.0

MIT

• Eddie Lau

README

环境需求

• PHP >= 7.0

依赖

"elasticsearch/elasticsearch": "^6.0"

使用说明

获取实例

$es = new \Eddie\ElasticSearch\Slim\Es([
    'hosts' => [
        'localhost:9200',
        /* others... */
    ],
    
    /* 指定 index, type 方式1 */
    //'index' => 'your_index',
    //'type' => 'doc'
]);

索引操作

/* 指定 index, type 方式2 */
$es
    ->setIndex('your_index')
    ->setType('doc')
;
/* 获取当前 index, type */
$es->getIndex();
$es->getType();

/* 创建索引 */
$ret = $es->createIndex('your_index');

/* 带参数创建索引 */
//ret = $es->createIndex('your_index', [
//    'settings' => [
//        'numbber_of_shards' => 1,
//        'number_of_replicas' => 1,
//    ]
//]);

/* 删除索引 */
$ret = $es->deleteIndex('your_index');

/* 索引是否存在 */
$ret = $es->existsIndex('your_index'); // true|false

文档操作

/* 创建文档 */
$ret = $es->createDocument([
    'id' => 'abc123',
    'key1' => 'val1',
    'key2' => 'val2',
]);

/* 获取文档 */
$ret = $es->getDocument('abc123');

/* 删除文档 */
$ret = $es->deleteDocument('abc123');

查询操作

$ret = $es
   /* 条件 "且" */
   ->where('key', 'val')
   ->where(['key' => 'val'])
   
   /* 条件 "或" */
   ->orWhere('key', 'val')
   ->orWhere(['key' => 'val'])
   
   /* 条件 "非" */
   ->whereNot('key', 'val')
   ->whereNot(['key' => 'val'])
   
   ->whereGt('key', 'val')               // 大于
   ->whereGte('key', 'val')              // 大于等于
   ->whereLt('key', 'val')               // 小于
   ->whereLte('key', 'val')              // 小于等于
   ->whereBetween('key', ['min', 'max']) // 指定范围
   /*
    * "或"条件 - 在 where 前加"or"; 如: "orWhereGt", "orWhereBetween"
    * "非"条件 - 在 where 后加"not"; 如: "whereNotGt", "whereNotBetween"
    */
    
   ->whereHas('key')     // 包含某字段
   ->orWhereHas('key')   // 包含某字段("或"条件)
   ->whereNotHas('key')  // 不包含某字段
   
   // 可以传入数组, 表示包含多字段;
   ->whereHas(['key1', 'key2', '...'])
   ->orWhereHas(['key1', 'key2', '...'])
   ->whereNotHas(['key1', 'key2', '...'])
   
  
   // 聚合查询
   // 方式一:
   //->aggregate([
   //    'aggs' => [
   //        'alias' => [
   //            'terms' => [
   //                'field' => 'your_aggregate_field',
   //                //'size' => 10
   //            ]
   //        ]
   //    ]
   //])
   // 方式二:
   ->aggregate(
       (new Aggregation())
           ->setTerms('your_aggregate_field')
           // 最大值
           ->addSubAgg((new Aggregation())->setMax('field', 'alias'), ['size' => 10])
           // 最大值
           ->addSubAgg((new Aggregation())->setMin('field', 'alias'))
           // 平均值
           ->addSubAgg((new Aggregation())->setAvg('field'))
   )
   
   ->limit(10) // 获取记录条目数, 相当于"size" 
   ->skip(0)   // 偏移量, 相当于"from"
   
   // 执行查询
   ->get()
   //->get(['key1', 'key2']) // 返回部分字段
;

//$es->flush(); // 清空查询条件