diff --git a/README.adoc b/README.adoc index 9d18017f..abf03cb7 100644 --- a/README.adoc +++ b/README.adoc @@ -1,9 +1,9 @@ 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 += Spring Data Relational -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. +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]. 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. @@ -19,6 +19,24 @@ This makes Spring Data JDBC a simple, limited, opinionated ORM. * JavaConfig based repository configuration by introducing `EnableJdbcRepository` * Integration with MyBatis +== Maven Coordinates + +[source,xml] +---- + + org.springframework.data + spring-data-jdbc + 1.1.0.BUILD-SNAPSHOT + +---- + +== Modules + +Spring Data Relational ships with multiple modules: + +* 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. + == Getting 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"] @@ -32,7 +50,14 @@ We are keeping an eye on the (soon to be created) https://stackoverflow.com/ques 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]. -== Execute Tests +== Building from Source + +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. + +[indent=0] +---- + $ mvn clean install +---- === Fast running tests @@ -40,7 +65,7 @@ Fast running tests can be executed with a simple [source] ---- -mvn test + $ mvn test ---- 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 [source] ---- -mvn test -Dspring.profiles.active= + $ mvn test -Dspring.profiles.active= ---- This will also execute the unit tests. @@ -67,16 +92,16 @@ Currently the following _databasetypes_ are available: [source] ---- -mvn test -Pall-dbs + $ mvn test -Pall-dbs ---- 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. -== Contributing to Spring Data JDBC +== Contributing to Spring Data Relational Here are some ways for you to get involved in the community: -* 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. +* 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. * 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. * 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. * 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:/ == License -link:src/main/resources/license.txt[The license und which Spring Data JDBC is published can be found here]. \ No newline at end of file +link:src/main/resources/license.txt[The license und which Spring Data Relational is published can be found here]. diff --git a/spring-data-jdbc/README.adoc b/spring-data-jdbc/README.adoc new file mode 100644 index 00000000..a5c97f97 --- /dev/null +++ b/spring-data-jdbc/README.adoc @@ -0,0 +1,84 @@ +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 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. + +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. + +== Features + +* Implementation of CRUD methods for Aggregates. +* `@Query` annotation +* 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 + +== Getting 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"] + +There are also examples in the https://github.com/spring-projects/spring-data-examples/tree/master/jdbc[Spring Data Examples] project. + +A very good source of information is the source code in this repository. +Especially the integration tests (if you are reading this on github, type `t` and then `IntegrationTests.java`) + +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]. + +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]. + +== Execute Tests + +=== Fast running tests + +Fast running tests can be executed with a simple + +[source] +---- +mvn test +---- + +This will execute unit tests and integration tests using an in-memory database. + +=== Running tests with a real database + +In order to run the integration tests against a specific database you need to have a local Docker installation available, and then execute. + +[source] +---- +mvn test -Dspring.profiles.active= +---- + +This will also execute the unit tests. + +Currently the following _databasetypes_ are available: + +* hsql (default, does not require a running database) +* mysql +* postgres +* mariadb + +=== Run tests with all databases + +[source] +---- +mvn test -Pall-dbs +---- + +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. + +== Contributing to Spring Data JDBC + +Here are some ways for you to get involved in the community: + +* 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. +* 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. +* 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. +* Watch for upcoming articles on Spring by http://spring.io/blog[subscribing] to spring.io. + +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. diff --git a/spring-data-r2dbc/pom.xml b/spring-data-r2dbc/pom.xml deleted file mode 100644 index fe1f0b95..00000000 --- a/spring-data-r2dbc/pom.xml +++ /dev/null @@ -1,166 +0,0 @@ - - - - 4.0.0 - - spring-data-r2dbc - 1.1.0.r2dbc-SNAPSHOT - - Spring Data R2DBC - Spring Data module for JDBC repositories. - http://projects.spring.io/spring-data-jdbc - - - org.springframework.data - spring-data-relational-parent - 1.1.0.r2dbc-SNAPSHOT - - - - - DATAR2DBC - - spring.data.r2dbc - 42.0.0 - 1.0.0.M5 - 1.0.0.M5 - - - - 2018 - - - - ogierke - Oliver Gierke - ogierke(at)pivotal.io - Pivotal Software, Inc. - https://pivotal.io - - Project Lead - - +1 - - - mpaluch - Mark Paluch - mpaluch(at)pivotal.io - Pivotal Software, Inc. - https://pivotal.io - - Project Lead - - +1 - - - - - - - ${project.groupId} - spring-data-relational - ${project.version} - - - - ${project.groupId} - spring-data-commons - ${springdata.commons} - - - - org.springframework - spring-tx - - - - org.springframework - spring-context - - - - org.springframework - spring-beans - - - - org.springframework - spring-jdbc - - - - org.springframework - spring-core - - - - io.r2dbc - r2dbc-spi - ${r2dbc-spi.version} - true - - - - io.projectreactor - reactor-core - true - - - - org.assertj - assertj-core - ${assertj-core.version} - test - - - - io.projectreactor - reactor-test - test - - - - org.postgresql - postgresql - ${postgresql.version} - test - - - - io.r2dbc - r2dbc-postgresql - ${r2dbc-postgresql.version} - test - - - - de.schauderhaft.degraph - degraph-check - ${degraph-check.version} - test - - - - org.testcontainers - mysql - ${testcontainers.version} - test - - - org.slf4j - jcl-over-slf4j - - - - - - org.testcontainers - postgresql - ${testcontainers.version} - test - - - - - diff --git a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/repository/query/Query.java b/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/repository/query/Query.java deleted file mode 100644 index 43b451da..00000000 --- a/spring-data-r2dbc/src/main/java/org/springframework/data/r2dbc/repository/query/Query.java +++ /dev/null @@ -1,41 +0,0 @@ -/* - * Copyright 2018 the original author or authors. - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ -package org.springframework.data.r2dbc.repository.query; - -import java.lang.annotation.Documented; -import java.lang.annotation.ElementType; -import java.lang.annotation.Retention; -import java.lang.annotation.RetentionPolicy; -import java.lang.annotation.Target; - -import org.springframework.data.annotation.QueryAnnotation; - -/** - * Annotation to provide SQL statements that will get used for executing the method. - * - * @author Mark Paluch - */ -@Retention(RetentionPolicy.RUNTIME) -@Target(ElementType.METHOD) -@QueryAnnotation -@Documented -public @interface Query { - - /** - * The SQL statement to execute when the annotated method gets invoked. - */ - String value(); -} diff --git a/spring-data-r2dbc/src/test/resources/logback.xml b/spring-data-r2dbc/src/test/resources/logback.xml deleted file mode 100644 index e310de95..00000000 --- a/spring-data-r2dbc/src/test/resources/logback.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - %d %5p %40.40c:%4L - %m%n - - - - - - - - - - - - \ No newline at end of file