Config Manual

1. IoTDB Configuration Files

The configuration files for IoTDB are located in the conf folder under the IoTDB installation directory. Key configuration files include:

  1. confignode-env.sh / confignode-env.bat:
    1. Environment configuration file for ConfigNode.
    2. Used to configure memory size and other environment settings for ConfigNode.
  2. datanode-env.sh / datanode-env.bat:
    1. Environment configuration file for DataNode.
    2. Used to configure memory size and other environment settings for DataNode.
  3. iotdb-system.properties:
    1. Main configuration file for IoTDB.
    2. Contains configurable parameters for IoTDB.
  4. iotdb-system.properties.template:
    1. Template for the iotdb-system.properties file.
    2. Provides a reference for all available configuration parameters.

2. Modify Configurations

2.1 Modify Existing Parameters:

  • Parameters already present in the iotdb-system.properties file can be directly modified.

2.2 Adding New Parameters:

  • For parameters not listed in iotdb-system.properties, you can find them in the iotdb-system.properties.template file.
  • Copy the desired parameter from the template file to iotdb-system.properties and modify its value.

2.3 Configuration Update Methods

Different configuration parameters have different update methods, categorized as follows:

  1. Modify before the first startup.:
    1. These parameters can only be modified before the first startup of ConfigNode/DataNode.
    2. Modifying them after the first startup will prevent ConfigNode/DataNode from starting.
  2. Restart Required for Changes to Take Effect:
    1. These parameters can be modified after ConfigNode/DataNode has started.
    2. However, a restart of ConfigNode/DataNode is required for the changes to take effect.
  3. Hot Reload:
    1. These parameters can be modified while ConfigNode/DataNode is running.
    2. After modification, use the following SQL commands to apply the changes:
      • load configuration: Reloads the configuration.
      • set configuration key1 = 'value1': Updates specific configuration parameters.

3. Environment Parameters

The environment configuration files (confignode-env.sh/bat and datanode-env.sh/bat) are used to configure Java environment parameters for ConfigNode and DataNode, such as JVM settings. These configurations are passed to the JVM when ConfigNode or DataNode starts.

3.1 confignode-env.sh/bat

  • MEMORY_SIZE
NameMEMORY_SIZE
DescriptionMemory size allocated when IoTDB ConfigNode starts.
TypeString
DefaultDepends on the operating system and machine configuration. Defaults to 3/10 of the machine's memory, capped at 16G.
EffectiveRestart required
  • ON_HEAP_MEMORY
NameON_HEAP_MEMORY
DescriptionOn-heap memory size available for IoTDB ConfigNode. Previously named MAX_HEAP_SIZE.
TypeString
DefaultDepends on the MEMORY_SIZE configuration.
EffectiveRestart required
  • OFF_HEAP_MEMORY
NameOFF_HEAP_MEMORY
DescriptionOff-heap memory size available for IoTDB ConfigNode. Previously named MAX_DIRECT_MEMORY_SIZE.
TypeString
DefaultDepends on the MEMORY_SIZE configuration.
EffectiveRestart required

3.2 datanode-env.sh/bat

  • MEMORY_SIZE
NameMEMORY_SIZE
DescriptionMemory size allocated when IoTDB DataNode starts.
TypeString
DefaultDepends on the operating system and machine configuration. Defaults to 1/2 of the machine's memory.
EffectiveRestart required
  • ON_HEAP_MEMORY
NameON_HEAP_MEMORY
DescriptionOn-heap memory size available for IoTDB DataNode. Previously named MAX_HEAP_SIZE.
TypeString
DefaultDepends on the MEMORY_SIZE configuration.
EffectiveRestart required
  • OFF_HEAP_MEMORY
NameOFF_HEAP_MEMORY
DescriptionOff-heap memory size available for IoTDB DataNode. Previously named MAX_DIRECT_MEMORY_SIZE.
TypeString
DefaultDepends on the MEMORY_SIZE configuration.
EffectiveRestart required

