Module: Eson::Shared::Explain

Extended by:
API
Defined in:
lib/eson/shared/core/explain.rb

Overview

Requests using this API have the following properties:

The request supports the following parameters: id, type, query, routing, parent, preference, q, df, analyzer, analyze_wildcard, lowercase_expanded_terms, lenient, default_operator, fields, facets, filter The request declares the following parameters as source parameters: query, fields, facets, filter The request can operate on multiple indices. The request can operate on multiple types.

Instance Method Summary collapse

Methods included from API

no_indices

Methods included from Chainable

#chainable, #extendable

Instance Method Details

#multi_index ⇒ true

The request can operate on multiple indices.

Returns:

  • (true) 


13
 
# File 'lib/eson/shared/core/explain.rb', line 13

multi_index false

#multi_types ⇒ true

The request can operate on multiple types.

Returns:

  • (true) 


16
 
# File 'lib/eson/shared/core/explain.rb', line 16

multi_types false

#parameters ⇒ Array<String>

The request supports the following parameters: id, type, query, routing, parent, preference, q, df, analyzer, analyze_wildcard, lowercase_expanded_terms, lenient, default_operator, fields, facets, filter

Returns:

  • (Array<String>) —

    The parameters



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/eson/shared/core/explain.rb', line 26

parameters :id,
:type,
:query,
:routing,
:parent,
:preference,
:q,
:df,
:analyzer,
:analyze_wildcard,
:lowercase_expanded_terms,
:lenient,
:default_operator,
:fields,
:facets,
:filter

#source_param ⇒ Array<String>

The request declares the following parameters as source parameters: query, fields, facets, filter

Returns:

  • (Array<String>) —

    The source parameters



20
21
22
23
 
# File 'lib/eson/shared/core/explain.rb', line 20

source_param :query,
:fields,
:facets,
:filter