options.go

package gobitcask

import "os"

type Options struct {
	// 数据库存放数据的目录
	DirPath string

	// 数据文件的大小
	DataFileSize int64

	// 内存索引类型
	IndexType IndexerType

	// 每次写数据是否持久化
	SyncWrite bool

	// 累计写到一定阈值再进行持久化
	BytesPerSync uint

	// 启动时是否需要以 mmap 的方式加载
	MMapAtStartup bool
}

// IteratorOptions 迭代器配置项
type IteratorOptions struct {
	// 遍历前缀为指定值的 key，默认为空
	Prefix []byte

	// 是否反向迭代， 默认 false 正向迭代
	Reverse bool
}

// WriteBatchOptions 批量写配置项
type WriteBatchOptions struct {
	// 一个批次当中最大的数据量
	MaxBatchNum uint
	// 提交时是否 sync 持久化
	SyncWrites bool
}

type IndexerType = int8

const (
	// BTree 索引
	BTree IndexerType = iota + 1

	// B+Tree 索引, 索引在磁盘上
	BPlusTree
)

var DefaultOption = Options{
	DirPath:       os.TempDir(),
	DataFileSize:  256 * 1024 * 1024, // 256MB
	IndexType:     BTree,
	SyncWrite:     false,
	BytesPerSync:  0,
	MMapAtStartup: true,
}

var DefaultIteratorOption = IteratorOptions{
	Prefix:  nil,
	Reverse: false,
}

var DefaultWriteBatchOptions = WriteBatchOptions{
	MaxBatchNum: 10000,
	SyncWrites:  true,
}