remon

README

remon

redis cached mongodb based nosql database

Documentation

Index

• Variables
• type Client
  • func New(rdb RedisClient, mdb *mongo.Client, opts ...Option) Client
  • func NewClient(rdb RedisClient, mdb *mongo.Client, opts ...Option) Client
• type GetOption
  • func AddIfNotFound(v string) GetOption
• type Mail
• type MailClient
  • func NewMailClient(rm Client) MailClient
• type MapKeyFunc
• type Metrics
  • func (m *Metrics) CacheHit() int64
  • func (m *Metrics) CacheMiss() int64
  • func (m *Metrics) DataError() int64
  • func (m *Metrics) MongoError() int64
  • func (m *Metrics) RedisError() int64
  • func (m *Metrics) Reset()
• type OnSyncErrorFunc
• type OnSyncIdleFunc
• type OnSyncSaveFunc
• type Option
  • func OnSyncError(f OnSyncErrorFunc) Option
  • func OnSyncIdle(f OnSyncIdleFunc) Option
  • func OnSyncSave(f OnSyncSaveFunc) Option
  • func WithKeyMap(f MapKeyFunc) Option
• type PushOption
  • func WithCapacity(v int) PushOption
  • func WithPushStrategy(v PushStrategy) PushOption
• type PushStrategy
• type RedisClient
• type Syncer
  • func NewSyncer(rdb RedisClient, mdb *mongo.Client, opts ...Option) *Syncer
  • func (s *Syncer) Serve()
  • func (s *Syncer) Stop()

Variables

var (
	ErrAlreadyExists = errors.New("remon: already exists")
	ErrNotFound      = errors.New("remon: not found")
	ErrMailFull      = errors.New("remon: mail full")
)

Types

type Client

type Client interface {
	// get stat info
	Metrics() *Metrics

	// Get value from remon
	// If cache miss, load from database
	Get(ctx context.Context, key string, opts ...GetOption) (rev int64, val string, err error)

	// Set value to remon
	// Value will be saved to cache and synced to database later automatically
	Set(ctx context.Context, key, val string) (rev int64, err error)

	// Add value to remon
	// If key already exists, return ErrAlreadyExists
	// If add success, the rev must be 1
	Add(ctx context.Context, key, val string) (err error)
	// contains filtered or unexported methods
}

func New

func New(rdb RedisClient, mdb *mongo.Client, opts ...Option) Client

func NewClient

func NewClient(rdb RedisClient, mdb *mongo.Client, opts ...Option) Client

type GetOption

type GetOption interface {
	// contains filtered or unexported methods
}

get method xOptions

func AddIfNotFound

func AddIfNotFound(v string) GetOption

type Mail

type Mail struct {
	// auto-generated seq to identify a mail
	Id int64 `msgpack:"id"`
	// mail payload
	Val string `msgpack:"val"`
}

type MailClient

type MailClient interface {
	// list mails
	List(ctx context.Context, key string) (_ []*Mail, err error)
	// push mail in
	Push(ctx context.Context, key, val string, opts ...PushOption) (id int64, err error)
	// pull mail(s) out
	Pull(ctx context.Context, key string, ids ...int64) (pulled []int64, err error)
	// clean all mails
	Clean(ctx context.Context, key string) (err error)
}

func NewMailClient

func NewMailClient(rm Client) MailClient

type MapKeyFunc

type MapKeyFunc func(key string) (db, collection, _id string)

Redis(key) -> Mongo(db,collection,_id)

type Metrics

type Metrics struct {
	// contains filtered or unexported fields
}

client wide statistics

func (*Metrics) CacheHit

func (m *Metrics) CacheHit() int64

func (*Metrics) CacheMiss

func (m *Metrics) CacheMiss() int64

func (*Metrics) DataError

func (m *Metrics) DataError() int64

func (*Metrics) MongoError

func (m *Metrics) MongoError() int64

func (*Metrics) RedisError

func (m *Metrics) RedisError() int64

func (*Metrics) Reset

func (m *Metrics) Reset()

type OnSyncErrorFunc

type OnSyncErrorFunc func(err error) time.Duration

同步失败回调函数

type OnSyncIdleFunc

type OnSyncIdleFunc func() time.Duration

同步空闲回调函数

type OnSyncSaveFunc

type OnSyncSaveFunc func(key string) time.Duration

同步成功回调函数

type Option

type Option interface {
	// contains filtered or unexported methods
}

func OnSyncError

func OnSyncError(f OnSyncErrorFunc) Option

func OnSyncIdle

func OnSyncIdle(f OnSyncIdleFunc) Option

func OnSyncSave

func OnSyncSave(f OnSyncSaveFunc) Option

func WithKeyMap

func WithKeyMap(f MapKeyFunc) Option

type PushOption

type PushOption interface {
	// contains filtered or unexported methods
}

func WithCapacity

func WithCapacity(v int) PushOption

func WithPushStrategy

func WithPushStrategy(v PushStrategy) PushOption

type PushStrategy

type PushStrategy int

push method options

const (
	RejectOnFull     PushStrategy = 0
	PullOldestOnFull PushStrategy = 1
)

type RedisClient

type RedisClient interface {
	EvalSha(ctx context.Context, sha1 string, keys []string, args ...interface{}) *redis.Cmd
	ScriptLoad(ctx context.Context, script string) *redis.StringCmd
}

type Syncer

type Syncer struct {
	// contains filtered or unexported fields
}

func NewSyncer

func NewSyncer(rdb RedisClient, mdb *mongo.Client, opts ...Option) *Syncer

func (*Syncer) Serve

func (s *Syncer) Serve()

func (*Syncer) Stop

func (s *Syncer) Stop()