Skip to content

Commit d23c438

Browse files
mp911deschauder
authored andcommitted
DATAJDBC-272 - Update readme files according to module split.
1 parent dd73625 commit d23c438

File tree

5 files changed

+118
-234
lines changed

5 files changed

+118
-234
lines changed

README.adoc

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
image:https://spring.io/badges/spring-data-jdbc/ga.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]
22
image:https://spring.io/badges/spring-data-jdbc/snapshot.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]
33

4-
= Spring Data JDBC
4+
= Spring Data Relational
55

6-
The primary goal of the http://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use data access technologies. *Spring Data JDBC* offers the popular Repository abstraction based on JDBC.
6+
The primary goal of the http://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use data access technologies. *Spring Data Relational* offers the popular Repository abstraction based on link:spring-data-jdbc[JDBC].
77

88
It aims at being conceptually easy.
99
In order to achieve this it does NOT offer caching, lazy loading, write behind or many other features of JPA.
@@ -19,6 +19,24 @@ This makes Spring Data JDBC a simple, limited, opinionated ORM.
1919
* JavaConfig based repository configuration by introducing `EnableJdbcRepository`
2020
* Integration with MyBatis
2121

22+
== Maven Coordinates
23+
24+
[source,xml]
25+
----
26+
<dependency>
27+
<groupId>org.springframework.data</groupId>
28+
<artifactId>spring-data-jdbc</artifactId>
29+
<version>1.1.0.BUILD-SNAPSHOT</version>
30+
</dependency>
31+
----
32+
33+
== Modules
34+
35+
Spring Data Relational ships with multiple modules:
36+
37+
* Spring Data Relational: Common infrastructure abstracting general aspects of relational database access.
38+
* link:spring-data-jdbc[Spring Data JDBC]: Repository support for JDBC-based datasources.
39+
2240
== Getting Help
2341

2442
If you are new to Spring Data JDBC read the following two articles https://spring.io/blog/2018/09/17/introducing-spring-data-jdbc["Introducing Spring Data JDBC"] and https://spring.io/blog/2018/09/24/spring-data-jdbc-references-and-aggregates["Spring Data JDBC, References, and Aggregates"]
@@ -32,15 +50,22 @@ We are keeping an eye on the (soon to be created) https://stackoverflow.com/ques
3250

3351
If you think you found a bug, or have a feature request please https://jira.spring.io/browse/DATAJDBC/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel[create a ticket in our issue tracker].
3452

35-
== Execute Tests
53+
== Building from Source
54+
55+
You don't need to build from source to use Spring Data Relational (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data Relational can be easily built with Maven. You also need JDK 1.8.
56+
57+
[indent=0]
58+
----
59+
$ mvn clean install
60+
----
3661

3762
=== Fast running tests
3863

3964
Fast running tests can be executed with a simple
4065

4166
[source]
4267
----
43-
mvn test
68+
$ mvn test
4469
----
4570

4671
This will execute unit tests and integration tests using an in-memory database.
@@ -51,7 +76,7 @@ In order to run the integration tests against a specific database you need to ha
5176

5277
[source]
5378
----
54-
mvn test -Dspring.profiles.active=<databasetype>
79+
$ mvn test -Dspring.profiles.active=<databasetype>
5580
----
5681

5782
This will also execute the unit tests.
@@ -67,16 +92,16 @@ Currently the following _databasetypes_ are available:
6792

6893
[source]
6994
----
70-
mvn test -Pall-dbs
95+
$ mvn test -Pall-dbs
7196
----
7297

7398
This will execute the unit tests, and all the integration tests with all the databases we currently support for testing. Running the integration-tests depends on Docker.
7499

75-
== Contributing to Spring Data JDBC
100+
== Contributing to Spring Data Relational
76101

77102
Here are some ways for you to get involved in the community:
78103

79-
* Get involved with the Spring community by helping out on http://stackoverflow.com/questions/tagged/spring-data-jdbc[stackoverflow] by responding to questions and joining the debate.
104+
* Get involved with the Spring community by helping out on Stackoverflow for http://stackoverflow.com/questions/tagged/spring-data-jdbc[Spring Data JDBC] by responding to questions and joining the debate.
80105
* Create https://jira.spring.io/browse/DATAJDBC[JIRA] tickets for bugs and new features and comment and vote on the ones that you are interested in.
81106
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from http://help.github.com/forking/[forks of this repository]. If you want to contribute code this way, please reference a JIRA ticket as well, covering the specific issue you are addressing.
82107
* Watch for upcoming articles on Spring by http://spring.io/blog[subscribing] to spring.io.
@@ -85,4 +110,4 @@ Before we accept a non-trivial patch or pull request we will need you to https:/
85110

