配置参数

下载IoTDB 来源:IoTDB 浏览 289 扫码分享 2023-09-09 13:02:48

参考
- 公共配置参数
  - 改后生效方式
  - 系统配置项

参考

公共配置参数

IoTDB ConfigNode 和 DataNode 的公共配置参数位于 conf 目录下。

iotdb-common.properties：IoTDB 集群的公共配置。

改后生效方式

不同的配置参数有不同的生效方式，分为以下三种：

仅允许在第一次启动服务前修改： 在第一次启动 ConfigNode/DataNode 后即禁止修改，修改会导致 ConfigNode/DataNode 无法启动。
重启服务生效： ConfigNode/DataNode 启动后仍可修改，但需要重启 ConfigNode/DataNode 后才生效。
热加载： 可在 ConfigNode/DataNode 运行时修改，修改后通过 Session 或 Cli 发送 load configuration 命令（SQL）至 IoTDB 使配置生效。

系统配置项

副本配置

config_node_consensus_protocol_class

名字	config_node_consensus_protocol_class
描述	ConfigNode 副本的共识协议，仅支持 RatisConsensus
类型	String
默认值	org.apache.iotdb.consensus.ratis.RatisConsensus
改后生效方式	仅允许在第一次启动服务前修改

schema_replication_factor

名字	schema_replication_factor
描述	Database 的默认元数据副本数
类型	int32
默认值	1
改后生效方式	重启服务后对新的 Database 生效

schema_region_consensus_protocol_class

名字	schema_region_consensus_protocol_class
描述	元数据副本的共识协议，1 副本时可以使用 SimpleConsensus 协议，多副本时只能使用 RatisConsensus
类型	String
默认值	org.apache.iotdb.consensus.ratis.RatisConsensus
改后生效方式	仅允许在第一次启动服务前修改

data_replication_factor

名字	data_replication_factor
描述	Database 的默认数据副本数
类型	int32
默认值	1
改后生效方式	重启服务后对新的 Database 生效

data_region_consensus_protocol_class

名字	data_region_consensus_protocol_class
描述	数据副本的共识协议，1 副本时可以使用 SimpleConsensus 协议，多副本时可以使用 IoTConsensus 或 RatisConsensus
类型	String
默认值	org.apache.iotdb.consensus.iot.IoTConsensus
改后生效方式	仅允许在第一次启动服务前修改

负载均衡配置

series_partition_slot_num

名字	series_slot_num
描述	序列分区槽数
类型	int32
默认值	10000
改后生效方式	仅允许在第一次启动服务前修改

series_partition_executor_class

名字	series_partition_executor_class
描述	序列分区哈希函数
类型	String
默认值	org.apache.iotdb.commons.partition.executor.hash.BKDRHashExecutor
改后生效方式	仅允许在第一次启动服务前修改

schema_region_group_extension_policy

名字	schema_region_group_extension_policy
描述	SchemaRegionGroup 的扩容策略
类型	string
默认值	AUTO
改后生效方式	重启服务生效

default_schema_region_group_num_per_database

名字	default_schema_region_group_num_per_database
描述	当选用 CUSTOM-SchemaRegionGroup 扩容策略时，此参数为每个 Database 拥有的 SchemaRegionGroup 数量；当选用 AUTO-SchemaRegionGroup 扩容策略时，此参数为每个 Database 最少拥有的 SchemaRegionGroup 数量
类型	int
默认值	1
改后生效方式	重启服务生效

schema_region_per_data_node

名字	schema_region_per_data_node
描述	期望每个 DataNode 可管理的 SchemaRegion 的最大数量
类型	double
默认值	与 schema_replication_factor 相同
改后生效方式	重启服务生效

data_region_group_extension_policy

名字	data_region_group_extension_policy
描述	DataRegionGroup 的扩容策略
类型	string
默认值	AUTO
改后生效方式	重启服务生效

default_data_region_group_num_per_database

名字	data_region_group_per_database
描述	当选用 CUSTOM-DataRegionGroup 扩容策略时，此参数为每个 Database 拥有的 DataRegionGroup 数量；当选用 AUTO-DataRegionGroup 扩容策略时，此参数为每个 Database 最少拥有的 DataRegionGroup 数量
类型	int
默认值	2
改后生效方式	重启服务生效

data_region_per_processor

名字	data_region_per_processor
描述	期望每个处理器可管理的 DataRegion 的最大数量
类型	double
默认值	1.0
改后生效方式	重启服务生效

enable_data_partition_inherit_policy

名字	enable_data_partition_inherit_policy
描述	开启 DataPartition 继承策略后，同一个序列分区槽内的 DataPartition 会继承之前时间分区槽的分配结果
类型	Boolean
默认值	false
改后生效方式	重启服务生效

leader_distribution_policy

名字	leader_distribution_policy
描述	集群 RegionGroup 的 leader 分配策略
类型	String
默认值	MIN_COST_FLOW
改后生效方式	重启服务生效

enable_auto_leader_balance_for_ratis_consensus

名字	enable_auto_leader_balance_for_ratis_consensus
描述	是否为 Ratis 共识协议开启自动均衡 leader 策略
类型	Boolean
默认值	false
改后生效方式	重启服务生效

enable_auto_leader_balance_for_iot_consensus

名字	enable_auto_leader_balance_for_iot_consensus
描述	是否为 IoT 共识协议开启自动均衡 leader 策略
类型	Boolean
默认值	true
改后生效方式	重启服务生效

集群管理

time_partition_interval

名字	time_partition_interval
描述	Database 默认的数据时间分区间隔
类型	Long
单位	毫秒
默认值	604800000
改后生效方式	仅允许在第一次启动服务前修改

heartbeat_interval_in_ms

名字	heartbeat_interval_in_ms
描述	集群节点间的心跳间隔
类型	Long
单位	ms
默认值	1000
改后生效方式	重启服务生效

disk_space_warning_threshold

名字	disk_space_warning_threshold
描述	DataNode 磁盘剩余阈值
类型	double(percentage)
默认值	0.05
改后生效方式	重启服务生效

内存控制配置

enable_mem_control

名字	enable_mem_control
描述	开启内存控制，避免爆内存
类型	Boolean
默认值	true
改后生效方式	重启服务生效

storage_query_schema_consensus_free_memory_proportion

