Module org.elasticsearch.server
Class ScriptScoreQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<ScriptScoreQueryBuilder>
org.elasticsearch.index.query.functionscore.ScriptScoreQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,ToXContent,ToXContentObject
A query that computes a document score based on the provided script
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ParseFieldstatic final Stringstatic final ParseFieldstatic final ParseFieldFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionRead from a stream.ScriptScoreQueryBuilder(QueryBuilder query, Script script) Creates a script_score query that executes the provided script function on documents that match a query. -
Method Summary
Modifier and TypeMethodDescriptionprotected booleandoEquals(ScriptScoreQueryBuilder other) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected QueryBuilderdoRewrite(QueryRewriteContext queryRewriteContext) protected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) protected voidextractInnerHitBuilders(Map<String, InnerHitContextBuilder> innerHits) For internal usage only! Extracts the inner hits from the query tree.static ScriptScoreQueryBuilderfromXContent(XContentParser parser) The minimal version of the recipient this object can be sent toReturns the name of the writeable objectquery()Returns the query builder that defines which documents the script_score query will be executed on.setMinScore(float minScore) Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doSearchRewrite, equals, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
- See Also:
-
QUERY_FIELD
-
SCRIPT_FIELD
-
MIN_SCORE_FIELD
-
-
Constructor Details
-
ScriptScoreQueryBuilder
Creates a script_score query that executes the provided script function on documents that match a query.- Parameters:
query- the query that defines which documents the script_score query will be executed on.script- the script to run for computing the query score
-
ScriptScoreQueryBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
fromXContent
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<ScriptScoreQueryBuilder>- Throws:
IOException
-
query
Returns the query builder that defines which documents the script_score query will be executed on. -
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<ScriptScoreQueryBuilder>- Throws:
IOException
-
setMinScore
-
getMinScore
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object -
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<ScriptScoreQueryBuilder>
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<ScriptScoreQueryBuilder>
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<ScriptScoreQueryBuilder>- Throws:
IOException
-
doRewrite
- Overrides:
doRewritein classAbstractQueryBuilder<ScriptScoreQueryBuilder>- Throws:
IOException
-
extractInnerHitBuilders
Description copied from class:AbstractQueryBuilderFor internal usage only! Extracts the inner hits from the query tree. While it extracts inner hits, child inner hits are inlined into the inner hit builder they belong to.- Overrides:
extractInnerHitBuildersin classAbstractQueryBuilder<ScriptScoreQueryBuilder>
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-