redis

Documentation

Index

• Variables
• func NewService() query.Service
• type Conn
• type HashObject
  • func (obj HashObject) Del(fields []string) int
  • func (obj HashObject) Set(field string, val string, opt redis.HSetOption) int
• type Key
  • func NewDocumentKeyWith(dbid redis.DatabaseID, key string) Key
• type Message
• type Service
  • func (service *Service) Del(conn *Conn, keys []string) (*Message, error)
  • func (service *Service) Exists(conn *Conn, keys []string) (*Message, error)
  • func (service *Service) Expire(conn *Conn, key string, opt redis.ExpireOption) (*Message, error)
  • func (service *Service) Get(conn *Conn, key string) (*Message, error)
  • func (service *Service) HDel(conn *Conn, key string, fields []string) (*Message, error)
  • func (service *Service) HGet(conn *Conn, key string, field string) (*Message, error)
  • func (service *Service) HGetAll(conn *Conn, key string) (*Message, error)
  • func (service *Service) HSet(conn *Conn, key string, field string, val string, opt redis.HSetOption) (*Message, error)
  • func (service *Service) Keys(conn *Conn, pattern string) (*Message, error)
  • func (service *Service) LIndex(conn *Conn, key string, index int) (*Message, error)
  • func (service *Service) LLen(conn *Conn, key string) (*Message, error)
  • func (service *Service) LPop(conn *Conn, key string, count int) (*Message, error)
  • func (service *Service) LPush(conn *Conn, key string, elements []string, opt redis.PushOption) (*Message, error)
  • func (service *Service) LRange(conn *Conn, key string, start int, stop int) (*Message, error)
  • func (service *Service) LookupDatabase(ctx context.Context, dbid redis.DatabaseID) (store.Database, error)
  • func (service *Service) LookupServiceConfigRequirepass() (string, error)
  • func (service *Service) LookupServiceConfigTLSPort() (int, error)
  • func (service *Service) RPop(conn *Conn, key string, count int) (*Message, error)
  • func (service *Service) RPush(conn *Conn, key string, elements []string, opt redis.PushOption) (*Message, error)
  • func (service *Service) Rename(conn *Conn, key string, newkey string, opt redis.RenameOption) (*Message, error)
  • func (service *Service) SAdd(conn *Conn, key string, members []string) (*Message, error)
  • func (service *Service) SMembers(conn *Conn, key string) (*Message, error)
  • func (service *Service) SRem(conn *Conn, key string, members []string) (*Message, error)
  • func (service *Service) Scan(conn *redis.Conn, cursor int, opt redis.ScanOption) (*redis.Message, error)
  • func (service *Service) ServiceName() string
  • func (service *Service) Set(conn *Conn, key string, val string, opt redis.SetOption) (*Message, error)
  • func (service *Service) SetConfig(conf config.Config)
  • func (service *Service) Start() error
  • func (service *Service) Stop() error
  • func (service *Service) TTL(conn *Conn, key string) (*Message, error)
  • func (service *Service) TransactDatabase(ctx context.Context, conn *Conn, write bool) (*Transaction, error)
  • func (service *Service) Type(conn *Conn, key string) (*Message, error)
  • func (service *Service) ZAdd(conn *Conn, key string, members []*redis.ZSetMember, opt redis.ZAddOption) (*Message, error)
  • func (service *Service) ZIncBy(conn *Conn, key string, inc float64, member string) (*Message, error)
  • func (service *Service) ZRange(conn *Conn, key string, start int, stop int, opt redis.ZRangeOption) (*Message, error)
  • func (service *Service) ZRangeByScore(conn *Conn, key string, zmin float64, zmax float64, opt redis.ZRangeOption) (*Message, error)
  • func (service *Service) ZRem(conn *Conn, key string, members []string) (*Message, error)
  • func (service *Service) ZScore(conn *Conn, key string, member string) (*Message, error)
