io.lettuce.core.search.arguments

Class ExplainArgs<K,V>

java.lang.Object

io.lettuce.core.search.arguments.ExplainArgs<K,V>

Type Parameters:

K - Key type.

V - Value type.

public class ExplainArgs<K,V>
extends Object

Argument list builder for the Redis FT.EXPLAIN command. Static import methods are available.

ExplainArgs is a mutable object and instances should be used only once to avoid shared mutable state.

Since:

6.8

Author:

Tihomir Mateev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExplainArgs.Builder Builder entry points for ExplainArgs.

Constructor Summary

Constructors

Constructor and Description
ExplainArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<K,V> args) Builds the arguments and appends them to the CommandArgs.
ExplainArgs<K,V>	dialect(QueryDialects dialect) Set the dialect version under which to execute the query.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExplainArgs

public ExplainArgs()

Method Detail

dialect

public ExplainArgs<K,V> dialect(QueryDialects dialect)

Set the dialect version under which to execute the query. If not specified, the query executes under the default dialect version set during module initial loading or via FT.CONFIG SET command.

Parameters:

dialect - the dialect version.

Returns:

this ExplainArgs.

build

public void build(CommandArgs<K,V> args)

Builds the arguments and appends them to the CommandArgs.

Parameters:

args - the command arguments to append to.