Package redis.clients.jedis.search

Class FTSearchParams

java.lang.Object
redis.clients.jedis.search.FTSearchParams
All Implemented Interfaces:
IParams
public class FTSearchParams extends Object implements IParams
Query represents query parameters and filters to load results from the engine

  • Field Details

  • Constructor Details

    • FTSearchParams

      public FTSearchParams()

  • Method Details

    • searchParams

      public static FTSearchParams searchParams()

    • addParams

      public void addParams(CommandArguments args)
      Specified by:
      addParams in interface IParams

    • noContent

      public FTSearchParams noContent()
      Set the query not to return the contents of documents, and rather just return the ids
      Returns:
      the query itself

    • verbatim

      public FTSearchParams verbatim()
      Set the query to verbatim mode, disabling stemming and query expansion
      Returns:
      the query object

    • noStopwords

      public FTSearchParams noStopwords()
      Set the query not to filter for stopwords. In general this should not be used
      Returns:
      the query object

    • withScores

      public FTSearchParams withScores()
      Set the query to return a factored score for each results. This is useful to merge results from multiple queries.
      Returns:
      the query object itself

    • filter

      public FTSearchParams filter(String field, double min, double max)

    • filter

      public FTSearchParams filter(String field, double min, boolean exclusiveMin, double max, boolean exclusiveMax)

    • filter

      public FTSearchParams filter(FTSearchParams.NumericFilter numericFilter)

    • geoFilter

      public FTSearchParams geoFilter(String field, double lon, double lat, double radius, GeoUnit unit)

    • geoFilter

      public FTSearchParams geoFilter(FTSearchParams.GeoFilter geoFilter)

    • inKeys

      public FTSearchParams inKeys(String... keys)
      Limit the query to results that are limited to a specific set of keys
      Parameters:
      keys - a list of TEXT fields in the schemas
      Returns:
      the query object itself

    • inKeys

      public FTSearchParams inKeys(Collection<String> keys)

    • inFields

      public FTSearchParams inFields(String... fields)
      Limit the query to results that are limited to a specific set of fields
      Parameters:
      fields - a list of TEXT fields in the schemas
      Returns:
      the query object itself

    • inFields

      public FTSearchParams inFields(Collection<String> fields)

    • returnFields

      public FTSearchParams returnFields(String... fields)
      Result's projection - the fields to return by the query
      Parameters:
      fields - a list of TEXT fields in the schemas
      Returns:
      the query object itself

    • returnField

      public FTSearchParams returnField(FieldName field)

    • returnFields

      public FTSearchParams returnFields(FieldName... fields)

    • returnFields

      public FTSearchParams returnFields(Collection<FieldName> fields)

    • initReturnFieldNames

      private void initReturnFieldNames()

    • summarize

      public FTSearchParams summarize()

    • summarize

      public FTSearchParams summarize(FTSearchParams.SummarizeParams summarizeParams)

    • highlight

      public FTSearchParams highlight()

    • highlight

      public FTSearchParams highlight(FTSearchParams.HighlightParams highlightParams)

    • scorer

      public FTSearchParams scorer(String scorer)
      Set the query custom scorer

      See http://redisearch.io for documentation on extending RediSearch

      Parameters:
      scorer - a custom scorer.
      Returns:
      the query object itself

    • slop

      public FTSearchParams slop(int slop)

    • timeout

      public FTSearchParams timeout(long timeout)

    • inOrder

      public FTSearchParams inOrder()

    • language

      public FTSearchParams language(String language)
      Set the query language, for stemming purposes

      See http://redisearch.io for documentation on languages and stemming

      Parameters:
      language - a language.
      Returns:
      the query object itself

    • sortBy

      public FTSearchParams sortBy(String sortBy, SortingOrder order)
      Set the query to be sorted by a Sortable field defined in the schema
      Parameters:
      sortBy - the sorting field's name
      order - the sorting order
      Returns:
      the query object itself

    • limit

      public FTSearchParams limit(int offset, int num)
      Limit the results to a certain offset and limit
      Parameters:
      offset - the first result to show, zero based indexing
      num - how many results we want to show
      Returns:
      the query itself, for builder-style syntax

    • addParam

      public FTSearchParams addParam(String name, Object value)
      Parameters can be referenced in the query string by a $ , followed by the parameter name, e.g., $user , and each such reference in the search query to a parameter name is substituted by the corresponding parameter value.
      Parameters:
      name -
      value - can be String, long or float
      Returns:
      the query object itself

    • params

      public FTSearchParams params(Map<String,Object> paramValues)

    • dialect

      public FTSearchParams dialect(int dialect)
      Set the dialect version to execute the query accordingly
      Parameters:
      dialect - integer
      Returns:
      the query object itself

    • getNoContent

      public boolean getNoContent()

    • getWithScores

      public boolean getWithScores()

    • summarizeParams

      public static FTSearchParams.SummarizeParams summarizeParams()

    • highlightParams

      public static FTSearchParams.HighlightParams highlightParams()