Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

bstore

package module

Go to main page

Versions in this module

v0

v0.0.6

May 10, 2024

Changes in this version

type Options

+ RegisterLogger *slog.Logger

v0.0.5

Mar 30, 2024

v0.0.4

Jan 5, 2024

v0.0.3

Nov 20, 2023

v0.0.2

Aug 5, 2023

v0.0.1

May 22, 2023

Changes in this version

+ var ErrAbsent = errors.New("absent")

+ var ErrFinished = errors.New("query finished")

+ var ErrIncompatible = errors.New("incompatible types")

+ var ErrMultiple = errors.New("multiple results")

+ var ErrParam = errors.New("bad parameters")

+ var ErrReference = errors.New("referential inconsistency")

+ var ErrSeq = errors.New("highest autoincrement sequence value reached")

+ var ErrStore = errors.New("internal/storage error")

+ var ErrTxBotched = errors.New("botched transaction")

+ var ErrType = errors.New("unknown/bad type")

+ var ErrUnique = errors.New("not unique")

+ var ErrZero = errors.New("must be nonzero")

+ var StopForEach error = errors.New("stop foreach")

+ type DB struct

+ func Open(ctx context.Context, path string, opts *Options, typeValues ...any) (*DB, error)

+ func (db *DB) Begin(ctx context.Context, writable bool) (*Tx, error)

+ func (db *DB) Close() error

+ func (db *DB) Delete(ctx context.Context, values ...any) error

+ func (db *DB) Drop(ctx context.Context, name string) error

+ func (db *DB) Get(ctx context.Context, values ...any) error

+ func (db *DB) HintAppend(append bool, values ...any) error

+ func (db *DB) Insert(ctx context.Context, values ...any) error

+ func (db *DB) Read(ctx context.Context, fn func(*Tx) error) error

+ func (db *DB) Register(ctx context.Context, typeValues ...any) error

+ func (db *DB) Stats() Stats

+ func (db *DB) Update(ctx context.Context, values ...any) error

+ func (db *DB) Write(ctx context.Context, fn func(*Tx) error) error

+ type Options struct

+ MustExist bool

+ Perm fs.FileMode

+ Timeout time.Duration

+ type Query struct

+ func QueryDB(ctx context.Context, db *DB) *Query[T]

+ func QueryTx(tx *Tx) *Query[T]

+ func (q *Query[T]) Close() error

+ func (q *Query[T]) Count() (n int, rerr error)

+ func (q *Query[T]) Delete() (deleted int, rerr error)

+ func (q *Query[T]) Err() error

+ func (q *Query[T]) Exists() (exists bool, rerr error)

+ func (q *Query[T]) FilterEqual(fieldName string, values ...any) *Query[T]

+ func (q *Query[T]) FilterFn(fn func(value T) bool) *Query[T]

+ func (q *Query[T]) FilterGreater(fieldName string, value any) *Query[T]

+ func (q *Query[T]) FilterGreaterEqual(fieldName string, value any) *Query[T]

+ func (q *Query[T]) FilterID(id any) *Query[T]

+ func (q *Query[T]) FilterIDs(ids any) *Query[T]

+ func (q *Query[T]) FilterIn(fieldName string, value any) *Query[T]

+ func (q *Query[T]) FilterLess(fieldName string, value any) *Query[T]

+ func (q *Query[T]) FilterLessEqual(fieldName string, value any) *Query[T]

+ func (q *Query[T]) FilterNonzero(value T) *Query[T]

+ func (q *Query[T]) FilterNotEqual(fieldName string, values ...any) *Query[T]

+ func (q *Query[T]) ForEach(fn func(value T) error) (rerr error)

+ func (q *Query[T]) Gather(l *[]T) *Query[T]

+ func (q *Query[T]) GatherIDs(ids any) *Query[T]

+ func (q *Query[T]) Get() (value T, rerr error)

+ func (q *Query[T]) IDs(idsptr any) (rerr error)

+ func (q *Query[T]) Limit(n int) *Query[T]

+ func (q *Query[T]) List() (list []T, rerr error)

+ func (q *Query[T]) Next() (value T, rerr error)

+ func (q *Query[T]) NextID(idptr any) (rerr error)

+ func (q *Query[T]) SortAsc(fieldNames ...string) *Query[T]

+ func (q *Query[T]) SortDesc(fieldNames ...string) *Query[T]

+ func (q *Query[T]) Stats() Stats

+ func (q *Query[T]) UpdateField(fieldName string, value any) (updated int, rerr error)

+ func (q *Query[T]) UpdateFields(fieldValues map[string]any) (updated int, rerr error)

+ func (q *Query[T]) UpdateNonzero(value T) (updated int, rerr error)

+ type Stats struct

+ Bucket StatsKV

+ Delete uint

+ Get uint

+ Index StatsKV

+ Insert uint

+ LastAsc bool

+ LastIndex string

+ LastOrdered bool

+ LastType string

+ PlanIndexScan uint

+ PlanPK uint

+ PlanPKScan uint

+ PlanTableScan uint

+ PlanUnique uint

+ Queries uint

+ Reads uint

+ Records StatsKV

+ Sort uint

+ Update uint

+ Writes uint

+ func (st Stats) Sub(o Stats) Stats

+ type StatsKV struct

+ Cursor uint

+ Delete uint

+ Get uint

+ Put uint

+ type Tx struct

+ func (tx *Tx) Commit() error

+ func (tx *Tx) Delete(values ...any) error

+ func (tx *Tx) Get(values ...any) error

+ func (tx *Tx) Insert(values ...any) error

+ func (tx *Tx) Keys(typeName string, fn func(pk any) error) error

+ func (tx *Tx) Record(typeName, key string, fields *[]string) (map[string]any, error)

+ func (tx *Tx) Records(typeName string, fields *[]string, fn func(map[string]any) error) error

+ func (tx *Tx) Rollback() error

+ func (tx *Tx) Stats() Stats

+ func (tx *Tx) Types() ([]string, error)

+ func (tx *Tx) Update(values ...any) error

+ func (tx *Tx) WriteTo(w io.Writer) (n int64, err error)