From 5f67c45200b0926bc279e7b561387069587751ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simonas=20=C5=A0erlinskas?= <saimaz@users.noreply.github.com> Date: Mon, 28 Dec 2015 12:50:08 +0200 Subject: [PATCH] Update README.md --- README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 49 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fa1a7ab..12955bb 100644 --- a/README.md +++ b/README.md @@ -8,4 +8,52 @@ Introducing Elasticsearch DSL library to provide objective query builder for [Elasticsearch bundle](https://github.com/ongr-io/ElasticsearchBundle) and [elasticsearch-php](https://github.com/elastic/elasticsearch-php) client. You can easily build any Elasticsearch query and transform it to an array. -If you have any questions, don't hesitate to ask them on [Gitter](https://gitter.im/ongr-io/support) chat, or just come to say Hi ;). +If you have any questions, don't hesitate to ask them on [](https://gitter.im/ongr-io/support) chat, or just come to say Hi ;). + +## Documentation + +[The online documentation of the bundle is here](docs/index.md) + +## Try it! + +### Installation + +Install library with [composer](https://getcomposer.org): + +``` +composer require ongr/elasticsearch-dsl "~1.0" +``` + +### Search + +Elasticsearch DSL was extracted from [Elasticsearch Bundle](https://github.com/ongr-io/ElasticsearchBundle) to provide standalone query dsl for [elasticsearch-php](https://github.com/elastic/elasticsearch-php). Examples how to use it together with [Elasticsearch Bundle](https://github.com/ongr-io/ElasticsearchBundle) can be found in the [Elasticsearch Bundle docs](https://github.com/ongr-io/ElasticsearchBundle/blob/master/Resources/doc/search.md). + +If you dont want to use Symfony or Elasticsearch bundle, no worries, you can use it in any project together with [elasticsearch-php](https://github.com/elastic/elasticsearch-php). Here's the example: + +Install `elasticsearch-php`: + +``` +composer require "elasticsearch/elasticsearch": "~2.0" +``` + +Create search: + +```php + <?php + require 'vendor/autoload.php'; + $client = ClientBuilder::create()->build(); + + $matchAll = new ONGR\ElasticsearchDSL\Query\MatchAllQuery(); + + $search = new ONGR\ElasticsearchDSL\Search(); + $search->addQuery($matchAll) + + $params = [ + 'index' => 'your_index', + 'body' => $search->toArray(), + ]; + + $results = $client->search($params); +``` + +Elasticsearch DSL covers every elasticsearch query, all examples can be found in [the documentation](docs/index.md) -- GitLab