Module config

This module defines the structure of the configuration file risingwave.toml.

RwConfig corresponds to the whole config file and each other config struct corresponds to a section in risingwave.toml.

Modules

• batch_prefix 🔒
• default
• meta_prefix 🔒
• streaming_prefix 🔒

Macros

• define_system_config 🔒

Structs

• BatchConfig
  The section [batch] in risingwave.toml.
• BatchDeveloperConfig
  The subsections [batch.developer].
• CacheConfig
  the section [storage.cache] in risingwave.toml.
• CacheRefillConfig
• CompactionConfig
• FileCacheConfig
  The subsection [storage.data_file_cache] and [storage.meta_file_cache] in risingwave.toml.
• HeapProfilingConfig
• MetaConfig
  The section [meta] in risingwave.toml.
• MetaDeveloperConfig
  The subsections [meta.developer].
• MetaStoreConfig
• NoOverride
  For non-user-facing components where the CLI arguments do not override the config file.
• ObjectStoreConfig
  The subsections [storage.object_store].
• ObjectStoreRetryConfig
• RwConfig
  RwConfig corresponds to the whole config file risingwave.toml. Each field corresponds to a section.
• S3ObjectStoreConfig
  The subsections [storage.object_store.s3].
• S3ObjectStoreDeveloperConfig
  The subsections [storage.object_store.s3.developer].
• ServerConfig
  The section [server] in risingwave.toml.
• StorageConfig
  The section [storage] in risingwave.toml.
• StorageMemoryConfig
• StreamingConfig
  The section [streaming] in risingwave.toml.
• StreamingDeveloperConfig
  The subsections [streaming.developer].
• SystemConfig
  The section [system] in risingwave.toml. All these fields are used to initialize the system parameters persisted in Meta store. Most fields are for testing purpose only and should not be documented.
• Unrecognized
  Unrecognized fields in a config section. Generic over the config section type to provide better error messages.

Enums

• AsyncStackTraceOption
• CacheEvictionConfig
  the section [storage.cache.eviction] in risingwave.toml.
• CompactorMode
• DefaultParallelism
• EvictionConfig
• MetaBackend
• MetricLevel

Constants

• MAX_BLOCK_CACHE_SHARD_BITS
• MAX_CONNECTION_WINDOW_SIZE
  Use the maximum value for HTTP/2 connection window size to avoid deadlock among multiplexed streams on the same connection.
• MAX_META_CACHE_SHARD_BITS
• MIN_BUFFER_SIZE_PER_SHARD
• STREAM_WINDOW_SIZE
  Use a large value for HTTP/2 stream window size to improve the performance of remote exchange, as we don’t rely on this for back-pressure.

Traits

• OverrideConfig

Functions

• extract_storage_memory_config
• load_config

Derive Macros

• OverrideConfig
  Sections in the configuration file can use #[derive(OverrideConfig)] to generate the implementation of overwriting configs from the file.