redisutil

Documentation

Overview

Package redisutil contains functions for working with redis.

Index

• Constants
• func NewClientFromURL(rawURL string, tlsConfig *tls.Config) (redis.UniversalClient, error)
• func ParseClusterURL(rawurl string) (*redis.ClusterOptions, error)
• func ParseSentinelURL(rawurl string) (*redis.FailoverOptions, error)

Constants

const KeyPrefix = "{pomerium_v3}."

KeyPrefix is the prefix used for all redis keys.

Functions

func NewClientFromURL

func NewClientFromURL(rawURL string, tlsConfig *tls.Config) (redis.UniversalClient, error)

NewClientFromURL creates a new redis client by parsing the raw URL.

func ParseClusterURL

func ParseClusterURL(rawurl string) (*redis.ClusterOptions, error)

ParseClusterURL parses a redis-cluster URL. Format is:

redis+cluster://[username:password@]host:port[,host2:port2,...]/[?param1=value1[&param2=value=2&...]]

Additionally TLS is supported with rediss+cluster, or redis+clusters. Supported query params:

max_redirects: int
read_only: bool
route_by_latency: bool
route_randomly: bool
max_retries: int
min_retry_backoff: duration
max_retry_backoff: duration
dial_timeout: duration
read_timeout: duration
write_timeout: duration
pool_size: int
min_idle_conns: int
max_conn_age: duration
pool_timeout: duration
idle_timeout: duration
idle_check_frequency: duration

func ParseSentinelURL

func ParseSentinelURL(rawurl string) (*redis.FailoverOptions, error)

ParseSentinelURL parses a redis-sentinel URL. Format is based on https://github.com/exponea/redis-sentinel-url:

redis+sentinel://[:password@]host:port[,host2:port2,...][/service_name[/db]][?param1=value1[&param2=value=2&...]]

Additionally TLS is supported with rediss+sentinel, or redis+sentinels. Supported query params:

slave_only: bool
use_disconnected_slaves: bool
query_sentinel_randomly: bool
username: string (username for redis connection)
password: string (password for redis connection)
max_retries: int
min_retry_backoff: duration
max_retry_backoff: duration
dial_timeout: duration
read_timeout: duration
write_timeout: duration
pool_size: int
min_idle_conns: int
max_conn_age: duration
pool_timeout: duration
idle_timeout: duration
idle_check_frequency: duration