ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / Managing databases / Big Data / Managing REDIS databases
  • Properties specific to redisConnection variables
  • WLanguage functions that use the redisConnection type
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
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 redisConnection variables

The following properties can be used to handle a connection to a Redis server or cluster:
Property nameType usedEffect
ConnectionTimeoutDuration, integerMaximum 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').
PasswordCharacter stringPassword used if a the connection to a Redis server requires authentication.
ServerArray of stringsArray 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"
Linux 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

RedisConnectOpens a connection to a Redis server (or cluster).
RedisExecuteCommandExecutes a command on a Redis server and retrieves the result.
RedisPipelineAddAdds a Redis command in a pipeline.
RedisPipelineGetRetrieves the result of the execution of a Redis command that was added by RedisPipelineAdd.
RedisPipelineResetIgnores the results of the execution of a Redis command that was added by RedisPipelineAdd.
RedisPublishPublishes a message on a Redis broadcast channel.
RedisSubscribeSubscribes to a Redis broadcast channel.
RedisUnsubscribeCancels a subscription to a Redis broadcast channel.
Minimum version required
  • Version 24
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/02/2023

Send a report | Local help