Struct RegionOptions 

pub struct RegionOptions {

    pub ttl: Option<TimeToLive>,
    pub auto_flush_interval: Option<Duration>,
    pub compaction: CompactionOptions,
    pub compaction_override: bool,
    pub storage: Option<String>,
    pub append_mode: bool,
    pub skip_wal: bool,
    pub wal_options: WalOptions,
    pub index_options: IndexOptions,
    pub memtable: Option<MemtableOptions>,
    pub merge_mode: Option<MergeMode>,
    pub sst_format: Option<FormatType>,
    pub max_row_group_row_count: Option<usize>,
    pub primary_key_encoding: Option<PrimaryKeyEncoding>,
    pub write_buffer_size: Option<ReadableSize>,
}

Options that affect the entire region.

Users need to specify the options while creating/opening a region.

Fields

ttl: Option<TimeToLive>

Region SST files TTL.

auto_flush_interval: Option<Duration>

Per-region auto flush interval override. Falls back to the global auto_flush_interval engine config when unset.

compaction: CompactionOptions

Compaction options.

compaction_override: bool

storage: Option<String>

Custom storage. Uses default storage if it is None.

append_mode: bool

If append mode is enabled, the region keeps duplicate rows.

skip_wal: bool

Whether to skip writing new WAL entries.

wal_options: WalOptions

Wal options.

index_options: IndexOptions

Index options.

memtable: Option<MemtableOptions>

Memtable options.

merge_mode: Option<MergeMode>

The mode to merge duplicate rows. Only takes effect when append_mode is false.

sst_format: Option<FormatType>

SST format type.

max_row_group_row_count: Option<usize>

Max number of rows in a parquet row group. Uses DEFAULT_ROW_GROUP_SIZE if None.

primary_key_encoding: Option<PrimaryKeyEncoding>

Internal primary key encoding override used by metric-engine.

write_buffer_size: Option<ReadableSize>

Per-region write buffer size. A positive size flushes/stalls this region independently of the global write buffer limit and rejects writes at twice the configured size; zero disables both limits.

Implementations

impl RegionOptions

pub fn validate(&self) -> Result<()>

Validates options.

pub fn row_group_size(&self) -> usize

Returns the configured row group size, falling back to DEFAULT_ROW_GROUP_SIZE.

pub fn need_dedup(&self) -> bool

Returns true if deduplication is needed.

pub fn merge_mode(&self) -> MergeMode

Returns the merge_mode if it is set, otherwise returns the default MergeMode.

pub fn auto_flush_interval_or(&self, default: Duration) -> Duration

Returns the auto_flush_interval if it is set, otherwise returns default.

pub fn primary_key_encoding(&self) -> PrimaryKeyEncoding

Returns the primary_key_encoding if it is set, otherwise returns the default [PrimaryKeyEncoding].

impl RegionOptions

pub fn try_from_options( region_id: RegionId, options_map: &HashMap<String, String>, ) -> Result<Self>

Parses RegionOptions from the raw options_map.

Trait Implementations

impl Clone for RegionOptions

fn clone(&self) -> RegionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegionOptions

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

Formats the value using the given formatter.

impl Default for RegionOptions

fn default() -> RegionOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RegionOptions

where RegionOptions: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RegionOptions

fn eq(&self, other: &RegionOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RegionOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RegionOptions

impl StructuralPartialEq for RegionOptions