baka/elasticsearch

Baka Elasticsearch component

Baka Phalcon Elastic Search

Phalcon Elastic Search package to index / query model with relationship easily, _(*1)

Table of Contents

1. Indexing
   1. Create
   2. Insert
2. Search
3. Testing

Installing

Packages: - "elasticsearch/elasticsearch": "~2.0@beta" - "baka/database": "dev-master" - "phalcon/incubator": "~3.0",", _(*2)

Add elastic configuration to config.php, _(*3)

#config.php

'namespace' => [
    'controller' => 'Project\Controllers',
    'models' => 'Project\Models',
],

'elasticSearch' => [
    'hosts' => [getenv('ELASTIC_HOST')], //change to pass array
],

add queue to DI, _(*4)

#service.php

$di->set('queue', function () use ($config) {
    //Connect to the queue
    $queue = new Phalcon\Queue\Beanstalk\Extended([
        'host' => $config->beanstalk->host,
        'prefix' => $config->beanstalk->prefix,
    ]);

    return $queue;
});

Indexing

To create a Index in Elastic search first you will need to configure a CLI project and extend it from IndexTasksBuilder , after doing that just run the following command, _(*5)

php cli/app.php IndexBuilder createIndex ModelName 3, _(*6)

Where 4 is the normal of levels you want the relationships to index for example, _(*7)

Level 1
 Class A 
 - Relation BelongsTo Class B

 Level 2
 Class A 
 - Relation BelongsTo Class B
 - - Class B
 - - - Relation HasMany Class C

Level 3
 Class A 
 - Relation BelongsTo Class B
 - - Class B
 - - - Relation HasMany Class C
 - - - - Class C
 - - - - - Relation HasMany Class D

We can ignore a relationship if we specify on the options 'elasticSearch' => false, _(*8)

I wont recommend going beyond 4 levels if it not neede, it will use a lot of space., _(*9)

If you get a error related to nestedLimit , you can use a 4th param to specify the amount the index limit, _(*10)

php cli/app.php IndexBuilder createIndex ModelName 3 100, _(*11)

Indexing Queue

Now that you created a Index we need to index the data, for that your model will need to extend from \Baka\Elasticsearch\Model . After every update | save we will send the information to a queue where the process will insert or update the info in elastic, _(*12)

<?php


class Users extends \Baka\Elasticsearch\Model
{

}

Queue, _(*13)

php cli/app.php IndexBuilder queue ModelName, _(*14)

Example: php cli/app.php IndexBuilder queue Users, _(*15)

Search

In order to simply searching en elastic search with elastic you most install this extension https://github.com/NLPchina/elasticsearch-sql, _(*16)

Now your search controller must use our trait, _(*17)

<?php

/**
 * Search controller
 */
class SearchController extends BaseController
{
    use \Baka\Elasticsearch\SearchTrait
}

And Follow the same query structure has Baka Http, _(*18)

https://api.dev/v1/search/indexName?sort=id|asc&q=(is_deleted:0,relationship.type_id:1)&fields=id,first_name,last_name,relationship.name,relationship.relationshipb.name, _(*19)

Example, _(*20)

https://api.dev/v1/search/users?sort=first_name|asc&q=(is_deleted:0,users_statuses_id:,first_name:,last_name:)&fields=id,first_name,last_name,potentiality,classification,userssprograms.id,events_satisfaction,is_prospect,gifts.name,is_key_users,dob,companies.name,companies.companiesstatuses.name,companies.rnc,position, _(*21)

Testing

codecept run