Introduction

Apache ShardingSphere provides the way of property configuration to configure system level configuration.

Configuration Item Explanation

NameData TypeDescriptionDefault ValueWhether to support dynamic modification
sql-show (?)booleanWhether show SQL or not in log.
Print SQL details can help developers debug easier. The log details include: logic SQL, actual SQL and SQL parse result.
Enable this property will log into log topic ShardingSphere-SQL, log level is INFO.
falsetrue
sql-simple (?)booleanWhether show SQL details in simple style.falsetrue
kernel-executor-size (?)intThe max thread size of worker group to execute SQL. One ShardingSphereDataSource will use a independent thread pool, it does not share thread pool even different data source in same JVM.infinitefalse
max-connections-size-per-query (?)intMax opened connection size for each query.1true
check-table-metadata-enabled (?)booleanWhether validate table meta data consistency when application startup or updated.falsefalse
proxy-frontend-flush-threshold (?)intFlush threshold for every records from databases for ShardingSphere-Proxy.128true
proxy-opentracing-enabled (?)booleanWhether enable opentracing for ShardingSphere-Proxy.falsetrue
proxy-hint-enabled (?)booleanWhether enable hint for ShardingSphere-Proxy. Using Hint will switch proxy thread mode from IO multiplexing to per connection per thread, which will reduce system throughput.falsetrue
proxy-backend-query-fetch-size (?)intProxy backend query fetch size. A larger value may increase the memory usage of ShardingSphere Proxy. The default value is -1, which means set the minimum value for different JDBC drivers.-1false
check-duplicate-table-enabled (?)booleanWhether validate duplicate table when application startup or updated.falsefalse
sql-comment-parse-enabled (?)booleanWhether parse the comment of SQL.falsetrue
proxy-frontend-executor-size (?)intProxy frontend Netty executor size. The default value is 0, which means let Netty decide.0false
proxy-backend-executor-suitable (?)StringAvailable options of proxy backend executor suitable: OLAP(default), OLTP. The OLTP option may reduce time cost of writing packets to client, but it may increase the latency of SQL execution if client connections are more than proxy-frontend-netty-executor-size, especially executing slow SQL.OLAPfalse
sql-federation-enabled (?)booleanWhether enable sql federation.falsetrue

Properties that support dynamic modification can take effect immediately after being configured through DistSQL. Properties that do not support dynamic modification can also be configured through DistSQL but need to be restarted to take effect.