ConfigNode Configuration

IoTDB ConfigNode files are under confignode/conf.

  • confignode-env.sh/bat：Environment configurations, in which we could set the memory allocation of ConfigNode.

  • iotdb-confignode.properties：IoTDB ConfigNode system configurations.

Environment Configuration File（confignode-env.sh/bat）

The environment configuration file is mainly used to configure the Java environment related parameters when ConfigNode is running, such as JVM related configuration. This part of the configuration is passed to the JVM when the ConfigNode starts.

The details of each parameter are as follows:

  • MAX_HEAP_SIZE
NameMAX_HEAP_SIZE
DescriptionThe maximum heap memory size that IoTDB can use
TypeString
DefaultOn Linux or MacOS, the default is one quarter of the memory. On Windows, the default value for 32-bit systems is 512M, and the default for 64-bit systems is 2G.
EffectiveAfter restarting system
  • HEAP_NEWSIZE
NameHEAP_NEWSIZE
DescriptionThe minimum heap memory size that IoTDB will use when startup
TypeString
DefaultOn Linux or MacOS, the default is min{cores * 100M, one quarter of MAX_HEAP_SIZE}. On Windows, the default value for 32-bit systems is 512M, and the default for 64-bit systems is 2G.
EffectiveAfter restarting system
  • MAX_DIRECT_MEMORY_SIZE
NameMAX_DIRECT_MEMORY_SIZE
DescriptionThe max direct memory that IoTDB could use
TypeString
DefaultEqual to the MAX_HEAP_SIZE
EffectiveAfter restarting system

ConfigNode Configuration File（iotdb-confignode.properties）

The global configuration of cluster is in ConfigNode.

Internal RPC Service Configurations

  • internal_address
Nameinternal_address
DescriptionConfigNode internal service address
TypeString
Default0.0.0.0
EffectiveAfter restarting system
  • internal_port
Nameinternal_port
DescriptionConfigNode internal service port
TypeShort Int : [0,65535]
Default22277
EffectiveAfter restarting system
  • target_config_nodes
Nametarget_config_nodes
DescriptionTarget ConfigNode address, for current ConfigNode to join the cluster
TypeString
Default127.0.0.1:22277
EffectiveAfter restarting system
  • rpc_thrift_compression_enable
Namerpc_thrift_compression_enable
DescriptionWhether enable thrift's compression (using GZIP).
TypeBoolean
Defaultfalse
EffectiveAfter restarting system
  • rpc_advanced_compression_enable
Namerpc_advanced_compression_enable
DescriptionWhether enable thrift's advanced compression.
TypeBoolean
Defaultfalse
EffectiveAfter restarting system
  • rpc_max_concurrent_client_num
Namerpc_max_concurrent_client_num
DescriptionMax concurrent rpc connections
TypeShort Int : [0,65535]
Description65535
EffectiveAfter restarting system
  • thrift_max_frame_size
Namethrift_max_frame_size
DescriptionMax size of bytes of each thrift RPC request/response
TypeLong
UnitByte
Default536870912
EffectiveAfter restarting system
  • thrift_init_buffer_size
Namethrift_init_buffer_size
DescriptionInitial size of bytes of buffer that thrift used
Typelong
Default1024
EffectiveAfter restarting system

Replication and Consensus

  • consensus_port
Nameconsensus_port
DescriptionConfigNode data Consensus Port
TypeShort Int : [0,65535]
Default22278
EffectiveAfter restarting system
  • data_replication_factor
Namedata_replication_factor
DescriptionData replication num
TypeInt
Default1
EffectiveAfter restarting system
  • data_region_consensus_protocol_class
Namedata_region_consensus_protocol_class
DescriptionConsensus protocol of data replicas, StandAloneConsensus could only be used in 1 replica，larger than 1 replicas could use MultiLeaderConsensus or RatisConsensus
TypeString
Defaultorg.apache.iotdb.consensus.standalone.StandAloneConsensus
EffectiveOnly allowed to be modified in first start up
  • schema_replication_factor
Nameschema_replication_factor
DescriptionSchema replication num
TypeInt
Default1
EffectiveAfter restarting system
  • schema_region_consensus_protocol_class
Nameschema_region_consensus_protocol_class
DescriptionConsensus protocol of schema replicas, StandAloneConsensus could only be used in 1 replica，larger than 1 replicas could only use RatisConsensus
TypeString
Defaultorg.apache.iotdb.consensus.standalone.StandAloneConsensus
EffectiveOnly allowed to be modified in first start up
  • region_allocate_strategy
Nameregion_allocate_strategy
DescriptionRegion allocate strategy, COPY_SET is suitable for large clusters, GREEDY is suitable for small clusters
TypeString
DefaultGREEDY
EffectiveAfter restarting system

HeartBeat

  • heartbeat_interval
Nameheartbeat_interval
DescriptionHeartbeat interval in the cluster nodes
TypeLong
Unitms
Default1000
EffectiveAfter restarting system

Partition Strategy

  • series_partition_slot_num
Nameseries_partition_slot_num
DescriptionSlot num of series partition
TypeInt
Default10000
EffectiveOnly allowed to be modified in first start up
  • series_partition_executor_class
Nameseries_partition_executor_class
DescriptionSeries partition hash function
TypeString
Defaultorg.apache.iotdb.commons.partition.executor.hash.BKDRHashExecutor
EffectiveOnly allowed to be modified in first start up

Storage Group

  • default_ttl
Namedefault_ttl
DescriptionDefault ttl when each storage group created
TypeLong
DefaultInfinity
EffectiveAfter restarting system
  • time_partition_interval_for_routing
Nametime_partition_interval_for_routing
DescriptionTime partition interval of data when ConfigNode allocate data
TypeLong
Unitms
Default86400000
EffectiveOnly allowed to be modified in first start up

Data Directory

  • system_dir
Namesystem_dir
DescriptionConfigNode system data dir
TypeString
Defaultdata/system（Windows：data\system）
EffectiveAfter restarting system
  • consensus_dir
Nameconsensus_dir
DescriptionConfigNode Consensus protocol data dir
TypeString
Defaultdata/consensus（Windows：data\consensus）
EffectiveAfter restarting system
  • udf_lib_dir
Nameudf_lib_dir
DescriptionUDF log and jar file dir
TypeString
Defaultext/udf（Windows：ext\udf）
EffectiveAfter restarting system
  • temporary_lib_dir
Nametemporary_lib_dir
DescriptionUDF jar file temporary dir
TypeString
Defaultext/temporary（Windows：ext\temporary）
EffectiveAfter restarting system