gocask

README

GoCask

Go implementation of Bitcask - A Log-Structured Hash Table for Fast Key / Value Data

Documentation

Index

• Constants
• type DB
  • func Open(dbPath string, opts ...Option) (*DB, error)
• type Option
  • func WithDataDir(path string) Option
  • func WithMaxDataFileSize(bytes int64) Option

Constants

const (
	// KB represents base2 kilobyte
	KB int64 = 1024

	// MB represents base2 megabyte
	MB = KB * 1024

	// GB represents base2 gigabyte
	GB = MB * 1024

	// TB represents base2 terabyte
	TB = GB * 1024
)

Types

type DB

type DB struct {
	*cask.DB
}

DB represents gocask A Log-Structured Hash Table for Fast Key/Value Data Based on https://riak.com/assets/bitcask-intro.pdf

func Open

func Open(dbPath string, opts ...Option) (*DB, error)

Open opens an existing database at dbPath or creates a new one The database location can be configured with config options and the default is ~/gcdata Magic in:mem:db value for dbPath can be used in order to instantiate an in memory file system which can be used for testing purposes

type Option

type Option func(config cask.Config) cask.Config

Option represents gocask configuration option

func WithDataDir

func WithDataDir(path string) Option

WithDataDir configures the location of the data dir where your databases will reside

func WithMaxDataFileSize

func WithMaxDataFileSize(bytes int64) Option

WithMaxDataFileSize configures maximum data file size after which data files will be rotated