sugadd(
key: str, // The suggestion dictionary key
suggestions: *Suggestion // Suggestions to add
) → int // The current size of the suggestion dictionary
Possible errors
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
client.ft.sugAdd(
key: RedisArgument, // The suggestion dictionary key
string: RedisArgument, // The suggestion string
score: number, // The suggestion score
options: { INCR?: boolean, PAYLOAD?: RedisArgument } // Optional add options
) → number // The current size of the suggestion dictionary
Possible errors
- WRONGTYPE:
SimpleError (test with err.message.startsWith('WRONGTYPE'))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
ioredis has no dedicated method for this command. Send it with call.
ftSugAdd(
key: String, // The suggestion dictionary key
string: String, // The suggestion string
score: double // The suggestion score
) → long // The current size of the suggestion dictionary
ftSugAddIncr(
key: String, // The suggestion dictionary key
string: String, // The suggestion string
score: double // The suggestion score
) → long // The current size of the suggestion dictionary
Possible errors
- WRONGTYPE:
JedisDataException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
ftSugadd(
key: K, // the suggestion dictionary key
suggestion: String, // the suggestion string to index
score: double // the floating point number of the suggestion string's weight
) → Long // the current size of the suggestion dictionary after adding the suggestion
ftSugadd(
key: K, // the suggestion dictionary key
suggestion: String, // the suggestion string to index
score: double, // the floating point number of the suggestion string's weight
args: SugAddArgs // the suggestion add arguments (INCR, deprecated PAYLOAD)
) → Long // the current size of the suggestion dictionary after adding the suggestion
Possible errors
- WRONGTYPE:
RedisCommandExecutionException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
ftSugadd(
key: K, // the suggestion dictionary key
suggestion: String, // the suggestion string to index
score: double // the floating point number of the suggestion string's weight
) → RedisFuture<Long> // the current size of the suggestion dictionary after adding the suggestion
ftSugadd(
key: K, // the suggestion dictionary key
suggestion: String, // the suggestion string to index
score: double, // the floating point number of the suggestion string's weight
args: SugAddArgs // the suggestion add arguments (INCR, deprecated PAYLOAD)
) → RedisFuture<Long> // the current size of the suggestion dictionary after adding the suggestion
Possible errors
- WRONGTYPE:
RedisCommandExecutionException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
ftSugadd(
key: K, // the suggestion dictionary key
suggestion: String, // the suggestion string to index
score: double // the floating point number of the suggestion string's weight
) → Mono<Long> // the current size of the suggestion dictionary after adding the suggestion
ftSugadd(
key: K, // the suggestion dictionary key
suggestion: String, // the suggestion string to index
score: double, // the floating point number of the suggestion string's weight
args: SugAddArgs // the suggestion add arguments (INCR, deprecated PAYLOAD)
) → Mono<Long> // the current size of the suggestion dictionary after adding the suggestion
Possible errors
- WRONGTYPE:
RedisCommandExecutionException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
FTSugAdd(
ctx: context.Context,
key: string, // The suggestion dictionary key
suggestion: string, // The suggestion string
score: float64 // The suggestion score
) → *IntCmd // The current size of the suggestion dictionary
FTSugAddWithArgs(
ctx: context.Context,
key: string, // The suggestion dictionary key
suggestion: string, // The suggestion string
score: float64, // The suggestion score
options: *FTSugAddOptions // Add options
) → *IntCmd // The current size of the suggestion dictionary
Possible errors
- WRONGTYPE:
redis.Error (test with redis.HasErrorPrefix(err, "WRONGTYPE"))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
SugAdd(
key: string, // The suggestion dictionary key
str: string, // The suggestion string
score: double, // The suggestion score
increment: bool, // Whether to increment the score if the suggestion exists
payload: string? // Optional payload
) → long // The current size of the suggestion dictionary
Possible errors
- WRONGTYPE:
RedisServerException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
SugAddAsync(
key: string, // The suggestion dictionary key
str: string, // The suggestion string
score: double, // The suggestion score
increment: bool, // Whether to increment the score if the suggestion exists
payload: string? // Optional payload
) → Task<long> // The current size of the suggestion dictionary
Possible errors
- WRONGTYPE:
RedisServerException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
ftsugadd(
$key: string, // The suggestion dictionary key
$string: string, // The suggestion string
$score: float, // The suggestion score
$arguments: ?SugAddArguments // Optional arguments (INCR, PAYLOAD)
) → int // The current size of the suggestion dictionary
Possible errors
- WRONGTYPE:
Predis\Response\ServerException (test with $e->getErrorType() === 'WRONGTYPE')
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
ft_sugadd(
key: String, // the suggestion dictionary key
string: String, // the suggestion text
score: Numeric, // the suggestion weight
options: Hash // accepts :incr (increment the existing score, INCR) and :payload (opaque payload, PAYLOAD)
) → Integer // the current size of the suggestion dictionary
Possible errors
- WRONGTYPE:
Redis::WrongTypeError
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
redis-rs has no dedicated method for this command. Send it with redis::cmd.
redis-rs has no dedicated method for this command. Send it with redis::cmd.