Flex::ModelIndexer

You access all the Flex features included in your model through the flex proxy object. It implements the methods to map your models to the elasticsearch index, define parent/child relationships and sync.

By default the index used for all the models in your app is the Flex::Configuration.variables[:index]. In a rails app that gets set before initializing the app (see Configuration). You can map your model to another index by explicitly setting it in your class.

flex.index = 'foo'

By default the type used for your model is the full-underscored class name. For example MyModel::SuperSpecial will generate my_model__super_special. Notice the double underscore in place of the commonly used slash, which avoids url conflicts. You can map your model to another type by explicitly setting it in your class:

      flex.type = 'bar'
      

Defines elasticsearch parent/child relations (see Indexing Records).

Implemented by the Flex::ModelSyncer module (see flex.sync).

Implemented by the Flex::ModelSyncer module (see flex.synced).

Custom defined method (see Model.flex_result).

The flex instance object is mostly used internally, however you can access all the Flex features included in your records through it. It implements the methods to manage the elasticsearch document related to your record.

The index for this record.

The document type for this record.

Indexes the flex_source of this record. It is used internally and you don’t need to use this directly if you use Model.flex.sync on this model.

Removes the elasticsearch document for this record. It is used internally and you don’t need to use this directly if you use Model.flex.sync on this model.

Implemented by the Flex::ModelSyncer module (see flex.sync).

Retrieves the elasticsearch document from the index. The result is extended as usual (see Flex Extenders, Flex Model Extenders and Flex Rails Extenders). Mostly useful in the console to inspect the elasticsearch related document.

>> comment = Comment.first
>> comment.flex.get
=> {"_index"=>"my_index", "_type"=>"review_comment","_id"=>"4f15d2712c16bf4337000012", ... }

(see Indexing Records)

(see Indexing Fields)

Use only if you know what you are doing!

You define any of this methods in your model, if you want to override the flex.id, flex.index, flex.type, flex.parent and/or flex.routing generation.

The flex_index should be used if you want to implement dynamic indices in your model.