- Documentation
- Reference manual
- Packages
- Redis -- a SWI-Prolog client for redis
- library(redis): Redis client
- redis_server/3
- redis_connect/1
- redis_connect/3
- tls_verify/5
- sentinel_slave/4
- redis_disconnect/1
- redis_disconnect/2
- redis/2
- redis/3
- redis/1
- redis_write/2
- redis_read/2
- redis_get_list/3
- redis_get_list/4
- redis_set_list/3
- redis_get_hash/3
- redis_set_hash/3
- redis_array_dict/3
- redis_scan/3
- redis_sscan/4
- redis_hscan/4
- redis_zscan/4
- redis_current_command/2
- redis_current_command/3
- redis_property/2
- redis_subscribe/4
- redis_subscribe/2
- redis_unsubscribe/2
- redis_current_subscription/2
- library(redis): Redis client
- Redis -- a SWI-Prolog client for redis
redis_connect(+Address, -Connection, +Options)
. redis_connect/1
is equivalent to
redis_connect(localhost:6379, Connection, [])
. Options:
- reconnect(+Boolean)
- If
true
, try to reconnect to the service when the connection seems lost. Default istrue
for connections specified using redis_server/3 andfalse
for explictly opened connections. - user(+User)
- If
version(3)
andpassword(Password)
are specified, these are used to authenticate using the HELLO command. - password(+Password)
- Authenticate using Password
- version(+Version)
- Specify the connection protocol version. Initially this is version 2.
Redis 6 also supports version 3. When specified as
3
, the HELLO command is used to upgrade the protocol. - tls(true)
- When specified, initiate a TLS connection. If this option is specified
we must also specify the
cacert
,key
andcert
options. - cacert(+File)
- CA Certificate file to verify with.
- cert(+File)
- Client certificate to authenticate with.
- key(+File)
- Private key file to authenticate with.
- sentinels(+ListOfAddresses)
- Used together with an Address of the form
sentinel(MasterName)
to enable contacting a network of Redis servers guarded by a sentinel network. - sentinel_user(+User)
- sentinel_password(+Password)
- Authentication information for the senitels. When omitted we try to connect withour authentication.
Instead of using these predicates, redis/2 and redis/3 are normally used with a server name argument registered using redis_server/3. These predicates are meant for creating a temporary paralel connection or using a connection with a blocking call.
Address | is a term Host:Port, unix(File)
or the name of a server registered using redis_server/3.
The latter realises a new connection that is typically used for
blocking redis commands such as listening for published messages,
waiting on a list or stream. |
- Compatibility
redis_connect(-Connection, +Host, +Port)
provides compatibility to the original GNU-Prolog interface and is equivalent toredis_connect(Host:Port, Connection, [])
.