heavy

Documentation

Index

• Variables
• func CreateDBConnection() (database.Driver, database.DB)
• func NewDatabase(path string, readonly bool) (database.DB, error)
• type DB
  • func (db DB) Begin(writable bool) (database.Transaction, error)
  • func (db DB) Close() error
  • func (db DB) GetSnapshot() (*leveldb.Snapshot, error)
  • func (db DB) Update(fn func(database.Transaction) error) error
  • func (db DB) View(fn func(database.Transaction) error) error

Variables

var (

	// HeaderPrefix is the prefix to identify the Header.
	HeaderPrefix = []byte{0x01}
	// TxPrefix is the prefix to identify Transactions.
	TxPrefix = []byte{0x02}
	// HeightPrefix is the prefix to identify the Height.
	HeightPrefix = []byte{0x03}
	// TxIDPrefix is the prefix to identify the Transaction ID.
	TxIDPrefix = []byte{0x04}
	// TipPrefix is the prefix to identify the hash of the latest blockchain block.
	TipPrefix = []byte{0x05}
	// PersistedPrefix is the prefix to identify the hash of the latest blockchain persisted block.
	PersistedPrefix = []byte{0x06}
	// CandidatePrefix is the prefix to identify Candidate messages.
	CandidatePrefix = []byte{0x07}
)

var DriverName = "heavy_v0.1.0"

DriverName is the unique identifier for the heavy driver.

Functions

func CreateDBConnection

func CreateDBConnection() (database.Driver, database.DB)

CreateDBConnection creates a connection with the DB using the `heavy` driver.

func NewDatabase

func NewDatabase(path string, readonly bool) (database.DB, error)

NewDatabase create or open backend storage (goleveldb) located at the specified path. Readonly option is pseudo read-only mode implemented by heavy.Database. Not to be confused with read-only goleveldb mode.

Types

type DB

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

DB on top of underlying storage syndtr/goleveldb/leveldb.

func (DB) Begin

func (db DB) Begin(writable bool) (database.Transaction, error)

Begin builds read-only or read-write Transaction.

func (DB) Close

func (db DB) Close() error

Close does not close the underlying storage as we need to reuse it within another DB instances. Note that we rely on the Finalizer that goleveldb is setting at the point of leveldb.DB.openDB to call leveldb.DB.Close() when the process is terminating.

func (DB) GetSnapshot

func (db DB) GetSnapshot() (*leveldb.Snapshot, error)

GetSnapshot returns current storage snapshot. To be used only by database/testing pkg.

func (DB) Update

func (db DB) Update(fn func(database.Transaction) error) error

Update a record within a transaction.

func (DB) View

func (db DB) View(fn func(database.Transaction) error) error

View is the equivalent of a Select SQL statement.