Package redis.clients.jedis.search

Class FTCreateParams

java.lang.Object
redis.clients.jedis.search.FTCreateParams
All Implemented Interfaces:
IParams
public class FTCreateParams extends Object implements IParams

  • Field Details

    • dataType

      private IndexDataType dataType

    • prefix

      private Collection<String> prefix

    • filter

      private String filter

    • language

      private String language

    • languageField

      private String languageField

    • score

      private Double score

    • scoreField

      private String scoreField

    • maxTextFields

      private boolean maxTextFields

    • noOffsets

      private boolean noOffsets

    • temporary

      private Long temporary

    • noHL

      private boolean noHL

    • noFields

      private boolean noFields

    • noFreqs

      private boolean noFreqs

    • stopwords

      private Collection<String> stopwords

    • skipInitialScan

      private boolean skipInitialScan

  • Constructor Details

    • FTCreateParams

      public FTCreateParams()

  • Method Details

    • createParams

      public static FTCreateParams createParams()

    • on

      public FTCreateParams on(IndexDataType dataType)
      Currently supports HASH (default) and JSON. To index JSON, you must have the RedisJSON module installed.

    • prefix

      public FTCreateParams prefix(String... prefixes)
      Tells the index which keys it should index. You can add several prefixes to index.

    • addPrefix

      public FTCreateParams addPrefix(String prefix)
      This method can be chained to add multiple prefixes.
      See Also:

    • filter

      public FTCreateParams filter(String filter)
      A filter expression with the full RediSearch aggregation expression language.

    • language

      public FTCreateParams language(String defaultLanguage)
      Indicates the default language for documents in the index.

    • languageField

      public FTCreateParams languageField(String languageAttribute)
      Document attribute set as the document language.

    • score

      public FTCreateParams score(double defaultScore)
      Default score for documents in the index.

    • scoreField

      public FTCreateParams scoreField(String scoreField)
      Document attribute that you use as the document rank based on the user ranking. Ranking must be between 0.0 and 1.0.

    • maxTextFields

      public FTCreateParams maxTextFields()
      Forces RediSearch to encode indexes as if there were more than 32 text attributes.

    • noOffsets

      public FTCreateParams noOffsets()
      Does not store term offsets for documents. It saves memory, but does not allow exact searches or highlighting.

    • temporary

      public FTCreateParams temporary(long seconds)
      Creates a lightweight temporary index that expires after a specified period of inactivity.

    • noHL

      public FTCreateParams noHL()
      Conserves storage space and memory by disabling highlighting support.

    • noHighlights

      public FTCreateParams noHighlights()
      See Also:

    • noFields

      public FTCreateParams noFields()
      Does not store attribute bits for each term. It saves memory, but it does not allow filtering by specific attributes.

    • noFreqs

      public FTCreateParams noFreqs()
      Avoids saving the term frequencies in the index. It saves memory, but does not allow sorting based on the frequencies of a given term within the document.

    • stopwords

      public FTCreateParams stopwords(String... stopwords)
      Sets the index with a custom stopword list, to be ignored during indexing and search time.

    • noStopwords

      public FTCreateParams noStopwords()
      The index does not have stopwords, not even the default ones.

    • skipInitialScan

      public FTCreateParams skipInitialScan()
      Does not scan and index.

    • addParams

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