Module
BoolQuery
BoolQuery ( )
A Query that matches documents matching boolean combinations of other
queries, e.g. termQuerys, phraseQuerys or other boolQuerys. |
Method Summary
| Returns | Name | Description |
|---|---|---|
String | _type() | The type of ejs object. For internal use only. |
Object | adjustPureNegative(trueFalse) | Sets if the Query should be enhanced with a
MatchAllQuery in order to act as a pure exclude when
only negative (mustNot) clauses exist. Default: true. |
Object | boost(boost) | Sets the boost value for documents matching the Query. |
Object | disableCoord(trueFalse) | Enables or disables similarity coordinate scoring of documents
matching the Query. Default: false. |
Object | minimumNumberShouldMatch(minMatch) | Sets the number of optional clauses that must match. By default no optional clauses are necessary for a match (unless there are no required clauses). If this method is used, then the specified number of clauses is required. Use of this method is totally independent of specifying that any specific clauses are required (or prohibited). This number will only be compared against the number of matching optional clauses. |
Object | must(oQuery) | Adds query to boolean container. Given query "must" appear in matching documents. |
Object | mustNot(oQuery) | Adds query to boolean container. Given query "must not" appear in matching documents. |
Object | should(oQuery) | Adds query to boolean container. Given query "should" appear in matching documents. |
String | toJSON() | Retrieves the internal query object. This is typically used by
internal API functions so use with caution. |
Method Detail
adjustPureNegative
Object adjustPureNegative ( trueFalse )
Sets if the Query should be enhanced with a
MatchAllQuery in order to act as a pure exclude when
only negative (mustNot) clauses exist. Default: true.
|
boost
Object boost ( boost )
Sets the boost value for documents matching the Query.
|
disableCoord
Object disableCoord ( trueFalse )
Enables or disables similarity coordinate scoring of documents
matching the Query. Default: false.
|
minimumNumberShouldMatch
Object minimumNumberShouldMatch ( minMatch )
Sets the number of optional clauses that must match. By default no optional clauses are necessary for a match (unless there are no required clauses). If this method is used, then the specified number of clauses is required. Use of this method is totally independent of specifying that any specific clauses are required (or prohibited). This number will only be compared against the number of matching optional clauses.
|
must
Object must ( oQuery )
Adds query to boolean container. Given query "must" appear in matching documents.
|
mustNot
Object mustNot ( oQuery )
Adds query to boolean container. Given query "must not" appear in matching documents.
|
should
Object should ( oQuery )
Adds query to boolean container. Given query "should" appear in matching documents.
|
toJSON
String toJSON ( )
Retrieves the internal query object. This is typically used by
internal API functions so use with caution.
|