RedisPipelineAdd (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

How the pipeline works

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

RedisPipelineAdd (Function)

In french: RedisPipelineAjoute

Adds a Redis command in a pipeline. This makes it possible to send a group of commands to a Redis server and optimize network access performance.

Example

RedisPipelineAdd(gRedis, "set p1 pv1")
RedisPipelineAdd(gRedis, "set p2 pv2")
RedisPipelineAdd(gRedis, "get p2")
RedisPipelineAdd(gRedis, "get p1")

r1 is redisResponse = RedisPipelineGet(gRedis)
r2 is redisResponse = RedisPipelineGet(gRedis)
r3 is redisResponse = RedisPipelineGet(gRedis)
r4 is redisResponse = RedisPipelineGet(gRedis)

Syntax

<Result> = RedisPipelineAdd(<Connection> , <Command> [, <Parameter 1> [... [, <Parameter N>]]])

<Result>: Boolean

True if the addition was performed,
False otherwise.

<Connection>: redisConnection variable

Name of the redisConnection variable that corresponds to the Redis server connection.

<Command>: Character string

Text of the Redis command to run.
This command can contain parameters separated by space characters.

<Parameter 1>: Type of optional parameter

First optional parameter of the command. This parameter allows you to pass strings containing spaces or binary values to the command being run.
Remark: The strings are converted to UTF8 when the command is sent to the Redis server.

<Parameter N>: Type of optional parameter

Nth command parameter. This parameter allows you to pass strings containing spaces or binary values to the command being run.
Remark: The strings are converted to UTF8 when the command is sent to the Redis server.

Remarks

How the pipeline works

When all the desired commands have been added to the pipeline, the results can be retrieved with RedisPipelineGet.

To avoid retrieving the results, it is possible to use RedisPipelineReset.

If RedisPipelineReset has not been used, there must be as many calls to RedisPipelineGet as there are to RedisPipelineAdd.

Business / UI classification: Business Logic

Component: wd270big.dll