risingwave_storage::opts

Struct StorageOpts

source
pub struct StorageOpts {
Show 78 fields pub parallel_compact_size_mb: u32, pub sstable_size_mb: u32, pub min_sstable_size_mb: u32, pub block_size_kb: u32, pub bloom_false_positive: f64, pub share_buffers_sync_parallelism: u32, pub share_buffer_compaction_worker_threads_number: u32, pub shared_buffer_capacity_mb: usize, pub shared_buffer_flush_ratio: f32, pub shared_buffer_min_batch_flush_size_mb: usize, pub data_directory: String, pub write_conflict_detection_enabled: bool, pub block_cache_capacity_mb: usize, pub block_cache_shard_num: usize, pub block_cache_eviction_config: EvictionConfig, pub meta_cache_capacity_mb: usize, pub meta_cache_shard_num: usize, pub meta_cache_eviction_config: EvictionConfig, pub prefetch_buffer_capacity_mb: usize, pub max_cached_recent_versions_number: usize, pub max_prefetch_block_number: usize, pub disable_remote_compactor: bool, pub share_buffer_upload_concurrency: usize, pub compactor_memory_limit_mb: usize, pub compact_iter_recreate_timeout_ms: u64, pub sstable_id_remote_fetch_number: u32, pub min_sst_size_for_streaming_upload: u64, pub max_concurrent_compaction_task_number: u64, pub max_version_pinning_duration_sec: u64, pub compactor_iter_max_io_retry_times: usize, pub data_file_cache_dir: String, pub data_file_cache_capacity_mb: usize, pub data_file_cache_file_capacity_mb: usize, pub data_file_cache_flushers: usize, pub data_file_cache_reclaimers: usize, pub data_file_cache_recover_mode: RecoverMode, pub data_file_cache_recover_concurrency: usize, pub data_file_cache_insert_rate_limit_mb: usize, pub data_file_cache_indexer_shards: usize, pub data_file_cache_compression: Compression, pub data_file_cache_flush_buffer_threshold_mb: usize, pub data_file_cache_runtime_config: RuntimeOptions, pub cache_refill_data_refill_levels: Vec<u32>, pub cache_refill_timeout_ms: u64, pub cache_refill_concurrency: usize, pub cache_refill_recent_filter_layers: usize, pub cache_refill_recent_filter_rotate_interval_ms: usize, pub cache_refill_unit: usize, pub cache_refill_threshold: f64, pub meta_file_cache_dir: String, pub meta_file_cache_capacity_mb: usize, pub meta_file_cache_file_capacity_mb: usize, pub meta_file_cache_flushers: usize, pub meta_file_cache_reclaimers: usize, pub meta_file_cache_recover_mode: RecoverMode, pub meta_file_cache_recover_concurrency: usize, pub meta_file_cache_insert_rate_limit_mb: usize, pub meta_file_cache_indexer_shards: usize, pub meta_file_cache_compression: Compression, pub meta_file_cache_flush_buffer_threshold_mb: usize, pub meta_file_cache_runtime_config: RuntimeOptions, pub backup_storage_url: String, pub backup_storage_directory: String, pub max_preload_wait_time_mill: u64, pub compactor_max_sst_key_count: u64, pub compactor_max_task_multiplier: f32, pub compactor_max_sst_size: u64, pub enable_fast_compaction: bool, pub check_compaction_result: bool, pub max_preload_io_retry_times: usize, pub compactor_fast_max_compact_delete_ratio: u32, pub compactor_fast_max_compact_task_size: u64, pub mem_table_spill_threshold: usize, pub compactor_concurrent_uploading_sst_count: Option<usize>, pub compactor_max_overlap_sst_count: usize, pub compactor_max_preload_meta_file_count: usize, pub object_store_config: ObjectStoreConfig, pub time_travel_version_cache_capacity: u64,
}

Fields§

§parallel_compact_size_mb: u32

The size of parallel task for one compact/flush job.

§sstable_size_mb: u32

Target size of the Sstable.

§min_sstable_size_mb: u32

Minimal target size of the Sstable to store data of different state-table in independent files as soon as possible.

§block_size_kb: u32

Size of each block in bytes in SST.

§bloom_false_positive: f64

False positive probability of bloom filter.

§share_buffers_sync_parallelism: u32

parallelism while syncing share buffers into L0 SST. Should NOT be 0.

§share_buffer_compaction_worker_threads_number: u32

Worker threads number of dedicated tokio runtime for share buffer compaction. 0 means use tokio’s default value (number of CPU core).

§shared_buffer_capacity_mb: usize

Maximum shared buffer size, writes attempting to exceed the capacity will stall until there is enough space.

§shared_buffer_flush_ratio: f32

The shared buffer will start flushing data to object when the ratio of memory usage to the shared buffer capacity exceed such ratio.

§shared_buffer_min_batch_flush_size_mb: usize

The minimum total flush size of shared buffer spill. When a shared buffer spill is trigger, the total flush size across multiple epochs should be at least higher than this size.

§data_directory: String

Remote directory for storing data and metadata objects.

§write_conflict_detection_enabled: bool

Whether to enable write conflict detection

§block_cache_capacity_mb: usize

Capacity of sstable block cache.

