_配置名称

_配置内容

_{默认值/单位}

_{详细作用原理或应用}

_配置范围

_homePath

_{基本目录 慢查询日志（slowlogs）、视图记录日志（viewConf）、xa的tm日志（xalogs）、load data临时文件（temp）等存放路径的父目录}

_{无默认值,不配置会报错}

_{其他一些类似于事务或者视图存储的的根路径}

_{有效路径,
推荐配置为当前目录}

_instanceName

_实例名称

_{无默认值，不配置会报错}

_{集群配置时的唯一标识，xa事务时的实例标识}

_{集群内唯一值}

_instanceId

_实例id

_无默认值

_{集群配置时的唯一标识，全局序列时的唯一标识}

_{仅当sequenceHandlerType=2 或者 3时候有意义.}

_{当sequenceHandlerType=2，合法值范围为0~1023}

_{当sequenceHandlerType=3，合法值范围为0~,511}

_serverId

_{服务器名称}

_{默认值为服务器IP}

_{dble所在机器的名称}

用于告警时候报告服务器名称

_bindIp

_服务IP

_{默认 "0.0.0.0"}

_{在服务初始化的时候作为侦听的IP}

_{有效IP地址,
推荐默认}

_serverPort

_服务端口

_默认8066

_{在服务初始化的时候作为服务侦听的端口}

_{机器空闲端口}

_managerPort

_控制端口

_默认9066

_{在服务初始化的时候作为控制侦听的}

_{机器空闲端口}

_maxCon

_{控制最大连接数}

_默认0

_{默认不做限制。若maxCon大于0,建立的连接数大于maxCon之后,建立连接会失败.注意当各个用户的maxcon总和值大于此值时，以当前值为准。 全局maxCon不作用于manager用户}

_正整数

_NIOFrontRW

_{NIO前端处理器的数量，兼容旧参数processors，同时配置NIOFrontRW和processors，以NIOFrontRW为准}

_{默认java虚拟机核数
,单位个}

_{进行前端网络IO吞吐的线程数}

_正整数

_NIOBackendRW

_{NIO后端处理器的数量，兼容旧参数backendProcessors，同时配置NIOBackendRW和backendProcessors，以NIOBackendRW为准}

_{默认java虚拟机核数
,单位个}

_{进行后端网络IO吞吐的线程数}

_正整数

_frontWorker

_{前端业务处理线程池数量，兼容旧参数processorExecutor，同时配置frontWorker和processorExecutor，以frontWorker为准}

_{默认
(单核为2,否则等于宿主机核数)}

_{进行前端具体业务处理的线程池大小，负责解析路由下发}

_正整数

_{managerFrontWorker}

_{前侧管理端线程池数量}

_{默认
默认(单核为2,否则等于宿主机核数/2)}

_{负责前侧管理端执行&处理命令的线程池大小}

_正整数

_{backendWorker}

_{后端业务处理线程池数量，兼容旧参数backendProcessorExecutor，同时配置backendWorker和backendProcessorExecutor，以backendWorker为准}

_{默认
(单核为2,否则等于宿主机核数)}

_{进行后端具体业务处理的线程池大小，负责回收结果集并合并}

_正整数

_{complexQueryWorker}

_{复杂查询后端业务线程池数量，兼容旧参数complexExecutor，同时配置complexQueryWorker和complexExecutor，以complexQueryWorker为准}

