model

Documentation

Index

• Constants
• type BaseConfig
• type Connector
• type Flusher
• type KeyValue
• type List
• type Message
• type Option
  • func WithNoopConfig() Option
  • func WithOnConnect(onConnect func(context.Context) error) Option
  • func WithRedisConfig(config *RedisOptions) Option
  • func WithRetries(config *RetryOptions) Option
  • func WithTLS(config *TLS) Option
• type Queue
• type RedisOptions
• type RetryOptions
• type Set
• type SortedSet
• type Subscription
• type TLS

Constants

const (
	MessageTypeMessage      = "message"
	MessageTypeSubscription = "subscription"
)

const (
	RedisV9Type = "redisv9"
)

Types

type BaseConfig

type BaseConfig struct {
	RedisConfig *RedisOptions
	RetryConfig *RetryOptions
	OnConnect   func(context.Context) error
	TLS         *TLS
}

type Connector

type Connector interface {
	// Disconnect disconnects from the backend
	Disconnect(context.Context) error

	// Ping executes a ping to the backend
	Ping(context.Context) error

	// Type returns the  connector type
	Type() string

	// As converts i to driver-specific types.
	// Same concept as https://gocloud.dev/concepts/as/ but for connectors.
	As(i interface{}) bool
}

type Flusher

type Flusher interface {
	// FlushAll deletes all keys the database
	FlushAll(ctx context.Context) error
}

type KeyValue

type KeyValue interface {
	// Get retrieves the value for a given key
	Get(ctx context.Context, key string) (value string, err error)
	// Set sets the string value of a key
	Set(ctx context.Context, key, value string, ttl time.Duration) error
	// SetIfNotExist sets the string value of a key if the key does not exist.
	// Returns true if the key was set, false otherwise.
	SetIfNotExist(ctx context.Context, key, value string, expiration time.Duration) (bool, error)
	// Delete removes the specified keys
	Delete(ctx context.Context, key string) error
	// Increment atomically increments the integer value of a key by one
	Increment(ctx context.Context, key string) (newValue int64, err error)
	// Decrement atomically decrements the integer value of a key by one
	Decrement(ctx context.Context, key string) (newValue int64, err error)
	// Exists checks if a key exists
	Exists(ctx context.Context, key string) (exists bool, err error)
	// Expire sets a timeout on key. After the timeout has expired, the key will automatically be deleted
	Expire(ctx context.Context, key string, ttl time.Duration) error
	// TTL returns the remaining time to live of a key that has a timeout
	TTL(ctx context.Context, key string) (ttl int64, err error)
	// DeleteKeys deletes all keys that match the given pattern
	DeleteKeys(ctx context.Context, keys []string) (numberOfDeletedKeys int64, err error)
	// DeleteScanMatch deletes all keys that match the given pattern
	DeleteScanMatch(ctx context.Context, pattern string) (numberOfDeletedKeys int64, err error)
	// Keys returns all keys that match the given pattern
	Keys(ctx context.Context, pattern string) (keys []string, err error)
	// GetMulti returns the values of all specified keys
	GetMulti(ctx context.Context, keys []string) (values []interface{}, err error)
	// GetKeysAndValuesWithFilter returns all keys and values that match the given pattern
	GetKeysAndValuesWithFilter(ctx context.Context, pattern string) (keysAndValues map[string]interface{}, err error)
	// GetKeysWithOpts retrieves keys with options like filter, cursor, and count
	GetKeysWithOpts(ctx context.Context, searchStr string, cursors map[string]uint64,
		count int64) (keys []string, updatedCursor map[string]uint64, continueScan bool, err error)
}

type List

type List interface {
	// Remove the first count occurrences of elements equal to element from the list stored at key.
	Remove(ctx context.Context, key string, count int64, element interface{}) (int64, error)

	// Returns the specified elements of the list stored at key.
	// The offsets start and stop are zero-based indexes.
	Range(ctx context.Context, key string, start, stop int64) ([]string, error)

	// Returns the length of the list stored at key.
	Length(ctx context.Context, key string) (int64, error)

	// Insert all the specified values at the head of the list stored at key.
	// If key does not exist, it is created.
	// pipelined: If true, the operation is pipelined and executed in a single roundtrip.
	Prepend(ctx context.Context, pipelined bool, key string, values ...[]byte) error

	// Insert all the specified values at the tail of the list stored at key.
	// If key does not exist, it is created.
	// pipelined: If true, the operation is pipelined and executed in a single roundtrip.
	Append(ctx context.Context, pipelined bool, key string, values ...[]byte) error

	// Pop removes and returns the first count elements of the list stored at key.
	// If stop is -1, all the elements from start to the end of the list are removed and returned.
	Pop(ctx context.Context, key string, stop int64) ([]string, error)
}

type Message

type Message interface {
	// Type returns the message type.
	// It can be one of the following:
	// - "message": a message received from a subscription with a payload and channel
	// - "subscription": a subscription confirmation message with a channel
	Type() string
	// Channel returns the channel the message was received on.
	// It can be one of the following depending on the message type:
	// - the channel the message was received on
	// - the channel the subscription was created on
	// - an empty string, returning an error
	Channel() (string, error)
	// Payload returns the message payload.
	// It can be one of the following depending on the message type:
	// - the message payload
	// - the subscription kind (e.g. "subscribe", "unsubscribe")
	// - an empty string, returning an error
	Payload() (string, error)
}