4. System Parameters (iotdb-system.properties.template

The iotdb-system.properties file contains various configurations for managing IoTDB clusters, nodes, replication, directories, monitoring, SSL, connections, object storage, tier management, and REST services. Below is a detailed breakdown of the parameters:

4.1 Cluster Configuration

  • cluster_name
Namecluster_name
DescriptionName of the cluster.
TypeString
Defaultdefault_cluster
EffectiveUse CLI: set configuration cluster_name='xxx'.
NoteChanges are distributed across nodes. Changes may not propagate to all nodes in case of network issues or node failures. Nodes that fail to update must manually modify cluster_name in their configuration files and restart. Under normal circumstances, it is not recommended to modify cluster_name by manually modifying configuration files or to perform hot-loading via load configuration method.

4.2 Seed ConfigNode

  • cn_seed_config_node
Namecn_seed_config_node
DescriptionAddress of the seed ConfigNode for Confignode to join the cluster.
TypeString
Default127.0.0.1:10710
EffectiveModify before the first startup.
  • dn_seed_config_node
Namedn_seed_config_node
DescriptionAddress of the seed ConfigNode for Datanode to join the cluster.
TypeString
Default127.0.0.1:10710
EffectiveModify before the first startup.

4.3 Node RPC Configuration

  • cn_internal_address
Namecn_internal_address
DescriptionInternal address for ConfigNode communication.
TypeString
Default127.0.0.1
EffectiveModify before the first startup.
  • cn_internal_port
Namecn_internal_port
DescriptionPort for ConfigNode internal communication.
TypeShort Int : [0,65535]
Default10710
EffectiveModify before the first startup.
  • cn_consensus_port
Namecn_consensus_port
DescriptionPort for ConfigNode consensus protocol communication.
TypeShort Int : [0,65535]
Default10720
EffectiveModify before the first startup.
  • dn_rpc_address
Namedn_rpc_address
DescriptionAddress for client RPC service.
TypeString
Default0.0.0.0
EffectiveRestart required.
  • dn_rpc_port
Namedn_rpc_port
DescriptionPort for client RPC service.
TypeShort Int : [0,65535]
Default6667
EffectiveRestart required.
  • dn_internal_address
Namedn_internal_address
DescriptionInternal address for DataNode communication.
Typestring
Default127.0.0.1
EffectiveModify before the first startup.
  • dn_internal_port
Namedn_internal_port
DescriptionPort for DataNode internal communication.
Typeint
Default10730
EffectiveModify before the first startup.
  • dn_mpp_data_exchange_port
Namedn_mpp_data_exchange_port
DescriptionPort for MPP data exchange.
Typeint
Default10740
EffectiveModify before the first startup.
  • dn_schema_region_consensus_port
Namedn_schema_region_consensus_port
DescriptionPort for Datanode SchemaRegion consensus protocol communication.
Typeint
Default10750
EffectiveModify before the first startup.
  • dn_data_region_consensus_port
Namedn_data_region_consensus_port
DescriptionPort for Datanode DataRegion consensus protocol communication.
Typeint
Default10760
EffectiveModify before the first startup.
  • dn_join_cluster_retry_interval_ms
Namedn_join_cluster_retry_interval_ms
DescriptionInterval for DataNode to retry joining the cluster.
Typelong
Default5000
EffectiveRestart required.

4.4 Replication configuration

  • config_node_consensus_protocol_class
Nameconfig_node_consensus_protocol_class
DescriptionConsensus protocol for ConfigNode replication, only supports RatisConsensus
TypeString
Defaultorg.apache.iotdb.consensus.ratis.RatisConsensus
EffectiveModify before the first startup.
  • schema_replication_factor
Nameschema_replication_factor
DescriptionDefault schema replication factor for databases.
Typeint32
Default1
EffectiveRestart required. Takes effect on the new database after restarting.
  • schema_region_consensus_protocol_class
Nameschema_region_consensus_protocol_class
DescriptionConsensus protocol for schema region replication. Only supports RatisConsensus when multi-replications.
TypeString
Defaultorg.apache.iotdb.consensus.ratis.RatisConsensus
EffectiveModify before the first startup.
  • data_replication_factor
Namedata_replication_factor
DescriptionDefault data replication factor for databases.
Typeint32
Default1
EffectiveRestart required. Takes effect on the new database after restarting.
  • data_region_consensus_protocol_class
Namedata_region_consensus_protocol_class
DescriptionConsensus protocol for data region replication. Supports IoTConsensus or RatisConsensus when multi-replications.
TypeString
Defaultorg.apache.iotdb.consensus.iot.IoTConsensus
EffectiveModify before the first startup.

4.5 Directory configuration

  • cn_system_dir
Namecn_system_dir
DescriptionSystem data storage path for ConfigNode.
TypeString
Defaultdata/confignode/system(Windows:data\configndoe\system)
EffectiveRestart required
  • cn_consensus_dir
Namecn_consensus_dir
DescriptionConsensus protocol data storage path for ConfigNode.
TypeString
Defaultdata/confignode/consensus(Windows:data\configndoe\consensus)
EffectiveRestart required
  • cn_pipe_receiver_file_dir
Namecn_pipe_receiver_file_dir
DescriptionDirectory for pipe receiver files in ConfigNode.
TypeString
Defaultdata/confignode/system/pipe/receiver(Windows:data\confignode\system\pipe\receiver)
EffectiveRestart required
  • dn_system_dir
Namedn_system_dir
DescriptionSchema storage path for DataNode. By default, it is stored in the data directory at the same level as the sbin directory. The starting directory of the relative path is related to the operating system. It is recommended to use an absolute path.
TypeString
Defaultdata/datanode/system(Windows:data\datanode\system)
EffectiveRestart required
  • dn_data_dirs
Namedn_data_dirs
DescriptionData storage path for DataNode. By default, it is stored in the data directory at the same level as the sbin directory. The starting directory of the relative path is related to the operating system. It is recommended to use an absolute path.
TypeString
Defaultdata/datanode/data(Windows:data\datanode\data)
EffectiveRestart required
  • dn_multi_dir_strategy
Namedn_multi_dir_strategy
DescriptionThe strategy used by IoTDB to select directories in data_dirs for TsFiles. You can use either the simple class name or the fully qualified class name. The system provides the following two strategies: 1. SequenceStrategy: IoTDB selects directories sequentially, iterating through all directories in data_dirs in a round-robin manner. 2. MaxDiskUsableSpaceFirstStrategy IoTDB prioritizes the directory in data_dirs with the largest disk free space. To implement a custom strategy: 1. Inherit the org.apache.iotdb.db.storageengine.rescon.disk.strategy.DirectoryStrategy class and implement your own strategy method. 2. Fill in the configuration item with the fully qualified class name of your implementation (package name + class name, e.g., UserDefineStrategyPackage). 3. Add the JAR file containing your custom class to the project.
TypeString
DefaultSequenceStrategy
EffectiveHot reload.
  • dn_consensus_dir
Namedn_consensus_dir
DescriptionConsensus log storage path for DataNode. By default, it is stored in the data directory at the same level as the sbin directory. The starting directory of the relative path is related to the operating system. It is recommended to use an absolute path.
TypeString
Defaultdata/datanode/consensus(Windows:data\datanode\consensus)
EffectiveRestart required
  • dn_wal_dirs
Namedn_wal_dirs
DescriptionWrite-ahead log (WAL) storage path for DataNode. By default, it is stored in the data directory at the same level as the sbin directory. The starting directory of the relative path is related to the operating system. It is recommended to use an absolute path.
TypeString
Defaultdata/datanode/wal(Windows:data\datanode\wal)
EffectiveRestart required
  • dn_tracing_dir
Namedn_tracing_dir
DescriptionTracing root directory for DataNode. By default, it is stored in the data directory at the same level as the sbin directory. The starting directory of the relative path is related to the operating system. It is recommended to use an absolute path.
TypeString
Defaultdatanode/tracing(Windows:datanode\tracing)
EffectiveRestart required
  • dn_sync_dir
Namedn_sync_dir
DescriptionSync storage path for DataNode.By default, it is stored in the data directory at the same level as the sbin directory. The starting directory of the relative path is related to the operating system. It is recommended to use an absolute path.
TypeString
Defaultdata/datanode/sync(Windows:data\datanode\sync)
EffectiveRestart required
  • sort_tmp_dir
Namesort_tmp_dir
DescriptionTemporary directory for sorting operations.
TypeString
Defaultdata/datanode/tmp(Windows:data\datanode\tmp)
EffectiveRestart required
  • dn_pipe_receiver_file_dirs
Namedn_pipe_receiver_file_dirs
DescriptionDirectory for pipe receiver files in DataNode.
TypeString
Defaultdata/datanode/system/pipe/receiver(Windows:data\datanode\system\pipe\receiver)
EffectiveRestart required
  • iot_consensus_v2_receiver_file_dirs
Nameiot_consensus_v2_receiver_file_dirs
DescriptionDirectory for IoTConsensus V2 receiver files.
TypeString
Defaultdata/datanode/system/pipe/consensus/receiver(Windows:data\datanode\system\pipe\consensus\receiver)
EffectiveRestart required
  • iot_consensus_v2_deletion_file_dir
Nameiot_consensus_v2_deletion_file_dir
DescriptionDirectory for IoTConsensus V2 deletion files.
TypeString
Defaultdata/datanode/system/pipe/consensus/deletion(Windows:data\datanode\system\pipe\consensus\deletion)
EffectiveRestart required

4.6 Metric Configuration

  • cn_metric_reporter_list
Namecn_metric_reporter_list
DescriptionSystems for reporting ConfigNode metrics.
TypeString
DefaultNone
EffectiveRestart required.
  • cn_metric_level
Namecn_metric_level
DescriptionLevel of detail for ConfigNode metrics.
TypeString
DefaultIMPORTANT
EffectiveRestart required.
  • cn_metric_async_collect_period
Namecn_metric_async_collect_period
DescriptionPeriod for asynchronous metric collection in ConfigNode (in seconds).
Typeint
Default5
EffectiveRestart required.
  • cn_metric_prometheus_reporter_port
Namecn_metric_prometheus_reporter_port
DescriptionPort for Prometheus metric reporting in ConfigNode.
Typeint
Default9091
EffectiveRestart required.
  • dn_metric_reporter_list
Namedn_metric_reporter_list
DescriptionSystems for reporting DataNode metrics.
TypeString
DefaultNone
EffectiveRestart required.
  • dn_metric_level
Namedn_metric_level
DescriptionLevel of detail for DataNode metrics.
TypeString
DefaultIMPORTANT
EffectiveRestart required.
  • dn_metric_async_collect_period
Namedn_metric_async_collect_period
DescriptionPeriod for asynchronous metric collection in DataNode (in seconds).
Typeint
Default5
EffectiveRestart required.
  • dn_metric_prometheus_reporter_port
Namedn_metric_prometheus_reporter_port
DescriptionPort for Prometheus metric reporting in DataNode.
Typeint
Default9092
EffectiveRestart required.
  • dn_metric_internal_reporter_type
Namedn_metric_internal_reporter_type
DescriptionInternal reporter types for DataNode metrics. For internal monitoring and checking that the data has been successfully written and refreshed.
TypeString
DefaultIOTDB
EffectiveRestart required.

4.7 SSL Configuration

  • enable_thrift_ssl
Nameenable_thrift_ssl
DescriptionEnables SSL encryption for RPC communication.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • enable_https
Nameenable_https
DescriptionEnables SSL for REST services.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • key_store_path
Namekey_store_path
DescriptionPath to the SSL certificate.
TypeString
DefaultNone
EffectiveRestart required.
  • key_store_pwd
Namekey_store_pwd
DescriptionPassword for the SSL certificate.
TypeString
DefaultNone
EffectiveRestart required.

4.8 Connection Configuration

  • cn_rpc_thrift_compression_enable
Namecn_rpc_thrift_compression_enable
DescriptionEnables Thrift compression for RPC.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • cn_rpc_max_concurrent_client_num
Namecn_rpc_max_concurrent_client_num
DescriptionMaximum number of concurrent RPC clients.
Typeint
Default3000
EffectiveRestart required.
  • cn_connection_timeout_ms
Namecn_connection_timeout_ms
DescriptionConnection timeout for ConfigNode (in milliseconds).
Typeint
Default60000
EffectiveRestart required.
  • cn_selector_thread_nums_of_client_manager
Namecn_selector_thread_nums_of_client_manager
DescriptionNumber of selector threads for client management in ConfigNode.
Typeint
Default1
EffectiveRestart required.
  • cn_max_client_count_for_each_node_in_client_manager
Namecn_max_client_count_for_each_node_in_client_manager
DescriptionMaximum clients per node in ConfigNode client manager.
Typeint
Default300
EffectiveRestart required.
  • dn_session_timeout_threshold
Namedn_session_timeout_threshold
DescriptionMaximum idle time for DataNode sessions.
Typeint
Default0
EffectiveRestart required.t required.
  • dn_rpc_thrift_compression_enable
Namedn_rpc_thrift_compression_enable
DescriptionEnables Thrift compression for DataNode RPC.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • dn_rpc_advanced_compression_enable
Namedn_rpc_advanced_compression_enable
DescriptionEnables advanced Thrift compression for DataNode RPC.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • dn_rpc_selector_thread_count
Namerpc_selector_thread_count
DescriptionNumber of selector threads for DataNode RPC.
Typeint
Default1
EffectiveRestart required.t required.
  • dn_rpc_min_concurrent_client_num
Namerpc_min_concurrent_client_num
DescriptionMinimum number of concurrent RPC clients for DataNode.
TypeShort Int : [0,65535]
Default1
EffectiveRestart required.
  • dn_rpc_max_concurrent_client_num
Namedn_rpc_max_concurrent_client_num
DescriptionMaximum number of concurrent RPC clients for DataNode.
TypeShort Int : [0,65535]
Default65535
EffectiveRestart required.
  • dn_thrift_max_frame_size
Namedn_thrift_max_frame_size
DescriptionMaximum frame size for RPC requests/responses.
Typelong
Default536870912 (Default 512MB)
EffectiveRestart required.
  • dn_thrift_init_buffer_size
Namedn_thrift_init_buffer_size
DescriptionInitial buffer size for Thrift RPC.
Typelong
Default1024
EffectiveRestart required.
  • dn_connection_timeout_ms
Namedn_connection_timeout_ms
DescriptionConnection timeout for DataNode (in milliseconds).
Typeint
Default60000
EffectiveRestart required.
  • dn_selector_thread_count_of_client_manager
Namedn_selector_thread_count_of_client_manager
Descriptionselector thread (TAsyncClientManager) nums for async thread in a clientManager
Typeint
Default1
EffectiveRestart required.t required.
  • dn_max_client_count_for_each_node_in_client_manager
Namedn_max_client_count_for_each_node_in_client_manager
DescriptionMaximum clients per node in DataNode clientmanager.
Typeint
Default300
EffectiveRestart required.

4.9 Object storage management

  • remote_tsfile_cache_dirs
Nameremote_tsfile_cache_dirs
DescriptionLocal cache directory for cloud storage.
TypeString
Defaultdata/datanode/data/cache
EffectiveRestart required.
  • remote_tsfile_cache_page_size_in_kb
Nameremote_tsfile_cache_page_size_in_kb
DescriptionBlock size for cached files in cloud storage.
Typeint
Default20480
EffectiveRestart required.
  • remote_tsfile_cache_max_disk_usage_in_mb
Nameremote_tsfile_cache_max_disk_usage_in_mb
DescriptionMaximum disk usage for cloud storage cache.
Typelong
Default51200
EffectiveRestart required.
  • object_storage_type
Nameobject_storage_type
DescriptionType of cloud storage.
TypeString
DefaultAWS_S3
EffectiveRestart required.
  • object_storage_endpoint
Nameobject_storage_endpoint
DescriptionEndpoint for cloud storage.
TypeString
DefaultNone
EffectiveRestart required.
  • object_storage_bucket
Nameobject_storage_bucket
DescriptionBucket name for cloud storage.
TypeString
Defaultiotdb_data
EffectiveRestart required.
  • object_storage_access_key
Nameobject_storage_access_key
DescriptionAccess key for cloud storage.
TypeString
DefaultNone
EffectiveRestart required.
  • object_storage_access_secret
Nameobject_storage_access_secret
DescriptionAccess secret for cloud storage.
TypeString
DefaultNone
EffectiveRestart required.

4.10 Tier management

  • dn_default_space_usage_thresholds
Namedn_default_space_usage_thresholds
DescriptionDisk usage threshold, data will be moved to the next tier when the usage of the tier is higher than this threshold.If tiered storage is enabled, please separate thresholds of different tiers by semicolons “;”.
Typedouble
Default0.85
EffectiveHot reload.
  • dn_tier_full_policy
Namedn_tier_full_policy
DescriptionHow to deal with the last tier's data when its used space has been higher than its dn_default_space_usage_thresholds.
TypeString
DefaultNULL
EffectiveHot reload.
  • migrate_thread_count
Namemigrate_thread_count
Descriptionthread pool size for migrate operation in the DataNode's data directories.
Typeint
Default1
EffectiveHot reload.
  • tiered_storage_migrate_speed_limit_bytes_per_sec
Nametiered_storage_migrate_speed_limit_bytes_per_sec
DescriptionThe migrate speed limit of different tiers can reach per second
Typeint
Default10485760
EffectiveHot reload.

4.11 REST Service Configuration

  • enable_rest_service
Nameenable_rest_service
DescriptionIs the REST service enabled
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • rest_service_port
Namerest_service_port
Descriptionthe binding port of the REST service
Typeint32
Default18080
EffectiveRestart required.
  • enable_swagger
Nameenable_swagger
DescriptionWhether to display rest service interface information through swagger. eg: http://ip:port/swagger.json
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • rest_query_default_row_size_limit
Namerest_query_default_row_size_limit
Descriptionthe default row limit to a REST query response when the rowSize parameter is not given in request
Typeint32
Default10000
EffectiveRestart required.
  • cache_expire_in_seconds
Namecache_expire_in_seconds
DescriptionThe expiration time of the user login information cache (in seconds)
Typeint32
Default28800
EffectiveRestart required.
  • cache_max_num
Namecache_max_num
DescriptionThe maximum number of users can be stored in the user login cache.
Typeint32
Default100
EffectiveRestart required.
  • cache_init_num
Namecache_init_num
DescriptionThe initial capacity of users can be stored in the user login cache.
Typeint32
Default10
EffectiveRestart required.
  • client_auth
Nameclient_auth
DescriptionIs client authentication required
Typeboolean
Defaultfalse
EffectiveRestart required.
  • trust_store_path
Nametrust_store_path
DescriptionSSL trust store path
TypeString
Default""
EffectiveRestart required.
  • trust_store_pwd
Nametrust_store_pwd
DescriptionSSL trust store password.
TypeString
Default""
EffectiveRestart required.
  • idle_timeout_in_seconds
Nameidle_timeout_in_seconds
DescriptionSSL timeout (in seconds)
Typeint32
Default5000
EffectiveRestart required.

4.12 Load balancing configuration

  • series_slot_num
Nameseries_slot_num
DescriptionNumber of SeriesPartitionSlots per Database
Typeint32
Default10000
EffectiveModify before the first startup.
  • series_partition_executor_class
Nameseries_partition_executor_class
DescriptionSeriesPartitionSlot executor class
TypeString
Defaultorg.apache.iotdb.commons.partition.executor.hash.BKDRHashExecutor
EffectiveModify before the first startup.
  • schema_region_group_extension_policy
Nameschema_region_group_extension_policy
DescriptionThe policy of extension SchemaRegionGroup for each Database.
Typestring
DefaultAUTO
EffectiveRestart required.
  • default_schema_region_group_num_per_database
Namedefault_schema_region_group_num_per_database
DescriptionWhen set schema_region_group_extension_policy=CUSTOM, this parameter is the default number of SchemaRegionGroups for each Database.When set schema_region_group_extension_policy=AUTO, this parameter is the default minimal number of SchemaRegionGroups for each Database.
Typeint
Default1
EffectiveRestart required.
  • schema_region_per_data_node
Nameschema_region_per_data_node
DescriptionIt only takes effect when set schema_region_group_extension_policy=AUTO.This parameter is the maximum number of SchemaRegions expected to be managed by each DataNode.
Typedouble
Default1.0
EffectiveRestart required.
  • data_region_group_extension_policy
Namedata_region_group_extension_policy
DescriptionThe policy of extension DataRegionGroup for each Database.
Typestring
DefaultAUTO
EffectiveRestart required.
  • default_data_region_group_num_per_database
Namedefault_data_region_group_per_database
DescriptionWhen set data_region_group_extension_policy=CUSTOM, this parameter is the default number of DataRegionGroups for each Database.When set data_region_group_extension_policy=AUTO, this parameter is the default minimal number of DataRegionGroups for each Database.
Typeint
Default2
EffectiveRestart required.
  • data_region_per_data_node
Namedata_region_per_data_node
DescriptionIt only takes effect when set data_region_group_extension_policy=AUTO.This parameter is the maximum number of DataRegions expected to be managed by each DataNode.
Typedouble
Default5.0
EffectiveRestart required.
  • enable_auto_leader_balance_for_ratis_consensus
Nameenable_auto_leader_balance_for_ratis_consensus
DescriptionWhether to enable auto leader balance for Ratis consensus protocol.
TypeBoolean
Defaulttrue
EffectiveRestart required.
  • enable_auto_leader_balance_for_iot_consensus
Nameenable_auto_leader_balance_for_iot_consensus
DescriptionWhether to enable auto leader balance for IoTConsensus protocol.
TypeBoolean
Defaulttrue
EffectiveRestart required.

4.13 Cluster management

  • time_partition_origin
Nametime_partition_origin
DescriptionTime partition origin in milliseconds, default is equal to zero.
TypeLong
Unitms
Default0
EffectiveModify before the first startup.
  • time_partition_interval
Nametime_partition_interval
DescriptionTime partition interval in milliseconds, and partitioning data inside each data region, default is equal to one week
TypeLong
Unitms
Default604800000
EffectiveModify before the first startup.
  • heartbeat_interval_in_ms
Nameheartbeat_interval_in_ms
DescriptionThe heartbeat interval in milliseconds
TypeLong
Unitms
Default1000
EffectiveRestart required.
  • disk_space_warning_threshold
Namedisk_space_warning_threshold
DescriptionDisk remaining threshold at which DataNode is set to ReadOnly status
Typedouble(percentage)
Default0.05
EffectiveRestart required.

4.14 Memory Control Configuration

  • datanode_memory_proportion
Namedatanode_memory_proportion
DescriptionMemory Allocation Ratio: StorageEngine, QueryEngine, SchemaEngine, Consensus, StreamingEngine and Free Memory.
TypeRatio
Default3:3:1:1:1:1
EffectiveRestart required.
  • schema_memory_proportion
Nameschema_memory_proportion
DescriptionSchema Memory Allocation Ratio: SchemaRegion, SchemaCache, and PartitionCache.
TypeRatio
Default5:4:1
EffectiveRestart required.
  • storage_engine_memory_proportion
Namestorage_engine_memory_proportion
DescriptionMemory allocation ratio in StorageEngine: Write, Compaction
TypeRatio
Default8:2
EffectiveRestart required.
  • write_memory_proportion
Namewrite_memory_proportion
DescriptionMemory allocation ratio in writing: Memtable, TimePartitionInfo
TypeRatio
Default19:1
EffectiveRestart required.
  • primitive_array_size
Nameprimitive_array_size
Descriptionprimitive array size (length of each array) in array pool
Typeint32
Default64
EffectiveRestart required.
  • chunk_metadata_size_proportion
Namechunk_metadata_size_proportion
DescriptionRatio of compaction memory for chunk metadata maintains in memory when doing compaction
TypeDouble
Default0.1
EffectiveRestart required.
  • flush_proportion
Nameflush_proportion
DescriptionRatio of memtable memory for invoking flush disk, 0.4 by defaultIf you have extremely high write load (like batch=1000), it can be set lower than the default value like 0.2
TypeDouble
Default0.4
EffectiveRestart required.
  • buffered_arrays_memory_proportion
Namebuffered_arrays_memory_proportion
DescriptionRatio of memtable memory allocated for buffered arrays, 0.6 by default
TypeDouble
Default0.6
EffectiveRestart required.
  • reject_proportion
Namereject_proportion
DescriptionRatio of memtable memory for rejecting insertion, 0.8 by defaultIf you have extremely high write load (like batch=1000) and the physical memory size is large enough, it can be set higher than the default value like 0.9
TypeDouble
Default0.8
EffectiveRestart required.
  • device_path_cache_proportion
Namedevice_path_cache_proportion
DescriptionRatio of memtable memory for the DevicePathCache. DevicePathCache is the deviceId cache, keeping only one copy of the same deviceId in memory
TypeDouble
Default0.05
EffectiveRestart required.
  • write_memory_variation_report_proportion
Namewrite_memory_variation_report_proportion
DescriptionIf memory cost of data region increased more than proportion of allocated memory for writing, report to system. The default value is 0.001
TypeDouble
Default0.001
EffectiveRestart required.
  • check_period_when_insert_blocked
Namecheck_period_when_insert_blocked
DescriptionWhen an insertion is rejected, the waiting period (in ms) to check system again, 50 by default.If the insertion has been rejected and the read load is low, it can be set larger.
Typeint32
Default50
EffectiveRestart required.
  • io_task_queue_size_for_flushing
Nameio_task_queue_size_for_flushing
Descriptionsize of ioTaskQueue. The default value is 10
Typeint32
Default10
EffectiveRestart required.
  • enable_query_memory_estimation
Nameenable_query_memory_estimation
DescriptionIf true, we will estimate each query's possible memory footprint before executing it and deny it if its estimated memory exceeds current free memory
Typebool
Defaulttrue
EffectiveHot reload.

4.15 Schema Engine Configuration

  • schema_engine_mode
Nameschema_engine_mode
DescriptionThe schema management mode of schema engine. Currently, support Memory and PBTree.This config of all DataNodes in one cluster must keep same.
Typestring
DefaultMemory
EffectiveModify before the first startup.
  • partition_cache_size
Namepartition_cache_size
Descriptioncache size for partition.
TypeInt32
Default1000
EffectiveRestart required.
  • sync_mlog_period_in_ms
Namesync_mlog_period_in_ms
DescriptionThe cycle when metadata log is periodically forced to be written to disk(in milliseconds)If sync_mlog_period_in_ms=0 it means force metadata log to be written to disk after each refreshmentSetting this parameter to 0 may slow down the operation on slow disk.
TypeInt64
Default100
EffectiveRestart required.
  • tag_attribute_flush_interval
Nametag_attribute_flush_interval
Descriptioninterval num for tag and attribute records when force flushing to disk
Typeint32
Default1000
EffectiveModify before the first startup.
  • tag_attribute_total_size
Nametag_attribute_total_size
Descriptionmax size for a storage block for tags and attributes of a one-time series
Typeint32
Default700
EffectiveModify before the first startup.
  • max_measurement_num_of_internal_request
Namemax_measurement_num_of_internal_request
Descriptionmax measurement num of internal requestWhen creating timeseries with Session.createMultiTimeseries, the user input plan, the timeseries num ofwhich exceeds this num, will be split to several plans with timeseries no more than this num.
TypeInt32
Default10000
EffectiveRestart required.
  • datanode_schema_cache_eviction_policy
Namedatanode_schema_cache_eviction_policy
DescriptionPolicy of DataNodeSchemaCache eviction.
TypeString
DefaultFIFO
EffectiveRestart required.
  • cluster_timeseries_limit_threshold
Namecluster_timeseries_limit_threshold
DescriptionThis configuration parameter sets the maximum number of time series allowed in the cluster.
TypeInt32
Default-1
EffectiveRestart required.
  • cluster_device_limit_threshold
Namecluster_device_limit_threshold
DescriptionThis configuration parameter sets the maximum number of devices allowed in the cluster.
TypeInt32
Default-1
EffectiveRestart required.
  • database_limit_threshold
Namedatabase_limit_threshold
DescriptionThis configuration parameter sets the maximum number of Cluster Databases allowed.
TypeInt32
Default-1
EffectiveRestart required.

4.16 Configurations for creating schema automatically

  • enable_auto_create_schema
Nameenable_auto_create_schema
DescriptionWhether creating schema automatically is enabled
Valuetrue or false
Defaulttrue
EffectiveRestart required.
  • default_storage_group_level
Namedefault_storage_group_level
DescriptionDatabase level when creating schema automatically is enabled e.g. root.sg0.d1.s2We will set root.sg0 as the database if database level is 1If the incoming path is shorter than this value, the creation/insertion will fail.
Valueint32
Default1
EffectiveRestart required.
  • boolean_string_infer_type
Nameboolean_string_infer_type
Descriptionregister time series as which type when receiving boolean string “true” or “false”
ValueBOOLEAN or TEXT
DefaultBOOLEAN
EffectiveRestart required.
  • integer_string_infer_type
Nameinteger_string_infer_type
Descriptionregister time series as which type when receiving an integer string and using float or double may lose precision
ValueINT32, INT64, FLOAT, DOUBLE, TEXT
DefaultDOUBLE
EffectiveRestart required.
  • floating_string_infer_type
Namefloating_string_infer_type
Descriptionregister time series as which type when receiving a floating number string “6.7”
ValueDOUBLE, FLOAT or TEXT
DefaultDOUBLE
EffectiveRestart required.
  • nan_string_infer_type
Namenan_string_infer_type
Descriptionregister time series as which type when receiving the Literal NaN.
ValueDOUBLE, FLOAT or TEXT
DefaultDOUBLE
EffectiveRestart required.
  • default_boolean_encoding
Namedefault_boolean_encoding
DescriptionBOOLEAN encoding when creating schema automatically is enabled
ValuePLAIN, RLE
DefaultRLE
EffectiveRestart required.
  • default_int32_encoding
Namedefault_int32_encoding
DescriptionINT32 encoding when creating schema automatically is enabled
ValuePLAIN, RLE, TS_2DIFF, REGULAR, GORILLA
DefaultTS_2DIFF
EffectiveRestart required.
  • default_int64_encoding
Namedefault_int64_encoding
DescriptionINT64 encoding when creating schema automatically is enabled
ValuePLAIN, RLE, TS_2DIFF, REGULAR, GORILLA
DefaultTS_2DIFF
EffectiveRestart required.
  • default_float_encoding
Namedefault_float_encoding
DescriptionFLOAT encoding when creating schema automatically is enabled
ValuePLAIN, RLE, TS_2DIFF, GORILLA
DefaultGORILLA
EffectiveRestart required.
  • default_double_encoding
Namedefault_double_encoding
DescriptionDOUBLE encoding when creating schema automatically is enabled
ValuePLAIN, RLE, TS_2DIFF, GORILLA
DefaultGORILLA
EffectiveRestart required.
  • default_text_encoding
Namedefault_text_encoding
DescriptionTEXT encoding when creating schema automatically is enabled
ValuePLAIN
DefaultPLAIN
EffectiveRestart required.

4.17 Query Configurations

  • read_consistency_level
Nameread_consistency_level
DescriptionThe read consistency levelThese consistency levels are currently supported:strong(Default, read from the leader replica)weak(Read from a random replica)
TypeString
Defaultstrong
EffectiveRestart required.
  • meta_data_cache_enable
Namemeta_data_cache_enable
DescriptionWhether to cache meta data (BloomFilter, ChunkMetadata and TimeSeriesMetadata) or not.
TypeBoolean
Defaulttrue
EffectiveRestart required.
  • chunk_timeseriesmeta_free_memory_proportion
Namechunk_timeseriesmeta_free_memory_proportion
DescriptionRead memory Allocation Ratio: BloomFilterCache : ChunkCache : TimeSeriesMetadataCache : Coordinator : Operators : DataExchange : timeIndex in TsFileResourceList : others.The parameter form is a:b:c:d:e:f:g:h, where a, b, c, d, e, f, g and h are integers. for example: 1:1:1:1:1:1:1:1 , 1:100:200:50:200:200:200:50
TypeString
Default1 : 100 : 200 : 300 : 400
EffectiveRestart required.
  • enable_last_cache
Nameenable_last_cache
DescriptionWhether to enable LAST cache
TypeBoolean
Defaulttrue
EffectiveRestart required.
  • mpp_data_exchange_core_pool_size
Namempp_data_exchange_core_pool_size
DescriptionCore size of ThreadPool of MPP data exchange
Typeint32
Default10
EffectiveRestart required.
  • mpp_data_exchange_max_pool_size
Namempp_data_exchange_max_pool_size
DescriptionMax size of ThreadPool of MPP data exchange
Typeint32
Default10
EffectiveRestart required.
  • mpp_data_exchange_keep_alive_time_in_ms
Namempp_data_exchange_keep_alive_time_in_ms
DescriptionMax waiting time for MPP data exchange
Typeint32
Default1000
EffectiveRestart required.
  • driver_task_execution_time_slice_in_ms
Namedriver_task_execution_time_slice_in_ms
DescriptionThe max execution time of a DriverTask
Typeint32
Default200
EffectiveRestart required.
  • max_tsblock_size_in_bytes
Namemax_tsblock_size_in_bytes
DescriptionThe max capacity of a TsBlock
Typeint32
Default131072
EffectiveRestart required.
  • max_tsblock_line_numbers
Namemax_tsblock_line_numbers
DescriptionThe max number of lines in a single TsBlock
Typeint32
Default1000
EffectiveRestart required.
  • slow_query_threshold
Nameslow_query_threshold
DescriptionTime cost(ms) threshold for slow query
Typelong
Default10000
EffectiveHot reload
  • query_timeout_threshold
Namequery_timeout_threshold
DescriptionThe max executing time of query. unit: ms
TypeInt32
Default60000
EffectiveRestart required.
  • max_allowed_concurrent_queries
Namemax_allowed_concurrent_queries
DescriptionThe maximum allowed concurrently executing queries
TypeInt32
Default1000
EffectiveRestart required.
  • query_thread_count
Namequery_thread_count
DescriptionHow many threads can concurrently execute query statement. When <= 0, use CPU core number.
TypeInt32
Default0
EffectiveRestart required.
  • degree_of_query_parallelism
Namedegree_of_query_parallelism
DescriptionHow many pipeline drivers will be created for one fragment instance. When <= 0, use CPU core number / 2.
TypeInt32
Default0
EffectiveRestart required.
  • mode_map_size_threshold
Namemode_map_size_threshold
DescriptionThe threshold of count map size when calculating the MODE aggregation function
TypeInt32
Default10000
EffectiveRestart required.
  • batch_size
Namebatch_size
DescriptionThe amount of data iterate each time in server (the number of data strips, that is, the number of different timestamps.)
TypeInt32
Default100000
EffectiveRestart required.
  • sort_buffer_size_in_bytes
Namesort_buffer_size_in_bytes
DescriptionThe memory for external sort in sort operator, when the data size is smaller than sort_buffer_size_in_bytes, the sort operator will use in-memory sort.
Typelong
Default1048576
EffectiveRestart required.
  • merge_threshold_of_explain_analyze
Namemerge_threshold_of_explain_analyze
DescriptionThe threshold of operator count in the result set of EXPLAIN ANALYZE, if the number of operator in the result set is larger than this threshold, operator will be merged.
Typeint
Default10
EffectiveHot reload

4.18 TTL Configuration

  • ttl_check_interval
Namettl_check_interval
DescriptionThe interval of TTL check task in each database. The TTL check task will inspect and select files with a higher volume of expired data for compaction. Default is 2 hours.
Typeint
Default7200000
EffectiveRestart required.
  • max_expired_time
Namemax_expired_time
DescriptionThe maximum expiring time of device which has a ttl. Default is 1 month.If the data elapsed time (current timestamp minus the maximum data timestamp of the device in the file) of such devices exceeds this value, then the file will be cleaned by compaction.
Typeint
Default2592000000
EffectiveRestart required.
  • expired_data_ratio
Nameexpired_data_ratio
DescriptionThe expired device ratio. If the ratio of expired devices in one file exceeds this value, then expired data of this file will be cleaned by compaction.
Typefloat
Default0.3
EffectiveRestart required.

4.19 Storage Engine Configuration

  • timestamp_precision
Nametimestamp_precision
DescriptionUse this value to set timestamp precision as “ms”, “us” or “ns”.
TypeString
Defaultms
EffectiveModify before the first startup.
  • timestamp_precision_check_enabled
Nametimestamp_precision_check_enabled
DescriptionWhen the timestamp precision check is enabled, the timestamps those are over 13 digits for ms precision, or over 16 digits for us precision are not allowed to be inserted.
TypeBoolean
Defaulttrue
EffectiveModify before the first startup.
  • max_waiting_time_when_insert_blocked
Namemax_waiting_time_when_insert_blocked
DescriptionWhen the waiting time (in ms) of an inserting exceeds this, throw an exception. 10000 by default.
TypeInt32
Default10000
EffectiveRestart required.
  • handle_system_error
Namehandle_system_error
DescriptionWhat will the system do when unrecoverable error occurs.
TypeString
DefaultCHANGE_TO_READ_ONLY
EffectiveRestart required.
  • enable_timed_flush_seq_memtable
Nameenable_timed_flush_seq_memtable
DescriptionWhether to timed flush sequence tsfiles' memtables.
TypeBoolean
Defaulttrue
EffectiveHot reload
  • seq_memtable_flush_interval_in_ms
Nameseq_memtable_flush_interval_in_ms
DescriptionIf a memTable's last update time is older than current time minus this, the memtable will be flushed to disk.
Typelong
Default600000
EffectiveHot reload
  • seq_memtable_flush_check_interval_in_ms
Nameseq_memtable_flush_check_interval_in_ms
DescriptionThe interval to check whether sequence memtables need flushing.
Typelong
Default30000
EffectiveHot reload
  • enable_timed_flush_unseq_memtable
Nameenable_timed_flush_unseq_memtable
DescriptionWhether to timed flush unsequence tsfiles' memtables.
TypeBoolean
Defaulttrue
EffectiveHot reload
  • unseq_memtable_flush_interval_in_ms
Nameunseq_memtable_flush_interval_in_ms
DescriptionIf a memTable's last update time is older than current time minus this, the memtable will be flushed to disk.
Typelong
Default600000
EffectiveHot reload
  • unseq_memtable_flush_check_interval_in_ms
Nameunseq_memtable_flush_check_interval_in_ms
DescriptionThe interval to check whether unsequence memtables need flushing.
Typelong
Default30000
EffectiveHot reload
  • tvlist_sort_algorithm
Nametvlist_sort_algorithm
DescriptionThe sort algorithms used in the memtable's TVList
TypeString
DefaultTIM
EffectiveRestart required.
  • avg_series_point_number_threshold
Nameavg_series_point_number_threshold
DescriptionWhen the average point number of timeseries in memtable exceeds this, the memtable is flushed to disk.
Typeint32
Default100000
EffectiveRestart required.
  • flush_thread_count
Nameflush_thread_count
DescriptionHow many threads can concurrently flush. When <= 0, use CPU core number.
Typeint32
Default0
EffectiveRestart required.
  • enable_partial_insert
Nameenable_partial_insert
DescriptionIn one insert (one device, one timestamp, multiple measurements), if enable partial insert, one measurement failure will not impact other measurements
TypeBoolean
Defaulttrue
EffectiveRestart required.
  • recovery_log_interval_in_ms
Namerecovery_log_interval_in_ms
Descriptionthe interval to log recover progress of each vsg when starting iotdb
TypeInt32
Default5000
EffectiveRestart required.
  • 0.13_data_insert_adapt
Name0.13_data_insert_adapt
DescriptionIf using a v0.13 client to insert data, please set this configuration to true.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • enable_tsfile_validation
Nameenable_tsfile_validation
DescriptionVerify that TSfiles generated by Flush, Load, and Compaction are correct.
Typeboolean
Defaultfalse
EffectiveHot reload
  • tier_ttl_in_ms
Nametier_ttl_in_ms
DescriptionDefault tier TTL. When the survival time of the data exceeds the threshold, it will be migrated to the next tier.
Typelong
Default-1
EffectiveRestart required.

4.20 Compaction Configurations

  • enable_seq_space_compaction
Nameenable_seq_space_compaction
Descriptionsequence space compaction: only compact the sequence files
TypeBoolean
Defaulttrue
EffectiveHot reload
  • enable_unseq_space_compaction
Nameenable_unseq_space_compaction
Descriptionunsequence space compaction: only compact the unsequence files
TypeBoolean
Defaulttrue
EffectiveHot reload
  • enable_cross_space_compaction
Nameenable_cross_space_compaction
Descriptioncross space compaction: compact the unsequence files into the overlapped sequence files
TypeBoolean
Defaulttrue
EffectiveHot reload
  • enable_auto_repair_compaction
Nameenable_auto_repair_compaction
Descriptionenable auto repair unsorted file by compaction
TypeBoolean
Defaulttrue
EffectiveHot reload
  • cross_selector
Namecross_selector
Descriptionthe selector of cross space compaction task
TypeString
Defaultrewrite
EffectiveRestart required.
  • cross_performer
Namecross_performer
Descriptionthe compaction performer of cross space compaction task
TypeString
Defaultfast
EffectiveRestart required.
  • inner_seq_selector
Nameinner_seq_selector
Descriptionthe selector of inner sequence space compaction task
TypeString
Defaultsize_tiered_multi_target
EffectiveHot reload
  • inner_seq_performer
Nameinner_seq_performer
Descriptionthe performer of inner sequence space compaction task
TypeString
Defaultread_chunk
EffectiveRestart required.
  • inner_unseq_selector
Nameinner_unseq_selector
Descriptionthe selector of inner unsequence space compaction task
TypeString
Defaultsize_tiered_multi_target
EffectiveHot reload
  • inner_unseq_performer
Nameinner_unseq_performer
Descriptionthe performer of inner unsequence space compaction task
TypeString
Defaultfast
EffectiveRestart required.
  • compaction_priority
Namecompaction_priority
DescriptionThe priority of compaction executionINNER_CROSS: prioritize inner space compaction, reduce the number of files firstCROSS_INNER: prioritize cross space compaction, eliminate the unsequence files firstBALANCE: alternate two compaction types
TypeString
DefaultINNER_CROSS
Effective重启服务生效
  • candidate_compaction_task_queue_size
Namecandidate_compaction_task_queue_size
DescriptionThe size of candidate compaction task queue.
Typeint32
Default50
EffectiveRestart required.
  • target_compaction_file_size
Nametarget_compaction_file_size
DescriptionThis parameter is used in two places:The target tsfile size of inner space compaction.The candidate size of seq tsfile in cross space compaction will be smaller than target_compaction_file_size * 1.5.In most cases, the target file size of cross compaction won't exceed this threshold, and if it does, it will not be much larger than it.
TypeInt64
Default2147483648
EffectiveHot reload
  • inner_compaction_total_file_size_threshold
Nameinner_compaction_total_file_size_threshold
DescriptionThe total file size limit in inner space compaction.
Typeint64
Default10737418240
EffectiveHot reload
  • inner_compaction_total_file_num_threshold
Nameinner_compaction_total_file_num_threshold
DescriptionThe total file num limit in inner space compaction.
Typeint32
Default100
EffectiveHot reload
  • max_level_gap_in_inner_compaction
Namemax_level_gap_in_inner_compaction
DescriptionThe max level gap in inner compaction selection
Typeint32
Default2
EffectiveHot reload
  • target_chunk_size
Nametarget_chunk_size
DescriptionThe target chunk size in compaction and when memtable reaches this threshold, flush the memtable to disk.
TypeInt64
Default1048576
EffectiveRestart required.
  • target_chunk_point_num
Nametarget_chunk_point_num
DescriptionThe target point nums in one chunk in compaction
Typeint32
Default100000
EffectiveRestart required.
  • chunk_size_lower_bound_in_compaction
Namechunk_size_lower_bound_in_compaction
DescriptionIf the chunk size is lower than this threshold, it will be deserialized into points
TypeInt64
Default128
EffectiveRestart required.
  • chunk_point_num_lower_bound_in_compaction
Namechunk_point_num_lower_bound_in_compaction
DescriptionIf the chunk point num is lower than this threshold, it will be deserialized into points
Typeint32
Default100
EffectiveRestart required.
  • inner_compaction_candidate_file_num
Nameinner_compaction_candidate_file_num
DescriptionThe file num requirement when selecting inner space compaction candidate files
Typeint32
Default30
EffectiveHot reload
  • max_cross_compaction_candidate_file_num
Namemax_cross_compaction_candidate_file_num
DescriptionThe max file when selecting cross space compaction candidate files
Typeint32
Default500
EffectiveHot reload
  • max_cross_compaction_candidate_file_size
Namemax_cross_compaction_candidate_file_size
DescriptionThe max total size when selecting cross space compaction candidate files
TypeInt64
Default5368709120
EffectiveHot reload
  • min_cross_compaction_unseq_file_level
Namemin_cross_compaction_unseq_file_level
DescriptionThe min inner compaction level of unsequence file which can be selected as candidate
Typeint32
Default1
EffectiveHot reload
  • compaction_thread_count
Namecompaction_thread_count
DescriptionHow many threads will be set up to perform compaction, 10 by default.
Typeint32
Default10
EffectiveHot reload
  • compaction_max_aligned_series_num_in_one_batch
Namecompaction_max_aligned_series_num_in_one_batch
DescriptionHow many chunk will be compacted in aligned series compaction, 10 by default.
Typeint32
Default10
EffectiveHot reload
  • compaction_schedule_interval_in_ms
Namecompaction_schedule_interval_in_ms
DescriptionThe interval of compaction task schedule
TypeInt64
Default60000
EffectiveRestart required.
  • compaction_write_throughput_mb_per_sec
Namecompaction_write_throughput_mb_per_sec
DescriptionThe limit of write throughput merge can reach per second
Typeint32
Default16
EffectiveRestart required.
  • compaction_read_throughput_mb_per_sec
Namecompaction_read_throughput_mb_per_sec
DescriptionThe limit of read throughput merge can reach per second
Typeint32
Default0
EffectiveHot reload
  • compaction_read_operation_per_sec
Namecompaction_read_operation_per_sec
DescriptionThe limit of read operation merge can reach per second
Typeint32
Default0
EffectiveHot reload
  • sub_compaction_thread_count
Namesub_compaction_thread_count
DescriptionThe number of sub compaction threads to be set up to perform compaction.
Typeint32
Default4
EffectiveHot reload
  • inner_compaction_task_selection_disk_redundancy
Nameinner_compaction_task_selection_disk_redundancy
DescriptionRedundancy value of disk availability, only use for inner compaction.
Typedouble
Default0.05
EffectiveHot reload
  • inner_compaction_task_selection_mods_file_threshold
Nameinner_compaction_task_selection_mods_file_threshold
DescriptionMods file size threshold, only use for inner compaction.
Typelong
Default131072
EffectiveHot reload
  • compaction_schedule_thread_num
Namecompaction_schedule_thread_num
DescriptionThe number of threads to be set up to select compaction task.
Typeint32
Default4
EffectiveHot reload

4.21 Write Ahead Log Configuration

  • wal_mode
Namewal_mode
DescriptionThe details of these three modes are as follows:DISABLE: the system will disable wal.SYNC: the system will submit wal synchronously, write request will not return until its wal is fsynced to the disk successfully.ASYNC: the system will submit wal asynchronously, write request will return immediately no matter its wal is fsynced to the disk successfully.
TypeString
DefaultASYNC
EffectiveRestart required.
  • max_wal_nodes_num
Namemax_wal_nodes_num
Descriptioneach node corresponds to one wal directory The default value 0 means the number is determined by the system, the number is in the range of [data region num / 2, data region num].
Typeint32
Default0
EffectiveRestart required.
  • wal_async_mode_fsync_delay_in_ms
Namewal_async_mode_fsync_delay_in_ms
DescriptionDuration a wal flush operation will wait before calling fsync in the async mode
Typeint32
Default1000
EffectiveHot reload
  • wal_sync_mode_fsync_delay_in_ms
Namewal_sync_mode_fsync_delay_in_ms
DescriptionDuration a wal flush operation will wait before calling fsync in the sync mode
Typeint32
Default3
EffectiveHot reload
  • wal_buffer_size_in_byte
Namewal_buffer_size_in_byte
DescriptionBuffer size of each wal node
Typeint32
Default33554432
EffectiveRestart required.
  • wal_buffer_queue_capacity
Namewal_buffer_queue_capacity
DescriptionBuffer capacity of each wal queue
Typeint32
Default500
EffectiveRestart required.
  • wal_file_size_threshold_in_byte
Namewal_file_size_threshold_in_byte
DescriptionSize threshold of each wal file
Typeint32
Default31457280
EffectiveHot reload
  • wal_min_effective_info_ratio
Namewal_min_effective_info_ratio
DescriptionMinimum ratio of effective information in wal files
Typedouble
Default0.1
EffectiveHot reload
  • wal_memtable_snapshot_threshold_in_byte
Namewal_memtable_snapshot_threshold_in_byte
DescriptionMemTable size threshold for triggering MemTable snapshot in wal
Typeint64
Default8388608
EffectiveHot reload
  • max_wal_memtable_snapshot_num
Namemax_wal_memtable_snapshot_num
DescriptionMemTable's max snapshot number in wal
Typeint32
Default1
EffectiveHot reload
  • delete_wal_files_period_in_ms
Namedelete_wal_files_period_in_ms
DescriptionThe period when outdated wal files are periodically deleted
Typeint64
Default20000
EffectiveHot reload
  • wal_throttle_threshold_in_byte
Namewal_throttle_threshold_in_byte
DescriptionThe minimum size of wal files when throttle down in IoTConsensus
Typelong
Default53687091200
EffectiveHot reload
  • iot_consensus_cache_window_time_in_ms
Nameiot_consensus_cache_window_time_in_ms
DescriptionMaximum wait time of write cache in IoTConsensus
Typelong
Default-1
EffectiveHot reload
  • enable_wal_compression
Nameiot_consensus_cache_window_time_in_ms
DescriptionEnable Write Ahead Log compression.
Typeboolean
Defaulttrue
EffectiveHot reload

4.22 IoTConsensus Configuration

  • data_region_iot_max_log_entries_num_per_batch
Namedata_region_iot_max_log_entries_num_per_batch
DescriptionThe maximum log entries num in IoTConsensus Batch
Typeint32
Default1024
EffectiveRestart required.
  • data_region_iot_max_size_per_batch
Namedata_region_iot_max_size_per_batch
DescriptionThe maximum size in IoTConsensus Batch
Typeint32
Default16777216
EffectiveRestart required.
  • data_region_iot_max_pending_batches_num
Namedata_region_iot_max_pending_batches_num
DescriptionThe maximum pending batches num in IoTConsensus
Typeint32
Default5
EffectiveRestart required.
  • data_region_iot_max_memory_ratio_for_queue
Namedata_region_iot_max_memory_ratio_for_queue
DescriptionThe maximum memory ratio for queue in IoTConsensus
Typedouble
Default0.6
EffectiveRestart required.
  • region_migration_speed_limit_bytes_per_second
Nameregion_migration_speed_limit_bytes_per_second
DescriptionThe maximum transit size in byte per second for region migration
Typelong
Default33554432
EffectiveRestart required.

4.23 TsFile Configurations

  • group_size_in_byte
Namegroup_size_in_byte
DescriptionThe maximum number of bytes written to disk each time the data in memory is written to disk
Typeint32
Default134217728
EffectiveHot reload
  • page_size_in_byte
Namepage_size_in_byte
DescriptionThe memory size for each series writer to pack page, default value is 64KB
Typeint32
Default65536
EffectiveHot reload
  • max_number_of_points_in_page
Namemax_number_of_points_in_page
DescriptionThe maximum number of data points in a page
Typeint32
Default10000
EffectiveHot reload
  • pattern_matching_threshold
Namepattern_matching_threshold
DescriptionThe threshold for pattern matching in regex
Typeint32
Default1000000
EffectiveHot reload
  • float_precision
Namefloat_precision
DescriptionFloating-point precision of query results.Only effective for RLE and TS_2DIFF encodings.Due to the limitation of machine precision, some values may not be interpreted strictly.
Typeint32
Default2
EffectiveHot reload
  • value_encoder
Namevalue_encoder
DescriptionEncoder of value series. default value is PLAIN.
TypeFor int, long data type, also supports TS_2DIFF and RLE(run-length encoding), GORILLA and ZIGZAG.
DefaultPLAIN
EffectiveHot reload
  • compressor
Namecompressor
DescriptionCompression configuration And it is also used as the default compressor of time column in aligned timeseries.
TypeData compression method, supports UNCOMPRESSED, SNAPPY, ZSTD, LZMA2 or LZ4. Default value is LZ4
DefaultLZ4
EffectiveHot reload
  • encrypt_flag
Namecompressor
DescriptionEnable data encryption
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • encrypt_type
Namecompressor
DescriptionThe method of data encrytion
TypeString
Defaultorg.apache.tsfile.encrypt.UNENCRYPTED
EffectiveRestart required.
  • encrypt_key_path
Nameencrypt_key_path
DescriptionThe path of key for data encryption
TypeString
DefaultNone
EffectiveRestart required.

4.24 Authorization Configuration

  • authorizer_provider_class
Nameauthorizer_provider_class
Descriptionwhich class to serve for authorization.
TypeString
Defaultorg.apache.iotdb.commons.auth.authorizer.LocalFileAuthorizer
EffectiveRestart required.
其他可选值org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer
  • openID_url
NameopenID_url
DescriptionThe url of openID server If OpenIdAuthorizer is enabled, then openID_url must be set.
TypeString(a http link)
DefaultNone
EffectiveRestart required.
  • iotdb_server_encrypt_decrypt_provider
Nameiotdb_server_encrypt_decrypt_provider
Descriptionencryption provider class
TypeString
Defaultorg.apache.iotdb.commons.security.encrypt.MessageDigestEncrypt
EffectiveModify before the first startup.
  • iotdb_server_encrypt_decrypt_provider_parameter
Nameiotdb_server_encrypt_decrypt_provider_parameter
Descriptionencryption provided class parameter
TypeString
DefaultNone
EffectiveModify before the first startup.
  • author_cache_size
Nameauthor_cache_size
DescriptionCache size of user and role
Typeint32
Default1000
EffectiveRestart required.
  • author_cache_expire_time
Nameauthor_cache_expire_time
DescriptionCache expire time of user and role
Typeint32
Default30
EffectiveRestart required.

4.25 UDF Configuration

  • udf_initial_byte_array_length_for_memory_control
Nameudf_initial_byte_array_length_for_memory_control
DescriptionUsed to estimate the memory usage of text fields in a UDF query.It is recommended to set this value to be slightly larger than the average length of all text records.
Typeint32
Default48
EffectiveRestart required.
  • udf_memory_budget_in_mb
Nameudf_memory_budget_in_mb
DescriptionHow much memory may be used in ONE UDF query (in MB). The upper limit is 20% of allocated memory for read.
TypeFloat
Default30.0
EffectiveRestart required.
  • udf_reader_transformer_collector_memory_proportion
Nameudf_reader_transformer_collector_memory_proportion
DescriptionUDF memory allocation ratio.The parameter form is a:b:c, where a, b, and c are integers.
TypeString
Default1:1:1
EffectiveRestart required.
  • udf_lib_dir
Nameudf_lib_dir
Descriptionthe udf lib directory
TypeString
Defaultext/udf(Windows:ext\udf)
EffectiveRestart required.

4.26 Trigger Configuration

  • trigger_lib_dir
Nametrigger_lib_dir
Descriptionthe trigger lib directory
TypeString
Defaultext/trigger
EffectiveRestart required.
  • stateful_trigger_retry_num_when_not_found
Namestateful_trigger_retry_num_when_not_found
DescriptionHow many times will we retry to found an instance of stateful trigger on DataNodes
TypeInt32
Default3
EffectiveRestart required.

4.27 Select-Into Configuration

  • into_operation_buffer_size_in_byte
Nameinto_operation_buffer_size_in_byte
DescriptionThe maximum memory occupied by the data to be written when executing select-into statements.
Typelong
Default104857600
EffectiveHot reload
  • select_into_insert_tablet_plan_row_limit
Nameselect_into_insert_tablet_plan_row_limit
DescriptionThe maximum number of rows can be processed in insert-tablet-plan when executing select-into statements.
Typeint32
Default10000
EffectiveHot reload
  • into_operation_execution_thread_count
Nameinto_operation_execution_thread_count
DescriptionThe number of threads in the thread pool that execute insert-tablet tasks
Typeint32
Default2
EffectiveRestart required.

4.28 Continuous Query Configuration

  • continuous_query_submit_thread_count
Namecontinuous_query_execution_thread
DescriptionThe number of threads in the scheduled thread pool that submit continuous query tasks periodically
Typeint32
Default2
EffectiveRestart required.
  • continuous_query_min_every_interval_in_ms
Namecontinuous_query_min_every_interval_in_ms
DescriptionThe minimum value of the continuous query execution time interval
Typelong (duration)
Default1000
EffectiveRestart required.

4.29 Pipe Configuration

  • pipe_lib_dir
Namepipe_lib_dir
Descriptionthe pipe lib directory.
Typestring
Defaultext/pipe
EffectiveNot support modify
  • pipe_subtask_executor_max_thread_num
Namepipe_subtask_executor_max_thread_num
DescriptionThe maximum number of threads that can be used to execute the pipe subtasks in PipeSubtaskExecutor. The actual value will be min(pipe_subtask_executor_max_thread_num, max(1, CPU core number / 2)).
Typeint
Default5
EffectiveRestart required.
  • pipe_sink_timeout_ms
Namepipe_sink_timeout_ms
DescriptionThe connection timeout (in milliseconds) for the thrift client.
Typeint
Default900000
EffectiveRestart required.
  • pipe_sink_selector_number
Namepipe_sink_selector_number
DescriptionThe maximum number of selectors that can be used in the sink.Recommend to set this value to less than or equal to pipe_sink_max_client_number.
Typeint
Default4
EffectiveRestart required.
  • pipe_sink_max_client_number
Namepipe_sink_max_client_number
DescriptionThe maximum number of clients that can be used in the sink.
Typeint
Default16
EffectiveRestart required.
  • pipe_air_gap_receiver_enabled
Namepipe_air_gap_receiver_enabled
DescriptionWhether to enable receiving pipe data through air gap.The receiver can only return 0 or 1 in TCP mode to indicate whether the data is received successfully.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • pipe_air_gap_receiver_port
Namepipe_air_gap_receiver_port
DescriptionThe port for the server to receive pipe data through air gap.
Typeint
Default9780
EffectiveRestart required.
  • pipe_all_sinks_rate_limit_bytes_per_second
Namepipe_all_sinks_rate_limit_bytes_per_second
DescriptionThe total bytes that all pipe sinks can transfer per second.When given a value less than or equal to 0, it means no limit. default value is -1, which means no limit.
Typedouble
Default-1
EffectiveHot reload

4.30 RatisConsensus Configuration

  • config_node_ratis_log_appender_buffer_size_max
Nameconfig_node_ratis_log_appender_buffer_size_max
Descriptionmax payload size for a single log-sync-RPC from leader to follower of ConfigNode (in byte, by default 16MB)
Typeint32
Default16777216
EffectiveRestart required.
  • schema_region_ratis_log_appender_buffer_size_max
Nameschema_region_ratis_log_appender_buffer_size_max
Descriptionmax payload size for a single log-sync-RPC from leader to follower of SchemaRegion (in byte, by default 16MB)
Typeint32
Default16777216
EffectiveRestart required.
  • data_region_ratis_log_appender_buffer_size_max
Namedata_region_ratis_log_appender_buffer_size_max
Descriptionmax payload size for a single log-sync-RPC from leader to follower of DataRegion (in byte, by default 16MB)
Typeint32
Default16777216
EffectiveRestart required.
  • config_node_ratis_snapshot_trigger_threshold
Nameconfig_node_ratis_snapshot_trigger_threshold
Descriptionmax numbers of snapshot_trigger_threshold logs to trigger a snapshot of Confignode
Typeint32
Default400,000
EffectiveRestart required.
  • schema_region_ratis_snapshot_trigger_threshold
Nameschema_region_ratis_snapshot_trigger_threshold
Descriptionmax numbers of snapshot_trigger_threshold logs to trigger a snapshot of SchemaRegion
Typeint32
Default400,000
EffectiveRestart required.
  • data_region_ratis_snapshot_trigger_threshold
Namedata_region_ratis_snapshot_trigger_threshold
Descriptionmax numbers of snapshot_trigger_threshold logs to trigger a snapshot of DataRegion
Typeint32
Default400,000
EffectiveRestart required.
  • config_node_ratis_log_unsafe_flush_enable
Nameconfig_node_ratis_log_unsafe_flush_enable
DescriptionIs confignode allowed flushing Raft Log asynchronously
Typeboolean
Defaultfalse
EffectiveRestart required.
  • schema_region_ratis_log_unsafe_flush_enable
Nameschema_region_ratis_log_unsafe_flush_enable
DescriptionIs schemaregion allowed flushing Raft Log asynchronously
Typeboolean
Defaultfalse
EffectiveRestart required.
  • data_region_ratis_log_unsafe_flush_enable
Namedata_region_ratis_log_unsafe_flush_enable
DescriptionIs dataregion allowed flushing Raft Log asynchronously
Typeboolean
Defaultfalse
EffectiveRestart required.
  • config_node_ratis_log_segment_size_max_in_byte
Nameconfig_node_ratis_log_segment_size_max_in_byte
Descriptionmax capacity of a RaftLog segment file of confignode (in byte, by default 24MB)
Typeint32
Default25165824
EffectiveRestart required.
  • schema_region_ratis_log_segment_size_max_in_byte
Nameschema_region_ratis_log_segment_size_max_in_byte
Descriptionmax capacity of a RaftLog segment file of schemaregion (in byte, by default 24MB)
Typeint32
Default25165824
EffectiveRestart required.
  • data_region_ratis_log_segment_size_max_in_byte
Namedata_region_ratis_log_segment_size_max_in_byte
Descriptionmax capacity of a RaftLog segment file of dataregion(in byte, by default 24MB)
Typeint32
Default25165824
EffectiveRestart required.
  • config_node_simple_consensus_log_segment_size_max_in_byte
Namedata_region_ratis_log_segment_size_max_in_byte
Descriptionmax capacity of a simple log segment file of confignode(in byte, by default 24MB)
Typeint32
Default25165824
EffectiveRestart required.
  • config_node_ratis_grpc_flow_control_window
Nameconfig_node_ratis_grpc_flow_control_window
Descriptionconfignode flow control window for ratis grpc log appender
Typeint32
Default4194304
EffectiveRestart required.
  • schema_region_ratis_grpc_flow_control_window
Nameschema_region_ratis_grpc_flow_control_window
Descriptionschema region flow control window for ratis grpc log appender
Typeint32
Default4194304
EffectiveRestart required.
  • data_region_ratis_grpc_flow_control_window
Namedata_region_ratis_grpc_flow_control_window
Descriptiondata region flow control window for ratis grpc log appender
Typeint32
Default4194304
EffectiveRestart required.
  • config_node_ratis_grpc_leader_outstanding_appends_max
Nameconfig_node_ratis_grpc_leader_outstanding_appends_max
Descriptionconfig node grpc line concurrency threshold
Typeint32
Default128
EffectiveRestart required.
  • schema_region_ratis_grpc_leader_outstanding_appends_max
Nameschema_region_ratis_grpc_leader_outstanding_appends_max
Descriptionschema region grpc line concurrency threshold
Typeint32
Default128
EffectiveRestart required.
  • data_region_ratis_grpc_leader_outstanding_appends_max
Namedata_region_ratis_grpc_leader_outstanding_appends_max
Descriptiondata region grpc line concurrency threshold
Typeint32
Default128
EffectiveRestart required.
  • config_node_ratis_log_force_sync_num
Nameconfig_node_ratis_log_force_sync_num
Descriptionconfig node fsync threshold
Typeint32
Default128
EffectiveRestart required.
  • schema_region_ratis_log_force_sync_num
Nameschema_region_ratis_log_force_sync_num
Descriptionschema region fsync threshold
Typeint32
Default128
EffectiveRestart required.
  • data_region_ratis_log_force_sync_num
Namedata_region_ratis_log_force_sync_num
Descriptiondata region fsync threshold
Typeint32
Default128
EffectiveRestart required.
  • config_node_ratis_rpc_leader_election_timeout_min_ms
Nameconfig_node_ratis_rpc_leader_election_timeout_min_ms
Descriptionconfignode leader min election timeout
Typeint32
Default2000ms
EffectiveRestart required.
  • schema_region_ratis_rpc_leader_election_timeout_min_ms
Nameschema_region_ratis_rpc_leader_election_timeout_min_ms
Descriptionschema region leader min election timeout
Typeint32
Default2000ms
EffectiveRestart required.
  • data_region_ratis_rpc_leader_election_timeout_min_ms
Namedata_region_ratis_rpc_leader_election_timeout_min_ms
Descriptiondata region leader min election timeout
Typeint32
Default2000ms
EffectiveRestart required.
  • config_node_ratis_rpc_leader_election_timeout_max_ms
Nameconfig_node_ratis_rpc_leader_election_timeout_max_ms
Descriptionconfignode leader max election timeout
Typeint32
Default4000ms
EffectiveRestart required.
  • schema_region_ratis_rpc_leader_election_timeout_max_ms
Nameschema_region_ratis_rpc_leader_election_timeout_max_ms
Descriptionschema region leader max election timeout
Typeint32
Default4000ms
EffectiveRestart required.
  • data_region_ratis_rpc_leader_election_timeout_max_ms
Namedata_region_ratis_rpc_leader_election_timeout_max_ms
Descriptiondata region leader max election timeout
Typeint32
Default4000ms
EffectiveRestart required.
  • config_node_ratis_request_timeout_ms
Nameconfig_node_ratis_request_timeout_ms
Descriptionconfignode ratis client retry threshold
Typeint32
Default10000
EffectiveRestart required.
  • schema_region_ratis_request_timeout_ms
Nameschema_region_ratis_request_timeout_ms
Descriptionschema region ratis client retry threshold
Typeint32
Default10000
EffectiveRestart required.
  • data_region_ratis_request_timeout_ms
Namedata_region_ratis_request_timeout_ms
Descriptiondata region ratis client retry threshold
Typeint32
Default10000
EffectiveRestart required.
  • config_node_ratis_max_retry_attempts
Nameconfig_node_ratis_max_retry_attempts
Descriptionconfignode ratis client retry times
Typeint32
Default10
EffectiveRestart required.
  • config_node_ratis_initial_sleep_time_ms
Nameconfig_node_ratis_initial_sleep_time_ms
Descriptionconfignode ratis client initial sleep time
Typeint32
Default100ms
EffectiveRestart required.
  • config_node_ratis_max_sleep_time_ms
Nameconfig_node_ratis_max_sleep_time_ms
Descriptionconfignode ratis client max retry sleep time
Typeint32
Default10000
EffectiveRestart required.
  • schema_region_ratis_max_retry_attempts
Nameschema_region_ratis_max_retry_attempts
Descriptionschema region ratis client max retry times
Typeint32
Default10
EffectiveRestart required.
  • schema_region_ratis_initial_sleep_time_ms
Nameschema_region_ratis_initial_sleep_time_ms
Descriptionschema region ratis client init sleep time
Typeint32
Default100ms
EffectiveRestart required.
  • schema_region_ratis_max_sleep_time_ms
Nameschema_region_ratis_max_sleep_time_ms
Descriptionschema region ratis client max sleep time
Typeint32
Default1000
EffectiveRestart required.
  • data_region_ratis_max_retry_attempts
Namedata_region_ratis_max_retry_attempts
Descriptiondata region ratis client max retry sleep time
Typeint32
Default10
EffectiveRestart required.
  • data_region_ratis_initial_sleep_time_ms
Namedata_region_ratis_initial_sleep_time_ms
Descriptiondata region ratis client init sleep time
Typeint32
Default100ms
EffectiveRestart required.
  • data_region_ratis_max_sleep_time_ms
Namedata_region_ratis_max_sleep_time_ms
Descriptiondata region ratis client max retry sleep time
Typeint32
Default1000
EffectiveRestart required.
  • ratis_first_election_timeout_min_ms
Nameratis_first_election_timeout_min_ms
DescriptionRatis first election min timeout
Typeint64
Default50 (ms)
EffectiveRestart required.
  • ratis_first_election_timeout_max_ms
Nameratis_first_election_timeout_max_ms
DescriptionRatis first election max timeout
Typeint64
Default150 (ms)
EffectiveRestart required.
  • config_node_ratis_preserve_logs_num_when_purge
Nameconfig_node_ratis_preserve_logs_num_when_purge
Descriptionconfignode snapshot preserves certain logs when taking snapshot and purge
Typeint32
Default1000
EffectiveRestart required.
  • schema_region_ratis_preserve_logs_num_when_purge
Nameschema_region_ratis_preserve_logs_num_when_purge
Descriptionschema region snapshot preserves certain logs when taking snapshot and purge
Typeint32
Default1000
EffectiveRestart required.
  • data_region_ratis_preserve_logs_num_when_purge
Namedata_region_ratis_preserve_logs_num_when_purge
Descriptiondata region snapshot preserves certain logs when taking snapshot and purge
Typeint32
Default1000
EffectiveRestart required.
  • config_node_ratis_log_max_size
Nameconfig_node_ratis_log_max_size
Descriptionconfig node Raft Log disk size control
Typeint64
Default2147483648 (2GB)
EffectiveRestart required.
  • schema_region_ratis_log_max_size
Nameschema_region_ratis_log_max_size
Descriptionschema region Raft Log disk size control
Typeint64
Default2147483648 (2GB)
EffectiveRestart required.
  • data_region_ratis_log_max_size
Namedata_region_ratis_log_max_size
Descriptiondata region Raft Log disk size control
Typeint64
Default21474836480 (20GB)
EffectiveRestart required.
  • config_node_ratis_periodic_snapshot_interval
Nameconfig_node_ratis_periodic_snapshot_interval
Descriptionconfig node Raft periodic snapshot interval
Typeint64
Default86400 (s)
EffectiveRestart required.
  • schema_region_ratis_periodic_snapshot_interval
Nameschema_region_ratis_preserve_logs_num_when_purge
Descriptionschema region Raft periodic snapshot interval
Typeint64
Default86400 (s)
EffectiveRestart required.
  • data_region_ratis_periodic_snapshot_interval
Namedata_region_ratis_preserve_logs_num_when_purge
Descriptiondata region Raft periodic snapshot interval
Typeint64
Default86400 (s)
EffectiveRestart required.

4.31 IoTConsensusV2 Configuration

  • iot_consensus_v2_pipeline_size
Nameiot_consensus_v2_pipeline_size
DescriptionDefault event buffer size for connector and receiver in iot consensus v2
Typeint
Default5
EffectiveRestart required.
  • iot_consensus_v2_mode
Nameiot_consensus_v2_pipeline_size
DescriptionIoTConsensusV2 mode.
TypeString
Defaultbatch
EffectiveRestart required.

4.32 Procedure Configuration

  • procedure_core_worker_thread_count
Nameprocedure_core_worker_thread_count
DescriptionDefault number of worker thread count
Typeint32
Default4
EffectiveRestart required.
  • procedure_completed_clean_interval
Nameprocedure_completed_clean_interval
DescriptionDefault time interval of completed procedure cleaner work in, time unit is second
Typeint32
Default30(s)
EffectiveRestart required.
  • procedure_completed_evict_ttl
Nameprocedure_completed_evict_ttl
DescriptionDefault ttl of completed procedure, time unit is second
Typeint32
Default60(s)
EffectiveRestart required.

4.33 MQTT Broker Configuration

  • enable_mqtt_service
Nameenable_mqtt_service。
Descriptionwhether to enable the mqtt service.
TypeBoolean
Defaultfalse
EffectiveHot reload
  • mqtt_host
Namemqtt_host
Descriptionthe mqtt service binding host.
TypeString
Default127.0.0.1
EffectiveHot reload
  • mqtt_port
Namemqtt_port
Descriptionthe mqtt service binding port.
Typeint32
Default1883
EffectiveHot reload
  • mqtt_handler_pool_size
Namemqtt_handler_pool_size
Descriptionthe handler pool size for handing the mqtt messages.
Typeint32
Default1
EffectiveHot reload
  • mqtt_payload_formatter
Namemqtt_payload_formatter
Descriptionthe mqtt message payload formatter.
TypeString
Defaultjson
EffectiveHot reload
  • mqtt_max_message_size
Namemqtt_max_message_size
Descriptionmax length of mqtt message in byte
Typeint32
Default1048576
EffectiveHot reload

4.34 Audit log Configuration

  • enable_audit_log
Nameenable_audit_log
Descriptionwhether to enable the audit log.
TypeBoolean
Defaultfalse
EffectiveRestart required.
  • audit_log_storage
Nameaudit_log_storage
DescriptionOutput location of audit logs
TypeString
DefaultIOTDB,LOGGER
EffectiveRestart required.
  • audit_log_operation
Nameaudit_log_operation
Descriptionwhether enable audit log for DML operation of datawhether enable audit log for DDL operation of schemawhether enable audit log for QUERY operation of data and schema
TypeString
DefaultDML,DDL,QUERY
EffectiveRestart required.
  • enable_audit_log_for_native_insert_api
Nameenable_audit_log_for_native_insert_api
Descriptionwhether the local write api records audit logs
TypeBoolean
Defaulttrue
EffectiveRestart required.

4.35 White List Configuration

  • enable_white_list
Nameenable_white_list
Descriptionwhether enable white list
TypeBoolean
Defaultfalse
EffectiveHot reload

4.36 IoTDB-AI Configuration

  • model_inference_execution_thread_count
Namemodel_inference_execution_thread_count
DescriptionThe thread count which can be used for model inference operation.
Typeint
Default5
EffectiveRestart required.

4.37 Load TsFile Configuration

  • load_clean_up_task_execution_delay_time_seconds
Nameload_clean_up_task_execution_delay_time_seconds
DescriptionLoad clean up task is used to clean up the unsuccessful loaded tsfile after a certain period of time.
Typeint
Default1800
EffectiveHot reload
  • load_write_throughput_bytes_per_second
Nameload_write_throughput_bytes_per_second
DescriptionThe maximum bytes per second of disk write throughput when loading tsfile.
Typeint
Default-1
EffectiveHot reload
  • load_active_listening_enable
Nameload_active_listening_enable
DescriptionWhether to enable the active listening mode for tsfile loading.
TypeBoolean
Defaulttrue
EffectiveHot reload
  • load_active_listening_dirs
Nameload_active_listening_dirs
DescriptionThe directory to be actively listened for tsfile loading.Multiple directories should be separated by a ‘,’.
TypeString
Defaultext/load/pending
EffectiveHot reload
  • load_active_listening_fail_dir
Nameload_active_listening_fail_dir
DescriptionThe directory where tsfiles are moved if the active listening mode fails to load them.
TypeString
Defaultext/load/failed
EffectiveHot reload
  • load_active_listening_max_thread_num
Nameload_active_listening_max_thread_num
DescriptionThe maximum number of threads that can be used to load tsfile actively.The default value, when this parameter is commented out or <= 0, use CPU core number.
TypeLong
Default0
EffectiveRestart required.
  • load_active_listening_check_interval_seconds
Nameload_active_listening_check_interval_seconds
DescriptionThe interval specified in seconds for the active listening mode to check the directory specified in load_active_listening_dirs.The active listening mode will check the directory every load_active_listening_check_interval_seconds seconds.
TypeLong
Default5
EffectiveRestart required.

4.38 Dispatch Retry Configuration

  • enable_retry_for_unknown_error
Nameenable_retry_for_unknown_error
DescriptionThe maximum retrying time for write request remotely dispatching, time unit is milliseconds.
TypeLong
Default60000
EffectiveHot reload
  • enable_retry_for_unknown_error
Nameenable_retry_for_unknown_error
DescriptionWhether retrying for unknown errors.
Typeboolean
Defaultfalse
EffectiveHot reload