You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by me...@apache.org on 2022/01/18 07:46:45 UTC
[shardingsphere] branch master updated: Correct and update descriptions of Proxy's props (#14857)
This is an automated email from the ASF dual-hosted git repository.
menghaoran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new 5e79602 Correct and update descriptions of Proxy's props (#14857)
5e79602 is described below
commit 5e796027172f57a35aa4c26f198f82333350d1f6
Author: 吴伟杰 <wu...@apache.org>
AuthorDate: Tue Jan 18 15:45:33 2022 +0800
Correct and update descriptions of Proxy's props (#14857)
* Correct and update descriptions of Proxy's props
* Update javadoc
---
.../shardingsphere-proxy/yaml-config/props.cn.md | 2 +-
.../shardingsphere-proxy/yaml-config/props.en.md | 32 +++++++++++-----------
.../config/props/ConfigurationPropertyKey.java | 2 +-
.../src/main/resources/conf/server.yaml | 2 +-
4 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
index 493efde..60060cb 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
@@ -23,7 +23,7 @@ Apache ShardingSphere 提供属性配置的方式配置系统级配置。
| proxy-backend-query-fetch-size (?) | int | Proxy 后端与数据库交互的每次获取数据行数（使用游标的情况下）。数值增大可能会增加 ShardingSphere Proxy 的内存使用。默认值为 -1，代表设置为 JDBC 驱动的最小值。 | -1 | 否 |
| check-duplicate-table-enabled (?) | boolean | 在程序启动和更新时，是否检查重复表。 | false | 否 |
| proxy-frontend-executor-size (?) | int | Proxy 前端 Netty 线程池线程数量，默认值 0 代表使用 Netty 默认值。 | 0 | 否 |
-| proxy-backend-executor-suitable (?)| String | 可选选项：OLAP、OLTP。OLTP 选项可能会减少向客户端写入数据包的时间开销，但如果客户端连接数超过 `proxy-frontend-netty-executor-size`，尤其是执行慢 SQL 时，它可能会增加 SQL 执行的延迟。 | OLAP | 否 |
+| proxy-backend-executor-suitable (?)| String | 可选选项：OLAP、OLTP。OLTP 选项可能会减少向客户端写入数据包的时间开销，但如果客户端连接数超过 `proxy-frontend-executor-size`，尤其是执行慢 SQL 时，它可能会增加 SQL 执行的延迟甚至阻塞其他客户端的连接。 | OLAP | 否 |
| proxy-frontend-max-connections (?) | int | 允许连接 Proxy 的最大客户端数量，默认值 0 代表不限制。 | 0 | 是 |
| sql-federation-enabled (?) | boolean | 是否开启 federation 查询。 | false | 是 |
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
index 3a6a947..3fcded9 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
@@ -10,22 +10,22 @@ Apache ShardingSphere provides the way of property configuration to configure sy
## Configuration Item Explanation
-| *Name* | *Data Type* | *Description* | *Default Value* | *Dynamic Update* |
-| ----------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --------------- |----------------- |
-| sql-show (?) | boolean | Whether show SQL or not in log. <br /> Print SQL details can help developers debug easier. The log details include: logic SQL, actual SQL and SQL parse result. <br /> Enable this property will log into log topic `ShardingSphere-SQL`, log level is INFO. | false | true |
-| sql-simple (?) | boolean | Whether show SQL details in simple style. | false | true |
-| kernel-executor-size (?) | int | The 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. | infinite | false |
-| max-connections-size-per-query (?) | int | Max opened connection size for each query. | 1 | true |
-| check-table-metadata-enabled (?) | boolean | Whether validate table meta data consistency when application startup or updated. | false | false |
-| proxy-frontend-flush-threshold (?) | int | Flush threshold for every records from databases for ShardingSphere-Proxy. | 128 | true |
-| proxy-opentracing-enabled (?) | boolean | Whether enable opentracing for ShardingSphere-Proxy. | false | true |
-| proxy-hint-enabled (?) | boolean | Whether 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. | false | true |
-| proxy-backend-query-fetch-size (?) | int | Proxy 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. | -1 | false |
-| check-duplicate-table-enabled (?) | boolean | Whether validate duplicate table when application startup or updated. | false | false |
-| proxy-frontend-executor-size (?) | int | Proxy frontend Netty executor size. The default value is 0, which means let Netty decide. | 0 | false |
-| proxy-backend-executor-suitable (?) | String | Available 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. | OLAP | false |
-| proxy-frontend-max-connections (?) | int | The maximum permitted number of client connections to Proxy. The default value is 0 and less than or equal to 0 means no limitation. | 0 | true |
-| sql-federation-enabled (?) | boolean | Whether enable sql federation. | false | true |
+| *Name* | *Data Type* | *Description* | *Default Value* | *Dynamic Update* |
+| ----------------------------------- | ----------- |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --------------- |----------------- |
+| sql-show (?) | boolean | Whether show SQL or not in log. <br /> Print SQL details can help developers debug easier. The log details include: logic SQL, actual SQL and SQL parse result. <br /> Enable this property will log into log topic `ShardingSphere-SQL`, log level is INFO. | false | true |
+| sql-simple (?) | boolean | Whether show SQL details in simple style. | false | true |
+| kernel-executor-size (?) | int | The 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. | infinite | false |
+| max-connections-size-per-query (?) | int | Max opened connection size for each query. | 1 | true |
+| check-table-metadata-enabled (?) | boolean | Whether validate table meta data consistency when application startup or updated. | false | false |
+| proxy-frontend-flush-threshold (?) | int | Flush threshold for every records from databases for ShardingSphere-Proxy. | 128 | true |
+| proxy-opentracing-enabled (?) | boolean | Whether enable opentracing for ShardingSphere-Proxy. | false | true |
+| proxy-hint-enabled (?) | boolean | Whether 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. | false | true |
+| proxy-backend-query-fetch-size (?) | int | Proxy 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. | -1 | false |
+| check-duplicate-table-enabled (?) | boolean | Whether validate duplicate table when application startup or updated. | false | false |
+| proxy-frontend-executor-size (?) | int | Proxy frontend Netty executor size. The default value is 0, which means let Netty decide. | 0 | false |
+| proxy-backend-executor-suitable (?) | String | Available 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 and block other clients if client connections are more than `proxy-frontend-executor-size`, especially executing slow SQL. | OLAP | false |
+| proxy-frontend-max-connections (?) | int | The maximum permitted number of client connections to Proxy. The default value is 0 and less than or equal to 0 means no limitation. | 0 | true |
+| sql-federation-enabled (?) | boolean | Whether enable sql federation. | false | true |
Properties can be updated by [DistSQL](/en/user-manual/shardingsphere-proxy/distsql/).
Dynamic update can take effect immediately, static update can take effect after restarted.
diff --git a/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/config/props/ConfigurationPropertyKey.java b/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/config/props/ConfigurationPropertyKey.java
index 1be134b..1181319 100644
--- a/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/config/props/ConfigurationPropertyKey.java
+++ b/shardingsphere-infra/shardingsphere-infra-common/src/main/java/org/apache/shardingsphere/infra/config/props/ConfigurationPropertyKey.java
@@ -105,7 +105,7 @@ public enum ConfigurationPropertyKey implements TypedPropertyKey {
/**
* Available 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.
+ * and block other clients if client connections are more than {@link ConfigurationPropertyKey#PROXY_FRONTEND_EXECUTOR_SIZE}, especially executing slow SQL.
*/
PROXY_BACKEND_EXECUTOR_SUITABLE("proxy-backend-executor-suitable", "OLAP", String.class),
diff --git a/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml b/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml
index 27d3959..dbbdb9e 100644
--- a/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml
+++ b/shardingsphere-proxy/shardingsphere-proxy-bootstrap/src/main/resources/conf/server.yaml
@@ -70,7 +70,7 @@
# check-duplicate-table-enabled: false
# proxy-frontend-executor-size: 0 # Proxy frontend executor size. The default value is 0, which means let Netty decide.
# # Available 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.
+# # and block other clients if client connections are more than `proxy-frontend-executor-size`, especially executing slow SQL.
# proxy-backend-executor-suitable: OLAP
# proxy-frontend-max-connections: 0 # Less than or equal to 0 means no limitation.
# sql-federation-enabled: false