db

package

v0.0.0-...-ec640b9 Latest Latest Go to latest Published: Feb 5, 2019 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	ErrPageNotFound = &Error{"page not found", nil}
	ErrNoPageName   = &Error{"no page name", nil}
)

Errors

This section is empty.

type DB struct {
	*bolt.DB
}

DB represents a Bolt-backed data store.

func (db *DB) Open(path string, mode os.FileMode) error

Open initializes and opens the database.

func (db *DB) Update(fn func(*Tx) error) error

Update executes a function in the context of a writable transaction.

func (db *DB) View(fn func(*Tx) error) error

View executes a function in the context of a read-only transaction.

type Error struct {
	// contains filtered or unexported fields
}

Error represents an error condition within the database.

func (e *Error) Error() string

Error returns a string representation of the error.

type Page struct {
	Tx   *Tx
	Name []byte
	Text []byte
}

Page represents a Wiki page

func (p *Page) Load() error

Load retrieves a page from the database.

func (p *Page) Save() error

Save commits the Page to the database.

type Tx struct {
	*bolt.Tx
}

Tx represents a BoltDB transaction

func (tx *Tx) Page(name []byte) (*Page, error)

Page retrieves a Page from the database with the given name.