sqlitekv

package module

Go to main page

Versions in this module

v0

v0.7.0

Nov 25, 2025

Changes in this version

+ const DictIDMask

+ const EncodeFlagCompress

+ const EncodeFlagUseDict

+ const EncodeSoftDelete

+ func IsCompressed(flags int64) bool

+ func IsDictCompressed(flags int64) bool

+ type DecodeOptions struct

+ DictKey string

+ type Dict struct

+ Buf []byte

+ Ver uint8

+ type DictCollection struct

+ func NewDictCollection(db *sql.DB) (c *DictCollection, err error)

+ func (c *DictCollection) DeleteAllVersions(key string) (err error)

+ func (c *DictCollection) DeleteDict(key string, ver int64) (err error)

+ func (c *DictCollection) Get(key string, ver uint8) (ok bool, dict Dict, err error)

+ func (c *DictCollection) GetLatest(key string) (ok bool, d Dict, err error)

+ func (c *DictCollection) GetMaxVersion(key string) (maxVer uint8, err error)

+ func (c *DictCollection) Insert(key string, d Dict) (err error)

+ type DictStore struct

+ func (s *DictStore) GetCDict(key string, ver uint8) (cdict *gozstd.CDict)

+ func (s *DictStore) GetDDict(key string, ver uint8) (ddict *gozstd.DDict)

+ func (s *DictStore) SetDict(key string, ver uint8, buf []byte) (err error)

+ type EncodeOptions struct

+ Compress bool

+ DictKey string

+ DictVer uint8

+ UseDict bool

+ type Encoder struct

+ func NewEncoder(dictColl *DictCollection) (e *Encoder)

+ func (e *Encoder) Decode(src []byte, destObj any, flags int64, opts DecodeOptions) (err error)

+ func (e *Encoder) DecodeBuf(src []byte, flags int64, opts DecodeOptions) (buf []byte, err error)

+ func (e *Encoder) DictCollection() *DictCollection

+ func (e *Encoder) Encode(obj any, opts EncodeOptions) (flags int64, ebuf []byte, err error)

+ func (e *Encoder) TrainWithRows(db *sql.DB, key string, selectSql string) (d Dict, err error)

+ type KeyVal struct

+ func NewKeyVal[T any](db *sql.DB, name string, opts KeyValOptions[T]) (kv *KeyVal[T], err error)

+ func (kv *KeyVal[T]) Delete(pkey any) (affectedCount int64, err error)

+ func (kv *KeyVal[T]) Get(pkey any, obj *T) (ok bool, err error)

+ func (kv *KeyVal[T]) GetUnique(columnName string, pkey any, obj *T) (ok bool, err error)

+ func (kv *KeyVal[T]) Insert(obj *T) (rid int64, err error)

+ func (kv *KeyVal[T]) Select(bindargs []any, opts SelectOptions[T]) (list []*T, err error)

+ func (kv *KeyVal[T]) SoftDelete(pkey any) (affectedCount int64, err error)

+ func (kv *KeyVal[T]) Table() *Table

+ func (kv *KeyVal[T]) Train(limit int) (err error)

+ func (kv *KeyVal[T]) Upsert(obj *T) (err error)

+ type KeyValField struct

+ Get func(t *T) any

+ GetPtr func(t *T) any

+ Indexed bool

+ Name string

+ Nullable bool

+ Type string

+ Unique bool

+ type KeyValOptions struct

+ Compression bool

+ Enc *Encoder

+ Fields []*KeyValField[T]

+ KeyField *KeyValField[T]

+ OnInsert func(*T)

+ OnUpdate func(*T)

+ UseDict bool

+ Validate func(*T) error

type SelectOptions

+ Order string

+ StmtName string

+ type StmtStore struct

+ func NewStmtStore() *StmtStore

+ func (s *StmtStore) GetOrCreate(db *sql.DB, stmtName string, getSql func() string) (*sql.Stmt, error)

+ type Table struct

+ Name string

+ func NewTable(db *sql.DB, name string, opts TableOptions) (t *Table, err error)

+ func (t *Table) Insert(args ...any) (rid int64, err error)

+ func (t *Table) Row(stmtName string, getSql func() string, bindargs []any, args ...any) (ok bool, err error)

+ func (t *Table) Select(selectSql string, bindargs []any, handleRow func(row *sql.Rows) error) (err error)

+ func (t *Table) SelectUsingStmt(stmtName string, getSql func() string, bindargs []any, ...) (err error)

+ func (t *Table) Update(updateSql string, args ...any) (affectedCount int64, err error)

+ func (t *Table) Upsert(args ...any) (rid int64, err error)

+ func (t Table) StmtStore() *StmtStore

+ type TableField struct

+ Indexed bool

+ Name string

+ Nullable bool

+ PrimaryKey bool

+ Type string

+ Unique bool

+ type TableOptions struct

+ Fields []TableField

