baradb

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

type DBOptions struct {
	// Directory of a DB engine instance where data files are stored in
	Directory string

	// Maximum size of every single data file (uint: Byte).
	//
	// It should be greater than 0.
	MaxDataFileSize int64

	// SyncWrites indicates whether persist data after writing
	SyncWrites bool

	// IndexType indicates the type of the index of the DB engine
	IndexType index.IndexType

	// SyncThreshold indicates a threshold for persisting data.
	//
	// It should equals 0 or be greater than 0 (uint: Byte).
	//
	// When the DB engine wrote bytes more than this threshold, the DB engine will sync the wirtten bytes to the acitve data file.
	SyncThreshold uint

	// MMapAtStartup indicates whether load memory mapping while starting up the DB engine
	MMapAtStartup bool

	// MergenceThreshold indicates a threshold for merging data.
	//
	// When proportion of the invalid data in the DB engine is greater than this threshold,
	// the DB engine will merge all its data.
	//
	// The value of this threshold should be between 0 and 1.
	//
	// If the value is 0, then this threshold is disabled and the DB engine will not merge its data.
	MergenceThreshold float64
}

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

type Stat struct {
	KeyNumber       uint  `json:"keyNumber"`       // Number of key(s) in the DB engine
	DataFileNumber  uint  `json:"dataFileNumber"`  // Number of data file(s) in the DB engine
	ReclaimableSize int64 `json:"reclaimableSize"` // Amount of mergable data (unit: byte)
	DiskSize        int64 `json:"diskSize"`        // Size of the DB engine occuppied in disk (unit: byte)
}

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

type WriteBatchOptions struct {
	MaxBatchNumber int  // Maximum amount of data in one batch
	SyncWrites     bool // Sync data after writing if true
}