Class FunctionScoreQueryBuilder

java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<FunctionScoreQueryBuilder>
org.elasticsearch.index.query.functionscore.FunctionScoreQueryBuilder
All Implemented Interfaces:
NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>

public class FunctionScoreQueryBuilder
extends AbstractQueryBuilder<FunctionScoreQueryBuilder>
A query that uses a filters with a script associated with them to compute the score.
  • Field Details

    • NAME

      public static final java.lang.String NAME
      See Also:
      Constant Field Values
    • WEIGHT_FIELD

      public static final org.elasticsearch.common.ParseField WEIGHT_FIELD
    • QUERY_FIELD

      public static final org.elasticsearch.common.ParseField QUERY_FIELD
    • FILTER_FIELD

      public static final org.elasticsearch.common.ParseField FILTER_FIELD
    • FUNCTIONS_FIELD

      public static final org.elasticsearch.common.ParseField FUNCTIONS_FIELD
    • SCORE_MODE_FIELD

      public static final org.elasticsearch.common.ParseField SCORE_MODE_FIELD
    • BOOST_MODE_FIELD

      public static final org.elasticsearch.common.ParseField BOOST_MODE_FIELD
    • MAX_BOOST_FIELD

      public static final org.elasticsearch.common.ParseField MAX_BOOST_FIELD
    • MIN_SCORE_FIELD

      public static final org.elasticsearch.common.ParseField MIN_SCORE_FIELD
    • DEFAULT_BOOST_MODE

      public static final CombineFunction DEFAULT_BOOST_MODE
    • DEFAULT_SCORE_MODE

      public static final FunctionScoreQuery.ScoreMode DEFAULT_SCORE_MODE
  • Constructor Details

    • FunctionScoreQueryBuilder

      public FunctionScoreQueryBuilder​(QueryBuilder query)
      Creates a function_score query without functions
      Parameters:
      query - the query that needs to be custom scored
    • FunctionScoreQueryBuilder

      public FunctionScoreQueryBuilder​(FunctionScoreQueryBuilder.FilterFunctionBuilder[] filterFunctionBuilders)
      Creates a function_score query that executes the provided filters and functions on all documents
      Parameters:
      filterFunctionBuilders - the filters and functions
    • FunctionScoreQueryBuilder

      public FunctionScoreQueryBuilder​(ScoreFunctionBuilder<?> scoreFunctionBuilder)
      Creates a function_score query that will execute the function provided on all documents
      Parameters:
      scoreFunctionBuilder - score function that is executed
    • FunctionScoreQueryBuilder

      public FunctionScoreQueryBuilder​(QueryBuilder query, ScoreFunctionBuilder<?> scoreFunctionBuilder)
      Creates a function_score query that will execute the function provided in the context of the provided query
      Parameters:
      query - the query to custom score
      scoreFunctionBuilder - score function that is executed
    • FunctionScoreQueryBuilder

      public FunctionScoreQueryBuilder​(QueryBuilder query, FunctionScoreQueryBuilder.FilterFunctionBuilder[] filterFunctionBuilders)
      Creates a function_score query that executes the provided filters and functions on documents that match a query.
      Parameters:
      query - the query that defines which documents the function_score query will be executed on.
      filterFunctionBuilders - the filters and functions
    • FunctionScoreQueryBuilder

      public FunctionScoreQueryBuilder​(StreamInput in) throws java.io.IOException
      Read from a stream.
      Throws:
      java.io.IOException
  • Method Details