Type Alias FrontendOptions

type FrontendOptions = GreptimeOptions<FrontendOptions>;

Aliased Type

struct FrontendOptions {
    pub runtime: RuntimeOptions,
    pub plugins: Vec<PluginOptions>,
    pub component: FrontendOptions,
}

Fields

runtime: RuntimeOptions

The runtime options.

plugins: Vec<PluginOptions>

The plugin options.

component: FrontendOptions

The options of each component (like Datanode or Standalone) of GreptimeDB.

Trait Implementations

impl<T: Clone> Clone for GreptimeOptions<T>

fn clone(&self) -> GreptimeOptions<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Configurable> Configurable for GreptimeOptions<T>

fn env_list_keys() -> Option<&'static [&'static str]>

List of toml keys that should be parsed as a list.

fn load_layered_options( config_file: Option<&str>, env_prefix: &str, ) -> Result<Self, Error>

Load the configuration from multiple sources and merge them. The precedence order is: config file > environment variables > default values. env_prefix is the prefix of environment variables, e.g. “FRONTEND__xxx”. The function will use dunder(double underscore) __ as the separator for environment variables, for example: DATANODE__STORAGE__MANIFEST__CHECKPOINT_MARGIN will be mapped to DatanodeOptions.storage.manifest.checkpoint_margin field in the configuration. list_keys is the list of keys that should be parsed as a list, for example, you can pass Some(&["meta_client_options.metasrv_addrs"] to parse GREPTIMEDB_METASRV__META_CLIENT_OPTIONS__METASRV_ADDRS as a list. The function will use comma , as the separator for list values, for example: 127.0.0.1:3001,127.0.0.1:3002,127.0.0.1:3003.

fn validate_sanitize(&mut self) -> Result<(), Error>

Validate(and possibly sanitize) the configuration.

fn to_toml(&self) -> Result<String, Error>

Serialize the configuration to a TOML string.

impl<T: Debug> Debug for GreptimeOptions<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for GreptimeOptions<T>

fn default() -> GreptimeOptions<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for GreptimeOptions<T>

where GreptimeOptions<T>: Default, T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for GreptimeOptions<T>

fn eq(&self, other: &GreptimeOptions<T>) -> 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<T> Serialize for GreptimeOptions<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for GreptimeOptions<T>