Message represents a message received from a subscription.

type Option

type Option interface {
	Apply(*BaseConfig)
}

func WithNoopConfig

func WithNoopConfig() Option

WithNoopConfig is a helper function to avoid creating a connection - useful for testing.

func WithOnConnect

func WithOnConnect(onConnect func(context.Context) error) Option

WithOnConnect is a helper function to trigger onConnect when a connection or reconnection is established.

func WithRedisConfig

func WithRedisConfig(config *RedisOptions) Option

WithRedisConfig is a helper function to create a ConnectionOption for Redis.

func WithRetries

func WithRetries(config *RetryOptions) Option

WithRetries is a helper function to create a RetryOption for the storage.

func WithTLS

func WithTLS(config *TLS) Option

WithTLS is a helper function to create a TLSOption for the storage.

type Queue

type Queue interface {
	// Publish sends a message to the specified channel.
	// It returns the number of clients that received the message.
	Publish(ctx context.Context, channel, message string) (int64, error)

	// Subscribe initializes a subscription to one or more channels.
	// It returns a Subscription interface that allows receiving messages and closing the subscription.
	Subscribe(ctx context.Context, channels ...string) Subscription
}

Queue interface represents a pub/sub queue with methods to publish messages and subscribe to channels.

type RedisOptions

type RedisOptions struct {
	// Connection username
	Username string `json:"username"`
	// Connection password
	Password string `json:"password"`
	// Connection host. For example: "localhost"
	Host string `json:"host"`
	// Connection port. For example: 6379
	Port int `json:"port"`
	// Set a custom timeout for Redis network operations. Default value 5 seconds.
	Timeout int               `json:"timeout"`
	Hosts   map[string]string `json:"hosts"` // Deprecated: Addrs instead.
	// If you have multi-node setup, you should use this field instead. For example: ["host1:port1", "host2:port2"].
	Addrs []string `json:"addrs"`
	// Redis sentinel master name
	MasterName string `json:"master_name"`
	// Redis sentinel password
	SentinelPassword string `json:"sentinel_password"`
	// Redis database
	Database int `json:"database"`
	// Set the number of maximum connections in the Redis connection pool, which defaults to 500
	// Set to a higher value if you are expecting more traffic.
	MaxActive int `json:"optimisation_max_active"`
	// Enable Redis Cluster support
	EnableCluster bool `json:"enable_cluster"`
}

RedisOptions contains options specific to Redis storage.

type RetryOptions

type RetryOptions struct {
	// Maximum number of retries before error.
	MaxRetries int
	// Minimum backoff between each retry.
	MinRetryBackoff time.Duration
	// Maximum backoff between each retry.
	MaxRetryBackoff time.Duration
}

type Set

type Set interface {
	// Returns all the members of the set value stored at key.
	Members(ctx context.Context, key string) ([]string, error)

	// Add the specified members to the set stored at key.
	// Specified members that are already a member of this set are ignored.
	// If key does not exist, a new set is created before adding the specified members.
	AddMember(ctx context.Context, key, member string) error

	// Remove the specified members from the set stored at key.
	// Specified members that are not a member of this set are ignored.
	RemoveMember(ctx context.Context, key, member string) error

	// Returns if member is a member of the set stored at key.
	IsMember(ctx context.Context, key, member string) (bool, error)
}

type SortedSet

type SortedSet interface {
	// AddScoredMember adds a member with a specific score to a sorted set.
	// Returns the number of elements added to the sorted set.
	AddScoredMember(ctx context.Context, key, member string, score float64) (int64, error)

	// GetMembersByScoreRange retrieves members and their scores from a sorted set
	// within the given score range.
	// Returns slices of members and their scores, and an error if any.
	GetMembersByScoreRange(ctx context.Context, key, minScore, maxScore string) ([]interface{}, []float64, error)

	// RemoveMembersByScoreRange removes members from a sorted set within a specified score range.
	// Returns the number of members removed.
	RemoveMembersByScoreRange(ctx context.Context, key, minScore, maxScore string) (int64, error)
}

type Subscription

type Subscription interface {
	// Receive waits for and returns the next message from the subscription.
	Receive(ctx context.Context) (Message, error)

	// Close closes the subscription and cleans up resources.
	Close() error
}

Subscription interface represents a subscription to one or more channels. It allows receiving messages and closing the subscription.

type TLS

type TLS struct {
	// Flag that can be used to enable TLS. Defaults to false (disabled).
	Enable bool `json:"enable"`
	// Flag that can be used to skip TLS verification if TLS is enabled.
	// Defaults to false.
	InsecureSkipVerify bool `json:"insecure_skip_verify"`
	// Path to the CA file.
	CAFile string `json:"ca_file"`
	// Path to the cert file.
	CertFile string `json:"cert_file"`
	// Path to the key file.
	KeyFile string `json:"key_file"`
	// Maximum TLS version that is supported.
	// Options: ["1.0", "1.1", "1.2", "1.3"].
	// Defaults to "1.3".
	MaxVersion string `json:"max_version"`
	// Minimum TLS version that is supported.
	// Options: ["1.0", "1.1", "1.2", "1.3"].
	// Defaults to "1.2".
	MinVersion string `json:"min_version"`
}