ledisdb: github.com/siddontang/ledisdb/ledis Index | Files

package ledis

import "github.com/siddontang/ledisdb/ledis"

Package ledis is a high performance embedded NoSQL.

Ledis supports various data structure like kv, list, hash and zset like redis.

Other features include replication, data with a limited time-to-live.


First create a ledis instance before use:

l := ledis.Open(cfg)

cfg is a Config instance which contains configuration for ledis use, like DataDir (root directory for ledis working to store data).

After you create a ledis instance, you can select a DB to store you data:

db, _ := l.Select(0)

DB must be selected by a index, ledis supports only 16 databases, so the index range is [0-15].


KV is the most basic ledis type like any other key-value database.

err := db.Set(key, value)
value, err := db.Get(key)


List is simply lists of values, sorted by insertion order. You can push or pop value on the list head (left) or tail (right).

err := db.LPush(key, value1)
err := db.RPush(key, value2)
value1, err := db.LPop(key)
value2, err := db.RPop(key)


Hash is a map between fields and values.

n, err := db.HSet(key, field1, value1)
n, err := db.HSet(key, field2, value2)
value1, err := db.HGet(key, field1)
value2, err := db.HGet(key, field2)


ZSet is a sorted collections of values. Every member of zset is associated with score, a int64 value which used to sort, from smallest to greatest score. Members are unique, but score may be same.

n, err := db.ZAdd(key, ScorePair{score1, member1}, ScorePair{score2, member2})
ay, err := db.ZRangeByScore(key, minScore, maxScore, 0, -1)


Package Files

batch.go const.go doc.go dump.go event.go ledis.go ledis_db.go migrate.go replication.go scan.go sort.go t_hash.go t_kv.go t_list.go t_set.go t_ttl.go t_zset.go util.go