+ type ZstdDict struct

+ CDict *gozstd.CDict

+ DDict *gozstd.DDict

v0.6.0

Nov 16, 2025

v0.5.0

Nov 16, 2025

Changes in this version

+ func Compress(src []byte) []byte

type Collection

+ func (c *Collection) Delete(ctx context.Context, id int64) (err error)

type CollectionOptions

+ Compress bool

type KV

+ func (kv *KV) Clone() (newKv *KV, err error)

+ func (kv *KV) WalCheckpoint() (err error)

v0.3.0

Nov 16, 2025

Changes in this version

+ const SQLITE_CONSTRAINT_PRIMARYKEY

+ const SQLITE_CONSTRAINT_UNIQUE

+ var ErrPrimaryConstraint = errors.New("primary key constraint failed")

+ var ErrUnimplemented = errors.New("not implemented")

+ var ErrUniqueConstraint = errors.New("constraint failed")

+ func GenerateID64() int64

type Collection

+ func NewCollection(kv *KV, name string, opts *CollectionOptions) (col *Collection, err error)

+ func (c *Collection) GetUnique(ctx context.Context, colname string, colval any, obj CollectionType) (ok bool, err error)

+ func (c *Collection) Insert(ctx context.Context, val CollectionType) (changeCount int, err error)

+ func (c *Collection) Update(ctx context.Context, obj CollectionType) (changeCount int, err error)

type CollectionOptions

+ AutoId bool

+ Json bool

+ type CollectionType interface

+ Column func(i int, name string) (ok bool, val any, err error)

+ GetId func() (id int64)

+ GetVal func() (val []byte, err error)

+ SetColumn func(i int, name string, ok bool, val any) error

+ SetId func(id int64)

+ SetVal func(val []byte) error

type Counter

+ Current int64

+ Id int64

+ Limit int64

+ ReserveCount int64

+ Start int64

+ func (c *Counter) Column(i int, name string) (ok bool, val any, err error)

+ func (c *Counter) GetId() int64

+ func (c *Counter) GetVal() (val []byte, err error)

+ func (c *Counter) SetColumn(i int, name string, ok bool, val any) error

+ func (c *Counter) SetId(id int64)

+ func (c *Counter) SetVal(val []byte) error

+ type DerivedColumn struct

+ Name string

+ Nullable bool

+ Type string

+ Unique bool

+ type FTSOptions struct

+ Columns []string

+ ExcludeKeys []string

+ type ParseFn func(obj CollectionType) error

type RowFn

+ func GetAccumulateFn[T any](out *[]*T) (fn RowFn)

v0.2.0

Nov 15, 2025

Changes in this version

type Collection

+ func (c *Collection) Search(ctx context.Context, query string, rowfn RowFn) (err error)

type CollectionOptions

+ FTS bool

v0.1.0

Nov 15, 2025

Changes in this version

+ type Collection struct

+ func (c *Collection) Get(ctx context.Context, key string, fn GetFn) (ok bool, err error)

+ func (c *Collection) GetById(ctx context.Context, id int64, fn GetFn) (err error)

+ func (c *Collection) List(ctx context.Context, keyPrefix string, fn GetFn, opts ListOptions) (err error)

+ func (c *Collection) Put(ctx context.Context, key string, buf []byte) (rowid int64, err error)

+ func (c *Collection) Select(ctx context.Context, rowfn RowFn, opts SelectOptions) (err error)

+ type CollectionOptions struct

+ Columns []GeneratedColumn

+ Delimiter string

+ Indexes []string

+ type Counter struct

+ func NewCounter(col *Collection, key string, opts CounterOptions) (c *Counter, err error)

+ func (c *Counter) Next(ctx context.Context) (counter int64, err error)

+ type CounterOptions struct

+ ReserveCount int64

+ StartCount int64

+ type GeneratedColumn struct

+ Def string

+ Name string

+ Storage string

+ Type string

+ type GetColumnValueFn func(i int) (val any, ok bool, err error)

+ type GetFn func(id int64, key string, rawJson []byte, genColVals []any) error

+ type KV struct

+ func Open(dbpath string, opts *Options) (kv *KV, err error)

+ func (kv *KV) Close() (err error)

+ func (kv *KV) Collection(name string, opts *CollectionOptions) (col *Collection, err error)

+ func (kv *KV) DefaultCollection() *Collection

+ func (kv *KV) JsonCollection(name string, opts *CollectionOptions) (col *Collection, err error)

+ func (kv *KV) WithTx(fn func() error) (err error)

+ type ListOptions struct

+ All bool

+ Descending bool

+ OrderBy []string

+ type Options struct

+ BusyRetryInterval time.Duration

+ JournalMode string

+ type RowFn func(fn GetColumnValueFn) error

+ type SelectOptions struct

+ Columns []string

+ Limit int

+ OrderBy []string

+ TableAlias string

+ Where string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL