redis

Documentation

Overview

Package redis provides the handler function for the Redis trigger, as well as access to Redis within Spin components.

Index

• Constants
• func Del(addr string, keys []string) (int64, error)
• func Get(addr, key string) ([]byte, error)
• func Handle(fn func(payload []byte) error)
• func Incr(addr, key string) (int64, error)
• func Publish(addr, channel string, payload []byte) error
• func Sadd(addr string, key string, values []string) (int64, error)
• func Set(addr, key string, payload []byte) error
• func Smembers(addr string, key string) ([]string, error)
• func Srem(addr string, key string, values []string) (int64, error)
• type RedisParameter
• type RedisParameterKind
• type RedisResult
  • func Execute(addr string, command string, arguments []RedisParameter) ([]RedisResult, error)
• type RedisResultKind

Constants

const (
	RedisParameterKindInt64 = iota
	RedisParameterKindBinary
)

const (
	RedisResultKindNil = iota
	RedisResultKindStatus
	RedisResultKindInt64
	RedisResultKindBinary
)

Functions

func Del

func Del(addr string, keys []string) (int64, error)

Removes the specified keys. A key is ignored if it does not exist.

func Get

func Get(addr, key string) ([]byte, error)

Get the value of a key. An error is returned if the value stored at key is not a string.

func Handle

func Handle(fn func(payload []byte) error)

Handle sets the handler function for redis. It must be set in an init() function.

func Incr

func Incr(addr, key string) (int64, error)

Increments the number stored at key by one. If the key does not exist, it is set to 0 before performing the operation. An error is returned if the key contains a value of the wrong type or contains a string that can not be represented as integer.

func Publish

func Publish(addr, channel string, payload []byte) error

Publish a Redis message to the specificed channel and return an error, if any.

func Sadd

func Sadd(addr string, key string, values []string) (int64, error)

Adds the specified values to the set for the specified key, creating it if it does not already exist.

func Set

func Set(addr, key string, payload []byte) error

Set key to value. If key alreads holds a value, it is overwritten.

func Smembers

func Smembers(addr string, key string) ([]string, error)

Get the elements of the set for the specified key.

func Srem

func Srem(addr string, key string, values []string) (int64, error)

Removes the specified elements from the set for the specified key. This has no effect if the key does not exist.

Types

type RedisParameter

type RedisParameter struct {
	Kind RedisParameterKind
	Val  interface{}
}

type RedisParameterKind

type RedisParameterKind uint8

type RedisResult

type RedisResult struct {
	Kind RedisResultKind
	Val  interface{}
}

func Execute

func Execute(addr string, command string, arguments []RedisParameter) ([]RedisResult, error)

Run the specified Redis command with the specified arguments, returning zero or more results. This is a general-purpose function which should work with any Redis command.

type RedisResultKind

type RedisResultKind uint8