Skip to content

Commit

Permalink
Merge branch 'apache:master' into dev_25892
Browse files Browse the repository at this point in the history
  • Loading branch information
zihaoAK47 authored Sep 26, 2023
2 parents 9e8a5e1 + 898dcc9 commit a4e3944
Show file tree
Hide file tree
Showing 106 changed files with 429 additions and 3,374 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/required-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Run CheckStyle
run: ./mvnw checkstyle:check -Dcheckstyle.skip=false -T1C
run: ./mvnw checkstyle:check -Pcheck -T1C

check-spotless:
if: ${{ needs.global-environment.outputs.GLOBAL_JOB_ENABLED == 'true' }}
Expand All @@ -51,7 +51,7 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Run Spotless
run: ./mvnw spotless:check -T1C
run: ./mvnw spotless:check -Pcheck -T1C

check-license:
if: ${{ needs.global-environment.outputs.GLOBAL_JOB_ENABLED == 'true' }}
Expand All @@ -62,4 +62,4 @@ jobs:
steps:
- uses: actions/checkout@v3
- name: Run Apache Rat
run: ./mvnw apache-rat:check -Drat.skip=false -T1C
run: ./mvnw apache-rat:check -Pcheck -T1C
24 changes: 0 additions & 24 deletions .mvn/extensions.xml

This file was deleted.

4 changes: 2 additions & 2 deletions docs/community/content/involved/conduct/code.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ chapter = true
## 代码提交行为规范

- 确保遵守编码规范。
- 确保构建流程中的各个步骤都成功完成,包括:Apache 协议文件头检查、Checkstyle 检查、编译、单元测试等。构建流程启动命令:`./mvnw clean install -B -T1C -Dmaven.javadoc.skip -Dmaven.jacoco.skip -e`
- 确保构建流程中的各个步骤都成功完成,包括:Apache 协议文件头检查、Checkstyle 检查、编译、单元测试等。构建流程启动命令:`./mvnw clean install -B -T1C -Pcheck`
- 确保覆盖率不低于 master 分支。
- 应尽量将设计精细化拆分;做到小幅度修改,多次数提交,但应保证提交的完整性。
- 通过 Spotless 统一代码风格,执行 `mvn spotless:apply` 格式化代码。
- 通过 Spotless 统一代码风格,执行 `./mvnw spotless:apply -Pcheck` 格式化代码。
- 如果您使用 IDEA,可导入推荐的 `src/resources/code-style-idea.xml`