86111
== License
87112

88-
link:src/main/resources/license.txt[The license und which Spring Data JDBC is published can be found here].
113+
link:src/main/resources/license.txt[The license und which Spring Data Relational is published can be found here].

spring-data-jdbc/README.adoc

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
image:https://spring.io/badges/spring-data-jdbc/ga.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]
2+
image:https://spring.io/badges/spring-data-jdbc/snapshot.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]
3+
4+
= Spring Data JDBC
5+
6+
The primary goal of the http://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use data access technologies. *Spring Data JDBC* offers the popular Repository abstraction based on JDBC.
7+
8+
It aims at being conceptually easy.
9+
In order to achieve this it does NOT offer caching, lazy loading, write behind or many other features of JPA.
10+
This makes Spring Data JDBC a simple, limited, opinionated ORM.
11+
12+
== Features
13+
14+
* Implementation of CRUD methods for Aggregates.
15+
* `@Query` annotation
16+
* Support for transparent auditing (created, last changed)
17+
* Events for persistence events
18+
* Possibility to integrate custom repository code
19+
* JavaConfig based repository configuration by introducing `EnableJdbcRepository`
20+
* Integration with MyBatis
21+
22+
== Getting Help
23+
24+
If you are new to Spring Data JDBC read the following two articles https://spring.io/blog/2018/09/17/introducing-spring-data-jdbc["Introducing Spring Data JDBC"] and https://spring.io/blog/2018/09/24/spring-data-jdbc-references-and-aggregates["Spring Data JDBC, References, and Aggregates"]
25+
26+
There are also examples in the https://github.com/spring-projects/spring-data-examples/tree/master/jdbc[Spring Data Examples] project.
27+
28+
A very good source of information is the source code in this repository.
29+
Especially the integration tests (if you are reading this on github, type `t` and then `IntegrationTests.java`)
30+
31+
We are keeping an eye on the (soon to be created) https://stackoverflow.com/questions/tagged/spring-data-jdbc[spring-data-jdbc tag on stackoverflow].
32+
33+
If you think you found a bug, or have a feature request please https://jira.spring.io/browse/DATAJDBC/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel[create a ticket in our issue tracker].
34+
35+
== Execute Tests
36+
37+
=== Fast running tests
38+
39+
Fast running tests can be executed with a simple
40+
41+
[source]
42+
----
43+
mvn test
44+
----
45+
46+
This will execute unit tests and integration tests using an in-memory database.
47+
48+
=== Running tests with a real database
49+
50+
In order to run the integration tests against a specific database you need to have a local Docker installation available, and then execute.
51+
52+
[source]
53+
----
54+
mvn test -Dspring.profiles.active=<databasetype>
55+
----
56+
57+
This will also execute the unit tests.
58+
59+
Currently the following _databasetypes_ are available:
60+
61+
* hsql (default, does not require a running database)
62+
* mysql
63+
* postgres
64+
* mariadb
65+
66+
=== Run tests with all databases
67+
68+
[source]
69+
----
70+
mvn test -Pall-dbs
71+
----
72+
73+
This will execute the unit tests, and all the integration tests with all the databases we currently support for testing. Running the integration-tests depends on Docker.
74+
75+
== Contributing to Spring Data JDBC
76+
77+
Here are some ways for you to get involved in the community:
78+
79+
* Get involved with the Spring community by helping out on http://stackoverflow.com/questions/tagged/spring-data-jdbc[stackoverflow] by responding to questions and joining the debate.
80+
* Create https://jira.spring.io/browse/DATAJDBC[JIRA] tickets for bugs and new features and comment and vote on the ones that you are interested in.
81+
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from http://help.github.com/forking/[forks of this repository]. If you want to contribute code this way, please reference a JIRA ticket as well, covering the specific issue you are addressing.
82+
* Watch for upcoming articles on Spring by http://spring.io/blog[subscribing] to spring.io.
83+
84+
Before we accept a non-trivial patch or pull request we will need you to https://cla.pivotal.io/sign/spring[sign the Contributor License Agreement]. Signing the contributor’s agreement does not grant anyone commit rights to the main repository, but it does mean that we can accept your contributions, and you will get an author credit if we do. If you forget to do so, you'll be reminded when you submit a pull request. Active contributors might be asked to join the core team, and given the ability to merge pull requests.

spring-data-r2dbc/pom.xml

Lines changed: 0 additions & 166 deletions
This file was deleted.

spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/repository/query/Query.java

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)