名字	storage_query_schema_consensus_free_memory_proportion
描述	存储，查询，元数据，共识层，空闲内存比例
类型	Ratio
默认值	3:3:1:1:2
改后生效方式	重启服务生效

schema_memory_allocate_proportion

名字	schema_memory_allocate_proportion
描述	SchemaRegion， SchemaCache，PartitionCache，LastCache 占元数据内存比例
类型	Ratio
默认值	5:3:1:1
改后生效方式	重启服务生效

storage_engine_memory_proportion

名字	storage_engine_memory_proportion
描述	写入和合并占存储内存比例
类型	Ratio
默认值	8:2
改后生效方式	重启服务生效

write_memory_proportion

名字	write_memory_proportion
描述	Memtable 和 TimePartitionInfo 占写入内存比例
类型	Ratio
默认值	19:1
改后生效方式	重启服务生效

concurrent_writing_time_partition

名字	concurrent_writing_time_partition
描述	最大可同时写入的时间分区个数，默认1个分区, enable_mem_control=false 时有效
类型	Int64
默认值	1
改后生效方式	重启服务生效

primitive_array_size

名字	primitive_array_size
描述	数组池中的原始数组大小（每个数组的长度）
类型	int32
默认值	64
改后生效方式	重启服务生效

flush_proportion

名字	flush_proportion
描述	调用flush disk的写入内存比例，默认0.4,若有极高的写入负载力（比如batch=1000），可以设置为低于默认值，比如0.2
类型	Double
默认值	0.4
改后生效方式	重启服务生效

buffered_arrays_memory_proportion

名字	buffered_arrays_memory_proportion
描述	为缓冲数组分配的写入内存比例，默认为0.6
类型	Double
默认值	0.6
改后生效方式	重启服务生效

reject_proportion

名字	reject_proportion
描述	拒绝插入的写入内存比例，默认0.8，若有极高的写入负载力（比如batch=1000）并且物理内存足够大，它可以设置为高于默认值，如0.9
类型	Double
默认值	0.8
改后生效方式	重启服务生效

write_memory_variation_report_proportion

名字	write_memory_variation_report_proportion
描述	如果 DataRegion 的内存增加超过写入可用内存的一定比例，则向系统报告。默认值为0.001
类型	Double
默认值	0.001
改后生效方式	重启服务生效

check_period_when_insert_blocked

名字	check_period_when_insert_blocked
描述	当插入被拒绝时，等待时间（以毫秒为单位）去再次检查系统，默认为50。若插入被拒绝，读取负载低，可以设置大一些。
类型	int32
默认值	50
改后生效方式	重启服务生效

io_task_queue_size_for_flushing

名字	io_task_queue_size_for_flushing
描述	ioTaskQueue 的大小。默认值为10。
类型	int32
默认值	10
改后生效方式	重启服务生效

enable_query_memory_estimation

名字	enable_query_memory_estimation
描述	开启后会预估每次查询的内存使用量，如果超过可用内存，会拒绝本次查询
类型	bool
默认值	true
改后生效方式	热加载

partition_cache_size

名字	partition_cache_size
描述	分区信息缓存的最大缓存条目数。
类型	Int32
默认值	1000
改后生效方式	重启服务生效

元数据引擎配置

schema_engine_mode

名字	schema_engine_mode
描述	元数据引擎的运行模式，支持 Memory 和 PBTree；PBTree 模式下支持将内存中暂时不用的序列元数据实时置换到磁盘上，需要使用时再加载进内存；此参数在集群中所有的 DataNode 上务必保持相同。
类型	string
默认值	Memory
改后生效方式	仅允许在第一次启动服务前修改

mlog_buffer_size

名字	mlog_buffer_size
描述	mlog 的 buffer 大小
类型	int32
默认值	1048576
改后生效方式	热加载

sync_mlog_period_in_ms

名字	sync_mlog_period_in_ms
描述	mlog定期刷新到磁盘的周期，单位毫秒。如果该参数为0，则表示每次对元数据的更新操作都会被立即写到磁盘上。
类型	Int64
默认值	100
改后生效方式	重启服务生效

tag_attribute_total_size

名字	tag_attribute_total_size
描述	每个时间序列标签和属性的最大持久化字节数
类型	int32
默认值	700
改后生效方式	仅允许在第一次启动服务前修改

tag_attribute_flush_interval

名字	tag_attribute_flush_interval
描述	标签和属性记录的间隔数，达到此记录数量时将强制刷盘
类型	int32
默认值	1000
改后生效方式	仅允许在第一次启动服务前修改

schema_region_device_node_cache_size

名字	schema_region_device_node_cache_size
描述	schemaRegion中用于加速device节点访问所设置的device节点缓存的大小
类型	Int32
默认值	10000
改后生效方式	重启服务生效

max_measurement_num_of_internal_request

名字	max_measurement_num_of_internal_request
描述	一次注册序列请求中若物理量过多，在系统内部执行时将被拆分为若干个轻量级的子请求，每个子请求中的物理量数目不超过此参数设置的最大值。
类型	Int32
默认值	10000
改后生效方式	重启服务生效

数据类型自动推断

enable_auto_create_schema

名字	enable_auto_create_schema
描述	当写入的序列不存在时，是否自动创建序列
取值	true or false
默认值	true
改后生效方式	重启服务生效

default_storage_group_level

名字	default_storage_group_level
描述	当写入的数据不存在且自动创建序列时，若需要创建相应的 database，将序列路径的哪一层当做 database。例如，如果我们接到一个新序列 root.sg0.d1.s2, 并且 level=1，那么 root.sg0 被视为database（因为 root 是 level 0 层）
取值	int32
默认值	1
改后生效方式	重启服务生效

boolean_string_infer_type

名字	boolean_string_infer_type
描述	“true” 或者 “false” 字符串被推断的数据类型
取值	BOOLEAN 或者 TEXT
默认值	BOOLEAN
改后生效方式	重启服务生效

integer_string_infer_type

名字	integer_string_infer_type
描述	整型字符串推断的数据类型
取值	INT32, INT64, FLOAT, DOUBLE, TEXT
默认值	FLOAT
改后生效方式	重启服务生效

long_string_infer_type

名字	long_string_infer_type
描述	大于 2 ^ 24 的整形字符串被推断的数据类型
取值	DOUBLE, FLOAT or TEXT
默认值	DOUBLE
改后生效方式	重启服务生效

