@@ -13,7 +13,7 @@ The following code of conduct is based on full compliance with [ASF CODE OF COND
- Make sure all the test cases are passed, Make sure `./mvnw clean install` can be compiled and tested successfully.
- Make sure the test coverage rate is not lower than the master branch.
- Make sure to check codes with Checkstyle. codes that violate check rules should have special reasons. Find checkstyle template from `https://github.com/apache/incubator-shardingsphere/blob/master/src/resources/checkstyle.xml`, please use checkstyle `8.8` to run the rules.
- Make sure to check codes with Checkstyle. codes that violate check rules should have special reasons. Find checkstyle template from `https://github.com/apache/shardingsphere/blob/master/src/resources/checkstyle.xml`, please use checkstyle `8.8` to run the rules.
- Careful consideration for each `pull request`; Small and frequent `pull request` with complete unit function is welcomed.
- Conform to `Contributor Covenant Code of Conduct` below.
This is an assessment of the ShardingSphere podling’s maturity, meant to help inform the decision (of the mentors, community, Incubator PMC and ASF Board of Directors) to graduate it as a top-level Apache project.
It is based on the ASF project maturity model at https://community.apache.org/apache-way/apache-project-maturity-model.html
## Status of this document
All open items are updated with the latest status.
## Maturity model assessment
Mentors and community members are encouraged to contribute to this page and comment on it, the following table summarizes project’s self-assessment against the Apache Maturity Model.
| **CD10** | The project produces Open Source software, for distribution to the public at no charge. | **YES.** The project source code is licensed under the `Apache License 2.0`. |
| **CD20** | The project's code is easily discoverable and publicly accessible. | **YES.** The [website](https://shardingsphere.apache.org/) includes `SCM` link which can access GitHub directly. |
| **CD30** | The code can be built in a reproducible way using widely available standard tools. | **YES.** The build uses Apache Maven and Jenkins as the continuous integration tools, user can find `How to Build` in the [GitHub's README.md](https://github.com/apache/incubator-shardingsphere/blob/dev/README.md) for more information. |
| **CD40** | The full history of the project's code is available via a source code control system, in a way that allows any released version to be recreated. | **YES.** The project uses git to manage source code, demo code, documentation and website, all releases are tagged. |
| **CD50** | The provenance of each line of code is established via the source code control system, in a reliable way based on strong authentication of the committer. When third-party contributions are committed, commit messages provide reliable information about the code provenance. | **YES.** The project uses GitHub which managed by Apache Infra, it ensuring provenance of each line of code to a committer. The third-party contributions are accepted in accordance with the [contributor guide](https://shardingsphere.apache.org/community/en/contribute/contributor/) only. |
| **LC10** | The code is released under the Apache License, version 2.0. | **YES.** The [LICENSE file](https://github.com/apache/incubator-shardingsphere/blob/dev/LICENSE) is in GitHub repository. |
| **LC20** | Libraries that are mandatory dependencies of the project's code do not create more restrictions than the Apache License does. | **YES.** The [list of dependencies](https://github.com/apache/incubator-shardingsphere/tree/dev/sharding-distribution/sharding-proxy-distribution/src/main/release-docs/licenses) for binary release and [list of dependencies](https://github.com/terrymanu/incubator-shardingsphere/tree/parser/shardingsphere-ui/shardingsphere-ui-distribution/src/main/release-docs/licenses) of UI binary release have been reviewed to contain compatible licenses only. |
| **LC30** | The libraries mentioned in LC20 are available as Open Source software. | **YES.** See LC20's dependencies list. |
| **LC40** | Committers are bound by an Individual Contributor Agreement (the "Apache iCLA") that defines which code they are allowed to commit and how they need to identify code that is not their own. | **YES.** All committers have iCLAs on file before they have an apache account. |
| **LC50** | The copyright ownership of everything that the project produces is clearly defined and documented. | **YES.** All files in the source code have appropriate headers and checked by `Apache rat plugin` when build. |
| **RE10** | Releases consist of source code, distributed using standard and open archive formats that are expected to stay readable in the long term. | **YES.** Source release is distributed via [dist.apache.org](https://dist.apache.org/repos/dist/release/incubator/shardingsphere/) and linked from [download page](https://shardingsphere.apache.org/document/current/en/downloads/). |
| **RE20** | Releases are approved by the project's PMC (see CS10), in order to make them an act of the Foundation. | **YES.** All releases have been voted by ShardingSphere community and incubator, which have least 3 (P)PMC votes. |
| **RE30** | Releases are signed and/or distributed along with digests that can be reliably used to validate the downloaded archives. | **YES.** All releases are signed, and the [KEYS file](https://dist.apache.org/repos/dist/release/incubator/shardingsphere/KEYS) is provided on dist.apache.org. |
| **RE40** | Convenience binaries can be distributed alongside source code but they are not Apache Releases -- they are just a convenience provided with no guarantee. | **YES.** Convenience binaries are distributed via [Maven Central Repository](https://mvnrepository.com/artifact/org.apache.shardingsphere), [DockerHub](https://hub.docker.com/r/apache/sharding-proxy/tags) and [dist.apache.org](https://dist.apache.org/repos/dist/release/incubator/shardingsphere/) at the same time. |
| **RE50** | The release process is documented and repeatable to the extent that someone new to the project is able to independently generate the complete set of artifacts required for a release. | **YES.**[Release guide](https://shardingsphere.apache.org/community/en/contribute/release/) is available. The releases of the project have been performed by 3 different release managers. |
| **QU10** | The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated. | **YES.** All [issues](https://github.com/apache/incubator-shardingsphere/issues) record in ShardingSphere's GitHub repository. |
| **QU20** | The project puts a very high priority on producing secure software. | **YES.** Security issues are treated with the highest priority. |
| **QU30** | The project provides a well-documented, secure and private channel to report security issues, along with a documented way of responding to them. | **YES.** Website provides a [security page](https://shardingsphere.apache.org/community/en/security/) |
| **QU40** | The project puts a high priority on backwards compatibility and aims to document any incompatible changes and provide tools and documentation to help users transition to new features. | **YES.** Each release note contains all related issues and pull requests in the milestone, and extract mainly updates and API changes from milestones. |
| **QU50** | The project strives to respond to documented bug reports in a timely manner. | **YES.** The project has resolved 2000+ issues and 1200+ pull requests during 3 years. The response times on are pretty good. |
| **CO10** | The project has a well-known homepage that points to all the information required to operate according to this maturity model. | **YES.** The [website](https://shardingsphere.apache.org/) describes of the project with download, user manual, technical details, how to contribute and team introduce. |
| **CO20** | The community welcomes contributions from anyone who acts in good faith and in a respectful manner and adds value to the project. | **YES.** There is [contributor guide](https://shardingsphere.apache.org/community/en/contribute/contributor/) and the current committers are really welcome contributions. |
| **CO30** | Contributions include not only source code, but also documentation, constructive bug reports, constructive discussions, marketing and generally anything that adds value to the project. | **YES.** The contribution guide refers to non source code contribution, like [documentation](https://shardingsphere.apache.org/community/en/contribute/document-contributor/). The community has elected some non-coding committers. |
| **CO40** | The community strives to be meritocratic and over time aims to give more rights and responsibilities to contributors who add value to the project. | **YES.** The community has elected 2 new PPMC members and 4 new committers during incubation, based on meritocracy. |
| **CO50** | The way in which contributors can be granted more rights such as commit access or decision power is clearly documented and is the same for all contributors. | **YES.** The criteria is documented in the [committer guide](https://shardingsphere.apache.org/community/en/contribute/committer/). |
| **CO60** | The community operates based on consensus of its members (see CS10) who have decision power. Dictators, benevolent or not, are not welcome in Apache projects. | **YES.** The project works to build consensus. All votes have been unanimous so far. |
| **CO70** | The project strives to answer user questions in a timely manner. | **YES.** The project typically provides detailed answers to user questions within a few days via [dev@ mailing list](mailto:dev@shardingsphere.apache.org) and [GitHub issues](https://github.com/apache/incubator-shardingsphere/issues). |
| **CS10** | The project maintains a public list of its contributors who have decision power -- the project's PMC (Project Management Committee) consists of those contributors. | **YES.** The [team page](https://shardingsphere.apache.org/community/en/team/) list all of PPMC members and committers. |
| **CS20** | Decisions are made by consensus among PMC members 9 and are documented on the project's main communications channel. Community opinions are taken into account but the PMC has the final word if needed. | **YES.** The project has been making important decisions on the mailing lists. |
| **CS30** | Documented voting rules are used to build consensus when discussion is not sufficient. | **YES.** The project uses the standard ASF voting rules. |
| **CS40** | In Apache projects, vetoes are only valid for code commits and are justified by a technical explanation, as per the Apache voting rules defined in CS30. | **YES.** The project has not used a veto at any point during incubating. |
| **CS50** | All "important" discussions happen asynchronously in written form on the project's main communications channel. Offline, face-to-face or private discussions 11 that affect the project are also documented on that channel. | **YES.** The project has been making important decisions on the project mailing lists. Minor decisions may occasionally happen during code reviews, which are also asynchronous and in written form. |
| **IN10** | The project is independent from any corporate or organizational influence. | **YES.** The project team gathers people from different companies (JD.com, dangdang.com, CHINA TELECOM Bestpay, DAOCloud). No company or organization has significantly more influence than any other. We can note a growth of the contributions coming from different committers. |
| **IN20** | Contributors act as themselves as opposed to representatives of a corporation or organization. | **YES.** The contributors act on their own initiative without representing a corporation or organization. |
Mentors, PPMCs and committers please discuss and modify on [wiki](https://cwiki.apache.org/confluence/display/SHARDINGSPHERE/Podling+Maturity+Assessment+for+ShardingSphere).
@@ -29,6 +29,9 @@ Aiming at reasonably making full use of the computation and storage capacity of
As the cornerstone of many enterprises, relational database still takes a huge market share.
Therefore, at the current stage, we prefer to focus on its increment instead of a total overturn.
ShardingSphere had graduated from [Apache Incubator](http://incubator.apache.org/projects/shardingsphere.html) on April 16 2020, is now officially an Apache Project!
Welcome discuss with community via [shardingsphere dev mail list](mailto:dev@shardingsphere.apache.org).
__Apache releases are beginning from version 4.0.0__
@@ -130,9 +133,9 @@ Architects can adjust the system architecture to the most applicable one to curr
Artifact:
```
sharding-distribution/sharding-jdbc-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-sharding-jdbc-bin.tar.gz: Binary package of Sharding-JDBC
sharding-distribution/sharding-proxy-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-sharding-proxy-bin.tar.gz: Binary package of Sharding-Proxy
sharding-distribution/shardingsphere-src-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-src.zip: Source code package of ShardingSphere
sharding-distribution/sharding-jdbc-distribution/target/apache-shardingsphere-${latest.release.version}-sharding-jdbc-bin.tar.gz: Binary package of Sharding-JDBC
sharding-distribution/sharding-proxy-distribution/target/apache-shardingsphere-${latest.release.version}-sharding-proxy-bin.tar.gz: Binary package of Sharding-Proxy
sharding-distribution/shardingsphere-src-distribution/target/apache-shardingsphere-${latest.release.version}-src.zip: Source code package of ShardingSphere
```
### Build ShardingSphere-UI
...
...
@@ -145,7 +148,7 @@ cd shardingsphere-ui
Artifact:
```
shardingsphere-ui/shardingsphere-ui-distribution/shardingsphere-ui-bin-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-shardingsphere-ui-bin.tar.gz: Binary package of ShardingSphere-UI
shardingsphere-ui/shardingsphere-ui-distribution/shardingsphere-ui-bin-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-ui-bin.tar.gz: Binary package of ShardingSphere-UI
@@ -17,7 +17,7 @@ The following code of conduct is based on full compliance with [ASF CODE OF COND
- Make sure all the test cases are passed, Make sure `./mvnw clean install` can be compiled and tested successfully.
- Make sure the test coverage rate is not lower than the master branch.
- Make sure to check codes with Checkstyle. codes that violate check rules should have special reasons. Find checkstyle template from `https://github.com/apache/incubator-shardingsphere/blob/master/src/resources/checkstyle.xml`, please use checkstyle `8.8` to run the rules.
- Make sure to check codes with Checkstyle. codes that violate check rules should have special reasons. Find checkstyle template from `https://github.com/apache/shardingsphere/blob/master/src/resources/checkstyle.xml`, please use checkstyle `8.8` to run the rules.
- Careful consideration for each `pull request`; Small and frequent `pull request` with complete unit function is welcomed.
- Conform to `Contributor Covenant Code of Conduct` below.
@@ -15,13 +15,13 @@ In the contributor guide, we have mentioned how to submit Issues and pull reques
- Familiar with [Hugo](https://gohugo.io/)
## Fock document
Fock the master branch of [ShardingSphere](https://github.com/apache/incubator-shardingsphere).
Fock the master branch of [ShardingSphere](https://github.com/apache/shardingsphere).
## Directory structure description
```
incubator-shardingsphere
shardingsphere
├─docs
├─community
│ ├─archetypes
...
...
@@ -69,12 +69,12 @@ incubator-shardingsphere
## Document Basics
The ShardingSphere document is written in markdown, processed in Hugo, generated HTML, deployed in [asf-site](https://github.com/apache/incubator-shardingsphere-doc/tree/asf-site) branch, and the source code is located in [Github](https://github.com/apache/incubator-shardingsphere/tree/master).
The ShardingSphere document is written in markdown, processed in Hugo, generated HTML, deployed in [asf-site](https://github.com/apache/shardingsphere-doc/tree/asf-site) branch, and the source code is located in [Github](https://github.com/apache/shardingsphere/tree/master).
-[Latest version Official course](https://shardingsphere.apache.org/document/current/en/overview/) source is stored in `/document/`
-[Community introduction and contribution](https://shardingsphere.apache.org/community/en/contribute/) related document sources are stored in `/community/content/`
You can submit questions, edit content, and view other people's changes from [Github](https://github.com/apache/incubator-shardingsphere/issues).
You can submit questions, edit content, and view other people's changes from [Github](https://github.com/apache/shardingsphere/issues).
## Page template
...
...
@@ -90,7 +90,7 @@ Anyone with a GitHub account can ask questions (error reports) about shardingsph
1. Describe the problem in detail.
1. Describe the problems caused to users.
1. Propose the repair method.
1. In [Issues](https://github.com/apache/incubator-shardingsphere/issues),`New issue ` asks your question.
1. In [Issues](https://github.com/apache/shardingsphere/issues),`New issue ` asks your question.
@@ -13,6 +13,6 @@ Use your mailbox to send an e-mail to [dev-subscribe@shardingsphere.apache.org](
After Step 1, you will receive a confirmation e-mail from [dev-help@shardingsphere.apache.org](mailto:dev-help@shardingsphere.apache.org)(if you have not receive that, please check “RSS feeds”, “junk e-mail” or other items). Reply that e-mail directly or click the link in e-mail to reply, with any subject or content.
1. Receive the welcome e-mail.
After finishing the two steps above, an e-mail with the subject of `WELCOME to dev@shardingsphere.apache.org` will be sent to your e-mail address. Until now, you have succeeded in subscribing Apache ShardingSphere（Incubating）mail-list.
After finishing the two steps above, an e-mail with the subject of `WELCOME to dev@shardingsphere.apache.org` will be sent to your e-mail address. Until now, you have succeeded in subscribing Apache ShardingSpheremail-list.
1. Until now, you can interact with community by your subscribed email or track email conversations by [Archived email list](https://lists.apache.org/list.html?dev@shardingsphere.apache.org).
It is essential that you verify the integrity of the downloaded files using the PGP or SHA signatures. The PGP signatures can be verified using GPG or PGP. Please download the KEYS as well as the asc signature files for relevant distribution. It is recommended to get these files from the main distribution directory and not from the mirrors.
...
...
@@ -43,25 +43,17 @@ pgp -ka KEYS
To verify the binaries/sources you can download the relevant asc files for it from main distribution directory and follow the below guide.
@@ -11,7 +11,7 @@ In Apache ShardingSphere, many functionality implementation are uploaded through
Apache ShardingSphere uses SPI to expand in order to optimize overall architecture design at most. It is to enable premier users, who have implemented interfaces provided by Apache ShardingSphere, to dynamically load self-defined implementation types. Therefore, it can satisfy their practical requirements for different scenarios, while keeping architecture integrity and functional stabilization.
This chapter has provided all the Apache ShardingSphere functional modules that are loaded through SPI. Users with no special requirements can use them to implement corresponding functions after simple configurations. Premier users can develop self-defined implementations, referring to interfaces of existing functional modules. Welcome to feed your self-defined implementations to the [open-source community](https://github.com/apache/incubator-shardingsphere/pulls), benefiting more users.
This chapter has provided all the Apache ShardingSphere functional modules that are loaded through SPI. Users with no special requirements can use them to implement corresponding functions after simple configurations. Premier users can develop self-defined implementations, referring to interfaces of existing functional modules. Welcome to feed your self-defined implementations to the [open-source community](https://github.com/apache/shardingsphere/pulls), benefiting more users.
Consider the implementation of [shardingsphere-benchmark](https://github.com/apache/incubator-shardingsphere-benchmark/tree/master/shardingsphere-benchmark)
Notes: the notes in incubator-shardingsphere-benchmark/README.md should be taken attention to
Consider the implementation of [shardingsphere-benchmark](https://github.com/apache/shardingsphere-benchmark/tree/master/shardingsphere-benchmark)
Notes: the notes in shardingsphere-benchmark/README.md should be taken attention to
The implementation of DataSource in the following configuration is [DataSourceUtil](https://github.com/geomonlin/incubator-shardingsphere-example/blob/4.0.0-RC2/example-core/example-api/src/main/java/org/apache/shardingsphere/example/core/api/DataSourceUtil.java)，The ModuloShardingTableAlgorithm class needs user-defined. For a detailed example [ModuloShardingTableAlgorithm](https://github.com/geomonlin/incubator-shardingsphere-example/tree/dev/example-core/config-utility/src/main/java/org/apache/shardingsphere/example/algorithm)
The implementation of DataSource in the following configuration is [DataSourceUtil](https://github.com/geomonlin/shardingsphere-example/blob/4.0.0-RC2/example-core/example-api/src/main/java/org/apache/shardingsphere/example/core/api/DataSourceUtil.java)，The ModuloShardingTableAlgorithm class needs user-defined. For a detailed example [ModuloShardingTableAlgorithm](https://github.com/geomonlin/incubator-shardingsphere-example/tree/dev/example-core/config-utility/src/main/java/org/apache/shardingsphere/example/algorithm)
Inline expression identifier can can use `${...} ` or `$->{...}`, but the former one clashes with the placeholder in property documents of Spring, so it is suggested to use `$->{...}` for inline expression identifier under Spring environment.
This chapter will introduce the use of Sharding-JDBC. Please refer to [Example](https://github.com/sharding-sphere/sharding-sphere-example) for more details.
This chapter will introduce the use of Sharding-JDBC. Please refer to [Example](https://github.com/apache/shardingsphere-example) for more details.
cd sharding-distribution/sharding-proxy-distribution
mvn clean package docker:build
...
...
@@ -23,7 +23,7 @@ mvn clean package docker:build
Create `server.yaml` and `config-xxx.yaml` to configure sharding rules and server rule in `/${your_work_dir}/conf/`.
Please refer to [Configuration Manual](/en/manual/sharding-proxy/configuration/).
Please refer to [Example](https://github.com/apache/incubator-shardingsphere/tree/master/sharding-proxy/sharding-proxy-bootstrap/src/main/resources/conf).
Please refer to [Example](https://github.com/apache/shardingsphere/tree/master/sharding-proxy/sharding-proxy-bootstrap/src/main/resources/conf).
The binary package's directory is:`/sharding-distribution/sharding-scaling-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-sharding-scaling-bin.tar.gz`。
The binary package's directory is:`/sharding-distribution/sharding-scaling-distribution/target/apache-shardingsphere-${latest.release.version}-sharding-scaling-bin.tar.gz`。
2. Unzip the distribution package, modify the configuration file `conf/server.yaml`, we should ensure the port does not conflict with others, and other values can be left as default:
1. Get the package in `/sharding-distribution/shardingsphere-ui-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-sharding-ui-bin.tar.gz`;
1. Get the package in `/sharding-distribution/shardingsphere-ui-distribution/target/apache-shardingsphere-${latest.release.version}-sharding-ui-bin.tar.gz`;
[](https://starchart.cc/apache/shardingsphere)
ShardingSphere is an open-source ecosphere consists of a set of distributed database middleware solutions, including 3 independent products, Sharding-JDBC, Sharding-Proxy & Sharding-Sidecar (todo).
They all provide functions of data sharding, distributed transaction and database orchestration, applicable in a variety of situations such as Java isomorphism, heterogeneous language and cloud native.
...
...
@@ -17,14 +17,17 @@ Aiming at reasonably making full use of the computation and storage capacity of
As the cornerstone of many enterprises, relational database still takes a huge market share.
Therefore, at the current stage, we prefer to focus on its increment instead of a total overturn.
ShardingSphere had graduated from [Apache Incubator](http://incubator.apache.org/projects/shardingsphere.html) on April 16 2020, is now officially an Apache Project!
Welcome discuss with community via [shardingsphere dev mail list](mailto:dev@shardingsphere.apache.org).
The binary package's directory is:`/sharding-distribution/sharding-scaling-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-sharding-scaling-bin.tar.gz`。
The binary package's directory is:`/sharding-distribution/sharding-scaling-distribution/target/apache-shardingsphere-${latest.release.version}-sharding-scaling-bin.tar.gz`。
#### 2. Unzip the distribution package, modify the configuration file `conf/server.yaml`, we should ensure the port does not conflict with others, and other values can be left as default:
Example for 1.x please see tags in `https://github.com/apache/incubator-shardingsphere/tree/${tag}/sharding-jdbc-example`
Example for 1.x please see tags in `https://github.com/apache/shardingsphere/tree/${tag}/sharding-jdbc-example`
Example for 2.x or 3.x or 4.x please see tags in `https://github.com/apache/incubator-shardingsphere-example/tree/${tag}`
Example for 2.x or 3.x or 4.x please see tags in `https://github.com/apache/shardingsphere-example/tree/${tag}`
**Need attention**
-*Please do not use `dev` branch to run your example, example of `dev` branch is not released yet.*
-*The manual schema initial script is in `https://github.com/apache/incubator-shardingsphere-example/blob/dev/src/resources/manual_schema.sql`, please execute it before you first run the example.*
-*The manual schema initial script is in `https://github.com/apache/shardingsphere-example/blob/dev/src/resources/manual_schema.sql`, please execute it before you first run the example.*
-*Please make sure master-slave data sync on MySQL is running correctly. Otherwise this example will query empty data from slave.*
## Before start the example if you want use `dev` branch
Please make sure some dependencies from [shardingsphere](https://github.com/apache/incubator-shardingsphere) and [shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl) have been installed since some examples depend on that.
Please make sure some dependencies from [shardingsphere](https://github.com/apache/shardingsphere) and [shardingsphere-spi-impl](https://github.com/OpenSharding/shardingsphere-spi-impl) have been installed since some examples depend on that.
if you are a newbie for shardingsphere, you could prepare the dependencies as following:
1.download and install [shardingsphere](https://github.com/apache/incubator-shardingsphere):
1.download and install [shardingsphere](https://github.com/apache/shardingsphere):
Get the package in `shardingsphere-ui/shardingsphere-ui-distribution/shardingsphere-ui-bin-distribution/target/apache-shardingsphere-incubating-${latest.release.version}-shardingsphere-ui-bin.tar.gz`
Get the package in `shardingsphere-ui/shardingsphere-ui-distribution/shardingsphere-ui-bin-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-ui-bin.tar.gz`
