Module resty.session.redis-cluster
Redis Cluster backend for session library
Configuration
configuration | Redis Cluster storage backend configuration |
nodes | Cluster Nodes |
node | Cluster Node |
Constructors
module.new ([configuration]) | Create a Redis Cluster storage. |
Storage
instance:set (name, key, value, ttl, current_time, old_key, stale_ttl, metadata, remember) | Store session data. |
instance:get (name, key) | Retrieve session data. |
instance:delete (name, key[, metadata]) | Delete session data. |
Configuration
- configuration
-
Redis Cluster storage backend configuration
Fields:
- prefix prefix for the keys stored in redis
- suffix suffix for the keys stored in redis
- name redis cluster name
- nodes redis cluster nodes
- lock_zone shared dictionary name for locks
- lock_prefix shared dictionary name prefix for lock
- max_redirections maximum retry attempts for redirection
- max_connection_attempts maximum retry attempts for connection
- max_connection_timeout maximum connection timeout in total among the retries
- username the database username to authenticate
- password password for authentication
- connect_timeout
controls the default timeout value used in TCP/unix-domain socket object’s
connect
method - send_timeout
controls the default timeout value used in TCP/unix-domain socket object’s
send
method - read_timeout
controls the default timeout value used in TCP/unix-domain socket object’s
receive
method - keepalive_timeout controls the default maximal idle time of the connections in the connection pool
- pool a custom name for the connection pool being used.
- pool_size the size of the connection pool,
- backlog a queue size to use when the connection pool is full (configured with @pool_size)
- ssl
enable ssl (defaults to
false
) - ssl_verify
verify server certificate (defaults to
nil
) - server_name the server name for the new TLS extension Server Name Indication (SNI)
- nodes
- Cluster Nodes An array of cluster nodes.
- node
-
Cluster Node
Fields:
- ip
the ip address to connect (defaults to
"127.0.0.1"
) - port
the port to connect (defaults to
6379
)
- ip
the ip address to connect (defaults to
Constructors
- module.new ([configuration])
-
Create a Redis Cluster storage.
This creates a new Redis Cluster storage instance.
Parameters:
- configuration table redis cluster storage configuration (optional)
Returns:
-
table
redis cluster storage instance
Storage
- instance:set (name, key, value, ttl, current_time, old_key, stale_ttl, metadata, remember)
-
Store session data.
Parameters:
- name string cookie name
- key string session key
- value string session value
- ttl number session ttl
- current_time number current time
- old_key string old session id
- stale_ttl string stale ttl
- metadata table table of metadata
- remember table whether storing persistent session or not
Returns:
- true or nil ok
- string error message
- instance:get (name, key)
-
Retrieve session data.
Parameters:
Returns:
- instance:delete (name, key[, metadata])
-
Delete session data.
Parameters:
Returns:
- boolean or nil session data
- string error message