• type Transaction
  • func (txn *Transaction) CancelWithError(ctx context.Context, err error) error
  • func (txn *Transaction) GetKeyHashObject(ctx context.Context, key string) (HashObject, error)
  • func (txn *Transaction) GetKeyObject(ctx context.Context, key string) (any, error)
  • func (txn *Transaction) GetKeyObjects(ctx context.Context, key string) ([]any, error)
  • func (txn *Transaction) GetKeyString(ctx context.Context, key string) (string, error)
  • func (txn *Transaction) SetKeyHashObject(ctx context.Context, key string, val HashObject) error
  • func (txn *Transaction) SetKeyObject(ctx context.Context, key string, val any) error

Variables

var ErrInvalid = document.ErrInvalid

var ErrNotExist = document.ErrNotExist

var ErrNotSupported = document.ErrNotSupported

Functions

func NewService

func NewService() query.Service

NewService returns a new Redis service instance.

Types

type Conn

type Conn = redis.Conn

type HashObject

type HashObject map[string]string

HashObject represents a hash object.

func (HashObject) Del

func (obj HashObject) Del(fields []string) int

func (HashObject) Set

func (obj HashObject) Set(field string, val string, opt redis.HSetOption) int

nolint: ifshort

type Key

type Key = document.Key

func NewDocumentKeyWith

func NewDocumentKeyWith(dbid redis.DatabaseID, key string) Key

NewDocumentKeyWith returns a new document key.

type Message

type Message = redis.Message

type Service

type Service struct {
	redis.Server
	*query.BaseService
}

Service represents a new Redis service instance.

func (*Service) Del

func (service *Service) Del(conn *Conn, keys []string) (*Message, error)

func (*Service) Exists

func (service *Service) Exists(conn *Conn, keys []string) (*Message, error)

func (*Service) Expire

func (service *Service) Expire(conn *Conn, key string, opt redis.ExpireOption) (*Message, error)

func (*Service) Get

func (service *Service) Get(conn *Conn, key string) (*Message, error)

func (*Service) HDel

func (service *Service) HDel(conn *Conn, key string, fields []string) (*Message, error)

func (*Service) HGet

func (service *Service) HGet(conn *Conn, key string, field string) (*Message, error)

func (*Service) HGetAll

func (service *Service) HGetAll(conn *Conn, key string) (*Message, error)

func (*Service) HSet

func (service *Service) HSet(conn *Conn, key string, field string, val string, opt redis.HSetOption) (*Message, error)

func (*Service) Keys

func (service *Service) Keys(conn *Conn, pattern string) (*Message, error)

func (*Service) LIndex

func (service *Service) LIndex(conn *Conn, key string, index int) (*Message, error)

func (*Service) LLen

func (service *Service) LLen(conn *Conn, key string) (*Message, error)

func (*Service) LPop

func (service *Service) LPop(conn *Conn, key string, count int) (*Message, error)

func (*Service) LPush

func (service *Service) LPush(conn *Conn, key string, elements []string, opt redis.PushOption) (*Message, error)

func (*Service) LRange

func (service *Service) LRange(conn *Conn, key string, start int, stop int) (*Message, error)

func (*Service) LookupDatabase

func (service *Service) LookupDatabase(ctx context.Context, dbid redis.DatabaseID) (store.Database, error)

GetDatabase returns the database with the specified ID.

func (*Service) LookupServiceConfigRequirepass

func (service *Service) LookupServiceConfigRequirepass() (string, error)

LookupServiceConfigRequirepass returns the requirepass value of the service.

func (*Service) LookupServiceConfigTLSPort

func (service *Service) LookupServiceConfigTLSPort() (int, error)

LookupServiceConfigTLSPort returns the TLS port value of the service.

func (*Service) RPop

func (service *Service) RPop(conn *Conn, key string, count int) (*Message, error)

func (*Service) RPush

