Documentation
¶
Overview ¶
Package redis implements the Redis storage.
Index ¶
- Constants
- func Get() storage.IStorage
- func Set(s storage.IStorage)
- type Config
- type Redis
- func (r *Redis) BulkCreate(ctx context.Context, target string, items []storage.BulkItem, ...) (storage.BulkResult, error)
- func (r *Redis) Close() error
- func (r *Redis) Count(ctx context.Context, target string, prm *count.Count, ...) (int64, error)
- func (r *Redis) Create(ctx context.Context, id, target string, v any, prm *create.Create, ...) (string, error)
- func (r *Redis) Delete(ctx context.Context, id, target string, prm *delete.Delete, ...) error
- func (r *Redis) GetClient() any
- func (r *Redis) List(ctx context.Context, target string, v any, prm *list.List, ...) error
- func (r *Redis) Retrieve(ctx context.Context, id, target string, v any, prm *retrieve.Retrieve, ...) error
- func (r *Redis) Update(ctx context.Context, id, target string, v any, prm *update.Update, ...) error
- type ResponseList
Constants ¶
View Source
const Name = "redis"
Name of the storage.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Redis ¶
type Redis struct {
*storage.Storage
// Client is the Redis client.
Client *redis.Client `json:"-" validate:"required,structonly"`
// Config is the Redis configuration.
// Skipped by the validator: it dives into untagged nested structs, and
// this config holds live client state that background goroutines write.
Config *Config `json:"-" validate:"-"`
// Target allows to set a static target. If it is empty, the target will be
// dynamic - the one set at the operation (count, create, delete, etc) time.
// Depending on the storage, target is a collection, a table, a bucket, etc.
// For ElasticSearch, for example it doesn't have a concept of a database -
// the target then is the index. Due to different cases of ElasticSearch
// usage, the target can be static or dynamic - defined at the index time,
// for example: log-{YYYY}-{MM}. For Redis, it isn't used at all.
Target string `json:"-" validate:"omitempty,gt=0"`
// contains filtered or unexported fields
}
Redis storage definition.
func (*Redis) BulkCreate ¶
func (r *Redis) BulkCreate( ctx context.Context, target string, items []storage.BulkItem, prm *create.Create, optionFuncs ...storage.Func[*create.Create], ) (storage.BulkResult, error)
BulkCreate queues SET commands in non-transactional Redis pipelines and reads each command's error instead of treating Exec's aggregate error as the outcome of every item.
func (*Redis) Count ¶
func (r *Redis) Count(ctx context.Context, target string, prm *count.Count, options ...storage.Func[*count.Count]) (int64, error)
Count returns the number of items in the storage.
func (*Redis) Create ¶
func (r *Redis) Create(ctx context.Context, id, target string, v any, prm *create.Create, options ...storage.Func[*create.Create]) (string, error)
Create data.
NOTE: Not all storages returns the ID, neither all storages requires `id` to be set. You are better off setting the ID yourself.
func (*Redis) Delete ¶
func (r *Redis) Delete(ctx context.Context, id, target string, prm *delete.Delete, options ...storage.Func[*delete.Delete]) error
Delete removes data.
func (*Redis) List ¶
func (r *Redis) List(ctx context.Context, target string, v any, prm *list.List, options ...storage.Func[*list.List]) error
List data.
Search is a glob passed to SCAN. Sort, Limit, Offset, and Fields are applied to the decoded values after matching.
type ResponseList ¶
type ResponseList[T any] struct { Items []T `json:"items"` }
ResponseList is the list response.
Source Files
Click to show internal directories.
Click to hide internal directories.