const (
    KVName   = "KV"
    ListName = "LIST"
    HashName = "HASH"
    SetName  = "SET"
    ZSetName = "ZSET"
const (
    NoneType   byte = 0
    KVType     byte = 1
    HashType   byte = 2
    HSizeType  byte = 3
    ListType   byte = 4
    LMetaType  byte = 5
    ZSetType   byte = 6
    ZSizeType  byte = 7
    ZScoreType byte = 8
    // BitType     byte = 9
    // BitMetaType byte = 10
    SetType   byte = 11
    SSizeType byte = 12

    	I make a big mistake about TTL time key format and have to use a new one (change 101 to 103).
    	You must run the ledis-upgrade-ttl to upgrade db.
    ObsoleteExpTimeType byte = 101
    ExpMetaType         byte = 102
    ExpTimeType         byte = 103

    MetaType byte = 201

for backend store

const (
    MaxDatabases int = 10240

    //max key size
    MaxKeySize int = 1024

    //max hash field size
    MaxHashFieldSize int = 1024

    //max zset member size
    MaxZSetMemberSize int = 1024

    //max set member size
    MaxSetMemberSize int = 1024

    //max value size
    MaxValueSize int = 1024 * 1024 * 1024
const (
    BitAND = "and"
    BitOR  = "or"
    BitXOR = "xor"
    BitNot = "not"
const (
    UnionType byte = 51
    DiffType  byte = 52
    InterType byte = 53
const (
    MinScore     int64 = -1<<63 + 1
    MaxScore     int64 = 1<<63 - 1
    InvalidScore int64 = -1 << 63

    AggregateSum byte = 0
    AggregateMin byte = 1
    AggregateMax byte = 2
const Version = "0.5"


var (
    ErrScoreMiss     = errors.New("zset score miss")
    ErrWriteInROnly  = errors.New("write not support in readonly mode")
    ErrRplInRDWR     = errors.New("replication not support in read write mode")
    ErrRplNotSupport = errors.New("replication not support")
var (
    ErrLogMissed = errors.New("log is pured in server")
var (
    TypeName = map[byte]string{
        KVType:     "kv",
        HashType:   "hash",
        HSizeType:  "hsize",
        ListType:   "list",
        LMetaType:  "lmeta",
        ZSetType:   "zset",
        ZSizeType:  "zsize",
        ZScoreType: "zscore",

        SetType:     "set",
        SSizeType:   "ssize",
        ExpTimeType: "exptime",
        ExpMetaType: "expmeta",

func AsyncNotify Uses

func AsyncNotify(ch chan struct{})

func Int64 Uses

func Int64(v []byte, err error) (int64, error)

func PutInt64 Uses

func PutInt64(v int64) []byte

func StrInt32 Uses

func StrInt32(v []byte, err error) (int32, error)

func StrInt64 Uses

func StrInt64(v []byte, err error) (int64, error)

func StrInt8 Uses

func StrInt8(v []byte, err error) (int8, error)

func StrUint64 Uses

func StrUint64(v []byte, err error) (uint64, error)

func Uint64 Uses

func Uint64(v []byte, err error) (uint64, error)

type DB Uses

type DB struct {
    // contains filtered or unexported fields

func (*DB) Append Uses

func (db *DB) Append(key []byte, value []byte) (int64, error)

func (*DB) BLPop Uses

func (db *DB) BLPop(keys [][]byte, timeout time.Duration) ([]interface{}, error)

func (*DB) BRPop Uses

func (db *DB) BRPop(keys [][]byte, timeout time.Duration) ([]interface{}, error)

func (*DB) BitCount Uses

func (db *DB) BitCount(key []byte, start int, end int) (int64, error)

func (*DB) BitOP Uses

func (db *DB) BitOP(op string, destKey []byte, srcKeys ...[]byte) (int64, error)

func (*DB) BitPos Uses

func (db *DB) BitPos(key []byte, on int, start int, end int) (int64, error)

func (*DB) Decr Uses

func (db *DB) Decr(key []byte) (int64, error)

func (*DB) DecrBy Uses

func (db *DB) DecrBy(key []byte, decrement int64) (int64, error)

func (*DB) Del Uses

func (db *DB) Del(keys ...[]byte) (int64, error)

func (*DB) Dump Uses

func (db *DB) Dump(key []byte) ([]byte, error)

func (*DB) Exists Uses

func (db *DB) Exists(key []byte) (int64, error)

func (*DB) Expire Uses

func (db *DB) Expire(key []byte, duration int64) (int64, error)

func (*DB) ExpireAt Uses

func (db *DB) ExpireAt(key []byte, when int64) (int64, error)

func (*DB) FlushAll Uses

func (db *DB) FlushAll() (drop int64, err error)

func (*DB) Get Uses

func (db *DB) Get(key []byte) ([]byte, error)

func (*DB) GetBit Uses

func (db *DB) GetBit(key []byte, offset int) (int64, error)

func (*DB) GetRange Uses

func (db *DB) GetRange(key []byte, start int, end int) ([]byte, error)

func (*DB) GetSet Uses

func (db *DB) GetSet(key []byte, value []byte) ([]byte, error)

func (*DB) GetSlice Uses

func (db *DB) GetSlice(key []byte) (store.Slice, error)

func (*DB) HClear Uses

func (db *DB) HClear(key []byte) (int64, error)

func (*DB) HDel Uses

func (db *DB) HDel(key []byte, args ...[]byte) (int64, error)

func (*DB) HDump Uses

func (db *DB) HDump(key []byte) ([]byte, error)

func (*DB) HExpire Uses

func (db *DB) HExpire(key []byte, duration int64) (int64, error)

func (*DB) HExpireAt Uses

func (db *DB) HExpireAt(key []byte, when int64) (int64, error)

func (*DB) HGet Uses

func (db *DB) HGet(key []byte, field []byte) ([]byte, error)

func (*DB) HGetAll Uses

func (db *DB) HGetAll(key []byte) ([]FVPair, error)

func (*DB) HIncrBy Uses

func (db *DB) HIncrBy(key []byte, field []byte, delta int64) (int64, error)

func (*DB) HKeyExists Uses

func (db *DB) HKeyExists(key []byte) (int64, error)

func (*DB) HKeys Uses

func (db *DB) HKeys(key []byte) ([][]byte, error)

func (*DB) HLen Uses

func (db *DB) HLen(key []byte) (int64, error)

func (*DB) HMclear Uses

func (db *DB) HMclear(keys ...[]byte) (int64, error)

func (*DB) HMget Uses

func (db *DB) HMget(key []byte, args ...[]byte) ([][]byte, error)

func (*DB) HMset Uses

func (db *DB) HMset(key []byte, args ...FVPair) error

func (*DB) HPersist Uses

func (db *DB) HPersist(key []byte) (int64, error)

func (*DB) HRevScan Uses

func (db *DB) HRevScan(key []byte, cursor []byte, count int, inclusive bool, match string) ([]FVPair, error)

func (*DB) HScan Uses

func (db *DB) HScan(key []byte, cursor []byte, count int, inclusive bool, match string) ([]FVPair, error)

func (*DB) HSet Uses

func (db *DB) HSet(key []byte, field []byte, value []byte) (int64, error)

func (*DB) HTTL Uses

func (db *DB) HTTL(key []byte) (int64, error)

func (*DB) HValues Uses

func (db *DB) HValues(key []byte) ([][]byte, error)

func (*DB) Incr Uses

func (db *DB) Incr(key []byte) (int64, error)

func (*DB) IncrBy Uses

func (db *DB) IncrBy(key []byte, increment int64) (int64, error)

func (*DB) Index Uses

func (db *DB) Index() int

func (*DB) LClear Uses

func (db *DB) LClear(key []byte) (int64, error)

func (*DB) LDump Uses

func (db *DB) LDump(key []byte) ([]byte, error)

func (*DB) LExpire Uses

func (db *DB) LExpire(key []byte, duration int64) (int64, error)

func (*DB) LExpireAt Uses

func (db *DB) LExpireAt(key []byte, when int64) (int64, error)

func (*DB) LIndex Uses

func (db *DB) LIndex(key []byte, index int32) ([]byte, error)

func (*DB) LKeyExists Uses

func (db *DB) LKeyExists(key []byte) (int64, error)

func (*DB) LLen Uses

func (db *DB) LLen(key []byte) (int64, error)

func (*DB) LMclear Uses

func (db *DB) LMclear(keys ...[]byte) (int64, error)

func (*DB) LPersist Uses

func (db *DB) LPersist(key []byte) (int64, error)

func (*DB) LPop Uses

func (db *DB) LPop(key []byte) ([]byte, error)

func (*DB) LPush Uses

func (db *DB) LPush(key []byte, args ...[]byte) (int64, error)

func (*DB) LRange Uses

func (db *DB) LRange(key []byte, start int32, stop int32) ([][]byte, error)

func (*DB) LSet Uses

func (db *DB) LSet(key []byte, index int32, value []byte) error

func (*DB) LTTL Uses

func (db *DB) LTTL(key []byte) (int64, error)

func (*DB) LTrim Uses

func (db *DB) LTrim(key []byte, start, stop int64) error

func (*DB) LTrimBack Uses

func (db *DB) LTrimBack(key []byte, trimSize int32) (int32, error)

func (*DB) LTrimFront Uses

func (db *DB) LTrimFront(key []byte, trimSize int32) (int32, error)

func (*DB) MGet Uses

func (db *DB) MGet(keys ...[]byte) ([][]byte, error)

func (*DB) MSet Uses

func (db *DB) MSet(args ...KVPair) error

func (*DB) Persist Uses

func (db *DB) Persist(key []byte) (int64, error)

func (*DB) RPop Uses

func (db *DB) RPop(key []byte) ([]byte, error)

func (*DB) RPush Uses

func (db *DB) RPush(key []byte, args ...[]byte) (int64, error)

func (*DB) Restore Uses

func (db *DB) Restore(key []byte, ttl int64, data []byte) error

func (*DB) RevScan Uses

func (db *DB) RevScan(dataType DataType, cursor []byte, count int, inclusive bool, match string) ([][]byte, error)

if inclusive is true, revscan range (-inf, cursor] else (inf, cursor)

func (*DB) SAdd Uses

func (db *DB) SAdd(key []byte, args ...[]byte) (int64, error)

func (*DB) SCard Uses

func (db *DB) SCard(key []byte) (int64, error)

func (*DB) SClear Uses

func (db *DB) SClear(key []byte) (int64, error)

func (*DB) SDiff Uses

func (db *DB) SDiff(keys ...[]byte) ([][]byte, error)

func (*DB) SDiffStore Uses

func (db *DB) SDiffStore(dstKey []byte, keys ...[]byte) (int64, error)

func (*DB) SDump Uses

func (db *DB) SDump(key []byte) ([]byte, error)

func (*DB) SExpire Uses

func (db *DB) SExpire(key []byte, duration int64) (int64, error)

func (*DB) SExpireAt Uses

func (db *DB) SExpireAt(key []byte, when int64) (int64, error)

func (*DB) SInter Uses

func (db *DB) SInter(keys ...[]byte) ([][]byte, error)

func (*DB) SInterStore Uses

func (db *DB) SInterStore(dstKey []byte, keys ...[]byte) (int64, error)

func (*DB) SIsMember Uses

func (db *DB) SIsMember(key []byte, member []byte) (int64, error)

func (*DB) SKeyExists Uses

func (db *DB) SKeyExists(key []byte) (int64, error)

func (*DB) SMclear Uses

func (db *DB) SMclear(keys ...[]byte) (int64, error)

func (*DB) SMembers Uses

func (db *DB) SMembers(key []byte) ([][]byte, error)

func (*DB) SPersist Uses

func (db *DB) SPersist(key []byte) (int64, error)

func (*DB) SRem Uses

func (db *DB) SRem(key []byte, args ...[]byte) (int64, error)

func (*DB) SRevScan Uses

func (db *DB) SRevScan(key []byte, cursor []byte, count int, inclusive bool, match string) ([][]byte, error)

func (*DB) SScan Uses

func (db *DB) SScan(key []byte, cursor []byte, count int, inclusive bool, match string) ([][]byte, error)

func (*DB) STTL Uses

func (db *DB) STTL(key []byte) (int64, error)

func (*DB) SUnion Uses

func (db *DB) SUnion(keys ...[]byte) ([][]byte, error)

func (*DB) SUnionStore Uses

func (db *DB) SUnionStore(dstKey []byte, keys ...[]byte) (int64, error)

func (*DB) Scan Uses

func (db *DB) Scan(dataType DataType, cursor []byte, count int, inclusive bool, match string) ([][]byte, error)

fif inclusive is true, scan range [cursor, inf) else (cursor, inf)

func (*DB) Set Uses

func (db *DB) Set(key []byte, value []byte) error

func (*DB) SetBit Uses

func (db *DB) SetBit(key []byte, offset int, on int) (int64, error)

func (*DB) SetEX Uses

func (db *DB) SetEX(key []byte, duration int64, value []byte) error

func (*DB) SetNX Uses

func (db *DB) SetNX(key []byte, value []byte) (int64, error)

func (*DB) SetRange Uses

func (db *DB) SetRange(key []byte, offset int, value []byte) (int64, error)

func (*DB) StrLen Uses

func (db *DB) StrLen(key []byte) (int64, error)

func (*DB) TTL Uses

func (db *DB) TTL(key []byte) (int64, error)

func (*DB) XLSort Uses

func (db *DB) XLSort(key []byte, offset int, size int, alpha bool, desc bool, sortBy []byte, sortGet [][]byte) ([][]byte, error)

func (*DB) XSSort Uses

func (db *DB) XSSort(key []byte, offset int, size int, alpha bool, desc bool, sortBy []byte, sortGet [][]byte) ([][]byte, error)

func (*DB) XZSort Uses

func (db *DB) XZSort(key []byte, offset int, size int, alpha bool, desc bool, sortBy []byte, sortGet [][]byte) ([][]byte, error)

func (*DB) ZAdd Uses

func (db *DB) ZAdd(key []byte, args ...ScorePair) (int64, error)

func (*DB) ZCard Uses

func (db *DB) ZCard(key []byte) (int64, error)

func (*DB) ZClear Uses

func (db *DB) ZClear(key []byte) (int64, error)

func (*DB) ZCount Uses

func (db *DB) ZCount(key []byte, min int64, max int64) (int64, error)

func (*DB) ZDump Uses

func (db *DB) ZDump(key []byte) ([]byte, error)

func (*DB) ZExpire Uses

func (db *DB) ZExpire(key []byte, duration int64) (int64, error)

func (*DB) ZExpireAt Uses

func (db *DB) ZExpireAt(key []byte, when int64) (int64, error)

func (*DB) ZIncrBy Uses

func (db *DB) ZIncrBy(key []byte, delta int64, member []byte) (int64, error)

func (*DB) ZInterStore Uses

func (db *DB) ZInterStore(destKey []byte, srcKeys [][]byte, weights []int64, aggregate byte) (int64, error)

func (*DB) ZKeyExists Uses

func (db *DB) ZKeyExists(key []byte) (int64, error)

func (*DB) ZLexCount Uses

func (db *DB) ZLexCount(key []byte, min []byte, max []byte, rangeType uint8) (int64, error)

func (*DB) ZMclear Uses

func (db *DB) ZMclear(keys ...[]byte) (int64, error)

func (*DB) ZPersist Uses

func (db *DB) ZPersist(key []byte) (int64, error)

func (*DB) ZRange Uses

func (db *DB) ZRange(key []byte, start int, stop int) ([]ScorePair, error)

func (*DB) ZRangeByLex Uses

func (db *DB) ZRangeByLex(key []byte, min []byte, max []byte, rangeType uint8, offset int, count int) ([][]byte, error)

func (*DB) ZRangeByScore Uses

func (db *DB) ZRangeByScore(key []byte, min int64, max int64,
    offset int, count int) ([]ScorePair, error)

min and max must be inclusive if no limit, set offset = 0 and count = -1

func (*DB) ZRangeByScoreGeneric Uses

func (db *DB) ZRangeByScoreGeneric(key []byte, min int64, max int64,
    offset int, count int, reverse bool) ([]ScorePair, error)

min and max must be inclusive if no limit, set offset = 0 and count = -1

func (*DB) ZRangeGeneric Uses

func (db *DB) ZRangeGeneric(key []byte, start int, stop int, reverse bool) ([]ScorePair, error)

func (*DB) ZRank Uses

func (db *DB) ZRank(key []byte, member []byte) (int64, error)

func (*DB) ZRem Uses

func (db *DB) ZRem(key []byte, members ...[]byte) (int64, error)

func (*DB) ZRemRangeByLex Uses

func (db *DB) ZRemRangeByLex(key []byte, min []byte, max []byte, rangeType uint8) (int64, error)

func (*DB) ZRemRangeByRank Uses

func (db *DB) ZRemRangeByRank(key []byte, start int, stop int) (int64, error)

func (*DB) ZRemRangeByScore Uses

func (db *DB) ZRemRangeByScore(key []byte, min int64, max int64) (int64, error)

min and max must be inclusive

func (*DB) ZRevRange Uses

func (db *DB) ZRevRange(key []byte, start int, stop int) ([]ScorePair, error)

func (*DB) ZRevRangeByScore Uses

func (db *DB) ZRevRangeByScore(key []byte, min int64, max int64, offset int, count int) ([]ScorePair, error)

min and max must be inclusive if no limit, set offset = 0 and count = -1

func (*DB) ZRevRank Uses

func (db *DB) ZRevRank(key []byte, member []byte) (int64, error)

func (*DB) ZRevScan Uses

func (db *DB) ZRevScan(key []byte, cursor []byte, count int, inclusive bool, match string) ([]ScorePair, error)

func (*DB) ZScan Uses

func (db *DB) ZScan(key []byte, cursor []byte, count int, inclusive bool, match string) ([]ScorePair, error)

func (*DB) ZScore Uses

func (db *DB) ZScore(key []byte, member []byte) (int64, error)

func (*DB) ZTTL Uses

func (db *DB) ZTTL(key []byte) (int64, error)

func (*DB) ZUnionStore Uses

func (db *DB) ZUnionStore(destKey []byte, srcKeys [][]byte, weights []int64, aggregate byte) (int64, error)

type DataType Uses

type DataType byte
const (
    KV  DataType = iota

for out use

func (DataType) String Uses

func (d DataType) String() string

type DumpHead Uses

type DumpHead struct {
    CommitID uint64

func (*DumpHead) Read Uses

func (h *DumpHead) Read(r io.Reader) error

func (*DumpHead) Write Uses

func (h *DumpHead) Write(w io.Writer) error

type FVPair Uses

type FVPair struct {
    Field []byte
    Value []byte

type KVPair Uses

type KVPair struct {
    Key   []byte
    Value []byte

type Ledis Uses

type Ledis struct {
    // contains filtered or unexported fields

func Open Uses

func Open(cfg *config.Config) (*Ledis, error)

func (*Ledis) AddNewLogEventHandler Uses

func (l *Ledis) AddNewLogEventHandler(h NewLogEventHandler) error

func (*Ledis) Close Uses

func (l *Ledis) Close()

func (*Ledis) CompactStore Uses

func (l *Ledis) CompactStore() error

func (*Ledis) Dump Uses

func (l *Ledis) Dump(w io.Writer) error

func (*Ledis) DumpFile Uses

func (l *Ledis) DumpFile(path string) error

func (*Ledis) FlushAll Uses

func (l *Ledis) FlushAll() error

Flush All will clear all data and replication logs

func (*Ledis) IsReadOnly Uses

func (l *Ledis) IsReadOnly() bool

func (*Ledis) LoadDump Uses

func (l *Ledis) LoadDump(r io.Reader) (*DumpHead, error)

clear all data and load dump file to db

func (*Ledis) LoadDumpFile Uses

func (l *Ledis) LoadDumpFile(path string) (*DumpHead, error)

clear all data and load dump file to db

func (*Ledis) ReadLogsTo Uses

func (l *Ledis) ReadLogsTo(startLogID uint64, w io.Writer) (n int, nextLogID uint64, err error)

func (*Ledis) ReadLogsToTimeout Uses

func (l *Ledis) ReadLogsToTimeout(startLogID uint64, w io.Writer, timeout int, quitCh chan struct{}) (n int, nextLogID uint64, err error)

try to read events, if no events read, try to wait the new event singal until timeout seconds

func (*Ledis) ReplicationStat Uses

func (l *Ledis) ReplicationStat() (*rpl.Stat, error)

func (*Ledis) ReplicationUsed Uses

func (l *Ledis) ReplicationUsed() bool

func (*Ledis) Select Uses

func (l *Ledis) Select(index int) (*DB, error)

func (*Ledis) StoreLogsFromData Uses

func (l *Ledis) StoreLogsFromData(data []byte) error

func (*Ledis) StoreLogsFromReader Uses

func (l *Ledis) StoreLogsFromReader(rb io.Reader) error

func (*Ledis) StoreStat Uses

func (l *Ledis) StoreStat() *store.Stat

func (*Ledis) WaitReplication Uses

func (l *Ledis) WaitReplication() error

type Limit Uses

type Limit struct {
    Offset int
    Size   int

type NewLogEventHandler Uses

type NewLogEventHandler func(rl *rpl.Log)

type ScorePair Uses

type ScorePair struct {
    Score  int64
    Member []byte

Package ledis imports 25 packages (graph) and is imported by 173 packages. Updated 2017-08-21. Refresh now. Tools for package owners.