boltutil

type BucketStatsMetric struct {
	// Page count statistics.
	BranchPageN     metrics2.Int64Metric // number of logical branch pages
	BranchOverflowN metrics2.Int64Metric // number of physical branch overflow pages
	LeafPageN       metrics2.Int64Metric // number of logical leaf pages
	LeafOverflowN   metrics2.Int64Metric // number of physical leaf overflow pages

	// Tree statistics.
	KeyN  metrics2.Int64Metric // number of keys/value pairs
	Depth metrics2.Int64Metric // number of levels in B+tree

	// Page size utilization.
	BranchAlloc metrics2.Int64Metric // bytes allocated for physical branch pages
	BranchInuse metrics2.Int64Metric // bytes actually used for branch data
	LeafAlloc   metrics2.Int64Metric // bytes allocated for physical leaf pages
	LeafInuse   metrics2.Int64Metric // bytes actually used for leaf data

	// Bucket statistics
	BucketN           metrics2.Int64Metric // total number of buckets including the top bucket
	InlineBucketN     metrics2.Int64Metric // total number of inlined buckets
	InlineBucketInuse metrics2.Int64Metric // bytes used for inlined buckets (also accounted for in LeafInuse)
}

type Config struct {
	// DB is the boltdb instance to store the indexed bucket.
	DB *bolt.DB

	// Name is the primary name of the database.
	Name string

	// Indices is the list of indices that should be created for every record stored.
	Indices []string

	// Codec is used to serialize and deserialize records. It has to consume
	// and produce instances that implement the Record interface.
	Codec util.LRUCodec
}

type DbMetric struct {
	Liveness           metrics2.Liveness
	DbStatsMetric      *DbStatsMetric
	BucketStatsMetrics map[string]*BucketStatsMetric
	// contains filtered or unexported fields
}

type DbStatsMetric struct {
	// Freelist stats
	FreePageN     metrics2.Int64Metric // total number of free pages on the freelist
	PendingPageN  metrics2.Int64Metric // total number of pending pages on the freelist
	FreeAlloc     metrics2.Int64Metric // total bytes allocated in free pages
	FreelistInuse metrics2.Int64Metric // total bytes used by the freelist

	// Transaction stats
	TxN     metrics2.Int64Metric // total number of started read transactions
	OpenTxN metrics2.Int64Metric // number of currently open read transactions

	TxStatsMetric *TxStatsMetric // global, ongoing stats.
}

type IndexedBucket struct {
	// BoltDB instance used by this store.
	DB *bolt.DB
	// contains filtered or unexported fields
}

type Record interface {
	// Key returns the primary key of the record. The return value does not have
	// to be a human readable string it can be any sequence of bytes. The
	// returned string has to uniquely identify this instance.
	Key() string

	// IndexValues returns the values of the type for the attributes we want to
	// index. The return value maps from the index names to the list of values for
	// that index (= secondary key values): map[index_name][]{val_1, val_2, val_n}.
	// Any key in the returned map must also be given in Indices field of the
	// Config instance passed to NewStore(...).
	// Note: Individual values for each index cannot be longer than 65535.
	IndexValues() map[string][]string
}

type TxStatsMetric struct {
	// Page statistics.
	PageCount metrics2.Int64Metric // number of page allocations
	PageAlloc metrics2.Int64Metric // total bytes allocated

	// Cursor statistics.
	CursorCount metrics2.Int64Metric // number of cursors created

	// Node statistics
	NodeCount metrics2.Int64Metric // number of node allocations
	NodeDeref metrics2.Int64Metric // number of node dereferences

	// Rebalance statistics.
	Rebalance     metrics2.Int64Metric // number of node rebalances
	RebalanceTime metrics2.Int64Metric // total time spent rebalancing

	// Split/Spill statistics.
	Split     metrics2.Int64Metric // number of nodes split
	Spill     metrics2.Int64Metric // number of nodes spilled
	SpillTime metrics2.Int64Metric // total time spent spilling

	// Write statistics.
	Write     metrics2.Int64Metric // number of writes performed
	WriteTime metrics2.Int64Metric // total time spent writing to disk
}

type WriteFn func(*bolt.Tx, []Record) error