storage

type CacheProxy interface {
	NewSession() CacheProxySession
}

type CacheProxySession interface {
	Tx
	HDel(table string, fields ...string) (int64, error)
	HExists(table, field string) (bool, error)
	HIncrBy(table, field string, incr int64) (int64, error)
	HMGet(table string, fields ...string) ([]interface{}, error)
	HMSet(table string, fields map[string]string) (string, error)
	Delete(keys ...string) (int64, error)
	ZAdd(key string, members ...redis.Z) (int64, error)
	ZRem(key string, members ...interface{}) (int64, error)
	ZRank(key, member string) (int64, error)
	ZScore(key, member string) (int64, error)
	// range APIs
	ZRange(key string, start, stop int64) (RangeResult, error)
	ZRangeWithScores(key string, start, stop int64) (RangeResult, error)
	ZRangeByScore(key string, opt redis.ZRangeBy) (RangeResult, error)
	ZRangeByLex(key string, opt redis.ZRangeBy) (RangeLexResult, error)
	ZRangeByScoreWithScores(key string, opt redis.ZRangeBy) (RangeResult, error)
	ZRevRange(key string, start, stop int64) (RangeResult, error)
	ZRevRangeWithScores(key string, start, stop int64) (RangeResult, error)
	ZRevRangeByScore(key string, opt redis.ZRangeBy) (RangeResult, error)
	ZRevRangeByLex(key string, opt redis.ZRangeBy) (RangeLexResult, error)
	ZRevRangeByScoreWithScores(key string, opt redis.ZRangeBy) (RangeResult, error)
}

type DatabaseProxy interface {
	NewSession() DatabaseProxySession
}

type DatabaseProxySession interface {
	Tx
	Insert(table Table) (int64, error)
	Update(table Table, fields ...string) (int64, error)
	Remove(tableName, keyName string, keys ...interface{}) (int64, error)
	Get(table Table, fields ...string) (bool, error)
}

type Engine interface {
	Repository
	// Cache returns CacheProxy
	Cache() CacheProxy
	// Database returns DatabaseProxy
	Database() DatabaseProxy
	// SetErrorHandler sets handler for handling error
	SetErrorHandler(eh ErrorHandler)
	// AddIndex adds an index, should panic if repeated index name on a same table
	AddIndex(index Index)
	// NewSession new a session
	NewSession() Session
}

type ErrorHandler func(action string, err error) error

type Field string

type FieldGetter interface {
	GetField(field string) (interface{}, bool)
}

type FieldList interface {
	Len() int
	Field(int) string
}

type FieldSetter interface {
	SetField(field, value string) error
}

type FieldSlice []string

type GetOption func(*getOptions)

type Index interface {
	Name() string
	TableMeta() TableMeta
	Update(s Session, table ReadonlyTable, key interface{}, updatedFields []string) error
	Remove(s Session, keys ...interface{}) error
}

type Int16Keys []int16

type Int32Keys []int32

type Int64Keys []int64

type Int8Keys []int8

type IntKeys []int

type InterfaceKeys []interface{}

type KeyList interface {
	Len() int
	Key(int) interface{}
}

type RangeLexResult interface {
	KeyList
}

type RangeOption func(*rangeOptions)

type RangeResult interface {
	KeyList
	Score(i int) int64
}

type ReadonlyTable interface {
	TableMeta() TableMeta
	Key() interface{}
	FieldGetter
}

type Record interface {
	Key() string
	Member() interface{}
	Unixstamp() int64
}

type Repository interface {
	// Name returns database name
	Name() string
	// Insert inserts new records
	Insert(tables ...Table) error
	// Update updates specific fields of record
	Update(table Table, fields ...string) error
	// UpdateByIndexScore updates specific fields of records which satify index score range
	UpdateByIndexScore(table Table, index Index, minScore, maxScore int64, fields ...string) (RangeResult, error)
	// Find gets records all fields by keys and stores loaded data to container
	Find(keys KeyList, container TableListContainer, opts ...GetOption) error
	// FindFields gets records specific fields by keys and stores loaded data to container
	FindFields(keys KeyList, container TableListContainer, fields ...string) error
	FindByIndexScore(index Index, minScore, maxScore int64, container TableListContainer, opts ...GetOption) error
	FindFieldsByIndexScore(index Index, minScore, maxScore int64, container TableListContainer, fields ...string) error
	// Get gets one record all fields
	Get(table Table, opts ...GetOption) (bool, error)
	// GetFields gets one record specific fields
	GetFields(table Table, fields ...string) (bool, error)
	// Remove removes one record
	Remove(table ReadonlyTable) error
	// RemoveRecords removes records by keys
	RemoveRecords(meta TableMeta, keys ...interface{}) error
	// Clear removes all records of table
	Clear(table string) error
	// FindView loads view by keys and stores loaded data to container
	FindView(view View, keys KeyList, container TableListContainer, opts ...GetOption) error
	// IndexRank gets rank of table key in index, returns InvalidRank if key not found
	IndexRank(index Index, key interface{}) (int64, error)
	// IndexScore gets score of table key in index, returns InvalidScore if key not found
	IndexScore(index Index, key interface{}) (int64, error)
	// IndexRange ranges index by rank
	IndexRange(index Index, start, stop int64, opts ...RangeOption) (RangeResult, error)
	// IndexRangeByScore ranges index by score
	IndexRangeByScore(index Index, min, max int64, opts ...RangeOption) (RangeResult, error)
	// IndexRangeByLex ranges index by lexicographical
	IndexRangeByLex(index Index, min, max string, opts ...RangeOption) (RangeLexResult, error)
	// AddRecord adds a record with timestamp
	AddRecord(key string, member interface{}, unixstamp int64) error
	GetRecordsByTime(key string, startUnixstamp, endUnixstamp int64) (RangeResult, error)
	GetRecordsByPage(key string, pageSize int, startRank int64) (RangeResult, error)
}

type Session interface {
	Tx
	Repository
	Cache() CacheProxySession
	Database() DatabaseProxySession
}

type StringKeys []string

type Table interface {
	ReadonlyTable
	SetKey(string) error
	FieldSetter
}

type TableListContainer interface {
	TableMeta() TableMeta
	Len() int
	New(tableName string, index int, key string) (Table, error)
}

type TableMeta interface {
	// Name returns name of table
	Name() string
	// Key returns name of key field
	Key() string
	// Fields returns names of all fields except key field
	Fields() []string
}

type Tx interface {
	Begin() error
	Commit() error
	Rollback() error
	Close()
}

type Uint16Keys []uint16

type Uint32Keys []uint32

type Uint64Keys []uint64

type Uint8Keys []uint8

type UintKeys []uint

type View interface {
	TableMeta() TableMeta
	Fields() FieldList
	Refs() map[string]View
}