Struct FrontendOpts

pub struct FrontendOpts {
    pub listen_addr: String,
    pub tcp_keepalive_idle_secs: usize,
    pub advertise_addr: Option<String>,
    pub meta_addr: MetaAddressStrategy,
    pub prometheus_listener_addr: String,
    pub frontend_rpc_listener_addr: String,
    pub config_path: String,
    pub metrics_level: Option<MetricLevel>,
    pub enable_barrier_read: Option<bool>,
    pub temp_secret_file_dir: String,
    pub frontend_total_memory_bytes: usize,
}

Command-line arguments for frontend-node.

Fields

listen_addr: String

The address that this service listens to. Usually the localhost + desired port.

tcp_keepalive_idle_secs: usize

The amount of time with no network activity after which the server will send a TCP keepalive message to the client.

advertise_addr: Option<String>

The address for contacting this instance of the service. This would be synonymous with the service’s “public address” or “identifying address”. Optional, we will use listen_addr if not specified.

meta_addr: MetaAddressStrategy

The address via which we will attempt to connect to a leader meta node.

prometheus_listener_addr: String

We will start a http server at this address via MetricsManager. Then the prometheus instance will poll the metrics from this address.

frontend_rpc_listener_addr: String

config_path: String

The path of risingwave.toml configuration file.

If empty, default configuration values will be used.

Note that internal system parameters should be defined in the configuration file at risingwave_common::config instead of command line arguments.

metrics_level: Option<MetricLevel>

Used for control the metrics level, similar to log level.

level = 0: disable metrics level > 0: enable metrics

enable_barrier_read: Option<bool>

temp_secret_file_dir: String

The path of the temp secret file directory.

frontend_total_memory_bytes: usize

Total available memory for the frontend node in bytes. Used for batch computing.

Trait Implementations

impl Args for FrontendOpts

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

impl Clone for FrontendOpts

fn clone(&self) -> FrontendOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for FrontendOpts

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for FrontendOpts

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

Formats the value using the given formatter.

impl Default for FrontendOpts

fn default() -> Self

Returns the “default value” for a type.

impl FromArgMatches for FrontendOpts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Opts for FrontendOpts

fn name() -> &'static str

The name of the component.

fn meta_addr(&self) -> MetaAddressStrategy

The address to the meta node.

impl OverrideConfig for FrontendOpts

fn override(&self, config: &mut RwConfig)

impl Parser for FrontendOpts

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.