rabosh-core/app.oreshkov.rabosh.core

Package-level declarations

Types

CorruptLogException

class CorruptLogException(message: String, val file: String, val offset: Long = -1, cause: Throwable? = null) : StoreException

The write-ahead log cannot be read as one this implementation wrote.

CorruptManifestException

class CorruptManifestException(message: String, val file: String, val offset: Long = -1, cause: Throwable? = null) : StoreException

The manifest cannot be read as one this implementation wrote.

CorruptSegmentException

class CorruptSegmentException(message: String, val file: String, val offset: Long = -1, cause: Throwable? = null) : StoreException

A sorted segment cannot be read as one this implementation wrote.

class DocumentCursor : AutoCloseable

An ordered walk over the documents a store holds, as one view of it sees them.

class DocumentStore : AutoCloseable

A durable, ordered store of JSON documents keyed by byte string.

enum Durability : Enum<Durability>

When a commit is forced to stable storage.

class Key : Comparable<Key>

A document key: an opaque byte string ordered as unsigned bytes.

LogRecoveryMode

enum LogRecoveryMode : Enum<LogRecoveryMode>

How much of a damaged log the engine is willing to read.

SegmentObservation

interface SegmentObservation

One segment's worth of observation.

SegmentObserver

interface SegmentObserver

A listener on the documents that pass through segment writing.

class SegmentSummary

What an observer is told about a finished segment.

class Snapshot : AutoCloseable

A fixed view of the store, taken at a sequence number.

StoreClosedException

class StoreClosedException(message: String) : StoreException

The store has been closed. A programming error, not a data error.

sealed class StoreException : RuntimeException

Base class for every failure the storage core raises on its own account.

StoreFailedException

class StoreFailedException(message: String, cause: Throwable) : StoreException

A write failed against the filesystem, and the store has stopped accepting new ones.

StoreLockedException

class StoreLockedException(message: String, cause: Throwable? = null) : StoreException

Another process — or another DocumentStore in this process — already holds the directory.

class StoreOptions(val durability: Durability = Durability.SYNC, val memtableMaxBytes: Long = DEFAULT_MEMTABLE_MAX_BYTES, val recoveryMode: LogRecoveryMode = LogRecoveryMode.TOLERATE_TORN_TAIL, val createIfMissing: Boolean = true, val segmentMaxBytes: Long = DEFAULT_SEGMENT_MAX_BYTES, val blockSize: Int = DEFAULT_BLOCK_SIZE, val bloomBitsPerKey: Int = DEFAULT_BLOOM_BITS_PER_KEY, val l0CompactionTrigger: Int = DEFAULT_L0_COMPACTION_TRIGGER, val baseLevelBytes: Long = DEFAULT_BASE_LEVEL_BYTES, val levelSizeMultiplier: Int = DEFAULT_LEVEL_SIZE_MULTIPLIER, val backgroundMaintenance: Boolean = true, val segmentObserver: SegmentObserver? = null)

Tuning for DocumentStore.open.

class StoreStats

A snapshot of what the store is holding, for tests, benchmarks and operational visibility.

UnsupportedFormatException

class UnsupportedFormatException(message: String) : StoreException

The directory holds files written by a newer format version.

class WriteBatch

A group of writes that commit together.

Properties

DEFAULT_BASE_LEVEL_BYTES

const val DEFAULT_BASE_LEVEL_BYTES: Long

Default byte budget for level 1; each level below it is DEFAULT_LEVEL_SIZE_MULTIPLIER times larger.

DEFAULT_BLOCK_SIZE

const val DEFAULT_BLOCK_SIZE: Int

Default block size: 4 KiB, one page.

DEFAULT_BLOOM_BITS_PER_KEY

const val DEFAULT_BLOOM_BITS_PER_KEY: Int = 10

Default bloom budget: 10 bits per key, a roughly 1% false-positive rate.

DEFAULT_L0_COMPACTION_TRIGGER

const val DEFAULT_L0_COMPACTION_TRIGGER: Int = 4

Default number of level-0 segments that triggers a compaction.

DEFAULT_LEVEL_SIZE_MULTIPLIER

const val DEFAULT_LEVEL_SIZE_MULTIPLIER: Int = 10

Default growth factor between levels.

DEFAULT_MEMTABLE_MAX_BYTES

const val DEFAULT_MEMTABLE_MAX_BYTES: Long

Default memtable ceiling: 64 MiB, the same working-set size RocksDB defaults to.

DEFAULT_SEGMENT_MAX_BYTES

const val DEFAULT_SEGMENT_MAX_BYTES: Long

Default ceiling on one sorted segment: 8 MiB.

const val LEVEL_COUNT: Int = 7

Number of levels below level 0. Seven levels at a factor of ten reach far past any embedded store.