floating_string_infer_type

名字	floating_string_infer_type
描述	“6.7”等字符串被推断的数据类型
取值	DOUBLE, FLOAT or TEXT
默认值	FLOAT
改后生效方式	重启服务生效

nan_string_infer_type

名字	nan_string_infer_type
描述	“NaN” 字符串被推断的数据类型
取值	DOUBLE, FLOAT or TEXT
默认值	DOUBLE
改后生效方式	重启服务生效

default_boolean_encoding

名字	default_boolean_encoding
描述	BOOLEAN 类型编码格式
取值	PLAIN, RLE
默认值	RLE
改后生效方式	重启服务生效

default_int32_encoding

名字	default_int32_encoding
描述	int32 类型编码格式
取值	PLAIN, RLE, TS_2DIFF, REGULAR, GORILLA
默认值	RLE
改后生效方式	重启服务生效

default_int64_encoding

名字	default_int64_encoding
描述	int64 类型编码格式
取值	PLAIN, RLE, TS_2DIFF, REGULAR, GORILLA
默认值	RLE
改后生效方式	重启服务生效

default_float_encoding

名字	default_float_encoding
描述	float 类型编码格式
取值	PLAIN, RLE, TS_2DIFF, GORILLA
默认值	GORILLA
改后生效方式	重启服务生效

default_double_encoding

名字	default_double_encoding
描述	double 类型编码格式
取值	PLAIN, RLE, TS_2DIFF, GORILLA
默认值	GORILLA
改后生效方式	重启服务生效

default_text_encoding

名字	default_text_encoding
描述	text 类型编码格式
取值	PLAIN
默认值	PLAIN
改后生效方式	重启服务生效

查询配置

read_consistency_level

名字	read_consistency_level
描述	查询一致性等级，取值 “strong” 时从 Leader 副本查询，取值 “weak” 时随机查询一个副本。
类型	String
默认值	strong
改后生效方式	重启服务生效

meta_data_cache_enable

名字	meta_data_cache_enable
描述	是否缓存元数据（包括 BloomFilter、Chunk Metadata 和 TimeSeries Metadata。）
类型	Boolean
默认值	true
改后生效方式	重启服务生效

chunk_timeseriesmeta_free_memory_proportion

名字	chunk_timeseriesmeta_free_memory_proportion
描述	读取内存分配比例，BloomFilterCache、ChunkCache、TimeseriesMetadataCache、数据集查询的内存和可用内存的查询。参数形式为a : b : c : d : e，其中a、b、c、d、e为整数。例如“1 : 1 : 1 : 1 : 1” ，“1 : 100 : 200 : 300 : 400” 。
类型	String
默认值	1 : 100 : 200 : 300 : 400
改后生效方式	重启服务生效

enable_last_cache

名字	enable_last_cache
描述	是否开启最新点缓存
类型	Boolean
默认值	true
改后生效方式	重启服务生效

mpp_data_exchange_core_pool_size

名字	mpp_data_exchange_core_pool_size
描述	MPP 数据交换线程池核心线程数
类型	int32
默认值	10
改后生效方式	重启服务生效

mpp_data_exchange_max_pool_size

名字	mpp_data_exchange_max_pool_size
描述	MPP 数据交换线程池最大线程数
类型	int32
默认值	10
改后生效方式	重启服务生效

mpp_data_exchange_keep_alive_time_in_ms

名字	mpp_data_exchange_keep_alive_time_in_ms
描述	MPP 数据交换最大等待时间
类型	int32
默认值	1000
改后生效方式	重启服务生效

driver_task_execution_time_slice_in_ms

名字	driver_task_execution_time_slice_in_ms
描述	单个 DriverTask 最长执行时间
类型	int32
默认值	100
改后生效方式	重启服务生效

max_tsblock_size_in_bytes

名字	max_tsblock_size_in_bytes
描述	单个 TsBlock 的最大容量
类型	int32
默认值	1024 * 1024 (1 MB)
改后生效方式	重启服务生效

max_tsblock_line_numbers

名字	max_tsblock_line_numbers
描述	单个 TsBlock 的最大行数
类型	int32
默认值	1000
改后生效方式	重启服务生效

slow_query_threshold

名字	slow_query_threshold
描述	慢查询的时间阈值。单位：毫秒。
类型	Int32
默认值	30000
改后生效方式	热加载

query_timeout_threshold

名字	query_timeout_threshold
描述	查询的最大执行时间。单位：毫秒。
类型	Int32
默认值	60000
改后生效方式	重启服务生效

max_allowed_concurrent_queries

名字	max_allowed_concurrent_queries
描述	允许的最大并发查询数量。
类型	Int32
默认值	1000
改后生效方式	重启服务生效

query_thread_count

名字	query_thread_count
描述	当 IoTDB 对内存中的数据进行查询时，最多启动多少个线程来执行该操作。如果该值小于等于 0，那么采用机器所安装的 CPU 核的数量。
类型	Int32
默认值	CPU 核数
改后生效方式	重启服务生效

batch_size

名字	batch_size
描述	服务器中每次迭代的数据量（数据条目，即不同时间戳的数量。）
类型	Int32
默认值	100000
改后生效方式	重启服务生效

存储引擎配置

timestamp_precision

名字	timestamp_precision
描述	时间戳精度，支持 ms、us、ns
类型	String
默认值	ms
改后生效方式	仅允许在第一次启动服务前修改

default_ttl_in_ms

名字	default_ttl_in_ms
描述	数据保留时间，会丢弃 now()-default_ttl 之前的数据，单位 ms
类型	long
默认值	36000000
改后生效方式	重启服务生效

max_waiting_time_when_insert_blocked

名字	max_waiting_time_when_insert_blocked
描述	当插入请求等待超过这个时间，则抛出异常，单位 ms
类型	Int32
默认值	10000
改后生效方式	重启服务生效

enable_discard_out_of_order_data

名字	enable_discard_out_of_order_data
描述	是否支持写入乱序数据
类型	Boolean
默认值	false
改后生效方式	重启服务生效

handle_system_error

名字	handle_system_error
描述	当系统遇到不可恢复的错误时的处理方法
类型	String
默认值	CHANGE_TO_READ_ONLY
改后生效方式	重启服务生效

memtable_size_threshold

