redisConnection (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Properties specific to the description of redisConnection variables
WLanguage functions that use the redisConnection type

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Redis management functions

redisConnection (Type of variable)

In french: redisConnexion

The type redisConnection makes it possible to define all the advanced characteristics of a connection to a Redis server (or cluster). The characteristics of this connection can be defined and changed using different WLanguage properties.

Remark: For more details on the declaration of this type of variable and the use of WLanguage properties, see Declaring a variable.

Example

// Connection to a server
gRedisSimple is redisConnection
gRedisSimple.Server = "myserveur:7001"
gRedisSimple.ConnectionTimeout = 1s
gRedisSimple.Password = "secret password"

// Connection to a cluster
gRedisCluster is redisConnexion
gRedisCluster.Server[1] = "RedisNode1:7001"
gRedisCluster.Server[2] = "RedisNode1:7002"
gRedisCluster.Server[3] = "RedisNode2:7001"
gRedisCluster.Server[4] = "RedisNode2:7002"

Remarks

Properties specific to the description of redisConnection variables

The following properties can be used to handle a connection to a Redis server or cluster:

Property name	Type used	Effect

ConnectionTimeout	Duration, integer	Maximum timeout for the connection expressed in milliseconds (20 seconds by default, which means 20000 milliseconds). This property can correspond to: an integer corresponding to the number of milliseconds, a Duration variable, the duration in a readable format (e.g., '20s' ou '20000ms').
Password	Character string	Password used if a the connection to a Redis server requires authentication.
Server	Array of strings	Array of Redis servers. Ability to specify multiple Redis servers. In the case of a Redis cluster, it will be possible to connect even if a node of the Redis cluster is inaccessible. The format of the server name must be "ip:port or dnsname:port" On Linux, it is possible to use the "unix:unixdomainsocket" format to use a connection by unix domain socket.

WLanguage functions that use the redisConnection type


RedisSubscribe	Subscribes to a Redis broadcast channel.
RedisConnect	Opens a connection to a Redis server (or cluster).
RedisUnsubscribe	Cancels a subscription to a Redis broadcast channel.
RedisExecuteCommand	Executes a command on a Redis server and retrieves the result.
RedisPipelineAdd	Adds a Redis command in a pipeline.
RedisPipelineReset	Ignores the results of the execution of a Redis command that was added by RedisPipelineAdd.
RedisPipelineGet	Retrieves the result of the execution of a Redis command that was added by RedisPipelineAdd.
RedisPublish	Publishes a message on a Redis broadcast channel.