You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by wu...@apache.org on 2021/11/15 13:34:55 UTC
[shardingsphere] branch master updated: Refactor proxy/yaml-config (#13626)
This is an automated email from the ASF dual-hosted git repository.
wuweijie 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 9375b28 Refactor proxy/yaml-config (#13626)
9375b28 is described below
commit 9375b281ddfcbd2c90225aee27e0078bdefcc23d
Author: Liang Zhang <te...@163.com>
AuthorDate: Mon Nov 15 21:34:17 2021 +0800
Refactor proxy/yaml-config (#13626)
* Rename proxy/configuration to proxy/yaml-config
* Refactor proxy/yaml-config
---
.../configuration/_index.cn.md | 13 -----------
.../configuration/_index.en.md | 14 ------------
.../configuration/data-source.cn.md | 26 ----------------------
.../configuration/data-source.en.md | 25 ---------------------
.../configuration/yaml-syntax.cn.md | 12 ----------
.../configuration/yaml-syntax.en.md | 12 ----------
.../shardingsphere-proxy/yaml-config/_index.cn.md | 9 ++++++++
.../shardingsphere-proxy/yaml-config/_index.en.md | 9 ++++++++
.../authentication.cn.md | 4 ++--
.../authentication.en.md | 4 ++--
.../{configuration => yaml-config}/props.cn.md | 2 +-
.../{configuration => yaml-config}/props.en.md | 4 ++--
12 files changed, 25 insertions(+), 109 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/_index.cn.md
deleted file mode 100644
index 181804d..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/_index.cn.md
+++ /dev/null
@@ -1,13 +0,0 @@
-+++
-title = "配置手册"
-weight = 2
-+++
-
-配置是 ShardingSphere-Proxy 中唯一与开发者交互的模块，通过它可以快速清晰的理解 ShardingSphere-Proxy 所提供的功能。
-
-本章节是 ShardingSphere-Proxy 的配置参考手册，需要时可当做字典查阅。
-
-ShardingSphere-Proxy 只提供基于 YAML 的配置方式。
-通过配置，应用开发者可以灵活的使用数据分片、读写分离、数据加密、影子库等功能，并且能够叠加使用。
-
-规则配置部分与 ShardingSphere-JDBC 的 YAML 配置完全一致。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/_index.en.md
deleted file mode 100644
index df145ac..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/_index.en.md
+++ /dev/null
@@ -1,14 +0,0 @@
-+++
-title = "Configuration Manual"
-weight = 2
-+++
-
-Configuration is the only module in ShardingSphere-Proxy that interacts with application developers,
-through which developer can quickly and clearly understand the functions provided by ShardingSphere-Proxy.
-
-This chapter is a configuration manual for ShardingSphere-Proxy, which can also be referred to as a dictionary if necessary.
-
-ShardingSphere-Proxy only provided YAML configuration.
-By configuration, application developers can flexibly use data sharding, readwrite-splitting, data encryption, shadow database or the combination of them.
-
-Rule configuration keeps consist with YAML configuration of ShardingSphere-JDBC.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/data-source.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/data-source.cn.md
deleted file mode 100644
index ca21941..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/data-source.cn.md
+++ /dev/null
@@ -1,26 +0,0 @@
-+++
-title = "数据源配置"
-weight = 1
-+++
-
-## 配置项说明
-
-```yaml
-schemaName: # 逻辑数据源名称
-
-dataSources: # 数据源配置，可配置多个 <data-source-name>
- <data-source-name>: # 与 ShardingSphere-JDBC 配置不同，无需配置数据库连接池
- url: # 数据库 URL 连接，支持 jdbc:mysql、jdbc:postgresql、jdbc:opengauss 前缀
- username: # 数据库用户名
- password: # 数据库密码
- connectionTimeoutMilliseconds: # 连接超时毫秒数
- idleTimeoutMilliseconds: # 空闲连接回收超时毫秒数
- maxLifetimeMilliseconds: # 连接最大存活时间毫秒数
- maxPoolSize: 50 # 最大连接数
- minPoolSize: 1 # 最小连接数
-
-rules: # 与 ShardingSphere-JDBC 配置一致
- # ...
-```
-
-更多的数据源配置参数详见[HikariCP](https://github.com/brettwooldridge/HikariCP) 。
\ No newline at end of file
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/data-source.en.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/data-source.en.md
deleted file mode 100644
index b23b9e2..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/data-source.en.md
+++ /dev/null
@@ -1,25 +0,0 @@
-+++
-title = "Data Source Configuration"
-weight = 1
-+++
-
-## Configuration Item Explanation
-
-```yaml
-schemaName: # Logic schema name
-
-dataSources: # Data sources configuration, multiple <data-source-name> available
- <data-source-name>: # Different from ShardingSphere-JDBC configuration, it does not need to be configured with database connection pool
- url: # Database URL, starts with jdbc:mysql, jdbc:postgresql, jdbc:opengauss
- username: # Database username
- password: # Database password
- connectionTimeoutMilliseconds: #Connection timeout milliseconds
- idleTimeoutMilliseconds: #Idle timeout milliseconds
- maxLifetimeMilliseconds: #Maximum life milliseconds
- maxPoolSize: 50 #Maximum connection count in the pool
- minPoolSize: 1 #Minimum connection count in the pool
-
-rules: # Keep consist with ShardingSphere-JDBC configuration
- # ...
-```
-For more data source configuration parameters, see [HikariCP](https://github.com/brettwooldridge/HikariCP).
\ No newline at end of file
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/yaml-syntax.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/yaml-syntax.cn.md
deleted file mode 100644
index 6adb94c..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/yaml-syntax.cn.md
+++ /dev/null
@@ -1,12 +0,0 @@
-+++
-title = "YAML 语法说明"
-weight = 4
-+++
-
-`!!` 表示实例化该类
-
-`!` 表示自定义别名
-
-`-` 表示可以包含一个或多个
-
-`[]` 表示数组，可以与减号相互替换使用
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/yaml-syntax.en.md b/docs/document/content/user-manual/shardingsphere-proxy/configuration/yaml-syntax.en.md
deleted file mode 100644
index d25bc30..0000000
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/yaml-syntax.en.md
+++ /dev/null
@@ -1,12 +0,0 @@
-+++
-title = "YAML Syntax"
-weight = 4
-+++
-
-`!!` means instantiation of that class
-
-`!` means self-defined alias
-
-`-` means one or multiple can be included
-
-`[]` means array, can substitutable with `-` each other
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/_index.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/_index.cn.md
new file mode 100644
index 0000000..7798955
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/_index.cn.md
@@ -0,0 +1,9 @@
++++
+title = "YAML 配置"
+weight = 2
++++
+
+ShardingSphere-JDBC 的 YAML 配置是 ShardingSphere-Proxy 的子集。
+在 `server.yaml` 文件中，ShardingSphere-Proxy 能够额外配置权限功能和更多的 Proxy 专有属性。
+
+本章节将介绍 ShardingSphere-Proxy 的 YAML 额外配置。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/_index.en.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/_index.en.md
new file mode 100644
index 0000000..8412ecc
--- /dev/null
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/_index.en.md
@@ -0,0 +1,9 @@
++++
+title = "Yaml Configuration"
+weight = 2
++++
+
+The YAML configuration of ShardingSphere-JDBC is the subset of ShardingSphere-Proxy.
+In `server.yaml` file, ShardingSphere-Proxy can configure authority feature and more properties for Proxy only.
+
+This chapter will introduce the extra YAML configuration of ShardingSphere-Proxy.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/authentication.cn.md
similarity index 93%
rename from docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/yaml-config/authentication.cn.md
index 0d5557a..1092b02 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/authentication.cn.md
@@ -1,6 +1,6 @@
+++
-title = "权限配置"
-weight = 2
+title = "权限"
+weight = 1
+++
用于执行登录 Sharding Proxy 的权限验证。
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.en.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/authentication.en.md
similarity index 93%
rename from docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/yaml-config/authentication.en.md
index 89bd212..385a861 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/authentication.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/authentication.en.md
@@ -1,6 +1,6 @@
+++
-title = "Authentication"
-weight = 2
+title = "Authority"
+weight = 1
+++
It is used to verify the authentication to log in ShardingSphere-Proxy, which must use correct user name and password after the configuration of them.
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/props.cn.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
similarity index 99%
rename from docs/document/content/user-manual/shardingsphere-proxy/configuration/props.cn.md
rename to docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
index 3b3fc83..9c6058d 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/props.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.cn.md
@@ -1,6 +1,6 @@
+++
title = "属性配置"
-weight = 3
+weight = 2
chapter = true
+++
diff --git a/docs/document/content/user-manual/shardingsphere-proxy/configuration/props.en.md b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
similarity index 98%
rename from docs/document/content/user-manual/shardingsphere-proxy/configuration/props.en.md
rename to docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
index f194afb..25f8a89 100644
--- a/docs/document/content/user-manual/shardingsphere-proxy/configuration/props.en.md
+++ b/docs/document/content/user-manual/shardingsphere-proxy/yaml-config/props.en.md
@@ -1,6 +1,6 @@
+++
-title = "Properties Configuration"
-weight = 3
+title = "Properties"
+weight = 2
chapter = true
+++