Struct FrontendOptions 

pub struct FrontendOptions {

    pub node_id: Option<String>,
    pub default_timezone: Option<String>,
    pub default_column_prefix: Option<String>,
    pub auto_create_table: bool,
    pub max_in_flight_write_bytes: ReadableSize,
    pub write_bytes_exhausted_policy: OnExhaustedPolicy,
    pub http: HttpOptions,
    pub grpc: GrpcOptions,
    pub internal_grpc: Option<GrpcOptions>,
    pub mysql: MysqlOptions,
    pub postgres: PostgresOptions,
    pub opentsdb: OpentsdbOptions,
    pub influxdb: InfluxdbOptions,
    pub pending_rows_batcher: PendingRowsBatcherOptions,
    pub prom_store: PromStoreOptions,
    pub jaeger: JaegerOptions,
    pub otlp: OtlpOptions,
    pub meta_client: Option<MetaClientOptions>,
    pub logging: LoggingOptions,
    pub datanode: DatanodeClientOptions,
    pub write_retry: WriteRetryOptions,
    pub user_provider: Option<String>,
    pub tracing: TracingOptions,
    pub query: QueryOptions,
    pub slow_query: SlowQueryOptions,
    pub memory: MemoryOptions,
    pub pipeline: PipelineOptions,
    pub event_recorder: EventRecorderOptions,
    pub heartbeat_env_vars: Vec<String>,
}

Configures frontend protocols, query execution, and distributed write retries.

Fields

node_id: Option<String>

default_timezone: Option<String>

default_column_prefix: Option<String>

auto_create_table: bool

Server-side global switch for auto table creation on write. Acts as an upper bound: when false, missing tables are never auto-created even if a request sets the auto_create_table hint to true. When true (default), the per-request hint still applies. Default: true.

max_in_flight_write_bytes: ReadableSize

Maximum total memory for all concurrent write request bodies and messages (HTTP, gRPC, Flight). Set to 0 to disable the limit. Default: “0” (unlimited)

write_bytes_exhausted_policy: OnExhaustedPolicy

Policy when write bytes quota is exhausted. Options: “wait” (default, 10s), “wait()”, “fail”

http: HttpOptions

grpc: GrpcOptions

internal_grpc: Option<GrpcOptions>

The internal gRPC options for the frontend service. It serves the same services as the public one plus the internal handler. CORS is always off on it.

mysql: MysqlOptions

postgres: PostgresOptions

opentsdb: OpentsdbOptions

influxdb: InfluxdbOptions

pending_rows_batcher: PendingRowsBatcherOptions

Ordinary-table batching with independent logical-table controls.

prom_store: PromStoreOptions

jaeger: JaegerOptions

otlp: OtlpOptions

meta_client: Option<MetaClientOptions>

logging: LoggingOptions

datanode: DatanodeClientOptions

write_retry: WriteRetryOptions

Retry policy for retryable distributed write failures.

user_provider: Option<String>

tracing: TracingOptions

query: QueryOptions

slow_query: SlowQueryOptions

memory: MemoryOptions

pipeline: PipelineOptions

The pipeline options.

event_recorder: EventRecorderOptions

The event recorder options.

heartbeat_env_vars: Vec<String>

Environment variable keys to read and report in heartbeat messages.

Implementations

impl FrontendOptions

pub(crate) fn table_batcher_options(&self) -> &BatcherOptions

Explicit configuration wins even when it disables batching.

pub(crate) fn logical_batcher_options(&self) -> BatcherOptions

Resolve legacy Prom controls once without merging fields across config blocks.

Trait Implementations

impl Clone for FrontendOptions

fn clone(&self) -> FrontendOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Configurable for FrontendOptions

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 Debug for FrontendOptions

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

Formats the value using the given formatter.

impl Default for FrontendOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FrontendOptions

where FrontendOptions: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FrontendOptions

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FrontendOptions