You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.adoc
+110-24
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,14 @@
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 image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-jdbc%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-jdbc/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]]
1
+
= Spring Data Relational image:https://jenkins.spring.io/buildStatus/icon?job=spring-data-jdbc%2Fmain&subject=Build[link=https://jenkins.spring.io/view/SpringData/job/spring-data-jdbc/] https://gitter.im/spring-projects/spring-data[image:https://badges.gitter.im/spring-projects/spring-data.svg[Gitter]]
5
2
6
3
The primary goal of the https://projects.spring.io/spring-data[Spring Data] project is to make it easier to build Spring-powered applications that use new data access technologies such as non-relational databases, map-reduce frameworks, and cloud based data services.
7
4
8
-
Spring Data JDBC, part of the larger Spring Data family, makes it easy to implement JDBC based repositories. This module deals with enhanced support for JDBC based data access layers. It makes it easier to build Spring powered applications that use data access technologies.
5
+
Spring Data Relational, part of the larger Spring Data family, makes it easy to implement repositories for SQL databases.
6
+
This module deals with enhanced support for JDBC and R2DBC based data access layers.
7
+
It makes it easier to build Spring powered applications that use data access technologies.
9
8
10
9
It aims at being conceptually easy.
11
10
In order to achieve this it does NOT offer caching, lazy loading, write behind or many other features of JPA.
12
-
This makes Spring Data JDBC a simple, limited, opinionated ORM.
11
+
This makes Spring Data JDBC and Spring Data R2DBC a simple, limited, opinionated ORM.
13
12
14
13
== Features
15
14
@@ -18,20 +17,20 @@ This makes Spring Data JDBC a simple, limited, opinionated ORM.
18
17
* Support for transparent auditing (created, last changed)
19
18
* Events for persistence events
20
19
* Possibility to integrate custom repository code
21
-
* JavaConfig based repository configuration by introducing `EnableJdbcRepository`
22
-
* Integration with MyBatis
20
+
* JavaConfig based repository configuration through `@EnableJdbcRepositories` respective `@EnableR2dbcRepositories`
21
+
* JDBC-only: Integration with MyBatis
23
22
24
23
== Code of Conduct
25
24
26
25
This project is governed by the https://github.com/spring-projects/.github/blob/e3cc2ff230d8f1dca06535aa6b5a4a23815861d4/CODE_OF_CONDUCT.md[Spring Code of Conduct]. By participating, you are expected to uphold this code of conduct. Please report unacceptable behavior to [email protected].
27
26
28
-
== Getting Started
27
+
== Getting Started with JDBC
29
28
30
-
Here is a quick teaser of an application using Spring Data Repositories in Java:
29
+
Here is a quick teaser of an application using Spring Data JDBC Repositories in Java:
31
30
32
31
[source,java]
33
32
----
34
-
public interface PersonRepository extends CrudRepository<Person, Long> {
If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
177
+
178
+
[source,xml]
179
+
----
180
+
<dependency>
181
+
<groupId>org.springframework.data</groupId>
182
+
<artifactId>spring-data-r2dbc</artifactId>
183
+
<version>${version}-SNAPSHOT</version>
103
184
</dependency>
104
185
105
186
<repository>
@@ -111,32 +192,36 @@ If you'd rather like the latest snapshots of the upcoming major version, use our
111
192
112
193
== Getting Help
113
194
114
-
Having trouble with Spring Data? We’d love to help!
195
+
Having trouble with Spring Data?
196
+
We’d love to help!
115
197
116
198
* 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"].
117
199
* Check the
118
200
https://docs.spring.io/spring-data/jdbc/docs/current/reference/html/[reference documentation], and https://docs.spring.io/spring-data/jdbc/docs/current/api/[Javadocs].
119
201
* Learn the Spring basics – Spring Data builds on Spring Framework, check the https://spring.io[spring.io] web-site for a wealth of reference documentation.
120
202
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
121
203
* If you are upgrading, check out the https://docs.spring.io/spring-data/jdbc/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features.
122
-
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-jdbc`].
204
+
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data`].
123
205
You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter].
124
206
125
207
== Reporting Issues
126
208
127
-
Spring Data uses GitHub as issue tracking system to record bugs and feature requests.If you want to raise an issue, please follow the recommendations below:
209
+
Spring Data uses GitHub as issue tracking system to record bugs and feature requests.If you want to raise an issue, please follow the recommendations below:
128
210
129
-
* Before you log a bug, please search the
130
-
Spring Data JDBCs https://github.com/spring-projects/spring-data-jdbc/issues[issue tracker] to see if someone has already reported the problem.
131
-
* If the issue doesn’t already exist, https://github.com/spring-projects/spring-data-jdbc/issues/new[create a new issue].
132
-
* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM version. Please include full stack traces when applicable.
211
+
* Before you log a bug, please search the Spring Data JDBCs https://github.com/spring-projects/spring-data-relational/issues[issue tracker] to see if someone has already reported the problem.
212
+
* If the issue doesn’t already exist, https://github.com/spring-projects/spring-data-relational/issues/new[create a new issue].
213
+
* Please provide as much information as possible with the issue report, we like to know the version of Spring Data that you are using and JVM version.
214
+
Please include full stack traces when applicable.
133
215
* If you need to paste code, or include a stack trace use triple backticks before and after your text.
134
-
* If possible try to create a test-case or project that replicates the issue. Attach a link to your code or a compressed file containing your code. Use an in-memory database when possible. If you need a different database include the setup using https://github.com/testcontainers[Testcontainers] in your test.
216
+
* If possible try to create a test-case or project that replicates the issue.
217
+
Attach a link to your code or a compressed file containing your code.
218
+
Use an in-memory database when possible.
219
+
If you need a different database include the setup using https://github.com/testcontainers[Testcontainers] in your test.
135
220
136
221
== Building from Source
137
222
138
223
You don’t need to build from source to use Spring Data (binaries in https://repo.spring.io[repo.spring.io]), but if you want to try out the latest and greatest, Spring Data can be easily built with the https://github.com/takari/maven-wrapper[maven wrapper].
139
-
You also need JDK 1.8.
224
+
You also need JDK 17.
140
225
141
226
[source,bash]
142
227
----
@@ -195,11 +280,12 @@ There are a number of modules in this project, here is a quick overview:
195
280
196
281
* Spring Data Relational: Common infrastructure abstracting general aspects of relational database access.
197
282
* link:spring-data-jdbc[Spring Data JDBC]: Repository support for JDBC-based datasources.
283
+
* link:spring-data-r2dbc[Spring Data R2DBC]: Repository support for R2DBC-based datasources.
198
284
199
285
== Examples
200
286
201
287
* https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail.
202
288
203
289
== License
204
290
205
-
Spring Data JDBC is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
291
+
Spring Data Relational is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
Copy file name to clipboardExpand all lines: spring-data-jdbc/README.adoc
-3
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,3 @@
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
1
= Spring Data JDBC
5
2
6
3
The primary goal of the https://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.
0 commit comments