RedisCluster.ClusterInfo (redis_cluster v0.8.0)

View Source

A module for fetching the cluster information from a Redis cluster. Aside from internal use, this may be used for testing and debugging. Be aware this module will open a connection for each call.

Summary

Functions

query(config)

Opens a new connection to the Redis cluster and fetches the cluster information.

query_while(config, fun)

Fetches the cluster information from the Redis cluster and passes it to the provided function.

Functions

query(config)

@spec query(RedisCluster.Configuration.t()) :: [RedisCluster.Cluster.NodeInfo.t()]

Opens a new connection to the Redis cluster and fetches the cluster information.

The host and port are taken from the provided configuration. Ideally the host should be a configuration endpoint for ElastiCache (or equivalent). The connection is closed after the information is fetched.

query_while(config, fun)

Fetches the cluster information from the Redis cluster and passes it to the provided function.

If the function returns true, the cluster will be queried again. This continues until the function returns false. The function also receives the current attempt number (starting from 1). The function must handle delays for the next query. The advantage of query_while/2 over query/1 is that it allows for the connection to be reused. The connection is closed when the given function returns false.