broton

README

broton

lightweight data store which is based on Pebble.

License

Licensed under the Apache License

Authors

Copyright(c) 2020 Fred Chien fred@brobridge.com

Documentation

Index

• func BytesToFloat64(data []byte) float64
• func BytesToInt64(data []byte) int64
• func BytesToUint64(data []byte) uint64
• func Float64ToBytes(n float64) []byte
• func Int64ToBytes(n int64) []byte
• func StrToBytes(s string) []byte
• func Uint64ToBytes(n uint64) []byte
• type Broton
  • func NewBroton(options *Options) (*Broton, error)
  • func (bt *Broton) Close()
  • func (bt *Broton) GetStore(storeName string) (*Store, error)
  • func (bt *Broton) UnregisterStore(name string)
• type ColumnFamily
  • func NewColumnFamily(store *Store, name string) *ColumnFamily
  • func (cf *ColumnFamily) Close() error
  • func (cf *ColumnFamily) Open() error
  • func (cf *ColumnFamily) Write(key []byte, data []byte) error
• type Options
  • func NewOptions() *Options
• type Store
  • func NewStore(broton *Broton, storeName string) (*Store, error)
  • func (store *Store) Close()
  • func (store *Store) Delete(column string, key []byte) error
  • func (store *Store) GetBytes(column string, key []byte) ([]byte, error)
  • func (store *Store) GetColumnFamailyHandle(name string) (*ColumnFamily, error)
  • func (store *Store) GetFloat64(column string, key []byte) (float64, error)
  • func (store *Store) GetInt64(column string, key []byte) (int64, error)
  • func (store *Store) GetString(column string, key []byte) (string, error)
  • func (store *Store) GetUint64(column string, key []byte) (uint64, error)
  • func (store *Store) List(column string, targetKey []byte, callback func(key []byte, value []byte) bool) error
  • func (store *Store) Put(column string, key []byte, data []byte) error
  • func (store *Store) PutFloat64(column string, key []byte, value float64) error
  • func (store *Store) PutInt64(column string, key []byte, value int64) error
  • func (store *Store) PutString(column string, key []byte, value string) error
  • func (store *Store) PutUint64(column string, key []byte, value uint64) error
  • func (store *Store) RegisterColumns(names []string) error

Functions

func BytesToFloat64

func BytesToFloat64(data []byte) float64

func BytesToInt64

func BytesToInt64(data []byte) int64

func BytesToUint64

func BytesToUint64(data []byte) uint64

func Float64ToBytes

func Float64ToBytes(n float64) []byte

func Int64ToBytes

func Int64ToBytes(n int64) []byte

func StrToBytes

func StrToBytes(s string) []byte

func Uint64ToBytes

func Uint64ToBytes(n uint64) []byte

Types

type Broton

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

func NewBroton

func NewBroton(options *Options) (*Broton, error)

func (*Broton) Close

func (bt *Broton) Close()

func (*Broton) GetStore

func (bt *Broton) GetStore(storeName string) (*Store, error)

func (*Broton) UnregisterStore

func (bt *Broton) UnregisterStore(name string)

type ColumnFamily

type ColumnFamily struct {
	Store *Store
	Db    *pebble.DB
	Name  string
	// contains filtered or unexported fields
}

func NewColumnFamily

func NewColumnFamily(store *Store, name string) *ColumnFamily

func (*ColumnFamily) Close

func (cf *ColumnFamily) Close() error

func (*ColumnFamily) Open

func (cf *ColumnFamily) Open() error

func (*ColumnFamily) Write

func (cf *ColumnFamily) Write(key []byte, data []byte) error

type Options

type Options struct {
	DatabasePath string
}

func NewOptions

func NewOptions() *Options

type Store

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

func NewStore

func NewStore(broton *Broton, storeName string) (*Store, error)

func (*Store) Close

func (store *Store) Close()

func (*Store) Delete

func (store *Store) Delete(column string, key []byte) error

func (*Store) GetBytes

func (store *Store) GetBytes(column string, key []byte) ([]byte, error)

func (*Store) GetColumnFamailyHandle

func (store *Store) GetColumnFamailyHandle(name string) (*ColumnFamily, error)

func (*Store) GetFloat64

func (store *Store) GetFloat64(column string, key []byte) (float64, error)

func (*Store) GetInt64

func (store *Store) GetInt64(column string, key []byte) (int64, error)

func (*Store) GetString

func (store *Store) GetString(column string, key []byte) (string, error)

func (*Store) GetUint64

func (store *Store) GetUint64(column string, key []byte) (uint64, error)

func (*Store) List

func (store *Store) List(column string, targetKey []byte, callback func(key []byte, value []byte) bool) error

func (*Store) Put

func (store *Store) Put(column string, key []byte, data []byte) error

func (*Store) PutFloat64

func (store *Store) PutFloat64(column string, key []byte, value float64) error

func (*Store) PutInt64

func (store *Store) PutInt64(column string, key []byte, value int64) error

func (*Store) PutString

func (store *Store) PutString(column string, key []byte, value string) error

func (*Store) PutUint64

func (store *Store) PutUint64(column string, key []byte, value uint64) error

func (*Store) RegisterColumns

func (store *Store) RegisterColumns(names []string) error