名字	memtable_size_threshold
描述	内存缓冲区 memtable 阈值
类型	Long
默认值	1073741824
改后生效方式	enable_mem_control 为 false 时生效、重启服务生效

enable_timed_flush_seq_memtable

名字	enable_timed_flush_seq_memtable
描述	是否开启定时刷盘顺序 memtable
类型	Boolean
默认值	true
改后生效方式	热加载

seq_memtable_flush_interval_in_ms

名字	seq_memtable_flush_interval_in_ms
描述	当 memTable 的创建时间小于当前时间减去该值时，该 memtable 需要被刷盘
类型	int32
默认值	10800000
改后生效方式	热加载

seq_memtable_flush_check_interval_in_ms

名字	seq_memtable_flush_check_interval_in_ms
描述	检查顺序 memtable 是否需要刷盘的时间间隔
类型	int32
默认值	600000
改后生效方式	热加载

enable_timed_flush_unseq_memtable

名字	enable_timed_flush_unseq_memtable
描述	是否开启定时刷新乱序 memtable
类型	Boolean
默认值	true
改后生效方式	热加载

unseq_memtable_flush_interval_in_ms

名字	unseq_memtable_flush_interval_in_ms
描述	当 memTable 的创建时间小于当前时间减去该值时，该 memtable 需要被刷盘
类型	int32
默认值	10800000
改后生效方式	热加载

unseq_memtable_flush_check_interval_in_ms

名字	unseq_memtable_flush_check_interval_in_ms
描述	检查乱序 memtable 是否需要刷盘的时间间隔
类型	int32
默认值	600000
改后生效方式	热加载

tvlist_sort_algorithm

名字	tvlist_sort_algorithm
描述	memtable中数据的排序方法
类型	String
默认值	TIM
改后生效方式	重启服务生效

avg_series_point_number_threshold

名字	avg_series_point_number_threshold
描述	内存中平均每个时间序列点数最大值，达到触发 flush
类型	int32
默认值	100000
改后生效方式	重启服务生效

flush_thread_count

名字	flush_thread_count
描述	当 IoTDB 将内存中的数据写入磁盘时，最多启动多少个线程来执行该操作。如果该值小于等于 0，那么采用机器所安装的 CPU 核的数量。默认值为 0。
类型	int32
默认值	0
改后生效方式	重启服务生效

enable_partial_insert

名字	enable_partial_insert
描述	在一次 insert 请求中，如果部分测点写入失败，是否继续写入其他测点。
类型	Boolean
默认值	true
改后生效方式	重启服务生效

recovery_log_interval_in_ms

名字	recovery_log_interval_in_ms
描述	data region的恢复过程中打印日志信息的间隔
类型	Int32
默认值	5000
改后生效方式	重启服务生效

0.13_data_insert_adapt

名字	0.13_data_insert_adapt
描述	如果 0.13 版本客户端进行写入，需要将此配置项设置为 true
类型	Boolean
默认值	false
改后生效方式	重启服务生效

device_path_cache_size

名字	device_path_cache_size
描述	Device Path 缓存的最大数量，这个缓存可以避免写入过程中重复的 Device Path 对象创建
类型	Int32
默认值	500000
改后生效方式	重启服务生效

insert_multi_tablet_enable_multithreading_column_threshold

名字	insert_multi_tablet_enable_multithreading_column_threshold
描述	插入时启用多线程插入列数的阈值
类型	int32
默认值	10
改后生效方式	重启服务生效

合并配置

enable_seq_space_compaction

名字	enable_seq_space_compaction
描述	顺序空间内合并，开启顺序文件之间的合并
类型	Boolean
默认值	true
改后生效方式	热加载

enable_unseq_space_compaction

名字	enable_unseq_space_compaction
描述	乱序空间内合并，开启乱序文件之间的合并
类型	Boolean
默认值	false
改后生效方式	热加载

enable_cross_space_compaction

名字	enable_cross_space_compaction
描述	跨空间合并，开启将乱序文件合并到顺序文件中
类型	Boolean
默认值	true
改后生效方式	热加载

cross_selector

名字	cross_selector
描述	跨空间合并任务选择器的类型
类型	String
默认值	rewrite
改后生效方式	重启服务生效

cross_performer

名字	cross_performer
描述	跨空间合并任务执行器的类型，可选项是read_point和fast，默认是read_point，fast还在测试中
类型	String
默认值	read_point
改后生效方式	重启服务生效

inner_seq_selector

名字	inner_seq_selector
描述	顺序空间内合并任务选择器的类型
类型	String
默认值	size_tiered
改后生效方式	重启服务生效

inner_seq_performer

名字	inner_seq_performer
描述	顺序空间内合并任务执行器的类型，可选项是read_chunk和fast，默认是read_chunk，fast还在测试中
类型	String
默认值	read_chunk
改后生效方式	重启服务生效

inner_unseq_selector

名字	inner_unseq_selector
描述	乱序空间内合并任务选择器的类型
类型	String
默认值	size_tiered
改后生效方式	重启服务生效

inner_unseq_performer

名字	inner_unseq_performer
描述	乱序空间内合并任务执行器的类型，可选项是read_point和fast，默认是read_point，fast还在测试中
类型	String
默认值	read_point
改后生效方式	重启服务生效

compaction_priority

名字	compaction_priority
描述	合并时的优先级，BALANCE 各种合并平等，INNER_CROSS 优先进行顺序文件和顺序文件或乱序文件和乱序文件的合并，CROSS_INNER 优先将乱序文件合并到顺序文件中
类型	String
默认值	BALANCE
改后生效方式	重启服务生效

target_compaction_file_size

名字	target_compaction_file_size
描述	合并后的目标文件大小
类型	Int64
默认值	2147483648
改后生效方式	重启服务生效

target_chunk_size

名字	target_chunk_size
描述	合并时 Chunk 的目标大小
类型	Int64
默认值	1048576
改后生效方式	重启服务生效

target_chunk_point_num

名字	target_chunk_point_num
描述	合并时 Chunk 的目标点数
类型	int32
默认值	100000
改后生效方式	重启服务生效

chunk_size_lower_bound_in_compaction

名字	chunk_size_lower_bound_in_compaction
描述	合并时源 Chunk 的大小小于这个值，将被解开成点进行合并
类型	Int64
默认值	10240
改后生效方式	重启服务生效

chunk_point_num_lower_bound_in_compaction

