FTCreateParams (valkey-java 5.3.0 API)

java.lang.Object
- io.valkey.search.FTCreateParams

All Implemented Interfaces:: IParams

public class FTCreateParams
extends Object
implements IParams

Constructor Summary

Constructors
Constructor and Description

FTCreateParams()

Constructors
Constructor and Description
`FTCreateParams()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addParams(CommandArguments args)`
`FTCreateParams`	`addPrefix(String prefix)` This method can be chained to add multiple prefixes.
`static FTCreateParams`	`createParams()`
`FTCreateParams`	`filter(String filter)` A filter expression with the full RediSearch aggregation expression language.
`FTCreateParams`	`language(String defaultLanguage)` Indicates the default language for documents in the index.
`FTCreateParams`	`languageField(String languageAttribute)` Document attribute set as the document language.
`FTCreateParams`	`maxTextFields()` Forces RediSearch to encode indexes as if there were more than 32 text attributes.
`FTCreateParams`	`noFields()` Does not store attribute bits for each term.
`FTCreateParams`	`noFreqs()` Avoids saving the term frequencies in the index.
`FTCreateParams`	`noHighlights()`
`FTCreateParams`	`noHL()` Conserves storage space and memory by disabling highlighting support.
`FTCreateParams`	`noOffsets()` Does not store term offsets for documents.
`FTCreateParams`	`noStopwords()` The index does not have stopwords, not even the default ones.
`FTCreateParams`	`on(IndexDataType dataType)` Currently supports HASH (default) and JSON.
`FTCreateParams`	`prefix(String... prefixes)` Tells the index which keys it should index.
`FTCreateParams`	`score(double defaultScore)` Default score for documents in the index.
`FTCreateParams`	`scoreField(String scoreField)` Document attribute that you use as the document rank based on the user ranking.
`FTCreateParams`	`skipInitialScan()` Does not scan and index.
`FTCreateParams`	`stopwords(String... stopwords)` Sets the index with a custom stopword list, to be ignored during indexing and search time.
`FTCreateParams`	`temporary(long seconds)` Creates a lightweight temporary index that expires after a specified period of inactivity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FTCreateParams
```
public FTCreateParams()
```
- Method Detail
  - 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:
    
    prefix(java.lang.String...)
  - 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:
    
    noHL()
  - 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

Class FTCreateParams

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FTCreateParams

Method Detail

createParams

on

prefix

addPrefix

filter

language

languageField

score

scoreField

maxTextFields

noOffsets

temporary

noHL

noHighlights

noFields

noFreqs

stopwords

noStopwords

skipInitialScan

addParams