func (service *Service) RPush(conn *Conn, key string, elements []string, opt redis.PushOption) (*Message, error)

func (*Service) Rename

func (service *Service) Rename(conn *Conn, key string, newkey string, opt redis.RenameOption) (*Message, error)

func (*Service) SAdd

func (service *Service) SAdd(conn *Conn, key string, members []string) (*Message, error)

func (*Service) SMembers

func (service *Service) SMembers(conn *Conn, key string) (*Message, error)

func (*Service) SRem

func (service *Service) SRem(conn *Conn, key string, members []string) (*Message, error)

func (*Service) Scan

func (service *Service) Scan(conn *redis.Conn, cursor int, opt redis.ScanOption) (*redis.Message, error)

func (*Service) ServiceName

func (service *Service) ServiceName() string

ServiceName returns the plug-in service name.

func (*Service) Set

func (service *Service) Set(conn *Conn, key string, val string, opt redis.SetOption) (*Message, error)

func (*Service) SetConfig

func (service *Service) SetConfig(conf config.Config)

SetConfig overrides redis.Server::SetConfig() to sets the specified plug-in configuration.

func (*Service) Start

func (service *Service) Start() error

Start starts the service.

func (*Service) Stop

func (service *Service) Stop() error

Stop stops the service.

func (*Service) TTL

func (service *Service) TTL(conn *Conn, key string) (*Message, error)

func (*Service) TransactDatabase

func (service *Service) TransactDatabase(ctx context.Context, conn *Conn, write bool) (*Transaction, error)

TransactDatabase returns a transaction for the database with the specified ID.

func (*Service) Type

func (service *Service) Type(conn *Conn, key string) (*Message, error)

func (*Service) ZAdd

func (service *Service) ZAdd(conn *Conn, key string, members []*redis.ZSetMember, opt redis.ZAddOption) (*Message, error)

func (*Service) ZIncBy

func (service *Service) ZIncBy(conn *Conn, key string, inc float64, member string) (*Message, error)

func (*Service) ZRange

func (service *Service) ZRange(conn *Conn, key string, start int, stop int, opt redis.ZRangeOption) (*Message, error)

func (*Service) ZRangeByScore

func (service *Service) ZRangeByScore(conn *Conn, key string, zmin float64, zmax float64, opt redis.ZRangeOption) (*Message, error)

func (*Service) ZRem

func (service *Service) ZRem(conn *Conn, key string, members []string) (*Message, error)

func (*Service) ZScore

func (service *Service) ZScore(conn *Conn, key string, member string) (*Message, error)

type Transaction

type Transaction struct {
	store.Transaction
	redis.DatabaseID
}

func (*Transaction) CancelWithError

func (txn *Transaction) CancelWithError(ctx context.Context, err error) error

CancelWithError cancels the transaction with an error.

func (*Transaction) GetKeyHashObject

func (txn *Transaction) GetKeyHashObject(ctx context.Context, key string) (HashObject, error)

GetKeyHashObject returns the hash objects with the specified key.

func (*Transaction) GetKeyObject

func (txn *Transaction) GetKeyObject(ctx context.Context, key string) (any, error)

GetKeyObject returns the object with the specified key.

func (*Transaction) GetKeyObjects

func (txn *Transaction) GetKeyObjects(ctx context.Context, key string) ([]any, error)

GetKeyObjects returns the objects with the specified key.

func (*Transaction) GetKeyString

func (txn *Transaction) GetKeyString(ctx context.Context, key string) (string, error)

GetKeyString returns the string with the specified key.

func (*Transaction) SetKeyHashObject

func (txn *Transaction) SetKeyHashObject(ctx context.Context, key string, val HashObject) error

SetKeyHashObject sets the objects with the specified key.

func (*Transaction) SetKeyObject

func (txn *Transaction) SetKeyObject(ctx context.Context, key string, val any) error

SetKeyObject sets the objects with the specified key.