名字	chunk_point_num_lower_bound_in_compaction
描述	合并时源 Chunk 的点数小于这个值，将被解开成点进行合并
类型	int32
默认值	1000
改后生效方式	重启服务生效

max_inner_compaction_candidate_file_num

名字	max_inner_compaction_candidate_file_num
描述	空间内合并中一次合并最多参与的文件数
类型	int32
默认值	30
改后生效方式	重启服务生效

max_cross_compaction_candidate_file_num

名字	max_cross_compaction_candidate_file_num
描述	跨空间合并中一次合并最多参与的文件数
类型	int32
默认值	500
改后生效方式	重启服务生效

max_cross_compaction_candidate_file_size

名字	max_cross_compaction_candidate_file_size
描述	跨空间合并中一次合并最多参与的文件总大小
类型	Int64
默认值	5368709120
改后生效方式	重启服务生效

cross_compaction_file_selection_time_budget

名字	cross_compaction_file_selection_time_budget
描述	若一个合并文件选择运行的时间超过这个时间，它将结束，并且当前的文件合并选择将用作为最终选择。当时间小于0 时，则表示时间是无边界的。单位：ms。
类型	int32
默认值	30000
改后生效方式	重启服务生效

compaction_thread_count

名字	compaction_thread_count
描述	执行合并任务的线程数目
类型	int32
默认值	10
改后生效方式	热加载

compaction_schedule_interval_in_ms

名字	compaction_schedule_interval_in_ms
描述	合并调度的时间间隔
类型	Int64
默认值	60000
改后生效方式	重启服务生效

compaction_submission_interval_in_ms

名字	compaction_submission_interval_in_ms
描述	合并任务提交的间隔
类型	Int64
默认值	60000
改后生效方式	重启服务生效

compaction_write_throughput_mb_per_sec

名字	compaction_write_throughput_mb_per_sec
描述	每秒可达到的写入吞吐量合并限制。
类型	int32
默认值	16
改后生效方式	重启服务生效

sub_compaction_thread_count

名字	sub_compaction_thread_count
描述	每个合并任务的子任务线程数，只对跨空间合并和乱序空间内合并生效
类型	int32
默认值	4
改后生效方式	热加载

compaction_validation_level

名字	compaction_validation_level
描述	合并结束后对顺序文件时间范围的检查, NONE 关闭检查，RESOURCE_ONLY 检查 resource 文件，RESOURCE_AND_TSFILE 检查 resource 文件和 tsfile 文件
类型	String
默认值	NONE
改后生效方式	热加载

candidate_compaction_task_queue_size

名字	candidate_compaction_task_queue_size
描述	合并任务优先级队列的大小
类型	int32
默认值	50
改后生效方式	重启服务生效

写前日志配置

wal_mode

名字	wal_mode
描述	写前日志的写入模式. DISABLE 模式下会关闭写前日志；SYNC 模式下写入请求会在成功写入磁盘后返回； ASYNC 模式下写入请求返回时可能尚未成功写入磁盘后。
类型	String
默认值	ASYNC
改后生效方式	重启服务生效

max_wal_nodes_num

名字	max_wal_nodes_num
描述	写前日志节点的最大数量，默认值 0 表示数量由系统控制。
类型	int32
默认值	0
改后生效方式	重启服务生效

wal_async_mode_fsync_delay_in_ms

名字	wal_async_mode_fsync_delay_in_ms
描述	async 模式下写前日志调用 fsync 前的等待时间
类型	int32
默认值	1000
改后生效方式	热加载

wal_sync_mode_fsync_delay_in_ms

名字	wal_sync_mode_fsync_delay_in_ms
描述	sync 模式下写前日志调用 fsync 前的等待时间
类型	int32
默认值	3
改后生效方式	热加载

wal_buffer_size_in_byte

名字	wal_buffer_size_in_byte
描述	写前日志的 buffer 大小
类型	int32
默认值	33554432
改后生效方式	重启服务生效

wal_buffer_queue_capacity

名字	wal_buffer_queue_capacity
描述	写前日志阻塞队列大小上限
类型	int32
默认值	500
改后生效方式	重启服务生效

wal_file_size_threshold_in_byte

名字	wal_file_size_threshold_in_byte
描述	写前日志文件封口阈值
类型	int32
默认值	31457280
改后生效方式	热加载

wal_min_effective_info_ratio

名字	wal_min_effective_info_ratio
描述	写前日志最小有效信息比
类型	double
默认值	0.1
改后生效方式	热加载

wal_memtable_snapshot_threshold_in_byte

名字	wal_memtable_snapshot_threshold_in_byte
描述	触发写前日志中内存表快照的内存表大小阈值
类型	int64
默认值	8388608
改后生效方式	热加载

max_wal_memtable_snapshot_num

名字	max_wal_memtable_snapshot_num
描述	写前日志中内存表的最大数量上限
类型	int32
默认值	1
改后生效方式	热加载

delete_wal_files_period_in_ms

名字	delete_wal_files_period_in_ms
描述	删除写前日志的检查间隔
类型	int64
默认值	20000
改后生效方式	热加载

TsFile 配置

group_size_in_byte

名字	group_size_in_byte
描述	每次将内存中的数据写入到磁盘时的最大写入字节数
类型	int32
默认值	134217728
改后生效方式	热加载

page_size_in_byte

名字	page_size_in_byte
描述	内存中每个列写出时，写成的单页最大的大小，单位为字节
类型	int32
默认值	65536
改后生效方式	热加载

max_number_of_points_in_page

名字	max_number_of_points_in_page
描述	一个页中最多包含的数据点（时间戳-值的二元组）数量
类型	int32
默认值	10000
改后生效方式	热加载

pattern_matching_threshold

名字	pattern_matching_threshold
描述	正则表达式匹配时最大的匹配次数
类型	int32
默认值	1000000
改后生效方式	热加载

max_string_length

名字	max_string_length
描述	针对字符串类型的数据，单个字符串最大长度，单位为字符
类型	int32
默认值	128
改后生效方式	热加载

float_precision

名字	float_precision
描述	浮点数精度，为小数点后数字的位数
类型	int32
默认值	默认为 2 位。注意：32 位浮点数的十进制精度为 7 位，64 位浮点数的十进制精度为 15 位。如果设置超过机器精度将没有实际意义。
改后生效方式	热加载

value_encoder

