Skip to content

Commit

Permalink
Harmonize content.
Browse files Browse the repository at this point in the history
Refactor content to a natural flow, remove duplications, extract partials.

See #1597
  • Loading branch information
mp911de committed Aug 31, 2023
1 parent 4202b09 commit 5be124d
Show file tree
Hide file tree
Showing 30 changed files with 772 additions and 664 deletions.
134 changes: 110 additions & 24 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
image:https://spring.io/badges/spring-data-jdbc/ga.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]
image:https://spring.io/badges/spring-data-jdbc/snapshot.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]

= 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]]
= 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]]

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.

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.
Spring Data Relational, part of the larger Spring Data family, makes it easy to implement repositories for SQL databases.
This module deals with enhanced support for JDBC and R2DBC based data access layers.
It makes it easier to build Spring powered applications that use data access technologies.

It aims at being conceptually easy.
In order to achieve this it does NOT offer caching, lazy loading, write behind or many other features of JPA.
This makes Spring Data JDBC a simple, limited, opinionated ORM.
This makes Spring Data JDBC and Spring Data R2DBC a simple, limited, opinionated ORM.

== Features

Expand All @@ -18,20 +17,20 @@ This makes Spring Data JDBC a simple, limited, opinionated ORM.
* Support for transparent auditing (created, last changed)
* Events for persistence events
* Possibility to integrate custom repository code
* JavaConfig based repository configuration by introducing `EnableJdbcRepository`
* Integration with MyBatis
* JavaConfig based repository configuration through `@EnableJdbcRepositories` respective `@EnableR2dbcRepositories`
* JDBC-only: Integration with MyBatis

== Code of Conduct

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 spring-code-of-conduct@pivotal.io.

== Getting Started
== Getting Started with JDBC

Here is a quick teaser of an application using Spring Data Repositories in Java:
Here is a quick teaser of an application using Spring Data JDBC Repositories in Java:

