module RedisClientOptions::ClassMethods

Public Instance Methods

_configure_options() click to toggle source
# File lib/redis_client_options.rb, line 39
def _configure_options
  option :socket,
         short: '-s SOCKET',
         long: '--socket SOCKET',
         description: 'Redis socket to connect to (overrides Host and Port)',
         required: false

  option :host,
         short: '-h HOST',
         long: '--host HOST',
         description: 'Redis Host to connect to',
         required: false,
         default: Redis::Client::DEFAULTS[:host]

  option :port,
         short: '-p PORT',
         long: '--port PORT',
         description: 'Redis Port to connect to',
         proc: proc(&:to_i),
         required: false,
         default: Redis::Client::DEFAULTS[:port]

  option :database,
         short: '-n DATABASE',
         long: '--dbnumber DATABASE',
         description: 'Redis database number to connect to',
         proc: proc(&:to_i),
         required: false,
         default: Redis::Client::DEFAULTS[:db]

  option :password,
         short: '-P PASSWORD',
         long: '--password PASSWORD',
         description: 'Redis Password to connect with'

  option :transport,
         short: '-T TRANSPORT',
         long: '--transport TRANSPORT',
         description: 'Redis transport protocol to use',
         required: false,
         default: Redis::Client::DEFAULTS[:scheme],
         in: %w[redis rediss]

  option :conn_failure_status,
         long: '--conn-failure-status EXIT_STATUS',
         description: 'Returns the following exit status for Redis connection failures',
         default: 'critical',
         in: %w[unknown warning critical]

  option :timeout,
         short: '-t TIMEOUT',
         long: '--timeout TIMEOUT',
         description: 'Redis connection timeout',
         proc: proc(&:to_f),
         required: false,
         default: Redis::Client::DEFAULTS[:timeout]

  option :reconnect_attempts,
         description: 'Reconnect attempts to Redis host',
         short: '-r ATTEMPTS',
         long: '--reconnect ATTEMPTS',
         proc: proc(&:to_i),
         default: Redis::Client::DEFAULTS[:reconnect_attempts]
end