名字	value_encoder
描述	value 列编码方式
类型	枚举 String: “TS_2DIFF”,“PLAIN”,“RLE”
默认值	PLAIN
改后生效方式	热加载

compressor

名字	compressor
描述	数据压缩方法; 对齐序列中时间列的压缩方法
类型	枚举 String : “UNCOMPRESSED”, “SNAPPY”, “LZ4”, “ZSTD”, “LZMA2”
默认值	SNAPPY
改后生效方式	热加载

max_degree_of_index_node

名字	max_degree_of_index_node
描述	元数据索引树的最大度（即每个节点的最大子节点个数）。
类型	int32
默认值	256
改后生效方式	仅允许在第一次启动服务前修改

授权配置

authorizer_provider_class

名字	authorizer_provider_class
描述	权限服务的类名
类型	String
默认值	org.apache.iotdb.commons.auth.authorizer.LocalFileAuthorizer
改后生效方式	重启服务生效
其他可选值	org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer

openID_url

名字	openID_url
描述	openID 服务器地址（当 OpenIdAuthorizer 被启用时必须设定）
类型	String（一个 http 地址）
默认值	无
改后生效方式	重启服务生效

iotdb_server_encrypt_decrypt_provider

名字	iotdb_server_encrypt_decrypt_provider
描述	用于用户密码加密的类
类型	String
默认值	org.apache.iotdb.commons.security.encrypt.MessageDigestEncrypt
改后生效方式	仅允许在第一次启动服务前修改

iotdb_server_encrypt_decrypt_provider_parameter

名字	iotdb_server_encrypt_decrypt_provider_parameter
描述	用于初始化用户密码加密类的参数
类型	String
默认值	空
改后生效方式	仅允许在第一次启动服务前修改

author_cache_size

名字	author_cache_size
描述	用户缓存与角色缓存的大小
类型	int32
默认值	1000
改后生效方式	重启服务生效

author_cache_expire_time

名字	author_cache_expire_time
描述	用户缓存与角色缓存的有效期，单位为分钟
类型	int32
默认值	30
改后生效方式	重启服务生效

UDF查询配置

udf_initial_byte_array_length_for_memory_control

名字	udf_initial_byte_array_length_for_memory_control
描述	用于评估UDF查询中文本字段的内存使用情况。建议将此值设置为略大于所有文本的平均长度记录。
类型	int32
默认值	48
改后生效方式	重启服务生效

udf_memory_budget_in_mb

名字	udf_memory_budget_in_mb
描述	在一个UDF查询中使用多少内存（以 MB 为单位）。上限为已分配内存的 20% 用于读取。
类型	Float
默认值	30.0
改后生效方式	重启服务生效

udf_reader_transformer_collector_memory_proportion

名字	udf_reader_transformer_collector_memory_proportion
描述	UDF内存分配比例。参数形式为a : b : c，其中a、b、c为整数。
类型	String
默认值	1:1:1
改后生效方式	重启服务生效

udf_lib_dir

名字	udf_lib_dir
描述	UDF 日志及jar文件存储路径
类型	String
默认值	ext/udf（Windows：ext\udf）
改后生效方式	重启服务生效

触发器配置

trigger_lib_dir

名字	trigger_lib_dir
描述	触发器 JAR 包存放的目录
类型	String
默认值	ext/trigger
改后生效方式	重启服务生效

stateful_trigger_retry_num_when_not_found

名字	stateful_trigger_retry_num_when_not_found
描述	有状态触发器触发无法找到触发器实例时的重试次数
类型	Int32
默认值	3
改后生效方式	重启服务生效

SELECT-INTO配置

into_operation_buffer_size_in_byte

名字	into_operation_buffer_size_in_byte
描述	执行 select-into 语句时，待写入数据占用的最大内存（单位：Byte）
类型	int64
默认值	100MB
改后生效方式	热加载

select_into_insert_tablet_plan_row_limit

名字	select_into_insert_tablet_plan_row_limit
描述	执行 select-into 语句时，一个 insert-tablet-plan 中可以处理的最大行数
类型	int32
默认值	10000
改后生效方式	热加载

into_operation_execution_thread_count

名字	into_operation_execution_thread_count
描述	SELECT INTO 中执行写入任务的线程池的线程数
类型	int32
默认值	2
改后生效方式	重启服务生效

连续查询配置

continuous_query_submit_thread_count

名字	continuous_query_execution_thread
描述	执行连续查询任务的线程池的线程数
类型	int32
默认值	2
改后生效方式	重启服务生效

continuous_query_min_every_interval_in_ms

名字	continuous_query_min_every_interval_in_ms
描述	连续查询执行时间间隔的最小值
类型	long (duration)
默认值	1000
改后生效方式	重启服务生效

PIPE 配置

ip_white_list

名字	ip_white_list
描述	设置同步功能发送端 IP 地址的白名单，以网段的形式表示，多个网段之间用逗号分隔。发送端向接收端同步数据时，只有当该发送端 IP 地址处于该白名单设置的网段范围内，接收端才允许同步操作。如果白名单为空，则接收端不允许任何发送端同步数据。默认接收端拒绝除了本地以外的全部 IP 的同步请求。对该参数进行配置时，需要保证发送端所有 DataNode 地址均被覆盖。
类型	String
默认值	127.0.0.1/32
改后生效方式	热加载

max_number_of_sync_file_retry

名字	max_number_of_sync_file_retry
描述	同步文件最大重试次数
类型	int32
默认值	5
改后生效方式	热加载

IoT 共识协议配置

当Region配置了IoTConsensus共识协议之后，下述的配置项才会生效

data_region_iot_max_log_entries_num_per_batch

名字	data_region_iot_max_log_entries_num_per_batch
描述	IoTConsensus batch 的最大日志条数
类型	int32
默认值	1024
改后生效方式	重启生效

data_region_iot_max_size_per_batch

名字	data_region_iot_max_size_per_batch
描述	IoTConsensus batch 的最大大小
类型	int32
默认值	16MB
改后生效方式	重启生效

data_region_iot_max_pending_batches_num

名字	data_region_iot_max_pending_batches_num
描述	IoTConsensus batch 的流水线并发阈值
类型	int32
默认值	12
改后生效方式	重启生效

data_region_iot_max_memory_ratio_for_queue