[source,java]
----
public interface PersonRepository extends CrudRepository<Person, Long> {
interface PersonRepository extends CrudRepository<Person, Long> {
@Query("SELECT * FROM person WHERE lastname = :lastname")
List<Person> findByLastname(String lastname);
Expand All @@ -41,7 +40,7 @@ public interface PersonRepository extends CrudRepository<Person, Long> {
}
@Service
public class MyService {
class MyService {
private final PersonRepository repository;
Expand Down Expand Up @@ -88,7 +87,7 @@ Add the Maven dependency:
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jdbc</artifactId>
<version>${version}.RELEASE</version>
<version>${version}</version>
</dependency>
----

Expand All @@ -99,7 +98,89 @@ If you'd rather like the latest snapshots of the upcoming major version, use our
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-jdbc</artifactId>
<version>${version}.BUILD-SNAPSHOT</version>
<version>${version}-SNAPSHOT</version>
</dependency>
<repository>
<id>spring-libs-snapshot</id>
<name>Spring Snapshot Repository</name>
<url>https://repo.spring.io/snapshot</url>
</repository>
----

== Getting Started with R2DBC

Here is a quick teaser of an application using Spring Data R2DBC Repositories in Java:

[source,java]
----
interface PersonRepository extends ReactiveCrudRepository<Person, Long> {
@Query("SELECT * FROM person WHERE lastname = :lastname")
Flux<Person> findByLastname(String lastname);
@Query("SELECT * FROM person WHERE firstname LIKE :firstname")
Flux<Person> findByFirstnameLike(String firstname);
}
@Service
class MyService {
private final PersonRepository repository;
public MyService(PersonRepository repository) {
this.repository = repository;
}
public Flux<Person> doWork() {
Person person = new Person();
person.setFirstname("Jens");
person.setLastname("Schauder");
repository.save(person);
Mono<Void> deleteAll = repository.deleteAll();
Flux<Person> lastNameResults = repository.findByLastname("Schauder");
Flux<Person> firstNameResults = repository.findByFirstnameLike("Je%");
return deleteAll.thenMany(lastNameResults.concatWith(firstNameResults));
}
}
@Configuration
@EnableR2dbcRepositories
class ApplicationConfig extends AbstractR2dbcConfiguration {
@Bean
public ConnectionFactory connectionFactory() {
return ConnectionFactories.get("r2dbc:<driver>://<host>:<port>/<database>");
}
}
----

=== Maven configuration

Add the Maven dependency:

[source,xml]
----
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-r2dbc</artifactId>
<version>${version}</version>
</dependency>
----

If you'd rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.

[source,xml]
----
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-r2dbc</artifactId>
<version>${version}-SNAPSHOT</version>
</dependency>
<repository>
Expand All @@ -111,32 +192,36 @@ If you'd rather like the latest snapshots of the upcoming major version, use our

== Getting Help

Having trouble with Spring Data? We’d love to help!
Having trouble with Spring Data?
We’d love to help!

* 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"].
* Check the
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].
* 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.
If you are just starting out with Spring, try one of the https://spring.io/guides[guides].
* If you are upgrading, check out the https://docs.spring.io/spring-data/jdbc/docs/current/changelog.txt[changelog] for "`new and noteworthy`" features.
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data-jdbc`].
* Ask a question - we monitor https://stackoverflow.com[stackoverflow.com] for questions tagged with https://stackoverflow.com/tags/spring-data[`spring-data`].
You can also chat with the community on https://gitter.im/spring-projects/spring-data[Gitter].

== Reporting Issues

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:
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:

* Before you log a bug, please search the
Spring Data JDBCs https://github.com/spring-projects/spring-data-jdbc/issues[issue tracker] to see if someone has already reported the problem.
* If the issue doesn’t already exist, https://github.com/spring-projects/spring-data-jdbc/issues/new[create a new issue].
* 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.
* 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.
* If the issue doesn’t already exist, https://github.com/spring-projects/spring-data-relational/issues/new[create a new issue].
* 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.
* If you need to paste code, or include a stack trace use triple backticks before and after your text.
* 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.
* 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.

== Building from Source

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].
You also need JDK 1.8.
You also need JDK 17.

[source,bash]
----
Expand Down Expand Up @@ -195,11 +280,12 @@ There are a number of modules in this project, here is a quick overview:

* Spring Data Relational: Common infrastructure abstracting general aspects of relational database access.
* link:spring-data-jdbc[Spring Data JDBC]: Repository support for JDBC-based datasources.
* link:spring-data-r2dbc[Spring Data R2DBC]: Repository support for R2DBC-based datasources.

== Examples

* https://github.com/spring-projects/spring-data-examples/[Spring Data Examples] contains example projects that explain specific features in more detail.

== License

Spring Data JDBC is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
Spring Data Relational is Open Source software released under the https://www.apache.org/licenses/LICENSE-2.0.html[Apache 2.0 license].
5 changes: 5 additions & 0 deletions spring-data-jdbc-distribution/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@

</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
</plugin>

<plugin>
<groupId>io.spring.maven.antora</groupId>
<artifactId>antora-maven-plugin</artifactId>
Expand Down
3 changes: 0 additions & 3 deletions spring-data-jdbc/README.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
image:https://spring.io/badges/spring-data-jdbc/ga.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]
image:https://spring.io/badges/spring-data-jdbc/snapshot.svg["Spring Data JDBC", link="https://spring.io/projects/spring-data-jdbc#learn"]

= Spring Data JDBC

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,9 @@ void queryByExampleSimple() {

Example<Employee> example = Example.of(employee); // <2>

Flux<Employee> employees = repository.findAll(example); // <3>
repository.findAll(example); // <3>

// do whatever with the flux
// do whatever with the result
// end::example[]

employees //
Expand Down Expand Up @@ -87,9 +87,9 @@ void queryByExampleCustomMatcher() {
.withIgnorePaths("role"); // <4>
Example<Employee> example = Example.of(employee, matcher); // <5>

Flux<Employee> employees = repository.findAll(example);
repository.findAll(example);

// do whatever with the flux
// do whatever with the result
// end::example-2[]

employees //
Expand Down
25 changes: 11 additions & 14 deletions src/main/antora/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
* xref:index.adoc[Overview]
** xref:commons/upgrade.adoc[]
* xref:repositories/introduction.adoc[]
** xref:repositories/core-concepts.adoc[]
** xref:repositories/definition.adoc[]
Expand All @@ -9,47 +10,43 @@
** xref:object-mapping.adoc[]
** xref:commons/custom-conversions.adoc[]
** xref:repositories/custom-implementations.adoc[]
** xref:repositories/core-extensions.adoc[]
** xref:query-by-example.adoc[]
** xref:repositories/core-domain-events.adoc[]
** xref:commons/entity-callbacks.adoc[]
** xref:repositories/core-extensions.adoc[]
** xref:repositories/null-handling.adoc[]
** xref:repositories/query-keywords-reference.adoc[]
** xref:repositories/query-return-types-reference.adoc[]
* xref:jdbc.adoc[]
** xref:jdbc/why.adoc[]
** xref:jdbc/domain-driven-design.adoc[]
** xref:jdbc/getting-started.adoc[]
** xref:jdbc/examples-repo.adoc[]
** xref:jdbc/configuration.adoc[]
** xref:jdbc/entity-persistence.adoc[]
** xref:jdbc/loading-aggregates.adoc[]
** xref:jdbc/mapping.adoc[]
** xref:jdbc/query-methods.adoc[]
** xref:jdbc/mybatis.adoc[]
** xref:jdbc/events.adoc[]
** xref:jdbc/logging.adoc[]
** xref:jdbc/transactions.adoc[]
** xref:jdbc/auditing.adoc[]
** xref:jdbc/mapping.adoc[]
** xref:jdbc/custom-conversions.adoc[]
** xref:jdbc/locking.adoc[]
** xref:query-by-example.adoc[]
** xref:jdbc/transactions.adoc[]
** xref:jdbc/schema-support.adoc[]
* xref:r2dbc.adoc[]
** xref:r2dbc/getting-started.adoc[]
** xref:r2dbc/core.adoc[]
** xref:r2dbc/template.adoc[]
** xref:r2dbc/entity-persistence.adoc[]
** xref:r2dbc/mapping.adoc[]
** xref:r2dbc/repositories.adoc[]
** xref:r2dbc/query-methods.adoc[]
** xref:r2dbc/entity-callbacks.adoc[]
** xref:r2dbc/auditing.adoc[]
** xref:r2dbc/mapping.adoc[]
** xref:r2dbc/query-by-example.adoc[]
** xref:r2dbc/kotlin.adoc[]
** xref:r2dbc/migration-guide.adoc[]
* xref:kotlin.adoc[]
** xref:kotlin/requirements.adoc[]
** xref:kotlin/null-safety.adoc[]
** xref:kotlin/object-mapping.adoc[]
** xref:kotlin/extensions.adoc[]
** xref:kotlin/coroutines.adoc[]
* https://github.com/spring-projects/spring-data-commons/wiki[Wiki]
2 changes: 1 addition & 1 deletion src/main/antora/modules/ROOT/pages/jdbc/auditing.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[[jdbc.auditing]]
= JDBC Auditing
= Auditing
:page-section-summary-toc: 1

In order to activate auditing, add `@EnableJdbcAuditing` to your configuration, as the following example shows:
Expand Down
64 changes: 0 additions & 64 deletions src/main/antora/modules/ROOT/pages/jdbc/configuration.adoc

This file was deleted.

Loading

0 comments on commit 5be124d

Please sign in to comment.