backend

README

Backend

Backend is the Backend interface declaration for Monjura.

Documentation

Index

• type Backend
• type Bucket
• type Cursor
• type Initializer
• type Transaction

Types

type Backend

type Backend interface {
	Transaction(func(Transaction) error) error
	ReadTransaction(func(Transaction) error) error
	Close() error
}

Backend represents a database

type Bucket

type Bucket interface {
	Transaction

	Get(key []byte) (value []byte)
	Put(key, value []byte) error
	Delete(key []byte) error
	Cursor() Cursor
	ForEach(func(key, value []byte) error) error
}

Bucket represents a bucket

type Cursor

type Cursor interface {
	Seek(seekTo []byte) (key, value []byte)
	First() (key, value []byte)
	Next() (key, value []byte)
	Prev() (key, value []byte)
	Last() (key, value []byte)
}

Cursor represents a cursor

type Initializer

type Initializer interface {
	New(filename string) (Backend, error)
}

Initializer represents a Backend initializer

type Transaction

type Transaction interface {
	GetBucket(key []byte) Bucket
	GetOrCreateBucket(key []byte) (Bucket, error)
	DeleteBucket(key []byte) error
}

Transaction represents a database transaction