名字	data_region_iot_max_memory_ratio_for_queue
描述	IoTConsensus 队列内存分配比例
类型	double
默认值	0.6
改后生效方式	重启生效

Ratis 共识协议配置

当Region配置了RatisConsensus共识协议之后，下述的配置项才会生效

config_node_ratis_log_appender_buffer_size_max

名字	config_node_ratis_log_appender_buffer_size_max
描述	confignode 一次同步日志RPC最大的传输字节限制
类型	int32
默认值	4MB
改后生效方式	重启生效

schema_region_ratis_log_appender_buffer_size_max

名字	schema_region_ratis_log_appender_buffer_size_max
描述	schema region 一次同步日志RPC最大的传输字节限制
类型	int32
默认值	4MB
改后生效方式	重启生效

data_region_ratis_log_appender_buffer_size_max

名字	data_region_ratis_log_appender_buffer_size_max
描述	data region 一次同步日志RPC最大的传输字节限制
类型	int32
默认值	4MB
改后生效方式	重启生效

config_node_ratis_snapshot_trigger_threshold

名字	config_node_ratis_snapshot_trigger_threshold
描述	confignode 触发snapshot需要的日志条数
类型	int32
默认值	400,000
改后生效方式	重启生效

schema_region_ratis_snapshot_trigger_threshold

名字	schema_region_ratis_snapshot_trigger_threshold
描述	schema region 触发snapshot需要的日志条数
类型	int32
默认值	400,000
改后生效方式	重启生效

data_region_ratis_snapshot_trigger_threshold

名字	data_region_ratis_snapshot_trigger_threshold
描述	data region 触发snapshot需要的日志条数
类型	int32
默认值	400,000
改后生效方式	重启生效

config_node_ratis_log_unsafe_flush_enable

名字	config_node_ratis_log_unsafe_flush_enable
描述	confignode 是否允许Raft日志异步刷盘
类型	boolean
默认值	false
改后生效方式	重启生效

schema_region_ratis_log_unsafe_flush_enable

名字	schema_region_ratis_log_unsafe_flush_enable
描述	schema region 是否允许Raft日志异步刷盘
类型	boolean
默认值	false
改后生效方式	重启生效

data_region_ratis_log_unsafe_flush_enable

名字	data_region_ratis_log_unsafe_flush_enable
描述	data region 是否允许Raft日志异步刷盘
类型	boolean
默认值	false
改后生效方式	重启生效

config_node_ratis_log_segment_size_max_in_byte

名字	config_node_ratis_log_segment_size_max_in_byte
描述	confignode 一个RaftLog日志段文件的大小
类型	int32
默认值	24MB
改后生效方式	重启生效

schema_region_ratis_log_segment_size_max_in_byte

名字	schema_region_ratis_log_segment_size_max_in_byte
描述	schema region 一个RaftLog日志段文件的大小
类型	int32
默认值	24MB
改后生效方式	重启生效

data_region_ratis_log_segment_size_max_in_byte

名字	data_region_ratis_log_segment_size_max_in_byte
描述	data region 一个RaftLog日志段文件的大小
类型	int32
默认值	24MB
改后生效方式	重启生效

config_node_ratis_grpc_flow_control_window

名字	config_node_ratis_grpc_flow_control_window
描述	confignode grpc 流式拥塞窗口大小
类型	int32
默认值	4MB
改后生效方式	重启生效

schema_region_ratis_grpc_flow_control_window

名字	schema_region_ratis_grpc_flow_control_window
描述	schema region grpc 流式拥塞窗口大小
类型	int32
默认值	4MB
改后生效方式	重启生效

data_region_ratis_grpc_flow_control_window

名字	data_region_ratis_grpc_flow_control_window
描述	data region grpc 流式拥塞窗口大小
类型	int32
默认值	4MB
改后生效方式	重启生效

data_region_ratis_grpc_leader_outstanding_appends_max

名字	data_region_ratis_grpc_leader_outstanding_appends_max
描述	data region grpc 流水线并发阈值
类型	int32
默认值	128
改后生效方式	重启生效

data_region_ratis_log_force_sync_num

名字	data_region_ratis_log_force_sync_num
描述	data region fsync 阈值
类型	int32
默认值	128
改后生效方式	重启生效

config_node_ratis_rpc_leader_election_timeout_min_ms

名字	config_node_ratis_rpc_leader_election_timeout_min_ms
描述	confignode leader 选举超时最小值
类型	int32
默认值	2000ms
改后生效方式	重启生效

schema_region_ratis_rpc_leader_election_timeout_min_ms

名字	schema_region_ratis_rpc_leader_election_timeout_min_ms
描述	schema region leader 选举超时最小值
类型	int32
默认值	2000ms
改后生效方式	重启生效

data_region_ratis_rpc_leader_election_timeout_min_ms

名字	data_region_ratis_rpc_leader_election_timeout_min_ms
描述	data region leader 选举超时最小值
类型	int32
默认值	2000ms
改后生效方式	重启生效

config_node_ratis_rpc_leader_election_timeout_max_ms

名字	config_node_ratis_rpc_leader_election_timeout_max_ms
描述	confignode leader 选举超时最大值
类型	int32
默认值	2000ms
改后生效方式	重启生效

schema_region_ratis_rpc_leader_election_timeout_max_ms

名字	schema_region_ratis_rpc_leader_election_timeout_max_ms
描述	schema region leader 选举超时最大值
类型	int32
默认值	2000ms
改后生效方式	重启生效

data_region_ratis_rpc_leader_election_timeout_max_ms

名字	data_region_ratis_rpc_leader_election_timeout_max_ms
描述	data region leader 选举超时最大值
类型	int32
默认值	2000ms
改后生效方式	重启生效

config_node_ratis_request_timeout_ms

名字	config_node_ratis_request_timeout_ms
描述	confignode Raft 客户端重试超时
类型	int32
默认值	10s
改后生效方式	重启生效

schema_region_ratis_request_timeout_ms

名字	schema_region_ratis_request_timeout_ms
描述	schema region Raft 客户端重试超时
类型	int32
默认值	10s
改后生效方式	重启生效

data_region_ratis_request_timeout_ms

名字	data_region_ratis_request_timeout_ms
描述	data region Raft 客户端重试超时
类型	int32
默认值	10s
改后生效方式	重启生效

config_node_ratis_max_retry_attempts

