Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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
- API
  
  Reference documentation for the pkg.go.dev API
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

docstore

package module

Go to main page

Versions in this module

v0

v0.6.1

Aug 2, 2026

v0.6.0

Aug 2, 2026

Changes in this version

type Collection

+ func (c *Collection) FindAll(conds []Condition, limit int) (out []Doc, err error)

+ func (c *Collection) FindAllIndexed(conds []Condition, limit int) (out []Doc, err error)

+ func (c *Collection) FindAny(conds []Condition, limit int) (out []Doc, err error)

+ type Condition struct

+ Op string

+ Path string

+ Value any

v0.5.0

Aug 1, 2026

Changes in this version

type Collection

+ func (c *Collection) Indexes() ([]IndexInfo, error)

+ type IndexInfo struct

+ Column string

+ JSONPath string

+ Name string

+ NoCase bool

+ SQL string

+ Unique bool

v0.4.0

Jul 29, 2026

Changes in this version

type Collection

+ func (c *Collection) FindIndexed(jsonPath, op string, value any, limit int) (out []Doc, err error)

v0.3.0

Jul 24, 2026

Changes in this version

type Collection

+ func (c *Collection) CountDeleted() (n int, err error)

v0.2.0

Jul 8, 2026

Changes in this version

type Collection

+ func (c *Collection) FindPath(path, op string, value any, limit int) (out []Doc, err error)

v0.1.0

Jul 8, 2026

Changes in this version

+ var ErrExists = errors.New("docstore: already exists")

+ var ErrNotFound = errors.New("docstore: not found")

+ type Collection struct

+ func (c *Collection) Count() (n int, err error)

+ func (c *Collection) Delete(id string) (err error)

+ func (c *Collection) Each(fn func(id string, raw []byte) error) (err error)

+ func (c *Collection) EachDeleted(fn func(id string, raw []byte) error) (err error)

+ func (c *Collection) ExistsBy(col string, val any, exceptID string) (found bool, err error)

+ func (c *Collection) ExportDir(dir string) (n int, err error)

+ func (c *Collection) Find(jsonPath, op string, value any, limit int) (out []Doc, err error)

+ func (c *Collection) Get(id string, out any) (err error)

+ func (c *Collection) GetBy(col string, val any, out any) (err error)

+ func (c *Collection) GetRaw(id string) (raw []byte, err error)

+ func (c *Collection) IDs() (out []string, err error)

+ func (c *Collection) ImportDir(dir string) (n int, err error)

+ func (c *Collection) ImportFile(path string) (err error)

+ func (c *Collection) Insert(id string, doc any) (err error)

+ func (c *Collection) Meta(id string) (m Meta, err error)

+ func (c *Collection) Purge(id string) (err error)

+ func (c *Collection) Put(id string, doc any) (err error)

+ func (c *Collection) Restore(id string) (err error)

+ func (c *Collection) Update(id string, fn func(raw []byte) ([]byte, error)) (err error)

+ type Doc struct

+ ID string

+ Raw []byte

+ type Meta struct

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ UpdatedAt time.Time

+ type Option func(*Collection)

+ func WithIndex(col, jsonPath string, nocase bool) Option

+ func WithSoftDelete() Option

+ func WithUniqueIndex(col, jsonPath string) Option

+ type Store struct

+ func Open(path string) (*Store, error)

+ func (s *Store) Close() error

+ func (s *Store) Collection(name string, opts ...Option) (*Collection, error)

+ func (s *Store) Collections() ([]string, error)

+ func (s *Store) DB() *sql.DB

+ func (s *Store) SetLogger(l *slog.Logger)