io.lettuce.core.search.arguments

Enum QueryDialects

java.lang.Object

java.lang.Enum<QueryDialects>

io.lettuce.core.search.arguments.QueryDialects

All Implemented Interfaces:

Serializable, Comparable<QueryDialects>

public enum QueryDialects
extends Enum<QueryDialects>

Enumeration of Redis Search query dialects that define the syntax and features available for search queries and aggregation operations.

Query dialects in Redis Search determine:

• The syntax rules for query expressions
• Available operators and functions
• Field reference syntax and behavior
• Compatibility with different Redis Search versions

Each dialect represents a specific version of the query language with its own capabilities and syntax rules. Higher dialect numbers generally include more features and improved functionality, but may not be compatible with older Redis Search versions.

Usage example:

 
 {
     @code
     SearchArgs args = SearchArgs. builder().dialect(QueryDialects.DIALECT2).build();
 }
 

Since:

6.8

Author:

Redis Ltd.

See Also:

SearchArgs, AggregateArgs

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIALECT1 Query dialect version 1 - the original Redis Search query syntax.
DIALECT2 Query dialect version 2 - enhanced query syntax with improved features.
DIALECT3 Query dialect version 3 - advanced query syntax with extended capabilities.
DIALECT4 Query dialect version 4 - latest query syntax with cutting-edge features.

Method Summary

Modifier and Type	Method and Description
String	toString() Returns the string representation of this query dialect.
static QueryDialects	valueOf(String name) Returns the enum constant of this type with the specified name.
static QueryDialects[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DIALECT1

public static final QueryDialects DIALECT1

Query dialect version 1 - the original Redis Search query syntax.

Features and characteristics:

• Basic query syntax with standard operators
• Field references without @ prefix
• Limited function support
• Compatible with early Redis Search versions

This dialect provides the most basic query functionality and is primarily maintained for backward compatibility with older applications.

DIALECT2

public static final QueryDialects DIALECT2

Query dialect version 2 - enhanced query syntax with improved features.

Features and characteristics:

• Field references with @ prefix (e.g., @field_name)
• Enhanced operator support
• Improved aggregation functions
• Better error handling and validation
• Support for more complex expressions

This is the recommended dialect for most applications as it provides a good balance of features and compatibility.

DIALECT3

public static final QueryDialects DIALECT3

Query dialect version 3 - advanced query syntax with extended capabilities.

Features and characteristics:

• All features from DIALECT2
• Additional built-in functions
• Enhanced aggregation capabilities
• Improved performance optimizations
• Extended operator set

This dialect includes advanced features for complex query scenarios and is suitable for applications requiring sophisticated search operations.

DIALECT4

public static final QueryDialects DIALECT4

Query dialect version 4 - latest query syntax with cutting-edge features.

Features and characteristics:

• All features from previous dialects
• Latest query language enhancements
• Newest built-in functions and operators
• Advanced optimization features
• Experimental or preview functionality

This dialect provides access to the latest Redis Search features but may require newer Redis Search versions and could include experimental functionality that might change in future releases.

Method Detail

values

public static QueryDialects[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QueryDialects c : QueryDialects.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QueryDialects valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Returns the string representation of this query dialect.

This method returns the dialect version identifier that is sent to Redis Search when executing queries or aggregations. The returned string corresponds to the DIALECT parameter value used in Redis Search commands.

Examples:

• QueryDialects.DIALECT1.toString() returns "1"
• QueryDialects.DIALECT2.toString() returns "2"
• QueryDialects.DIALECT3.toString() returns "3"
• QueryDialects.DIALECT4.toString() returns "4"

Overrides:

toString in class Enum<QueryDialects>

Returns:

the string representation of the dialect version, never null or empty