名字	config_node_ratis_max_retry_attempts
描述	confignode Raft客户端最大重试次数
类型	int32
默认值	10
改后生效方式	重启生效

config_node_ratis_initial_sleep_time_ms

名字	config_node_ratis_initial_sleep_time_ms
描述	confignode Raft客户端初始重试睡眠时长
类型	int32
默认值	100ms
改后生效方式	重启生效

config_node_ratis_max_sleep_time_ms

名字	config_node_ratis_max_sleep_time_ms
描述	confignode Raft客户端最大重试睡眠时长
类型	int32
默认值	10s
改后生效方式	重启生效

schema_region_ratis_max_retry_attempts

名字	schema_region_ratis_max_retry_attempts
描述	schema region Raft客户端最大重试次数
类型	int32
默认值	10
改后生效方式	重启生效

schema_region_ratis_initial_sleep_time_ms

名字	schema_region_ratis_initial_sleep_time_ms
描述	schema region Raft客户端初始重试睡眠时长
类型	int32
默认值	100ms
改后生效方式	重启生效

schema_region_ratis_max_sleep_time_ms

名字	schema_region_ratis_max_sleep_time_ms
描述	schema region Raft客户端最大重试睡眠时长
类型	int32
默认值	10s
改后生效方式	重启生效

data_region_ratis_max_retry_attempts

名字	data_region_ratis_max_retry_attempts
描述	data region Raft客户端最大重试次数
类型	int32
默认值	10
改后生效方式	重启生效

data_region_ratis_initial_sleep_time_ms

名字	data_region_ratis_initial_sleep_time_ms
描述	data region Raft客户端初始重试睡眠时长
类型	int32
默认值	100ms
改后生效方式	重启生效

data_region_ratis_max_sleep_time_ms

名字	data_region_ratis_max_sleep_time_ms
描述	data region Raft客户端最大重试睡眠时长
类型	int32
默认值	10s
改后生效方式	重启生效

config_node_ratis_preserve_logs_num_when_purge

名字	config_node_ratis_preserve_logs_num_when_purge
描述	confignode snapshot后保持一定数量日志不删除
类型	int32
默认值	1000
改后生效方式	重启生效

schema_region_ratis_preserve_logs_num_when_purge

名字	schema_region_ratis_preserve_logs_num_when_purge
描述	schema region snapshot后保持一定数量日志不删除
类型	int32
默认值	1000
改后生效方式	重启生效

data_region_ratis_preserve_logs_num_when_purge

名字	data_region_ratis_preserve_logs_num_when_purge
描述	data region snapshot后保持一定数量日志不删除
类型	int32
默认值	1000
改后生效方式	重启生效

Procedure 配置

procedure_core_worker_thread_count

名字	procedure_core_worker_thread_count
描述	工作线程数量
类型	int32
默认值	4
改后生效方式	重启服务生效

procedure_completed_clean_interval

名字	procedure_completed_clean_interval
描述	清理已完成的 procedure 时间间隔
类型	int32
默认值	30(s)
改后生效方式	重启服务生效

procedure_completed_evict_ttl

名字	procedure_completed_evict_ttl
描述	已完成的 procedure 的数据保留时间
类型	int32
默认值	800(s)
改后生效方式	重启服务生效

MQTT代理配置

enable_mqtt_service

名字	enable_mqtt_service。
描述	是否开启MQTT服务
类型	Boolean
默认值	false
改后生效方式	热加载

mqtt_host

名字	mqtt_host
描述	MQTT服务绑定的host。
类型	String
默认值	0.0.0.0
改后生效方式	热加载

mqtt_port

名字	mqtt_port
描述	MQTT服务绑定的port。
类型	int32
默认值	1883
改后生效方式	热加载

mqtt_handler_pool_size

名字	mqtt_handler_pool_size
描述	用于处理MQTT消息的处理程序池大小。
类型	int32
默认值	1
改后生效方式	热加载

mqtt_payload_formatter

名字	mqtt_payload_formatter
描述	MQTT消息有效负载格式化程序。
类型	String
默认值	json
改后生效方式	热加载

mqtt_max_message_size

名字	mqtt_max_message_size
描述	MQTT消息的最大长度（以字节为单位）。
类型	int32
默认值	1048576
改后生效方式	热加载

REST 服务配置

enable_rest_service

名字	enable_rest_service
描述	是否开启Rest服务。
类型	Boolean
默认值	false
改后生效方式	重启生效

rest_service_port

名字	rest_service_port
描述	Rest服务监听端口号
类型	int32
默认值	18080
改后生效方式	重启生效

enable_swagger

名字	enable_swagger
描述	是否启用swagger来展示rest接口信息
类型	Boolean
默认值	false
改后生效方式	重启生效

rest_query_default_row_size_limit

名字	rest_query_default_row_size_limit
描述	一次查询能返回的结果集最大行数
类型	int32
默认值	10000
改后生效方式	重启生效

cache_expire

名字	cache_expire
描述	缓存客户登录信息的过期时间
类型	int32
默认值	28800
改后生效方式	重启生效

cache_max_num

名字	cache_max_num
描述	缓存中存储的最大用户数量
类型	int32
默认值	100
改后生效方式	重启生效

cache_init_num

名字	cache_init_num
描述	缓存初始容量
类型	int32
默认值	10
改后生效方式	重启生效

enable_https

名字	cache_init_num
描述	REST Service 是否开启 SSL 配置
类型	Boolean
默认值	false
改后生效方式	重启生效

key_store_path

名字	key_store_path
描述	keyStore 所在路径（非必填）
类型	String
默认值	“”
改后生效方式	重启生效

key_store_pwd

名字	key_store_pwd
描述	keyStore 密码（非必填）
类型	String
默认值	“”
改后生效方式	重启生效

trust_store_path

名字	trust_store_path
描述	keyStore 密码（非必填）
类型	String
默认值	“”
改后生效方式	重启生效

trust_store_pwd

名字	trust_store_pwd
描述	trustStore 密码（非必填）
类型	String
默认值	“”
改后生效方式	重启生效

idle_timeout

名字	idle_timeout
描述	SSL 超时时间，单位为秒
类型	int32
默认值	5000
改后生效方式	重启生效

当前内容版权归 IoTDB 或其关联方所有，如需对内容或内容相关联开源项目进行关注与资助，请访问 IoTDB .

本文档使用 BookStack 构建

展开/收起文章目录