FE Configuration
FE parameters are classified into dynamic parameters and static parameters.
-
Dynamic parameters can be configured and adjusted by running SQL commands, which is very convenient. But the configurations become invalid if you restart your FE. Therefore, we recommend that you also modify the configuration items in the fe.conf file to prevent the loss of modifications.
-
Static parameters can only be configured and adjusted in the FE configuration file fe.conf. After you modify this file, you must restart your FE for the changes to take effect.
Whether a parameter is a dynamic parameter is indicated by the IsMutable
column in the output of ADMIN SHOW CONFIG. TRUE
indicates a dynamic parameter.
Note that both dynamic and static FE parameters can be configured in the fe.conf file.
View FE configuration items
After your FE is started, you can run the ADMIN SHOW FRONTEND CONFIG command on your MySQL client to check the parameter configurations. If you want to query the configuration of a specific parameter, run the following command:
ADMIN SHOW FRONTEND CONFIG [LIKE "pattern"];
For detailed description of the returned fields, see ADMIN SHOW CONFIG.
You must have administrator privileges to run cluster administration-related commands.
Configure FE parameters
Configure FE dynamic parameters
You can configure or modify the settings of FE dynamic parameters using ADMIN SET FRONTEND CONFIG.
ADMIN SET FRONTEND CONFIG ("key" = "value");
The configuration changes made with ADMIN SET FRONTEND
will be restored to the default values in the fe.conf
file after the FE restarts. Therefore, we recommend that you also modify the configuration items in fe.conf
if you want the changes to be permanent.
Configure FE static parameters
Static parameters of an FE are set by changing them in the configuration file fe.conf and restarting the FE to allow the changes to take effect.
Understand FE parameters
Logging
log_roll_size_mb
- Default: 1024
- Type: Int
- Unit: MB
- Is mutable: No
- Description: The maximum size of a system log file or an audit log file.
- Introduced in: -
sys_log_dir
- Default: StarRocksFE.STARROCKS_HOME_DIR + "/log"
- Type: String
- Unit: -
- Is mutable: No
- Description: The directory that stores system log files.
- Introduced in: -
sys_log_level
- Default: INFO
- Type: String
- Unit: -
- Is mutable: No
- Description: The severity levels into which system log entries are classified. Valid values:
INFO
,WARN
,ERROR
, andFATAL
. - Introduced in: -
sys_log_roll_num
- Default: 10
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of system log files that can be retained within each retention period specified by the
sys_log_roll_interval
parameter. - Introduced in: -
sys_log_verbose_modules
- Default: Empty string
- Type: String[]
- Unit: -
- Is mutable: No
- Description: The modules for which StarRocks generates system logs. If this parameter is set to
org.apache.starrocks.catalog
, StarRocks generates system logs only for the catalog module. Separate the module names with a comma (,) and a space. - Introduced in: -
sys_log_roll_interval
- Default: DAY
- Type: String
- Unit: -
- Is mutable: No
- Description: The time interval at which StarRocks rotates system log entries. Valid values:
DAY
andHOUR
.- If this parameter is set to
DAY
, a suffix in theyyyyMMdd
format is added to the names of system log files. - If this parameter is set to
HOUR
, a suffix in theyyyyMMddHH
format is added to the names of system log files.
- If this parameter is set to
- Introduced in: -
sys_log_delete_age
- Default: 7d
- Type: String
- Unit: -
- Is mutable: No
- Description: The retention period of system log files. The default value
7d
specifies that each system log file can be retained for 7 days. StarRocks checks each system log file and deletes those that were generated 7 days ago. - Introduced in: -
audit_log_dir
- Default: StarRocksFE.STARROCKS_HOME_DIR + "/log"
- Type: String
- Unit: -
- Is mutable: No
- Description: The directory that stores audit log files.
- Introduced in: -
audit_log_roll_num
- Default: 90
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of audit log files that can be retained within each retention period specified by the
audit_log_roll_interval
parameter. - Introduced in: -
audit_log_modules
- Default: slow_query, query
- Type: String[]
- Unit: -
- Is mutable: No
- Description: The modules for which StarRocks generates audit log entries. By default, StarRocks generates audit logs for the
slow_query
module and thequery
module. Theconnection
module is supported from v3.0. Separate the module names with a comma (,) and a space. - Introduced in: -
qe_slow_log_ms
- Default: 5000
- Type: Long
- Unit: Milliseconds
- Is mutable: Yes
- Description: The threshold used to determine whether a query is a slow query. If the response time of a query exceeds this threshold, it is recorded as a slow query in fe.audit.log.
- Introduced in: -
audit_log_roll_interval
- Default: DAY
- Type: String
- Unit: -
- Is mutable: No
- Description: The time interval at which StarRocks rotates audit log entries. Valid values:
DAY
andHOUR
.- If this parameter is set to
DAY
, a suffix in theyyyyMMdd
format is added to the names of audit log files. - If this parameter is set to
HOUR
, a suffix in theyyyyMMddHH
format is added to the names of audit log files.
- If this parameter is set to
- Introduced in: -
audit_log_delete_age
- Default: 30d
- Type: String
- Unit: -
- Is mutable: No
- Description: The retention period of audit log files. The default value
30d
specifies that each audit log file can be retained for 30 days. StarRocks checks each audit log file and deletes those that were generated 30 days ago. - Introduced in: -
dump_log_dir
- Default: StarRocksFE.STARROCKS_HOME_DIR + "/log"
- Type: String
- Unit: -
- Is mutable: No
- Description: The directory that stores dump log files.
- Introduced in: -
dump_log_roll_num
- Default: 10
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of dump log files that can be retained within each retention period specified by the
dump_log_roll_interval
parameter. - Introduced in: -
dump_log_modules
- Default: query
- Type: String[]
- Unit: -
- Is mutable: No
- Description: The modules for which StarRocks generates dump log entries. By default, StarRocks generates dump logs for the query module. Separate the module names with a comma (,) and a space.
- Introduced in: -
dump_log_roll_interval
- Default: DAY
- Type: String
- Unit: -
- Is mutable: No
- Description: The time interval at which StarRocks rotates dump log entries. Valid values:
DAY
andHOUR
.- If this parameter is set to
DAY
, a suffix in theyyyyMMdd
format is added to the names of dump log files. - If this parameter is set to
HOUR
, a suffix in theyyyyMMddHH
format is added to the names of dump log files.
- If this parameter is set to
- Introduced in: -
dump_log_delete_age
- Default: 7d
- Type: String
- Unit: -
- Is mutable: No
- Description: The retention period of dump log files. The default value
7d
specifies that each dump log file can be retained for 7 days. StarRocks checks each dump log file and deletes those that were generated 7 days ago. - Introduced in: -
Server
frontend_address
- Default: 0.0.0.0
- Type: String
- Unit: -
- Is mutable: No
- Description: The IP address of the FE node.
- Introduced in: -
priority_networks
- Default: Empty string
- Type: String
- Unit: -
- Is mutable: No
- Description: Declares a selection strategy for servers that have multiple IP addresses. Note that at most one IP address must match the list specified by this parameter. The value of this parameter is a list that consists of entries, which are separated with semicolons (;) in CIDR notation, such as 10.10.10.0/24. If no IP address matches the entries in this list, an IP address will be randomly selected.
- Introduced in: -
http_port
- Default: 8030
- Type: Int
- Unit: -
- Is mutable: No
- Description: The port on which the HTTP server in the FE node listens.
- Introduced in: -
http_worker_threads_num
- Default: 0
- Type: Int
- Unit: -
- Is mutable: No
- Description: Number of worker threads for http server to deal with http requests. For a negative or 0 value, the number of threads will be twice the number of cpu cores.
- Introduced in: v2.5.18, v3.0.10, v3.1.7, v3.2.2
http_backlog_num
- Default: 1024
- Type: Int
- Unit: -
- Is mutable: No
- Description: The length of the backlog queue held by the HTTP server in the FE node.
- Introduced in: -
cluster_name
- Default: StarRocks Cluster
- Type: String
- Unit: -
- Is mutable: No
- Description: The name of the StarRocks cluster to which the FE belongs. The cluster name is displayed for
Title
on the web page. - Introduced in: -
rpc_port
- Default: 9020
- Type: Int
- Unit: -
- Is mutable: No
- Description: The port on which the Thrift server in the FE node listens.
- Introduced in: -
thrift_server_max_worker_threads
- Default: 4096
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of worker threads that are supported by the Thrift server in the FE node.
- Introduced in: -
thrift_server_queue_size
- Default: 4096
- Type: Int
- Unit: -
- Is mutable: No
- Description: The length of queue where requests are pending. If the number of threads that are being processed in the thrift server exceeds the value specified in
thrift_server_max_worker_threads
, new requests are added to the pending queue. - Introduced in: -
thrift_client_timeout_ms
- Default: 5000
- Type: Int
- Unit: Milliseconds
- Is mutable: No
- Description: The length of time after which idle client connections time out.
- Introduced in: -
thrift_backlog_num
- Default: 1024
- Type: Int
- Unit: -
- Is mutable: No
- Description: The length of the backlog queue held by the Thrift server in the FE node.
- Introduced in: -
brpc_idle_wait_max_time
- Default: 10000
- Type: Int
- Unit: ms
- Is mutable: No
- Description: The maximum length of time for which bRPC clients wait as in the idle state.
- Introduced in: -
query_port
- Default: 9030
- Type: Int
- Unit: -
- Is mutable: No
- Description: The port on which the MySQL server in the FE node listens.
- Introduced in: -
mysql_nio_backlog_num
- Default: 1024
- Type: Int
- Unit: -
- Is mutable: No
- Description: The length of the backlog queue held by the MySQL server in the FE node.
- Introduced in: -
mysql_service_nio_enabled
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: No
- Description: Specifies whether asynchronous I/O is enabled for the FE node.
- Introduced in: -
mysql_service_io_threads_num
- Default: 4
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of threads that can be run by the MySQL server in the FE node to process I/O events.
- Introduced in: -
max_mysql_service_task_threads_num
- Default: 4096
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of threads that can be run by the MySQL server in the FE node to process tasks.
- Introduced in: -
mysql_server_version
- Default: 5.1.0
- Type: String
- Unit: -
- Is mutable: Yes
- Description: The MySQL server version returned to the client. Modifying this parameter will affect the version information in the following situations:
select version();
- Handshake packet version
- Value of the global variable
version
(show variables like 'version';
)
- Introduced in: -
qe_max_connection
- Default: 4096
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of connections that can be established by all users to the FE node. From v3.1.12 and v3.2.7 onwards, the default value has been changed from
1024
to4096
. - Introduced in: -
max_connection_scheduler_threads_num
- Default: 4096
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of threads that are supported by the connection scheduler.
- Introduced in: -
Metadata and cluster management
cluster_id
- Default: -1
- Type: Int
- Unit: -
- Is mutable: No
- Description: The ID of the StarRocks cluster to which the FE belongs. FEs or BEs that have the same cluster ID belong to the same StarRocks cluster. Valid values: any positive integer. The default value
-1
specifies that StarRocks will generate a random cluster ID for the StarRocks cluster at the time when the leader FE of the cluster is started for the first time. - Introduced in: -
meta_dir
- Default: StarRocksFE.STARROCKS_HOME_DIR + "/meta"
- Type: String
- Unit: -
- Is mutable: No
- Description: The directory that stores metadata.
- Introduced in: -
edit_log_type
- Default: BDB
- Type: String
- Unit: -
- Is mutable: No
- Description: The type of edit log that can be generated. Set the value to
BDB
. - Introduced in: -
edit_log_port
- Default: 9010
- Type: Int
- Unit: -
- Is mutable: No
- Description: The port that is used for communication among the Leader, Follower, and Observer FEs in the cluster.
- Introduced in: -
edit_log_roll_num
- Default: 50000
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of metadata log entries that can be written before a log file is created for these log entries. This parameter is used to control the size of log files. The new log file is written to the BDBJE database.
- Introduced in: -
ignore_unknown_log_id
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to ignore an unknown log ID. When an FE is rolled back, the FEs of the earlier version may be unable to recognize some log IDs. If the value is
TRUE
, the FE ignores unknown log IDs. If the value isFALSE
, the FE exits. - Introduced in: -
meta_delay_toleration_second
- Default: 300
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The maximum duration by which the metadata on the follower and observer FEs can lag behind that on the leader FE. Unit: seconds. If this duration is exceeded, the non-leader FEs stops providing services.
- Introduced in: -
master_sync_policy
-
Default: SYNC
-
Type: String
-
Unit: -
-
Is mutable: No
-
Description: The policy based on which the leader FE flushes logs to disk. This parameter is valid only when the current FE is a leader FE. Valid values:
SYNC
: When a transaction is committed, a log entry is generated and flushed to disk simultaneously.NO_SYNC
: The generation and flushing of a log entry do not occur at the same time when a transaction is committed.WRITE_NO_SYNC
: When a transaction is committed, a log entry is generated simultaneously but is not flushed to disk.
If you have deployed only one follower FE, we recommend that you set this parameter to
SYNC
. If you have deployed three or more follower FEs, we recommend that you set this parameter and thereplica_sync_policy
both toWRITE_NO_SYNC
. -
Introduced in: -
replica_sync_policy
- Default: SYNC
- Type: String
- Unit: -
- Is mutable: No
- Description: The policy based on which the follower FE flushes logs to disk. This parameter is valid only when the current FE is a follower FE. Valid values:
SYNC
: When a transaction is committed, a log entry is generated and flushed to disk simultaneously.NO_SYNC
: The generation and flushing of a log entry do not occur at the same time when a transaction is committed.WRITE_NO_SYNC
: When a transaction is committed, a log entry is generated simultaneously but is not flushed to disk.
- Introduced in: -
replica_ack_policy
- Default: SIMPLE_MAJORITY
- Type: String
- Unit: -
- Is mutable: No
- Description: The policy based on which a log entry is considered valid. The default value
SIMPLE_MAJORITY
specifies that a log entry is considered valid if a majority of follower FEs return ACK messages. - Introduced in: -
bdbje_heartbeat_timeout_second
- Default: 30
- Type: Int
- Unit: Seconds
- Is mutable: No
- Description: The amount of time after which the heartbeats among the leader, follower, and observer FEs in the StarRocks cluster time out.
- Introduced in: -
bdbje_replica_ack_timeout_second
- Default: 10
- Type: Int
- Unit: Seconds
- Is mutable: No
- Description: The maximum amount of time for which the leader FE can wait for ACK messages from a specified number of follower FEs when metadata is written from the leader FE to the follower FEs. Unit: second. If a large amount of metadata is being written, the follower FEs require a long time before they can return ACK messages to the leader FE, causing ACK timeout. In this situation, metadata writes fail, and the FE process exits. We recommend that you increase the value of this parameter to prevent this situation.
- Introduced in: -
bdbje_lock_timeout_second
- Default: 1
- Type: Int
- Unit: Seconds
- Is mutable: No
- Description: The amount of time after which a lock in the BDB JE-based FE times out.
- Introduced in: -
bdbje_reset_election_group
- Default: false
- Type: String
- Unit: -
- Is mutable: No
- Description: Whether to reset the BDBJE replication group. If this parameter is set to
TRUE
, the FE will reset the BDBJE replication group (that is, remove the information of all electable FE nodes) and start as the leader FE. After the reset, this FE will be the only member in the cluster, and other FEs can rejoin this cluster by usingALTER SYSTEM ADD/DROP FOLLOWER/OBSERVER 'xxx'
. Use this setting only when no leader FE can be elected because the data of most follower FEs have been damaged.reset_election_group
is used to replacemetadata_failure_recovery
. - Introduced in: -
max_bdbje_clock_delta_ms
- Default: 5000
- Type: Long
- Unit: Milliseconds
- Is mutable: No
- Description: The maximum clock offset that is allowed between the leader FE and the follower or observer FEs in the StarRocks cluster.
- Introduced in: -
txn_rollback_limit
- Default: 100
- Type: Int
- Unit: -
- Is mutable: No
- Description: The maximum number of transactions that can be rolled back.
- Introduced in: -
heartbeat_mgr_threads_num
- Default: 8
- Type: Int
- Unit: -
- Is mutable: No
- Description: The number of threads that can be run by the Heartbeat Manager to run heartbeat tasks.
- Introduced in: -
heartbeat_mgr_blocking_queue_size
- Default: 1024
- Type: Int
- Unit: -
- Is mutable: No
- Description: The size of the blocking queue that stores heartbeat tasks run by the Heartbeat Manager.
- Introduced in: -
catalog_try_lock_timeout_ms
- Default: 5000
- Type: Long
- Unit: Milliseconds
- Is mutable: Yes
- Description: The timeout duration to obtain the global lock.
- Introduced in: -
ignore_materialized_view_error
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether FE ignores the metadata exception caused by materialized view errors. If FE fails to start due to the metadata exception caused by materialized view errors, you can set this parameter to
true
to allow FE to ignore the exception. - Introduced in: v2.5.10
ignore_meta_check
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether non-Leader FEs ignore the metadata gap from the Leader FE. If the value is TRUE, non-Leader FEs ignore the metadata gap from the Leader FE and continue providing data reading services. This parameter ensures continuous data reading services even when you stop the Leader FE for a long period of time. If the value is FALSE, non-Leader FEs do not ignore the metadata gap from the Leader FE and stop providing data reading services.
- Introduced in: -
drop_backend_after_decommission
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to delete a BE after the BE is decommissioned.
TRUE
indicates that the BE is deleted immediately after it is decommissioned.FALSE
indicates that the BE is not deleted after it is decommissioned. - Introduced in: -
enable_collect_query_detail_info
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to collect the profile of a query. If this parameter is set to
TRUE
, the system collects the profile of the query. If this parameter is set toFALSE
, the system does not collect the profile of the query. - Introduced in: -
enable_background_refresh_connector_metadata
- Default: true in v3.0 and later and false in v2.5
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable the periodic Hive metadata cache refresh. After it is enabled, StarRocks polls the metastore (Hive Metastore or AWS Glue) of your Hive cluster, and refreshes the cached metadata of the frequently accessed Hive catalogs to perceive data changes.
true
indicates to enable the Hive metadata cache refresh, andfalse
indicates to disable it. - Introduced in: v2.5.5
background_refresh_metadata_interval_millis
- Default: 600000
- Type: Int
- Unit: Milliseconds
- Is mutable: Yes
- Description: The interval between two consecutive Hive metadata cache refreshes.
- Introduced in: v2.5.5
background_refresh_metadata_time_secs_since_last_access_secs
- Default: 3600 * 24
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The expiration time of a Hive metadata cache refresh task. For the Hive catalog that has been accessed, if it has not been accessed for more than the specified time, StarRocks stops refreshing its cached metadata. For the Hive catalog that has not been accessed, StarRocks will not refresh its cached metadata.
- Introduced in: v2.5.5
enable_statistics_collect_profile
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to generate profiles for statistics queries. You can set this item to
true
to allow StarRocks to generate query profiles for queries on system statistics. - Introduced in: v3.1.5
metadata_enable_recovery_mode
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: No
- Description: Whether to enable the metadata recovery mode. When this mode is enabled, if part of the cluster metadata is lost, it can be restored based on the information from BE. Currently, only the version information of partitions can be restored.
- Introduced in: v3.3.0
enable_legacy_compatibility_for_replication
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable the Legacy Compatibility for Replication. StarRocks may behave differently between the old and new versions, causing problems during cross-cluster data migration. Therefore, you must enable Legacy Compatibility for the target cluster before data migration and disable it after data migration is completed.
true
indicates enabling this mode. - Introduced in: v3.1.10, v3.2.6
User, role, and privilege
privilege_max_total_roles_per_user
- Default: 64
- Type: Int
- Unit:
- Is mutable: Yes
- Description: The maximum number of roles a user can have.
- Introduced in: v3.0.0
privilege_max_role_depth
- Default: 16
- Type: Int
- Unit:
- Is mutable: Yes
- Description: The maximum role depth (level of inheritance) of a role.
- Introduced in: v3.0.0
Query engine
publish_version_interval_ms
- Default: 10
- Type: Int
- Unit: Milliseconds
- Is mutable: No
- Description: The time interval at which release validation tasks are issued.
- Introduced in: -
statistic_cache_columns
- Default: 100000
- Type: Long
- Unit: -
- Is mutable: No
- Description: The number of rows that can be cached for the statistics table.
- Introduced in: -
statistic_cache_thread_pool_size
- Default: 10
- Type: Int
- Unit: -
- Is mutable: No
- Description: The size of the thread-pool which will be used to refresh statistic caches.
- Introduced in: -
max_allowed_in_element_num_of_delete
- Default: 10000
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of elements allowed for the IN predicate in a DELETE statement.
- Introduced in: -
enable_materialized_view
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable the creation of materialized views.
- Introduced in: -
enable_materialized_view_spill
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable Intermediate Result Spilling for materialized view refresh tasks.
- Introduced in: v3.1.1
enable_backup_materialized_view
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable the BACKUP and RESTORE of asynchronous materialized views when backing up or restoring a specific database. If this item is set to
false
, StarRocks will skip backing up asynchronous materialized views. - Introduced in: v3.2.0
enable_experimental_mv
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable the asynchronous materialized view feature. TRUE indicates this feature is enabled. From v2.5.2 onwards, this feature is enabled by default. For versions earlier than v2.5.2, this feature is disabled by default.
- Introduced in: v2.4
enable_colocate_mv_index
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to support colocating the synchronous materialized view index with the base table when creating a synchronous materialized view. If this item is set to
true
, tablet sink will speed up the write performance of synchronous materialized views. - Introduced in: v3.2.0
default_mv_refresh_immediate
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to refresh an asynchronous materialized view immediately after creation. When this item is set to
true
, newly created materialized view will be refreshed immediately. - Introduced in: v3.2.3
enable_materialized_view_metrics_collect
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to collect monitoring metrics for asynchronous materialized views by default.
- Introduced in: v3.1.11, v3.2.5
enable_materialized_view_text_based_rewrite
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable text-based query rewrite by default. If this item is set to
true
, the system builds the abstract syntax tree while creating an asynchronous materialized view. - Introduced in: v3.2.5
enable_mv_automatic_active_check
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable the system to automatically check and re-activate the asynchronous materialized views that are set inactive because their base tables (views) had undergone Schema Change or had been dropped and re-created. Please note that this feature will not re-activate the materialized views that are manually set inactive by users.
- Introduced in: v3.1.6
enable_udf
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: No
- Description: Whether to enable UDF.
- Introduced in: -
enable_decimal_v3
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to support the DECIMAL V3 data type.
- Introduced in: -
enable_sql_blacklist
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable blacklist check for SQL queries. When this feature is enabled, queries in the blacklist cannot be executed.
- Introduced in: -
dynamic_partition_enable
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable the dynamic partitioning feature. When this feature is enabled, StarRocks dynamically creates partitions for new data and automatically deletes expired partitions to ensure the freshness of data.
- Introduced in: -
dynamic_partition_check_interval_seconds
- Default: 600
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The interval at which new data is checked. If new data is detected, StarRocks automatically creates partitions for the data.
- Introduced in: -
max_query_retry_time
- Default: 2
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of query retries on an FE.
- Introduced in: -
max_create_table_timeout_second
- Default: 600
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The maximum timeout duration for creating a table.
- Introduced in: -
create_table_max_serial_replicas
- Default: 128
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of replicas to create serially. If actual replica count exceeds this value, replicas will be created concurrently. Try to reduce this value if table creation is taking a long time to complete.
- Introduced in: -
http_slow_request_threshold_ms
- Default: 5000
- Type: Int
- Unit: Milliseconds
- Is mutable: Yes
- Description: If the response time for an HTTP request exceeds the value specified by this parameter, a log is generated to track this request.
- Introduced in: v2.5.15, v3.1.5
max_partitions_in_one_batch
- Default: 4096
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: The maximum number of partitions that can be created when you bulk create partitions.
- Introduced in: -
max_running_rollup_job_num_per_table
- Default: 1
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of rollup jobs can run in parallel for a table.
- Introduced in: -
expr_children_limit
- Default: 10000
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of child expressions allowed in an expression.
- Introduced in: -
max_planner_scalar_rewrite_num
- Default: 100000
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: The maximum number of times that the optimizer can rewrite a scalar operator.
- Introduced in: -
enable_statistic_collect
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to collect statistics for the CBO. This feature is enabled by default.
- Introduced in: -
enable_statistic_collect_on_first_load
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to automatically collect statistics when data is loaded into a table for the first time. If a table has multiple partitions, any data loading into an empty partition of this table will trigger automatic statistics collection on this partition. If new tables are frequently created and data is frequently loaded, the memory and CPU overhead will increase.
- Introduced in: v3.1
statistic_auto_analyze_start_time
- Default: 00:00:00
- Type: String
- Unit: -
- Is mutable: Yes
- Description: The start time of automatic collection. Value range:
00:00:00
-23:59:59
. - Introduced in: -
statistic_auto_analyze_end_time
- Default: 23:59:59
- Type: String
- Unit: -
- Is mutable: Yes
- Description: The end time of automatic collection. Value range:
00:00:00
-23:59:59
. - Introduced in: -
statistic_analyze_status_keep_second
- Default: 3 * 24 * 3600
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The duration to retain the history of collection tasks. The default value is 3 days.
- Introduced in: -
statistic_collect_interval_sec
- Default: 5 * 60
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The interval for checking data updates during automatic collection.
- Introduced in: -
statistic_update_interval_sec
- Default: 24 * 60 * 60
- Type: Long
- Unit: Seconds
- Is mutable: Yes
- Description: The interval at which the cache of statistical information is updated.
- Introduced in: -
enable_collect_full_statistic
- Default: true
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to enable automatic full statistics collection. This feature is enabled by default.
- Introduced in: -
statistic_auto_collect_ratio
- Default: 0.8
- Type: Double
- Unit: -
- Is mutable: Yes
- Description: The threshold for determining whether the statistics for automatic collection are healthy. If statistics health is below this threshold, automatic collection is triggered.
- Introduced in: -
statistic_auto_collect_small_table_rows
- Default: 10000000
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: Threshold to determine whether a table in an external data source (Hive, Iceberg, Hudi) is a small table during automatic collection. If the table has rows less than this value, the table is considered a small table.
- Introduced in: v3.2
statistic_max_full_collect_data_size
- Default: 100 * 1024 * 1024 * 1024
- Type: Long
- Unit: bytes
- Is mutable: Yes
- Description: The size of the largest partition for the automatic collection of statistics. If a partition exceeds this value, then sampled collection is performed instead of full.
- Introduced in: -
statistic_collect_max_row_count_per_query
- Default: 5000000000
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: The maximum number of rows to query for a single analyze task. An analyze task will be split into multiple queries if this value is exceeded.
- Introduced in: -
statistic_sample_collect_rows
- Default: 200000
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: The minimum number of rows to collect for sampled collection. If the parameter value exceeds the actual number of rows in your table, full collection is performed.
- Introduced in: -
histogram_buckets_size
- Default: 64
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: The default bucket number for a histogram.
- Introduced in: -
histogram_mcv_size
- Default: 100
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: The number of most common values (MCV) for a histogram.
- Introduced in: -
histogram_sample_ratio
- Default: 0.1
- Type: Double
- Unit: -
- Is mutable: Yes
- Description: The sampling ratio for a histogram.
- Introduced in: -
histogram_max_sample_row_count
- Default: 10000000
- Type: Long
- Unit: -
- Is mutable: Yes
- Description: The maximum number of rows to collect for a histogram.
- Introduced in: -
enable_local_replica_selection
- Default: false
- Type: Boolean
- Unit: -
- Is mutable: Yes
- Description: Whether to select local replicas for queries. Local replicas reduce the network transmission cost. If this parameter is set to TRUE, the CBO preferentially selects tablet replicas on BEs that have the same IP address as the current FE. If this parameter is set to
FALSE
, both local replicas and non-local replicas can be selected. - Introduced in: -
max_distribution_pruner_recursion_depth
- Default: 100
- Type: Int
- Unit: -
- Is mutable: Yes
- Description:: The maximum recursion depth allowed by the partition pruner. Increasing the recursion depth can prune more elements but also increases CPU consumption.
- Introduced in: -
Loading and unloading
load_straggler_wait_second
- Default: 300
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The maximum loading lag that can be tolerated by a BE replica. If this value is exceeded, cloning is performed to clone data from other replicas.
- Introduced in: -
load_checker_interval_second
- Default: 5
- Type: Int
- Unit: Seconds
- Is mutable: No
- Description: The time interval at which load jobs are processed on a rolling basis.
- Introduced in: -
broker_load_default_timeout_second
- Default: 14400
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The timeout duration for a Broker Load job.
- Introduced in: -
min_bytes_per_broker_scanner
- Default: 67108864
- Type: Long
- Unit: Bytes
- Is mutable: Yes
- Description: The minimum allowed amount of data that can be processed by a Broker Load instance.
- Introduced in: -
insert_load_default_timeout_second
- Default: 3600
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The timeout duration for the INSERT INTO statement that is used to load data.
- Introduced in: -
stream_load_default_timeout_second
- Default: 600
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The default timeout duration for each Stream Load job.
- Introduced in: -
max_stream_load_timeout_second
- Default: 259200
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The maximum allowed timeout duration for a Stream Load job.
- Introduced in: -
max_load_timeout_second
- Default: 259200
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The maximum timeout duration allowed for a load job. The load job fails if this limit is exceeded. This limit applies to all types of load jobs.
- Introduced in: -
min_load_timeout_second
- Default: 1
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The minimum timeout duration allowed for a load job. This limit applies to all types of load jobs.
- Introduced in: -
spark_dpp_version
- Default: 1.0.0
- Type: String
- Unit: -
- Is mutable: No
- Description: The version of Spark Dynamic Partition Pruning (DPP) used.
- Introduced in: -
spark_load_default_timeout_second
- Default: 86400
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The timeout duration for each Spark Load job.
- Introduced in: -
spark_home_default_dir
- Default: StarRocksFE.STARROCKS_HOME_DIR + "/lib/spark2x"
- Type: String
- Unit: -
- Is mutable: No
- Description: The root directory of a Spark client.
- Introduced in: -