_{默认
(单核为2,否则等于宿主机核数，宿主机核数大于8时，数量为8}

_{负责复杂查询或者子命令结果集的回收}

_正整数

_{writeToBackendWorker}

_{广播下发SQL时候批量处理的线程池，兼容旧参数writeToBackendExecutor，同时配置writeToBackendWorker和writeToBackendExecutor，以writeToBackendWorker为准}

_{默认
(单核为2,否则等于宿主机核数)}

_{负责广播下发SQL时候批量处理}

_正整数

_{fakeMySQLVersion}

_{Dble模拟Mysql版本号}

_默认NULL

<sub>模拟成正常的MySql版本, 用于与客户端协议交互
+ 分布式使用规则：填写的版本号不能高于后端Mysql节点的最低版本号, 否则启动失败
+ 读写分离使用规则：填写的版本号和后端MySQL节点的版本号需要在范围上保持一致，否则启动失败。MySQL官方认为 5.7.20<=版本<8.0.0 和="" 版本="">=8.0.3 是一致的，除此之外其它的版本则认为是同一种情况。例如以下的配置情况：
1.fakeMySQLVersion：5.7.20 mysql-version：5.7.25
2.fakeMySQLVersion：8.0.3 mysql-version：8.0.23
3.fakeMySQLVersion：5.7.15 mysql-version：8.0.1
建议：填写的大版本号与后端Mysql节点的大版本号保持一致</sub>

_{MYSQL版本号}

_正整数

_{usePerformanceMode}

_{是否启用性能模式}

_{默认0/单位无}

_{开启之后Dble会大量占用CPU资源，并提供更高的性能体现,慎用}

_1-是0-否

_useOuterHa

_{是否启用外部高可用联动}

_{默认为true，若此时不设置外部高可用，将不做切换}

_{如关闭此功能并且dble部署方式为单机，将使用默认的切换方式，详情请见切换相关章节}

_{groupConcatMaxLen}

_{GROUP CONCAT()函数允许的最大结果长度}

_{默认为1024}

_{GROUP CONCAT()函数允许的最大结果长度，以字节为单位}

_charset

_字符集

_utf8mb4

_{服务启动后的默认字符集于所有字符集相关的部分，包括前端连接和后端连接}

_{有效字符集}

_{maxPacketSize}

_{包大小限制}

_{默认 4×1024×1024}

_{限制请求的包大小，启动时候dble会拉取并尝试同步(此值+1024)到每个dbInstance，如果同步失败，就取配置值与各个dbInstance中最小的那个值-1024.留出1024的冗余用于对SQL改写或者上下文同步的支持}

_正整数

_txIsolation

_隔离级别

_{默认 3}

_{执行具体SQL的时候会比较前后端连接，}

_{启动时候dble会拉取并尝试同步此值到每个dbInstance，如果同步失败或者session级别重新设置该值，session在SQL下发之前，会执行session级别的隔离级别set}

_{1-READ_UNCOMMITTED
2-READ_COMMITTED
3-REPEATABLE_READ
4-SERIALIZABLE}

_autocommit

_{是否自动提交}

_{默认 1，自动提交}

_{启动时候dble会拉取并尝试同步此值到每个dbInstance}

_{如果同步失败或者session级别重新设置该值，执行具体SQL的时候会比较，如果不一致将会执行session级别的set}

_0/1

_{useCompression}

_{是否启用数据压缩}

_{默认 0否}

_{使用mysql压缩协议}

_{1 - 是 0 - 否}

_{capClientFoundRows}

_{是否开启Client_Found_Rows权能标识}

_{默认 false，关闭}

_{dble开启Client_Found_Rows权能标识}

_{true - 开启 false - 关闭}

_usingAIO

_{是否启用AIO}

_默认0

_{在初始化服务的时候将会作为判断启用AIO或是NIO的依据}

_{1 - 是 0 - 否}

_{线程使用率统计}

_{useThreadUsageStat}

_{开启线程使用率统计}

_{默认0/单位无}

_{开启之后能在管理端通过管理命令show @@thread_used查看各个部分的线程使用情况}

_1-是0-否

_{useCostTimeStat}

_{是否启用查询耗时统计}

_{默认0/单位无}

_{开启之后以一定的比例统计查询过程中的各个步骤的耗时情况，可以使用BTraceCostTime.java进行观测,也可在管理端使用show @@cost_time观察}

_1-是0-否

_{maxCostStatSize}

_默认100

_{show @@cost_time结果最近保留的行数}

_{costSamplePercent}

_{查询采样百分比}

_{默认1/单位%}

_{在耗时采样统计中实际采样百分比为costSamplePercent}

_{checkTableConsistency}

_{表格一致性检查}

_默认0

_{如果值为1，那么在服务初始化的时候会启动一个定时任务，在}

_{定时任务会检查DB是不是存在，表格是不是存在，表结构是否一致}

_1-是,0-否

_{checkTableConsistencyPeriod}

_{表格一致性检查周期}

_{默认30×60×1000
,单位毫秒}

_{表格一致性检查周期}

_正整数

_{sqlExecuteTimeout}

_{后端连接执行超时时间}

_{默认 300
,单位秒}

_{如果超过这个时间没有完毕，就直接关闭连接}

_正整数

_idleTimeout

_{前端连接无响应超时时间}

_{默认 10 × 60 × 1000
,单位毫秒}

_{在processor定时连接检查时，发现前端连接上一次的读写距今超过阀值，会直接关闭连接}

_正整数

_{processorCheckPeriod}

_{processor定时任务检查周期}

_{1000
,单位毫秒}

_{根据此配置定时的检查在processor中的前后端连接的状态}

_正整数

_{backSocketSoRcvbuf}  

_{后端套接字接收缓冲区大小}

_{1024×1024×4
,单位字节}

_{在创建后端管道的时候作为buffer大小使用}

_{backSocketSoSndbuf}

_{后端套接字发送缓冲区大小}

_{1024×1024
,单位字节}

_{在创建后端管道的时候作为buffer大小使用}

_{backSocketNoDelay}

_{后端Nagle算法是否禁用}

_{默认1/单位无}

_{在创建后端管道的时候禁用延迟加载，会影响网络包的情况 详见相关资料}

_{frontSocketSoRcvbuf}

_{前端套接字接受缓冲区大小}

_{1024 × 1024
,单位字节}

_{在读取网络传输信息的时候作为每次缓冲的大小使用}

_{frontSocketSoSndbuf}

_{前端套接字发送缓冲区大小}

_{1024×1024×4
,单位字节}

_{在创建前端管道的时候作为buffer大小使用}

_{frontSocketNoDelay}

_{前端Nagle算法是否禁用}

_默认1

_{在创建前端管道的时候禁用延迟加载 相关资料}

_orderMemSize

_{session中的复杂查询order预留内存}

_{默认4,单位M}

_{在session初始化的时候创建内存分配对象，在复杂查询order by的时候使用到}

_otherMemSize

_{session中的复杂查询其他预留内存}

_{默认4,单位M}

_{在session初始化的时候创建内存分配对象，在复杂查询subQuery以及distinctd的时候使用}

_joinMemSize

_{session中的复杂查询join预留内存}

_{默认4，单位M}

_{在session初始化的时候创建内存分配对象，在复杂查询join使用到}

_{bufferPoolChunkSize}

_{默认4096
,单位字节}

_{内存池中分配的最小粒度，需要的大小除以此粒度，向上取整}

_{bufferPoolPageNumber}

_{预分配内存池页数量}

_{默认 0.8 × MaxDirectMemorySize / bufferPoolPageSize(default 2M)， 向下取整}

_{在初始化的时候通过和bufferPoolPageSize的相乘确定缓冲池最后的大小，内存配置建议见启动参数}

_{bufferPoolPageSize}

_{预分配内存池页大小}

_{默认1024 * 1024 * 2,
单位字节}

_{在初始化的时候通过和bufferPoolPageNumbe的相乘确定缓冲池最后的大小,}

_{注意：虚拟机参数MaxDirectMemorySize(见启动参数)需要大于bufferPoolPageNumber * bufferPoolPageSize，否则会触发OOM}

_{mappedFileSize}

_{文件映射区单个文件最大体积}

_{默认1024×1024×64
,单位字节}

_{在初始化的时候此参数确定文件映射区最大容量,参见内存管理章节}

_正整数

_0或者1

_0或者1

_recordTxn

_{事务log记录}

_默认0

_{在初始化服务的时候会注册一个类，其作用就是将事务的log写到一个指定的文件中}

_{1-是，0-否}

_{transactionLogBaseDir}

_{事务log目录}

_{默认当前路径/txlogs}

_{当开启日志log记录时，记录文件会被存放在对应目录下}

_绝对路径

_{transactionLogBaseName}

_{事务log文件名称}

_{默认server-tx}

_{事务记录存储文件的文件名}

_{符合运行系统
文件的命名规范}

_正整数

_{xaRecoveryLogBaseDir}

_{xa的tm日志路径}

_{dble目录/xalogs/} 

_绝对路径

_{符合运行系统
文件的命名规范}

_{xaSessionCheckPeriod}

_{XA定时任务执行周期}

_{默认1000， 单位ms}

_{在server开始的时候会注册一个定时任务以此参数为执行周期}

_{（注：定时任务必定会被注册）}

_{如果有尝试多次没有成功提交的session在之后的定时任务会被重复提交}

_正整数

_{xaLogCleanPeriod}

_{定时XAlog清除周期}

_{默认1000， 单位ms}

_{在server开始的时候会根据这个周期注册一个定时任务}

_{（注：定时任务必定会被注册）}

_{定时清XA log，主要是将已经回滚和提交成功的部分从记录中删除}

_正整数

_xaRetryCount

_{后台重试XA次数}

_默认0

_{后台定时任务重试XA次数，0为无限重试，达到设定次数后，停止重试}

_正整数

_{xaIdCheckPeriod}

_{检测疑似残留XA任务的周期}

_{默认300，单位s}

_{后台定时检测疑似残留Xid任务； 如果设置小于等于0，则表示不开启此检测定时任务}

_正整数

_{viewPersistenceConfBaseDir}

_{视图记录本地文件路径}

_{dble目录/viewConf}

_{用于存放视图本地记录文件的文件路径,集群配置时无意义}

_绝对路径

_{viewPersistenceConfBaseName}

_{视图记录本地文件名}

_viewJson

_{视图记录的文件文件名,集群配置时无意义}

_{符合运行系统
文件的命名规范}

_{enableSlowLog}

_{慢查询日志开关}

_{默认为0，关闭}

_{慢查询日志开关}

_{slowLogBaseDir}

_{慢查询日志存储文件夹}

_{dble根目录/slowlogs}

_{慢查询日志存储文件夹}

_{slowLogBaseName}

_{慢查询日志存储文件名前缀}

_slow-query

_{慢查询日志存储文件名前缀(后缀名是.log)}

_{flushSlowLogPeriod}

_{日志刷盘周期，单位秒}

₁

_{日志刷盘周期，每隔这个周期，会强制将内存数据刷入磁盘}

_{flushSlowLogSize}

_{日志刷盘条数阈值}

₁₀₀₀

_{日志刷盘条数阈值，内存中每次写出这么多条日志，会强制刷盘1次}

_sqlSlowTime

_{慢日志时间阈值，单位毫秒}

₁₀₀

_{慢日志时间阈值，大于此时间的查询会记录下来}

_{slowQueueOverflowPolicy}

_{慢日志队列无空间时，后续日志的处理策略}

₂

_{慢日志队列存储的是等待落盘的慢日志，目前队列固定长度为2000，当队列满了，后续慢日志会根据不同的策略进行不同的处理}

_{策略1：保障持续服务业务：当遇到慢查询超过等待写入阈值时，丢弃当前产生的慢SQL，并发出告警；}

_{策略2：尽量保证慢日志不丢失：当遇到慢查询超过等待写入阈值时，触发阻塞队列机制，新的慢SQL等待加入落盘队列，并触发告警；最大阻塞时间为3s，超时会丢弃当前慢日志的记录}

_{maxCharsPerColumn}

_{每列所允许最大字符数}

_{默认为65535}

_{每列所允许最大字符数}

_{maxRowSizeToFile}

_{需要持久化的最大行数，在开启load data批处理模式下是拆分文件的阈值}

_{默认为100000}

_{当load data的数据行数超过阈值后，会将数据保存在文件中以防OOM。在开启批处理模式后load data的数据行数超过阈值后，会将该文件按照阈值拆分成多个文件进行保存，拆分过程中最后的数据行不到阈值放入在最后一个拆分的文件中,而不是再单独创建新文件存放}

_{enableBatchLoadData}

_{是否启用load data的批处理模式}

_默认为0

_{load data会将导入文件按照maxRowSizeToFile的值拆分成多个文件分批导入}

_{enableFlowControl}

_{是否启用流量控制，true/false}

_{默认为false}

_{具体流量控制请参见相关功能描述章节}

_{flowControlHighLevel}

_{触发流量控制的前端连接水位}

_{默认为4194304（4096K）}

_{当部分前端连接的写出队列的字节数超出水位时触发流量控制，单位为字节数}

_{flowControlLowLevel}

_{流量控制取消的前端连接水位}

_{默认为262144（256K）}

_{当流量控制中的前端连接写出队列的字节数小于水位，则取消流量控制，单位为字节数}

_enableCursor

_{是否开启 server-side-cursor.}

_默认false

_{注意游标功能必须客户端和服务器端同时开启才有效。且目前只支持分库分表场景使用。另外，如果客户端没开，服务器端开启了，运行 prepare statement依旧会损失一小部分性能。具体见 4.4}

_{maxHeapTableSize}

_{临时表在内存中存储的最大大小,单位byte}

_{默认为4096}

_{临时表在内存中存储的最大大小，超过这个大小会被落盘}

_{heapTableBufferChunkSize}

_{读 buffer 的 cache的大小}

_{默认等于bufferPoolChunkSize,单位byte}

_{读取临时表临时文件时，读 buffer 的大小}

_{enableGeneralLog}

_{是否开启genegral日志}

_{默认为0，关闭}

_{开启后会将所有接收的sql记录在general日志文件中}

_{generalLogFile}

_{general日志文件地址；}

_{默认为general/general.log}

_{若配置以'/'开头则作为绝对路径生效，反之，则在homepath后拼接得到最终绝对路径且生效}

_{generalLogFileSize}

_{general日志文件大小；}

_默认16M

_{当general.log超过其大小则将会生成yyyy-MM/general-MM-dd-%d.log（默认格式）文件；类似与log4j}

_{generalLogQueueSize}

_{处理general日志的队列大小}

_默认4096

_{涉及内部实现机制；（类似与log4j的AsyncLogger）}

_{enableStatistic}

_{是否开启全量统计}

_默认0

_{是否开启全量统计}

_{enableStatisticAnalysis}

_{是否开启sql对user、table、condition聚合统计}

_{默认为0，即不开启}

_{作为show @@sql.sum.user、show @@sql.sum.table、show @@sql.condition聚合统计的开关}

_{associateTablesByEntryByUserTableSize}

_{sql_statistic_by_associate_tables_by_entry_by_user表的大小}

_默认1024

_{超过其大小值，则淘汰溢出的历史数据}

_{frontendByBackendByEntryByUserTableSize}

_{sql_statistic_by_frontend_by_backend_by_entry_by_user表的大小}

_默认1024

_{超过其大小值，则淘汰溢出的历史数据}

_{tableByUserByEntryTableSize}

_{sql_statistic_by_table_by_user_by_entry表的大小}

_默认1024

_{超过其大小值，则淘汰溢出的历史数据}

_{statisticQueueSize}

_{处理sql statistic的队列大小}

_默认4096

_{涉及内部实现机制；（类似与log4j的AsyncLogger）}

_samplingRate

_{sql抽样统计的采样率}

_{默认为100，即开启全样统计}

_{samplingRate是个百分数。假如有100条事务进入dble，采样率设置为4，此时从100条事务中随机采样4条，且单个事务中的所有语句都会记录。}

_{sqlLogTableSize}

_{sql log 表格大小}

_默认1024

_{超过其大小值，则淘汰最旧的一条事务(在开启事务的情况下，一个事务中可能包含多个sql)}

_rwStickyTime

_{读写分离场景下，主(写)从(读)实例的粘滞时间段}

_{默认1000(ms), 若设置为0，则表示不开启主(写)从(读)实例的粘滞}

_{执行当前读SQL的时间，距离上一次写SQL执行的时间段，没有超过rwStickyTime时间段时，则当前读SQL将会下发至后端主(写)实例.}

_district

_{dble配置所属区域,读写分离本地读场景下使用}

_{默认为null}

_{读写分离本地读场景下读流量转发依据，该参数会和db.xml中dbInstance下的dbDistrict参数匹配}

_{有效字符集}

_dataCenter

_{dble配置所属数据中心,读写分离本地读场景下使用}

_{默认为null}

_{读写分离本地读场景下读流量转发依据，该参数会和db.xml中dbInstance下的dbDataCenter参数匹配}

_{有效字符集}

_{enableMemoryBufferMonitor}

_{是否开启堆外内存泄露监控}

₀

_{是否开启堆外内存泄露监控}

_{0表示关闭，1 表示开启}

_{enableMemoryBufferMonitorRecordPool}

_{是否记录连接池的常驻内存}

₁

_{是否记录连接池的常驻内存，一般不用修改。该类内存通常被连接池一直持有且不释放，属于正常现象也不属于泄露。如果对观测产生了困扰可关闭}

_{0表示关闭，1 表示开启}

_{enableSqlDumpLog}

_{是否开启审计日志}

_{默认为0，关闭}

_{开启后会记录读写分离(或者分析用户)，执行sql下发后端实例的系列信息}

_{sqlDumpLogBasePath}

_{审计日志的base路径}

_{默认为sqldump}

_{审计日志的base路径}

_合法路径

_{sqlDumpLogFileName}

_{审计日志文件名}

_{默认为sqldump.log}

_{日志文件名，生成日志的相对路径：sqldump/sqldump.log}

_{合法文件名}

_{sqlDumpLogCompressFilePattern}

_{压缩日志文件命名格式}

_{默认为${date:yyyy-MM}/sqldump-%d{MM-dd}-%i.log.gz}

_{如：sqldump/2022-10/sqldump-10-11-1.log.gz（精度为：天)}

