db

Documentation

Overview

Package db defines the interfaces for using the underlying database.

Index

• type Database
• type Deleter
• type Getter
• type Putter
• type Tx

Types

type Database

type Database interface {
	Getter
	Putter
	Deleter
	Close() error
	Begin() (Tx, error)
	NewBucket(bucket string) error
}

Generic database operations interface.

type Deleter

type Deleter interface {
	Delete(bucket string, key []byte) error
}

Deleter wraps the database delete operation.

type Getter

type Getter interface {
	// Get the value of key in bucket.
	Get(bucket string, key []byte) ([]byte, error)
	// Get all values of keys with the prefix in bucket.
	GetAll(bucket string, keyPrefix []byte) ([][]byte, error)
}

Getter wraps the database read operation.

type Putter

type Putter interface {
	Put(bucket string, key []byte, value []byte) error
}

Putter wraps the database write operation.

type Tx

type Tx interface {
	Getter
	Putter
	Deleter
	Rollback() error
	Commit() error
}

Generic database transaction operations interface.