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
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

database

package

Go to main page

Versions in this module

v1

v1.2.1

Mar 28, 2026

v1.2.0

Feb 9, 2026

v1.1.3

Jan 2, 2025

v1.1.2

Feb 26, 2024

v1.1.1

Feb 23, 2024

v1.1.0

Mar 3, 2023

Changes in this version

+ const NotFound

+ const PrivateDir

+ const PrivateFile

+ const Timeout

+ var ErrEmpty = errors.New("database is empty and contains no items")

+ var ErrImportList = errors.New("import list cannot be empty")

+ var ErrNoBucket = errors.New("the named bucket cannot be empty")

+ var ErrNoClean = errors.New("database has nothing to clean")

+ var ErrNoCompact = errors.New("compression has not reduced the database size")

+ var ErrNoDest = errors.New("the destination path cannot be empty")

+ var ErrNoFilename = errors.New("the named file cannot be empty")

+ var ErrNoTerm = errors.New("cannot compare an empty term")

+ var ErrNotFound = errors.New("database file does not exist")

+ var ErrSameName = errors.New("bucket target is the same as the bucket name")

+ var ErrZeroByte = errors.New("database is a zero byte file and is unusable")

+ func Abs(name string) (string, error)

+ func AbsB(name string) ([]byte, error)

+ func All(db *bolt.DB) ([]string, error)

+ func Backup() (name string, written int64, err error)

+ func CSVExport(db *bolt.DB, bucket string) (string, error)

+ func CSVImport(db *bolt.DB, name string, assumeYes bool) (int, error)

+ func Check() (int64, error)

+ func Clean(db *bolt.DB, quiet, debug bool, buckets ...string) error

+ func Compact(db *bolt.DB, debug bool) error

+ func CopyFile(name, dest string) (int64, error)

+ func Count(db *bolt.DB, name string) (int, error)

+ func Create(path string) error

+ func DB() (string, error)

+ func Exist(db *bolt.DB, bucket string) error

+ func Home() (string, error)

+ func Import(db *bolt.DB, name Bucket, ls *Lists) (imported int, err error)

+ func Info(db *bolt.DB) (string, error)

+ func IsEmpty(db *bolt.DB) error

+ func OpenRead() (db *bolt.DB, err error)

+ func OpenWrite() (db *bolt.DB, err error)

+ func Remove(db *bolt.DB, name string) error

+ func Rename(db *bolt.DB, name, target string) error

+ func Usage(db *bolt.DB, name string, assumeYes bool) (string, error)

+ type Bucket string

+ type Filepath string

+ type Lists map[Filepath][32]byte

+ func List(db *bolt.DB, bucket string) (Lists, error)

+ func Scanner(file *os.File) (string, *Lists, error)

+ type Matches map[Filepath]Bucket

+ func Compare(db *bolt.DB, s string, buckets ...string) (*Matches, error)

+ func CompareBase(db *bolt.DB, s string, buckets ...string) (*Matches, error)

+ func CompareBaseNoCase(db *bolt.DB, s string, buckets ...string) (*Matches, error)

+ func CompareNoCase(db *bolt.DB, s string, buckets ...string) (*Matches, error)