README

Stretchy 是 Laravel 5 的一个 Elasticsearch 集成。

深受 Laravel 的查询构建器和模式启发。

描述进行中。

版本

2.0.0 - Alpha

文档

当前文档位于 stretchy.readthedocs.org。

##安装

###要求

• PHP 5.5.9+

使用 Composer 安装

1. 在你的 composer.json 中添加依赖："tamayo/stretchy": "2.0.0"

2. 在你的 app.config 中添加 Stretchy 服务提供者

        'Tamayo\Stretchy\StretchyServiceProvider'

1. 添加以下别名

		'Index'    => 'Tamayo\Stretchy\Facades\Index',
		'Document' => 'Tamayo\Stretchy\Facades\Document',
		'Stretchy' => 'Tamayo\Stretchy\Facades\Stretchy'

1. （可选）如果你想覆盖默认配置

php artisan config:publish tamayo/stretchy

位于你的 Laravel 配置目录： packages/tamayo/stretchy/config.php

##快速示例 ####创建索引 要创建一个基本索引，只需执行以下操作

Index::create('foo');

如果你想指定分片和副本

Index::create('foo', function($index)
	{
		$index->shards(5);
		$index->replicas(1);
	});

####删除索引

Index::delete('foo');

####文档索引

Document::index('foo')
    ->type('tweet')
    ->id(13) // Optional (if not specified elastic will generate an unique id)
    ->insert([
        'username' => '@ericktamayo',
        'tweet'    => 'Hello world!'
    ]);

####更新文档

Document::index('foo')
    ->type('tweet')
    ->id(13)
    ->update(['tweet' => 'Hello world!!!']);

####获取文档

Document::index('foo')->type('tweet')->Id(13)->get();

####删除文档

Document::index('foo')->type('tweet')->Id(13)->delete();

###搜索

#####匹配查询

Stretchy::search('foo')->match('bar', 'Stretchy')->get();

提供额外的参数

Stretchy::search('foo')
	->match('bar', 'baz', ['operator' => 'and', 'zero_terms_query' => 'all'])
	->get();

或

Stretchy::search('foo')
	->match('bar', 'Stretchy', function($match)
	{
		$match->operator('and');
		$match->zeroTermsQuery('all');
		$match->cutoffFrequency(0.001);
	})
	->get();

#####术语查询

Stretchy::search('foo')->term('bar', 'baz')->get();

提供额外的参数

Stretchy::search('foo')->term('bar', 'baz', ['boost' => 2])->get();

或

Stretchy::search('foo')
	->term('bar', 'baz', function($term)
	{
		$term->boost(2);
	})
	->get();

#####布尔查询

Stretchy::search('foo')
	->bool(function($query)
	{
		$query->must(function($must)
		{
			$must->match('bar', 'baz');
		});

		$query->mustNot(function($mustNot)
		{
			$mustNot->match('bar', 'qux');
		});

		$query->should(function($should)
		{
			$should->match('bar', 'bah');
		});

		$query->minimumShouldMatch(1);
	})
	->get();

更多示例可以在 文档 中找到。

路线图

• 文档
• 使库独立于 Laravel 组件
• 添加 PutMapping API

###作者 Erick Tamayo - ericktamayo@gmail.com - @ericktamayo

许可证

MIT