StoreOptions

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.

A plain class with default arguments rather than a data class: copy and componentN would become part of the published ABI, and adding an option later would then be a binary-incompatible change to a type whose whole purpose is to grow.

Constructors

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Whether flush and compaction run on a background thread.

Link copied to clipboard

Byte budget for level 1.

Link copied to clipboard

Approximate size of a segment's data blocks. See DEFAULT_BLOCK_SIZE.

Link copied to clipboard

Bits of bloom filter per distinct key in a segment.

Link copied to clipboard

Whether DocumentStore.open may create the directory.

Link copied to clipboard

When commits reach stable storage. See Durability.

Link copied to clipboard

Level-0 segments that trigger a compaction. See DEFAULT_L0_COMPACTION_TRIGGER.

Link copied to clipboard

Growth factor between levels.

Link copied to clipboard

Approximate ceiling on the active memtable, in bytes. Reaching it seals the memtable and starts a new log; see DocumentStore.rotate.

Link copied to clipboard

How much of a damaged log may be read. See LogRecoveryMode.

Link copied to clipboard

Approximate ceiling on one sorted segment, in bytes.

Link copied to clipboard

Where documents are reported as they are written into segments. See SegmentObserver.

Functions

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard

These options with a different segmentObserver, everything else unchanged.