Puppet Function: redis::get

Defined in:
lib/puppet/functions/redis/get.rb
Function type:
Ruby 4.x API

Summary

Returns the value of the key being looked up or `undef` if the key does not exist.

Overview

redis::get(String[1] $key, Redis::RedisUrl $url, Optional[String] $default) ⇒ Optional[String]

Examples:

Get the version

$version = redis::get('version.myapp', 'redis://redis.example.com:6379')
$version_with_default = redis::get('version.myapp', 'redis://redis.example.com:6379', $::myapp_version)

Parameters:

  • key (String[1]) —

    The key to look up in redis

  • url (Redis::RedisUrl) —

    The endpoint of the Redis instance

  • default (Optional[String]) —

    The value to return if the key is not found or the connection to Redis fails

Returns:

  • (Optional[String]) —

    Returns the value of the key from Redis



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/puppet/functions/redis/get.rb', line 6

Puppet::Functions.create_function(:'redis::get') do
  # @summary Returns the value of the key being looked up or `undef` if the key does not exist.
  # @param key The key to look up in redis
  # @param url The endpoint of the Redis instance
  # @param default The value to return if the key is not found or the connection to Redis fails
  # @return Returns the value of the key from Redis
  # @example Get the version
  #   $version = redis::get('version.myapp', 'redis://redis.example.com:6379')
  #   $version_with_default = redis::get('version.myapp', 'redis://redis.example.com:6379', $::myapp_version)
  #
  # Takes two arguments with an optional third. The first being a string
  # value of the key to be looked up, the second is the URL to the Redis service
  # and the third optional argument is a default value to be used if the lookup
  # fails.
  dispatch :get do
    param 'String[1]', :key
    param 'Redis::RedisUrl', :url
    optional_param 'String', :default
    return_type 'Optional[String]'
  end

  def get(key, url, default = nil)
    Redis.new(url: url).get(key) || default
  rescue Redis::CannotConnectError, SocketError => e
    raise Puppet::Error, "connection to redis server failed - #{e}" unless default

    Puppet.debug "Connection to redis failed with #{e} - Returning default value of #{default}"
    default
  end
end