RedisOptions

This class, RedisOptions, is a copy of redis.Options designed for use in configuration files. It provides a comprehensive set of fields to configure various aspects of a Redis client connection, including network settings, authentication, timeouts, and connection pooling parameters. It allows for detailed control over how the application connects and interacts with a Redis server.

Attributes

Attribute	Type	Description
Network	string = tcp	The network type, either tcp or unix, used for connecting to Redis.
Addr	string	The host:port address of the Redis server.
ClientName	string	The client name that will be set for each connection using the CLIENT SETNAME command.
Protocol	int = 3	The RESP protocol version (2 or 3) to negotiate with the Redis server.
Username	string	The username used to authenticate the connection with a Redis 6.0+ instance using the ACL system.
Password	string	The optional password for authentication, matching the server's requirepass or User Password for Redis 6.0+ ACL.
PasswordSecretName	string	The name of the secret that contains the password for Redis authentication.
DB	int	The database to be selected after connecting to the Redis server.
MaxRetries	int = 3	The maximum number of retries before giving up on a failed operation; -1 disables retries.
MinRetryBackoff	config.Duration = 8 milliseconds	The minimum backoff duration between each retry attempt; -1 disables backoff.
MaxRetryBackoff	config.Duration = 512 milliseconds	The maximum backoff duration between each retry attempt; -1 disables backoff.
DialTimeout	config.Duration = 5 seconds	The timeout duration for establishing new connections to the Redis server.
ReadTimeout	config.Duration = 3 seconds	The timeout duration for socket reads; 0 uses default, -1 blocks indefinitely, -2 disables SetReadDeadline calls.
WriteTimeout	config.Duration = 3 seconds	The timeout duration for socket writes; 0 uses default, -1 blocks indefinitely, -2 disables SetWriteDeadline calls.
ContextTimeoutEnabled	bool	A boolean indicating whether the client respects context timeouts and deadlines for operations.
PoolFIFO	bool	A boolean indicating the type of connection pool; true for FIFO, false for LIFO.
PoolSize	int = 10 connections per CPU	The base number of socket connections in the pool, with new connections allocated in excess if needed.
PoolTimeout	config.Duration = ReadTimeout + 1 second	The amount of time the client waits for a connection if all connections are busy before returning an error.
MinIdleConns	int = 0	The minimum number of idle connections to maintain in the pool.
MaxIdleConns	int = 0	The maximum number of idle connections to maintain in the pool.
MaxActiveConns	int	The maximum number of connections allocated by the pool at a given time; zero means no limit.
ConnMaxIdleTime	config.Duration = 30 minutes	The maximum amount of time a connection may be idle before being closed; < = 0 disables idle timeout.
ConnMaxLifetime	config.Duration = not close idle connections	The maximum amount of time a connection may be reused before being closed; < = 0 disables lifetime limit.
TLSConfig	*tls.Config	The TLS configuration to use for negotiating TLS, which is not settable from a config file.
UseTLS	bool	A boolean indicating whether to negotiate TLS using the system certificate pool, ignored if TLSConfig is provided.
TLSInsecureSkipVerify	bool	A boolean that disables server certificate verification, intended only for testing against self-signed certificates.
DisableIndentity	bool = false	A boolean that disables the set-lib command on connection.

---

Methods

---

GetOptions()

@classmethod
def GetOptions(
    ctx: context.Context,
    secretManager: [SecretManager](../../flyteplugins/go/tasks/pluginmachinery/core/secretmanager.md?sid=flyteplugins_go_tasks_pluginmachinery_core_secretmanager)
) - > (*redis.Options, error)

Retrieves Redis options, potentially fetching the password from a secret manager if PasswordSecretName is specified. This method is used to construct the redis.Options object required for connecting to a Redis instance.

Parameters

Name	Type	Description
ctx	context.Context	The context for the operation, used for cancellation and timeouts.
secretManager	[SecretManager](../../flyteplugins/go/tasks/pluginmachinery/core/secretmanager.md?sid=flyteplugins_go_tasks_pluginmachinery_core_secretmanager)	The secret manager instance used to retrieve the Redis password if PasswordSecretName is set.

Returns

Type	Description
(*redis.Options, error)	A pointer to the redis.Options struct configured for connection, and an error if any occurred during secret retrieval or option processing.

---