librakv

README

LibraDB

LibraKV is a Go-based key-value database.

Contents

• Requirements
• Installation
• Usage
• License

Requirements

• Go 1.22 or later

Installation

1. Install Go and set your workspace

2. Get the project

go -get https://github.com/Huangkai1008/librakv

Usage

1.Add the libs

go mod download       

2.Run the application

go run cmd/main.go

License

MIT @ Huang Kai

Documentation

Index

• Constants
• Variables
• type Database
  • func Open(dataDir string, opts ...Option) (*Database, error)
• type Key
• type Option
  • func WithLogFileThresholdSize(size uint) Option
• type Options
  • func DefaultOptions() *Options
  • func (o *Options) Apply(opts ...Option) error
• type Value

Constants

const (
	DefaultLogFileSize = 64 << 20 // 64MB
)

const (
	FileLockName = "libra.lock"
)

Variables

var (
	ErrNilOption            = errors.New("nil option provided")
	ErrLogFileThresholdSize = errors.New("log file threshold size cannot be 0")
)

var (
	ErrDatabaseIsRunning = errors.New("database is used by another process")
)

Types

type Database

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

func Open

func Open(dataDir string, opts ...Option) (*Database, error)

Open creates a new Database instance with dataDir and the specified options.

If the dataDir doesn't exist, it will be created automatically.

type Key

type Key []byte

type Option

type Option func(*Options) error

func WithLogFileThresholdSize

func WithLogFileThresholdSize(size uint) Option

type Options

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

Options of the database.

func DefaultOptions

func DefaultOptions() *Options

func (*Options) Apply

func (o *Options) Apply(opts ...Option) error

Apply applies the given options to Options.

type Value

type Value []byte