_{合法文件名格式}

_{sqlDumpLogOnStartupRotate}

_{重启触发日志翻转}

_默认为1

_{每次重启，是否触发翻转；1-是，0-否}

_{1-是，0-否}

_{sqlDumpLogSizeBasedRotate}

_{文件大小上限触发日志翻转}

_{默认为50MB}

_{当sqldump.log文件大小达到50MB，触发日志翻转；单位可以为:KB、MB、GB}

_{合法文件大小}

_{sqlDumpLogTimeBasedRotate}

_{间隔天数，触发日志翻转}

_默认为1

_{当设置为1时，则每天会进行日志反转}

_正整数

_{sqlDumpLogDeleteFileAge}

_{对过期时间段内的压缩文件进行删除}

_默认为90d

_{对过期90天内的压缩文件进行删除，单位可以为:d(天)、h(时)、m(分)、s(秒)；（注意，精度单位需要与sqlDumpLogCompressFilePattern保持一致，否者可能不生效；原因：基于log4j2的实现，存在这个现象}

_{合法时间段}

_{sqlDumpLogCompressFilePath}

_{过期的文件压缩匹配}

_{默认为 */sqldump-*.log.gz}

_{匹配 sqlDumpLogCompressFilePath 路径下 且满足sqlDumpLogDeleteFileAge 的文件进行删除}

_合法路径

_tcpKeepIdle

_{启用tcp-keepalive连接检测的连接空闲时间}

_{默认为30s,最大值跟使用的操作系统相关}

_{dble连接如果没有数据发送，多久后会发送Keepalive探测分组，生效条件需要指定版本的jdk，具体可查看2.38章节内容}

_{tcpKeepInterval}

_{启用tcp-keepalive连接检测的时间间隔}

_{默认为10s，最大值跟使用的操作系统相关}

_{dble连接开启tcp-keepalive探活机制后，前后两次探测之间的时间间隔，生效条件需要指定版本的jdk，具体可查看2.38章节内容}

_tcpKeepCount

_{启用tcp-keepalive检测启用后的最大重试次数}

_{默认3，最大值跟使用的操作系统相关}

_{开启tcp-keepalive探活机制后，关闭一个非正常连接之前的最大重试次数，生效条件需要指定版本的jdk，具体可查看2.38章节内容}