Documentation { elastic.js }

ejs ⟩ SpanOrQuery

The spanOrQuery takes an array of SpanQuerys and will match if any of the underlying SpanQueries match. The span or query maps to Lucene SpanOrQuery.

Module

 SpanOrQuery

 SpanOrQuery ( clauses )
Matches the union of its span clauses.

Parameters
clauses <Object> A single SpanQuery or array of SpanQueries.

Method Summary

Returns Name Description
String_type()The type of ejs object. For internal use only.
Objectboost(boost)Sets the boost value for documents matching the Query.
Objectclauses(clauses)Sets the clauses used. If passed a single SpanQuery, it is added to the existing list of clauses. If passed an array of SpanQueries, they replace any existing clauses.
StringtoJSON()Retrieves the internal query object. This is typically used by internal API functions so use with caution.

Method Detail

 _type

 String _type ( )
The type of ejs object. For internal use only.

Returns
the type of object

 boost

 Object boost ( boost )
Sets the boost value for documents matching the Query.

Parameters
boost <Double> A positive double value.
Returns
returns this so that calls can be chained.

 clauses

 Object clauses ( clauses )
Sets the clauses used. If passed a single SpanQuery, it is added to the existing list of clauses. If passed an array of SpanQueries, they replace any existing clauses.

Parameters
clauses <Query | Query[]> A SpanQuery or array of SpanQueries.
Returns
returns this so that calls can be chained.

 toJSON

 String toJSON ( )
Retrieves the internal query object. This is typically used by internal API functions so use with caution.

Returns
returns this object's internal query property.

Request

Queries

Filters

Aggregations

Facets

Suggesters

Geo