datastore

package

v0.0.0-...-873507f Latest Latest Go to latest Published: Apr 29, 2019 License: GPL-2.0, GPL-2.0-only Imports: 7 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.

This section is empty.

This section is empty.

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

Datastore is where user accounts and page metadata is stored

func New(path string) (*Datastore, error)

New returns a new, already opened Datastore instance at <path>

func (d *Datastore) Close()

Close closes the enclosed bolt database

func (d *Datastore) CountUsers() (int, error)

CountUsers returns the number of users in the datastore

func (d *Datastore) CreateUser(u *user.User) error

CreateUser creates a new user in the database

func (d *Datastore) DeletePage(id string) error

DeletePage deletes a page from the datastore.

func (d *Datastore) DeleteUser(id string) error

DeleteUser deletes a user from the datastore.

func (d *Datastore) GetPage(id string) (*page.Page, error)

GetPage returns a page from the datastore

func (d *Datastore) GetUser(id string) (*user.User, error)

GetUser returns a page from the datastore

func (d *Datastore) RenamePage(oldID string, newID string) error

RenamePage will delete the old page and insert the new one

func (d *Datastore) UpdatePage(p *page.Page, pageID string) error

UpdatePage updates a page in the datastore

func (d *Datastore) UpdateUser(u *user.User) error

UpdateUser updates a user in the datastore

func (d *Datastore) UserExists(id string) (bool, error)

UserExists returns a false if the user doesn't exist in the datastore