## 编码规范
Expand Down
4 changes: 2 additions & 2 deletions docs/community/content/involved/conduct/code.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ The following code of conduct is based on full compliance with [ASF CODE OF COND
## Contributor Covenant Submitting of Conduct

- Conform to `Contributor Covenant Code of Conduct` below.
- Make sure Maven build process success. Run `./mvnw clean install -B -T1C -Dmaven.javadoc.skip -Dmaven.jacoco.skip -e` command in shell to start Maven build process.
- Make sure Maven build process success. Run `./mvnw clean install -B -T1C -Pcheck` command in shell to start Maven build process.
- Make sure the test coverage rate is not lower than the master branch.
- Careful consideration for each `pull request`; Small and frequent `pull request` with complete unit function is welcomed.
- Through the uniform code style of spotless, execute the `mvn spotless:apply` formatted code.
- Through the uniform code style of spotless, execute the `./mvnw spotless:apply -Pcheck` formatted code.
- If using IDEA, you can import the recommended `src/resources/code-style-idea.xml`.

## Contributor Covenant Code of Conduct
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ git remote -v

```shell
cd shardingsphere
mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true -Dspotbugs.skip=true -Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease
./mvnw clean install -DskipITs -DskipTests -Prelease
```

当你以后从 ShardingSphere 拉取最新代码并新建分支,可能会遇到类似的解析器编译错误,可以重新运行这个命令来解决问题。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Build and install all modules, it'll install modules into Maven local repository

```shell
cd shardingsphere
mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true -Dspotbugs.skip=true -Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease
./mvnw clean install -DskipITs -DskipTests -Prelease
```

When you pull the latest code from ShardingSphere and create new branch later, you might get similar compile error of parser again, then you could run this command again.
Expand Down
2 changes: 0 additions & 2 deletions docs/document/content/dev-manual/encrypt.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,4 @@ chapter = true
| *配置标识* | *详细说明* | *全限定类名* |
|------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| AES | 基于 AES 的数据加密算法 | [`org.apache.shardingsphere.encrypt.algorithm.encrypt.AESEncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/standard/AESEncryptAlgorithm.java) |
| RC4 | 基于 RC4 的数据加密算法 | [`org.apache.shardingsphere.encrypt.algorithm.encrypt.RC4EncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/standard/RC4EncryptAlgorithm.java) |
| MD5 | 基于 MD5 的辅助查询加密算法 | [`org.apache.shardingsphere.encrypt.algorithm.encrypt.MD5EncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/assisted/MD5AssistedEncryptAlgorithm.java) |
| CHAR_DIGEST_LIKE | 用于模糊查询的数据加密算法 | [`org.apache.shardingsphere.encrypt.algorithm.like.CharDigestLikeEncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/like/CharDigestLikeEncryptAlgorithm.java) |
2 changes: 0 additions & 2 deletions docs/document/content/dev-manual/encrypt.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,4 @@ Data encrypt algorithm definition
| *Configuration Type* | *Description* | *Fully-qualified class name* |
|----------------------|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| AES | AES data encrypt algorithm | [`org.apache.shardingsphere.encrypt.algorithm.encrypt.AESEncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/standard/AESEncryptAlgorithm.java) |
| RC4 | RC4 data encrypt algorithm | [`org.apache.shardingsphere.encrypt.algorithm.encrypt.RC4EncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/standard/RC4EncryptAlgorithm.java) |
| MD5 | MD5 assisted query encrypt algorithm | [`org.apache.shardingsphere.encrypt.algorithm.encrypt.MD5EncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/assisted/MD5AssistedEncryptAlgorithm.java) |
| CHAR_DIGEST_LIKE | Data encryption algorithms for like queries | [`org.apache.shardingsphere.encrypt.algorithm.like.CharDigestLikeEncryptAlgorithm`](https://github.com/apache/shardingsphere/blob/master/features/encrypt/core/src/main/java/org/apache/shardingsphere/encrypt/algorithm/like/CharDigestLikeEncryptAlgorithm.java) |
1 change: 0 additions & 1 deletion docs/document/content/dev-manual/mode.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,4 @@ chapter = true
|-----------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ZooKeeper | 基于 ZooKeeper 的持久化 | [`org.apache.shardingsphere.mode.repository.cluster.zookeeper.ZookeeperRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/zookeeper/src/main/java/org/apache/shardingsphere/mode/repository/cluster/zookeeper/ZookeeperRepository.java) |
| etcd | 基于 Etcd 的持久化 | [`org.apache.shardingsphere.mode.repository.cluster.etcd.EtcdRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/etcd/src/main/java/org/apache/shardingsphere/mode/repository/cluster/etcd/EtcdRepository.java) |
| Nacos | 基于 Nacos 的持久化 | [`org.apache.shardingsphere.mode.repository.cluster.nacos.NacosRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/nacos/src/main/java/org/apache/shardingsphere/mode/repository/cluster/nacos/NacosRepository.java) |
| Consul | 基于 Consul 的持久化 | [`org.apache.shardingsphere.mode.repository.cluster.consul.ConsulRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/consul/src/main/java/org/apache/shardingsphere/mode/repository/cluster/consul/ConsulRepository.java) |
1 change: 0 additions & 1 deletion docs/document/content/dev-manual/mode.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,4 @@ Cluster mode configuration information persistence definition
|----------------------|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ZooKeeper | ZooKeeper based persistence | [`org.apache.shardingsphere.mode.repository.cluster.zookeeper.ZookeeperRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/zookeeper/src/main/java/org/apache/shardingsphere/mode/repository/cluster/zookeeper/ZookeeperRepository.java) |
| etcd | Etcd based persistence | [`org.apache.shardingsphere.mode.repository.cluster.etcd.EtcdRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/etcd/src/main/java/org/apache/shardingsphere/mode/repository/cluster/etcd/EtcdRepository.java) |
| Nacos | Nacos based persistence | [`org.apache.shardingsphere.mode.repository.cluster.nacos.NacosRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/nacos/src/main/java/org/apache/shardingsphere/mode/repository/cluster/nacos/NacosRepository.java) |
| Consul | Consul based persistence | [`org.apache.shardingsphere.mode.repository.cluster.consul.ConsulRepository`](https://github.com/apache/shardingsphere/blob/master/mode/type/cluster/repository/provider/consul/src/main/java/org/apache/shardingsphere/mode/repository/cluster/consul/ConsulRepository.java) |
2 changes: 1 addition & 1 deletion docs/document/content/faq/_index.cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ ShardingSphere-Proxy 在部署过程中没有添加 jdbc 驱动,需要将 jdbc
ShardingSphere 使用 lombok 实现极简代码。关于更多使用和安装细节,请参考 [lombok官网](https://projectlombok.org/download.html)
`org.apache.shardingsphere.sql.parser.autogen` 包下的代码由 ANTLR 生成,可以执行以下命令快速生成:
```bash
./mvnw -Dcheckstyle.skip=true -Dspotbugs.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true -Djacoco.skip=true -DskipITs -DskipTests install -T1C
./mvnw -DskipITs -DskipTests install -T1C
```
生成的代码例如 `org.apache.shardingsphere.sql.parser.autogen.PostgreSQLStatementParser` 等 Java 文件由于较大,默认配置的 IDEA 可能不会索引该文件。
可以调整 IDEA 的属性:`idea.max.intellisense.filesize=10000`
Expand Down
2 changes: 1 addition & 1 deletion docs/document/content/faq/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ Answer:
ShardingSphere uses lombok to enable minimal coding. For more details about using and installment, please refer to the official website of [lombok](https://projectlombok.org/download.html).
The codes under the package `org.apache.shardingsphere.sql.parser.autogen` are generated by ANTLR. You may execute the following command to generate codes:
```bash
./mvnw -Dcheckstyle.skip=true -Dspotbugs.skip=true -Drat.skip=true -Dmaven.javadoc.skip=true -Djacoco.skip=true -DskipITs -DskipTests install -T1C
./mvnw -DskipITs -DskipTests install -T1C
```
The generated codes such as `org.apache.shardingsphere.sql.parser.autogen.PostgreSQLStatementParser` may be too large to be indexed by the IDEA.
You may configure the IDEA's property `idea.max.intellisense.filesize=10000`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,31 +22,6 @@ weight = 5
| aes-key-value | String | AES 使用的 KEY |
| digest-algorithm-name | String | AES KEY 的摘要算法 (可选,默认值:SHA-1) |

#### RC4 加密算法

类型:RC4

可配置属性:

| *名称* | *数据类型* | *说明* |
|---------------|--------|-------------|
| rc4-key-value | String | RC4 使用的 KEY |

### 模糊加密算法

#### 单字符摘要模糊加密算法

类型:CHAR_DIGEST_LIKE

可配置属性:

| *名称* | *数据类型* | *说明* |
|-------|--------|--------------------|
| delta | int | 字符Unicode码偏移量(十进制) |
| mask | int | 字符加密掩码(十进制) |
| start | int | 密文Unicode初始码(十进制) |
| dict | String | 常见字 |

### 辅助查询加密算法

#### MD5 辅助查询加密算法
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,31 +22,6 @@ Attributes:
| aes-key-value | String | AES KEY |
| digest-algorithm-name | String | AES KEY DIGEST ALGORITHM (optional, default: SHA-1) |

#### RC4 Encrypt Algorithm

Type: RC4

Attributes:

| *Name* | *DataType* | *Description* |
|---------------|------------|---------------|
| rc4-key-value | String | RC4 KEY |

### Like Encrypt Algorithm

#### CharDigestLike Encrypt Algorithm

Type:CHAR_DIGEST_LIKE

Attributes:

| *Name* | *DataType* | *Description* |
|--------|------------|-------------------------------------------------|
| delta | int | Character Unicode offset(decimal number) |
| mask | int | Character encryption mask(decimal number) |
| start | int | Ciphertext Unicode initial code(decimal number) |
| dict | String | Common words |

### Assisted Encrypt Algorithm

#### MD5 Assisted Encrypt Algorithm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,6 @@ Apache ShardingSphere 为不同的运行模式提供了不同的元数据持久
| timeToLiveSeconds | long | 临时数据失效的秒数 | 30 |
| connectionTimeout | long | 连接超时秒数 | 30 |

### Nacos 持久化

类型:Nacos

适用模式:Cluster

可配置属性:

| *名称* | *数据类型* | *说明* | *默认值* |
|---------------------------|--------|-------------------|--------|
| clusterIp | String | 集群中的唯一标识 | 真实主机IP |
| retryIntervalMilliseconds | long | 重试间隔毫秒数 | 500 |
| maxRetries | int | 客户端检查数据可用性的最大重试次数 | 3 |
| timeToLiveSeconds | int | 临时实例失效的秒数 | 30 |

### Consul 持久化

类型:Consul
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,21 +54,6 @@ Attributes:
| timeToLiveSeconds | long | Seconds of ephemeral data live | 30 |
| connectionTimeout | long | Seconds of connection timeout | 30 |

### Nacos Repository

Type: Nacos

Mode: Cluster

Attributes:

| *Name* | *Type* | *Description* | *Default Value* |
|---------------------------|--------|---------------------------------------------------|-----------------|
| clusterIp | String | Unique identifier in cluster | Host IP |
| retryIntervalMilliseconds | long | Milliseconds of retry interval | 500 |
| maxRetries | int | Max retries for client to check data availability | 3 |
| timeToLiveSeconds | int | Seconds of ephemeral instance live | 30 |

### Consul Repository

Type: Consul
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ weight = 7
```shell
git clone --depth 1 https://github.com/apache/shardingsphere.git
cd shardingsphere
mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true -Dspotbugs.skip=true -Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease
mvn clean install -DskipITs -DskipTests -Prelease
```
agent 包输出目录为 distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Download Apache ShardingSphere from GitHub,Then compile.
```shell
git clone --depth 1 https://github.com/apache/shardingsphere.git
cd shardingsphere
mvn clean install -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true -Dspotbugs.skip=true -Drat.skip=true -Djacoco.skip=true -DskipITs -DskipTests -Prelease
mvn clean install -DskipITs -DskipTests -Prelease
```

Artifact is distribution/agent/target/apache-shardingsphere-${latest.release.version}-shardingsphere-agent-bin.tar.gz
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ ShardingSphere 默认情况下仅包含核心 SPI 的实现,在 Git Source 存
- 集群模式配置信息持久化定义
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`,基于 Zookeeper 的持久化实现
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`,基于 Etcd 的持久化实现
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-nacos`,基于 Nacos 的持久化实现
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-consul`,基于 Consul 的持久化实现
- XA 分布式事务管理器
- `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`,基于 Narayana 的 XA 分布式事务管理器
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ All optional plugins are listed below in the form of `groupId:artifactId`.
- Cluster mode configuration information persistence definition
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-zookeeper`, Zookeeper based persistence
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-etcd`, Etcd based persistence
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-nacos`, Nacos based persistence
- `org.apache.shardingsphere:shardingsphere-cluster-mode-repository-consul`, Consul based persistence
- XA transaction manager provider definition
- `org.apache.shardingsphere:shardingsphere-transaction-xa-narayana`, XA distributed transaction manager based on Narayana
Expand Down
Loading

0 comments on commit a4e3944

Please sign in to comment.