weburnit/elasticsearch-bundle

Elasticsearch bundle for Symfony.

5.1.1 2016-12-30 09:16 UTC

Requires

• php: ^5.6.6|^7.0
• doctrine/annotations: ~1.2
• doctrine/cache: ~1.4
• doctrine/inflector: ~1.0
• elasticsearch/elasticsearch: ~5.0
• monolog/monolog: ~1.10
• ongr/elasticsearch-dsl: ~2.0
• symfony/symfony: ~2.8|~3.0

Requires (Dev)

• mikey179/vfsstream: ~1.4
• phpunit/phpunit: ~5.6
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.0

MIT

• ONGR team

README

Elasticsearch Bundle was created in order to serve the need for professional Elasticsearch integration with enterprise level Symfony applications. This bundle is:

• Supported by ONGR.io development team.
• Uses the official elasticsearch-php client.
• Ensures full integration with Symfony framework.

Technical goodies:

• Provides interactive Document object generator via CLI (ongr:es:document:generate)
• Provides DSL query builder to be executed by type repository services.
• Uses Doctrine-like documents(entities) document-object mapping using annotations.
• Query results iterators are provided for your convenience.
• Console CLI commands for index and types management and data import / export.
• Profiler that integrates in the Symfony debug bar and shows all executed queries.
• Designed in an extensible way for all your custom needs.

If you need any help, stack overflow is the preferred and recommended way to ask questions about ONGR bundles and libraries.

Version matrix

Documentation

The online documentation of the bundle can be found in http://docs.ongr.io. Docs source is stored within the repo under Resources/doc/, so if you see a typo or problem, please submit a PR to fix it!

For contribution to the documentation you can find it in the contribute topic.

FAQ

• Mapping explained
• Using Meta-Fields
• Configuration
• Console commands
• How to do a simple CRUD actions
• Quick find functions
• How to search the index
• Scan through the index
• Parsing the results

Setup the bundle

Step 1: Install Elasticsearch bundle

Elasticsearch bundle is installed using Composer.

php composer.phar require ongr/elasticsearch-bundle "~5.0"

Instructions for installing and deploying Elasticsearch can be found in Elasticsearch installation page.

Enable Elasticsearch bundle in your AppKernel:

// app/AppKernel.php

public function registerBundles()
{
    $bundles = [
        // ...
        new ONGR\ElasticsearchBundle\ONGRElasticsearchBundle(),
    ];
    
    // ...
}

Step 2: Add configuration

Add minimal configuration for Elasticsearch bundle.

# app/config/config.yml

ongr_elasticsearch:
    managers:
        default:
            index:
                index_name: acme
            mappings:
                - AppBundle

This is the very basic example only, for more information, please take a look at the configuration chapter.

In this particular example there are 2 things you should know. The index name in the index node and the mappings. Mappings is the place where your documents are stored (more info at the mapping chapter).

Step 3: Define your Elasticsearch types as Document objects

This bundle uses objects to represent Elasticsearch documents. Lets create a Customer class for customer document.

// src/AppBundle/Document/Customer.php

namespace AppBundle\Document;

use ONGR\ElasticsearchBundle\Annotation as ES;

/**
 * @ES\Document()
 */
class Customer
{
    /**
     * @var string
     *
     * @ES\Id()
     */
    public $id;

    /**
     * @var string
     *
     * @ES\Property(name="name", type="string")
     */
    public $name;
}

This is the basic example only, for more information about mapping, please take a look at the the mapping chapter.

Step 4: Create index and mappings

Elasticsearch bundle provides several CLI commands. One of them is for creating index, run command in your terminal:

bin/console ongr:es:index:create

More info about the rest of the commands can be found in the commands chapter.

Step 5: Enjoy with the Elasticsearch

We advise to take a look at the mapping chapter to configure the index. Search documentation for the Elasticsearch bundle is available here. And finally it's up to you what amazing things you are going to create 😎 .

Troubleshooting

• How to upgrade from the older versions?
• How to overwrite some parts of the bundle?

License

This bundle is licensed under the MIT license. Please, see the complete license in the bundle LICENSE file.