CLI Commands

All commands can be accessed using Symfony command line interface. To use it simply type app/console <command_name> <arguments/options> in root folder of your project.

Create index

Command name: ongr:es:index:create

Creates a new index in Elasticsearch (including with mapping if not skipped) for the specified manager (see: configuration chapter).

If you want to use timestabale indexes it's very handy to use it together with -a option. -t adds a date as the suffix and -a adds an alias as defined index name in manager configuration. So the code will work fine without any configuration changes, you dont need to do any other actions.

-a option drops a previous aliases before creating new one.

Drop index

Command name: ongr:es:index:drop

Drops the index for the specified manager.

Import index

Command name: ongr:es:index:import <file-path>

Imports data to the selected index. We are using custom JSON notation to specify data inside the file for faster handling. Please keep the structure as it is described below.

So here's a simple example how the data looks like:

[
    {"count":2,"date":"2015-10-25T14:46:21+0200"},
    {"_type":"content","_id":"15","_source":{"id":"15","title":"About","content":"Sample ONGR about page..","urls":[{"url":"about\/","key":""}]}},
    {"_type":"content","_id":"37","_source":{"id":"37","title":"Home Page","content":"<div class=\"jumbotron\">\r\n  <h1>Welcome to ONGR demo site!<\/h1>\r\n  <p>Enterprise E-commerce Accelerator.<\/p><\/div>","urls":[{"url":"home-page\/","key":""}]}}
]

Every line of file is JSON object. First line must specify count, how many lines are in the files except first and the file timestamp in date.

There is one document per line. There could be different types defined in a single file, basically with a single file you can import the whole index. There are 3 required keys:

• _type which specifies elasticsearch type name (not an ElasticsearchBundle class document)
• _id is optional, if not specified (provided null) elasticsearch will create a random id for that document.
• _source: document array encoded to json object, where all fields are equal to the elasticsearch type field names.

Export index

Command name: ongr:es:index:export <file-path>

Exports data from Elasticsearch index in a json format.

Index export generates the same JSON format as specified in the import chapter.

Generate document

Command name: ongr:es:document:generate

ONGR ElasticsearchBundle supports automatic document generation. This command will present a user with a set of questions and when those questions are answered an ES document class is generated. This command does not require any options, all the information that is needed should be provided during the execution of the command. The resulting documents are generated in the provided bundles Documents directory.

Cache clear

Command name: ongr:es:cache:clear

Clears elasticsearch document storage cache. See more info at (official elastic docs).