§block_cache_shard_num: usize

the number of block-cache shard. Less shard means that more concurrent-conflict.

§block_cache_eviction_config: EvictionConfig

Eviction config for block cache.

§meta_cache_capacity_mb: usize

Capacity of sstable meta cache.

§meta_cache_shard_num: usize

the number of meta-cache shard. Less shard means that more concurrent-conflict.

§meta_cache_eviction_config: EvictionConfig

Eviction config for meta cache.

§prefetch_buffer_capacity_mb: usize

max memory usage for large query.

§max_cached_recent_versions_number: usize§max_prefetch_block_number: usize§disable_remote_compactor: bool§share_buffer_upload_concurrency: usize

Number of tasks shared buffer can upload in parallel.

§compactor_memory_limit_mb: usize

Capacity of sstable meta cache.

§compact_iter_recreate_timeout_ms: u64

compactor streaming iterator recreate timeout. deprecated

§sstable_id_remote_fetch_number: u32

Number of SST ids fetched from meta per RPC

§min_sst_size_for_streaming_upload: u64

Whether to enable streaming upload for sstable.

§max_concurrent_compaction_task_number: u64§max_version_pinning_duration_sec: u64§compactor_iter_max_io_retry_times: usize§data_file_cache_dir: String§data_file_cache_capacity_mb: usize§data_file_cache_file_capacity_mb: usize§data_file_cache_flushers: usize§data_file_cache_reclaimers: usize§data_file_cache_recover_mode: RecoverMode§data_file_cache_recover_concurrency: usize§data_file_cache_insert_rate_limit_mb: usize§data_file_cache_indexer_shards: usize§data_file_cache_compression: Compression§data_file_cache_flush_buffer_threshold_mb: usize§data_file_cache_runtime_config: RuntimeOptions§cache_refill_data_refill_levels: Vec<u32>§cache_refill_timeout_ms: u64§cache_refill_concurrency: usize§cache_refill_recent_filter_layers: usize§cache_refill_recent_filter_rotate_interval_ms: usize§cache_refill_unit: usize§cache_refill_threshold: f64§meta_file_cache_dir: String§meta_file_cache_capacity_mb: usize§meta_file_cache_file_capacity_mb: usize§meta_file_cache_flushers: usize§meta_file_cache_reclaimers: usize§meta_file_cache_recover_mode: RecoverMode§meta_file_cache_recover_concurrency: usize§meta_file_cache_insert_rate_limit_mb: usize§meta_file_cache_indexer_shards: usize§meta_file_cache_compression: Compression§meta_file_cache_flush_buffer_threshold_mb: usize§meta_file_cache_runtime_config: RuntimeOptions§backup_storage_url: String

The storage url for storing backups.

§backup_storage_directory: String

The storage directory for storing backups.

§max_preload_wait_time_mill: u64

max time which wait for preload. 0 represent do not do any preload.

§compactor_max_sst_key_count: u64§compactor_max_task_multiplier: f32§compactor_max_sst_size: u64§enable_fast_compaction: bool

enable FastCompactorRunner.

§check_compaction_result: bool§max_preload_io_retry_times: usize§compactor_fast_max_compact_delete_ratio: u32§compactor_fast_max_compact_task_size: u64§mem_table_spill_threshold: usize§compactor_concurrent_uploading_sst_count: Option<usize>§compactor_max_overlap_sst_count: usize§compactor_max_preload_meta_file_count: usize

The maximum number of meta files that can be preloaded.

§object_store_config: ObjectStoreConfig§time_travel_version_cache_capacity: u64

Trait Implementations§

source§

impl Clone for StorageOpts

source§

fn clone(&self) -> StorageOpts

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for StorageOpts

source§

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

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

impl Default for StorageOpts

source§

fn default() -> Self

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

impl From<&StorageOpts> for SstableBuilderOptions

source§

fn from(options: &StorageOpts) -> SstableBuilderOptions

Converts to this type from the input type.
source§

impl From<(&RwConfig, &SystemParamsReader, &StorageMemoryConfig)> for StorageOpts

source§

fn from( (c, p, s): (&RwConfig, &SystemParamsReader, &StorageMemoryConfig), ) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

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<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

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

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

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

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> IntoResult<T> for T

§

type Err = Infallible

§

fn into_result(self) -> Result<T, <T as IntoResult<T>>::Err>

§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<M> MetricVecRelabelExt for M

source§

fn relabel( self, metric_level: MetricLevel, relabel_threshold: MetricLevel, ) -> RelabeledMetricVec<M>

source§

fn relabel_n( self, metric_level: MetricLevel, relabel_threshold: MetricLevel, relabel_num: usize, ) -> RelabeledMetricVec<M>

source§

fn relabel_debug_1( self, relabel_threshold: MetricLevel, ) -> RelabeledMetricVec<M>

Equivalent to RelabeledMetricVec::with_metric_level_relabel_n with metric_level set to MetricLevel::Debug and relabel_num set to 1.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
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
§

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

§

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

§

impl<T> DevConfig for T
where T: Send + Sync + 'static + Debug,

source§

impl<T> LruValue for T
where T: Send + Sync,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> Value for T
where T: Send + Sync + 'static,