Skip to main content

SegmentWriterConfig

Struct SegmentWriterConfig 

Source
pub struct SegmentWriterConfig {
    pub row_group_size: usize,
    pub max_row_group_size: usize,
    pub compress: bool,
    pub float_encoding: FloatEncoding,
    pub compression_codec: CompressionCodec,
    pub zstd_level: i32,
    pub column_codec_overrides: HashMap<String, CompressionCodec>,
    pub target_segment_size_bytes: usize,
    pub bloom_fpr: f64,
    pub zstd_dict_training: bool,
    pub field_encryption: FieldEncryptionConfig,
}
Expand description

Configuration for the segment writer.

Fields§

§row_group_size: usize

Maximum rows per row group.

§max_row_group_size: usize

Maximum rows per row group for memory-limiting purposes.

When set, the writer will split row groups to ensure that no single row group exceeds this number of rows. This bounds peak memory usage during encoding: only max_row_group_size rows worth of encoded column buffers are held in memory at any time.

Defaults to DEFAULT_ROW_GROUP_SIZE (65 536 rows). Reducing this trades write throughput (more row groups, more metadata) for lower peak memory consumption.

§compress: bool

Whether to apply compression after encoding.

§float_encoding: FloatEncoding

Float encoding strategy.

§compression_codec: CompressionCodec

Compression codec (LZ4, Zstd, or None).

§zstd_level: i32

Zstd compression level (1–22). Only used when compression_codec is Zstd.

§column_codec_overrides: HashMap<String, CompressionCodec>

Per-column codec overrides. Keys are column names; values override the default compression_codec for that column.

§target_segment_size_bytes: usize

Advisory maximum segment file size in bytes (default: 256 MiB).

When the estimated segment size exceeds this threshold, the flush logic in the database layer should split the data into multiple segments. This keeps individual segment files manageable for compaction, object-store upload, and cache eviction.

Note: This is an advisory limit — the writer itself produces a single segment file. Size-based splitting is enforced by the flush layer (chronix-memtable::flush::flush_frozen), which estimates the compressed row size and splits large measurement batches into multiple SegmentWriter instances.

§bloom_fpr: f64

Bloom filter false-positive rate (default: 0.01 = 1%).

Lower values improve query pruning at the cost of larger bloom filter bitmaps. Recommended values: Low cardinality (<100 unique): 0.001 Default workloads: 0.01 High cardinality (>100K unique): 0.05

§zstd_dict_training: bool

Enable Zstd dictionary training.

When true and compression_codec is Zstd, the writer collects encoded column blocks from the first row group as training samples, trains a dictionary via zstd::dict::from_samples, and compresses subsequent row groups with the trained dictionary. The dictionary is embedded in the segment metadata for the reader.

Most beneficial when row groups are small (< 64 KiB) and values contain repeating structure (e.g. string tags, enum fields).

§field_encryption: FieldEncryptionConfig

Per-column field-level encryption configuration.

Only columns listed here are encrypted with AES-256-GCM. Encrypted columns have their statistics (min/max/sum/distinct) zeroed to prevent information leakage through zone maps.

Trait Implementations§

Source§

impl Clone for SegmentWriterConfig

Source§

fn clone(&self) -> SegmentWriterConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for SegmentWriterConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SegmentWriterConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more