Skip to content

Commit

Permalink
for #2147, add README for sharding-jdbc-distribution
Browse files Browse the repository at this point in the history
  • Loading branch information
terrymanu committed Apr 1, 2019
1 parent 08bf90e commit af82994
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ It can be considered as an enhanced JDBC driver, which is fully compatible with

* Applicable in any ORM framework based on Java, such as JPA, Hibernate, Mybatis, Spring JDBC Template or direct use of JDBC.
* Based on any third-party database connection pool, such as DBCP, C3P0, BoneCP, Druid, HikariCP.
* Support any kind of database that conforms to JDBC standard: MySQLOracleSQLServer and PostgreSQL for now.
* Support any kind of database that conforms to JDBC standard: MySQL, Oracle, SQLServer and PostgreSQL for now.

![Sharding-JDBC Architecture](http://shardingsphere.jd.com/document/current/img/sharding-jdbc-brief.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<format>tar.gz</format>
</formats>
<includeBaseDirectory>true</includeBaseDirectory>
<baseDirectory>${project.build.finalName}-sharding-jdbc-bin-release</baseDirectory>
<baseDirectory>${project.build.finalName}-sharding-jdbc-bin</baseDirectory>

<fileSets>
<fileSet>
Expand All @@ -31,9 +31,15 @@
<include>LICENSE</include>
<include>NOTICE</include>
<include>DISCLAIMER</include>
<include>README.md</include>
</includes>
</fileSet>
<fileSet>
<directory>src/main/release-docs</directory>
<includes>
<include>**/*</include>
</includes>
<outputDirectory>/</outputDirectory>
</fileSet>
</fileSets>

<dependencySets>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
Welcome to Apache ShardingSphere
===============================================================================

ShardingSphere is an open-source ecosystem consisted of a set of distributed database middleware solutions, including 2 independent products, Sharding-JDBC & Sharding-Proxy.
They both provide functions of data sharding, distributed transaction and database orchestration, applicable in a variety of situations such as Java isomorphism, heterogeneous language.

Aiming at reasonably making full use of the computation and storage capacity of database in distributed system, ShardingSphere defines itself as a middleware, rather than a totally new type of database.
As the cornerstone of many enterprises, relational database still takes a huge market share.
Therefore, at current stage, we prefer to focus on its increment instead of a total overturn.

Sharding-JDBC defines itself as a lightweight Java framework that provides extra service at Java JDBC layer.
With client end connecting directly to the database, it provides service in the form of jar and requires no extra deployment and dependence.
It can be considered as an enhanced JDBC driver, which is fully compatible with JDBC and all kinds of ORM frameworks.

* Applicable in any ORM framework based on Java, such as JPA, Hibernate, Mybatis, Spring JDBC Template or direct use of JDBC.
* Based on any third-party database connection pool, such as DBCP, C3P0, BoneCP, Druid, HikariCP.
* Support any kind of database that conforms to JDBC standard: MySQL, Oracle, SQLServer and PostgreSQL for now.

Getting Started
===============================================================================
To help you get started, try the following links:

Getting Started
https://shardingsphere.apache.org/document/current/en/quick-start/sharding-jdbc-quick-start/

We welcome contributions of all kinds, for details of how you can help
https://shardingsphere.apache.org/community/en/contribute/

Find the issue tracker from here
https://github.com/apache/incubator-shardingsphere/issues

Please help us make Apache ShardingSphere better - we appreciate any feedback you may have.

Have fun!

-----------------

Licensing
===============================================================================

This software is licensed under the terms you may find in the file named "LICENSE" in this directory.

0 comments on commit af82994

Please sign in to comment.