Struct MetaNodeOpts

pub struct MetaNodeOpts {

    pub listen_addr: String,
    pub advertise_addr: String,
    pub dashboard_host: Option<String>,
    pub prometheus_listener_addr: Option<String>,
    pub sql_endpoint: Option<Secret<String>>,
    pub sql_username: String,
    pub sql_password: Secret<String>,
    pub sql_database: String,
    pub prometheus_endpoint: Option<String>,
    pub prometheus_selector: Option<String>,
    pub privatelink_endpoint_default_tags: Option<String>,
    pub vpc_id: Option<String>,
    pub security_group_id: Option<String>,
    pub config_path: String,
    pub backend: Option<MetaBackend>,
    pub barrier_interval_ms: Option<u32>,
    pub sstable_size_mb: Option<u32>,
    pub block_size_kb: Option<u32>,
    pub bloom_false_positive: Option<f64>,
    pub state_store: Option<String>,
    pub data_directory: Option<String>,
    pub do_not_config_object_storage_lifecycle: Option<bool>,
    pub backup_storage_url: Option<String>,
    pub backup_storage_directory: Option<String>,
    pub heap_profiling_dir: Option<String>,
    pub dangerous_max_idle_secs: Option<u64>,
    pub connector_rpc_endpoint: Option<String>,
    pub license_key: Option<LicenseKey>,
    pub license_key_path: Option<PathBuf>,
    pub secret_store_private_key_hex: Option<String>,
    pub temp_secret_file_dir: String,
}

Fields

listen_addr: String

advertise_addr: String

The address for contacting this instance of the service. This would be synonymous with the service’s “public address” or “identifying address”. It will serve as a unique identifier in cluster membership and leader election. Must be specified for meta backend.

dashboard_host: Option<String>

prometheus_listener_addr: Option<String>

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

sql_endpoint: Option<Secret<String>>

Endpoint of the SQL service, make it non-option when SQL service is required.

sql_username: String

Username of sql backend, required when meta backend set to MySQL or PostgreSQL.

sql_password: Secret<String>

Password of sql backend, required when meta backend set to MySQL or PostgreSQL.

sql_database: String

Database of sql backend, required when meta backend set to MySQL or PostgreSQL.

prometheus_endpoint: Option<String>

The HTTP REST-API address of the Prometheus instance associated to this cluster. This address is used to serve PromQL queries to Prometheus. It is also used by Grafana Dashboard Service to fetch metrics and visualize them.

prometheus_selector: Option<String>

The additional selector used when querying Prometheus.

The format is same as PromQL. Example: instance="foo",namespace="bar"

privatelink_endpoint_default_tags: Option<String>

Default tag for the endpoint created when creating a privatelink connection. Will be appended to the tags specified in the tags field in with clause in create connection.

vpc_id: Option<String>

security_group_id: Option<String>

config_path: String

The path of risingwave.toml configuration file.

If empty, default configuration values will be used.

backend: Option<MetaBackend>

barrier_interval_ms: Option<u32>

The interval of periodic barrier.

sstable_size_mb: Option<u32>

Target size of the Sstable.

block_size_kb: Option<u32>

Size of each block in bytes in SST.

bloom_false_positive: Option<f64>

False positive probability of bloom filter.

state_store: Option<String>

State store url

data_directory: Option<String>

Remote directory for storing data and metadata objects.

do_not_config_object_storage_lifecycle: Option<bool>

Whether config object storage bucket lifecycle to purge stale data.

backup_storage_url: Option<String>

Remote storage url for storing snapshots.

backup_storage_directory: Option<String>

Remote directory for storing snapshots.

heap_profiling_dir: Option<String>

Enable heap profile dump when memory usage is high.

dangerous_max_idle_secs: Option<u64>

Exit if idle for a certain period of time.

connector_rpc_endpoint: Option<String>

👎Deprecated: connector node has been deprecated.

Endpoint of the connector node.

license_key: Option<LicenseKey>

The license key to activate enterprise features.

license_key_path: Option<PathBuf>

The path of the license key file to be watched and hot-reloaded.

secret_store_private_key_hex: Option<String>

128-bit AES key for secret store in HEX format.

temp_secret_file_dir: String

The path of the temp secret file directory.

Trait Implementations

impl Args for MetaNodeOpts

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 MetaNodeOpts

fn clone(&self) -> MetaNodeOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for MetaNodeOpts

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 MetaNodeOpts

where String: Debug, Option<String>: Debug, Option<Secret<String>>: Debug, Secret<String>: Debug, Option<MetaBackend>: Debug, Option<u32>: Debug, Option<f64>: Debug, Option<bool>: Debug, Option<u64>: Debug, Option<LicenseKey>: Debug, Option<PathBuf>: Debug,

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

Formats the value using the given formatter.

impl FromArgMatches for MetaNodeOpts

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 MetaNodeOpts

fn name() -> &'static str

The name of the component.

fn meta_addr(&self) -> MetaAddressStrategy

The address to the meta node.

impl OverrideConfig for MetaNodeOpts

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

impl Parser for MetaNodeOpts

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.