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
[](https://projects.spring.io/spring-data-cassandra/#quick-start)
2
-
[](https://projects.spring.io/spring-data-cassandra/#quick-start)
1
+
image:https://spring.io/badges/spring-data-cassandra/ga.svg[Spring Data for Apache Cassandra,link=https://projects.spring.io/spring-data-cassandra/#quick-start]
2
+
image:https://spring.io/badges/spring-data-cassandra/snapshot.svg[Spring Data for Apache Cassandra,link=https://projects.spring.io/spring-data-cassandra/#quick-start]
The primary goal of the [Spring Data](https://projects.spring.io/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.
8
+
= Spring Data for Apache Cassandra
7
9
8
-
The Spring Data for Apache Cassandra project aims to provide a familiar and consistent Spring-based programming model for new datastores while retaining store-specific features and capabilities. The Spring Data for Apache Cassandra project provides integration with the Apache Cassandra database. Key functional areas of Spring Data for Apache Cassandra are a CQL abstraction, a POJO centric model for interacting with an Apache Cassandra tables and easily writing a repository style data access layer.
10
+
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.
9
11
12
+
The Spring Data for Apache Cassandra project aims to provide a familiar and consistent Spring-based programming model for new datastores while retaining store-specific features and capabilities. The Spring Data for Apache Cassandra project provides integration with the Apache Cassandra database. Key functional areas of Spring Data for Apache Cassandra are a CQL abstraction, a POJO centric model for interacting with an Apache Cassandra tables and easily writing a repository style data access layer.
10
13
11
-
##Getting Help
14
+
== Getting Help
12
15
13
16
For a comprehensive treatment of all the Spring Data for Apache Cassandra features, please refer to:
14
17
15
-
* the [User Guide](https://docs.spring.io/spring-data/cassandra/docs/current/reference/html/)
16
-
* the [JavaDocs](https://docs.spring.io/spring-data/cassandra/docs/current/api/) have extensive comments in them as well.
17
-
* the home page of [Spring Data for Apache Cassandra](https://projects.spring.io/spring-data-cassandra) contains links to articles and other resources.
18
-
* for more detailed questions, use [Spring Data for Apache Cassandra on Stackoverflow](https://stackoverflow.com/questions/tagged/spring-data-cassandra).
18
+
* the https://docs.spring.io/spring-data/cassandra/docs/current/reference/html/[User Guide]
19
+
* the https://docs.spring.io/spring-data/cassandra/docs/current/api/[JavaDocs] have extensive comments in them as well.
20
+
* the home page of https://projects.spring.io/spring-data-cassandra[Spring Data for Apache Cassandra] contains links to articles and other resources.
21
+
* for more detailed questions, use https://stackoverflow.com/questions/tagged/spring-data-cassandra[Spring Data for Apache Cassandra on Stackoverflow].
19
22
20
-
If you are new to Spring as well as to Spring Data, look for information about [Spring projects](https://projects.spring.io/).
23
+
If you are new to Spring as well as to Spring Data, look for information about https://projects.spring.io/[Spring projects].
21
24
22
-
23
-
## Quick Start
25
+
== Quick Start
24
26
25
27
Prerequisites:
26
28
* Java 6
27
-
*[DataStax Java Driver for Apache Cassandra 3.x](https://docs.datastax.com/en/developer/driver-matrix/doc/javaDrivers.html)
29
+
* https://docs.datastax.com/en/developer/driver-matrix/doc/javaDrivers.html[DataStax Java Driver for Apache Cassandra 3.x]
28
30
* Apache Cassandra 1.x, 2.x or 3.x
29
31
30
-
###Maven configuration
32
+
=== Maven configuration
31
33
32
34
Add the Maven dependency:
33
35
34
-
```xml
36
+
[source,xml]
37
+
----
35
38
<dependency>
36
39
<groupId>org.springframework.data</groupId>
37
40
<artifactId>spring-data-cassandra</artifactId>
38
41
<version>${version}.RELEASE</version>
39
42
</dependency>
40
-
```
43
+
----
41
44
42
45
If you would rather like the latest snapshots of the upcoming major version, use our Maven snapshot repository and declare the appropriate dependency version.
43
46
44
-
```xml
47
+
[source,xml]
48
+
----
45
49
<dependency>
46
50
<groupId>org.springframework.data</groupId>
47
51
<artifactId>spring-data-cassandra</artifactId>
@@ -53,38 +57,39 @@ If you would rather like the latest snapshots of the upcoming major version, use
53
57
<name>Spring Snapshot Repository</name>
54
58
<url>https://repo.spring.io/libs-snapshot</url>
55
59
</repository>
56
-
```
60
+
----
57
61
58
-
###CassandraTemplate
62
+
=== CassandraTemplate
59
63
60
64
`CassandraTemplate` is the central support class for Cassandra database operations. It provides:
61
65
62
66
* Increased productivity by handling common Cassandra operations properly. Includes integrated object mapping between CQL Tables and POJOs.
63
-
* Exception translation into Spring's [technology agnostic DAO exception hierarchy](https://docs.spring.io/spring/docs/current/spring-framework-reference/html/dao.html#dao-exceptions).
67
+
* Exception translation into Spring's https://docs.spring.io/spring/docs/current/spring-framework-reference/html/dao.html#dao-exceptions[technology agnostic DAO exception hierarchy].
64
68
* Feature rich object mapping integrated with Spring’s Conversion Service.
65
69
* Annotation-based mapping metadata but extensible to support other metadata formats.
66
70
71
+
=== Spring Data repositories
67
72
68
-
### Spring Data repositories
69
-
70
-
To simplify the creation of data repositories Spring Data for Apache Cassandra provides a generic repository programming model. It will automatically create a repository proxy for you that adds implementations of finder methods you specify on an interface.
73
+
To simplify the creation of data repositories Spring Data for Apache Cassandra provides a generic repository programming model. It will automatically create a repository proxy for you that adds implementations of finder methods you specify on an interface.
71
74
72
75
For example, given a `Person` class with first and last name properties, a `PersonRepository` interface that can query for `Person` by last name and when the first name matches a like expression is shown below:
73
76
74
-
```java
77
+
[source,java]
78
+
----
75
79
public interface PersonRepository extends CrudRepository<Person, Long> {
The queries issued on execution will be derived from the method name. Extending `CrudRepository` causes CRUD methods being pulled into the interface so that you can easily save and find single entities and collections of them.
84
88
85
89
You can have Spring automatically create a proxy for the interface by using the following JavaConfig:
86
90
87
-
```java
91
+
[source,java]
92
+
----
88
93
@Configuration
89
94
@EnableCassandraRepositories
90
95
class ApplicationConfig extends AbstractCassandraConfiguration {
@@ -99,23 +104,25 @@ class ApplicationConfig extends AbstractCassandraConfiguration {
99
104
return "springdata";
100
105
}
101
106
}
102
-
```
107
+
----
103
108
104
109
This sets up a connection to a local Apache Cassandra instance and enables the detection of Spring Data repositories (through `@EnableCassandraRepositories`). The same configuration would look like this in XML:
Spring Data for Apache Cassandra consists of two modules:
147
-
154
+
148
155
* Spring CQL
149
156
* Spring Data for Apache Cassandra
150
157
151
158
You can choose among several approaches to form the basis for your Cassandra database access. Spring’s support for Apache Cassandra comes in different flavors. Once you start using one of these approaches, you can still mix and match to include a feature from a different approach.
152
159
153
-
###Spring CQL
160
+
=== Spring CQL
154
161
155
162
Spring CQL takes care of all the low-level details that can make Cassandra and CQL such a tedious API to develop with.
156
163
157
164
`CqlTemplate` is the classic Spring CQL approach and the most popular. This "lowest level" approach and all others use a `CqlTemplate` under the covers including schema generation support.
158
165
159
-
###Spring Data Cassandra
166
+
=== Spring Data Cassandra
160
167
161
168
Spring Data for Apache Cassandra adds object mapping, schema generation and repository support to the feature set.
162
169
163
170
`CassandraTemplate` wraps a `CqlTemplate` to provide result to object mapping and the use of `SELECT`, `INSERT`, `UPDATE` and `DELETE` methods instead of writing CQL statements. This approach provides better documentation and ease of use. Schema generation support supports fast bootstrapping by using mapped objects to create tables and user types.
164
171
165
-
##Contributing to Spring Data
172
+
== Contributing to Spring Data
166
173
167
174
Here are some ways for you to get involved in the community:
168
175
169
-
* Get involved with the Spring community on Stackoverflow and help out on the [spring-data-cassandra](https://stackoverflow.com/questions/tagged/spring-data-cassandra) tag by responding to questions and joining the debate.
170
-
* Create [JIRA](https://jira.spring.io/browse/DATACASS) tickets for bugs and new features and comment and vote on the ones that you are interested in.
171
-
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from [forks of this repository](https://help.github.com/forking/). If you want to contribute code this way, please reference a JIRA ticket as well covering the specific issue you are addressing.
172
-
* Watch for upcoming articles on Spring by [subscribing](https://spring.io/blog) to spring.io.
176
+
* Get involved with the Spring community on Stackoverflow and help out on the https://stackoverflow.com/questions/tagged/spring-data-cassandra[spring-data-cassandra] tag by responding to questions and joining the debate.
177
+
* Create https://jira.spring.io/browse/DATACASS[JIRA] tickets for bugs and new features and comment and vote on the ones that you are interested in.
178
+
* Github is for social coding: if you want to write code, we encourage contributions through pull requests from https://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.
179
+
* Watch for upcoming articles on Spring by https://spring.io/blog[subscribing] to spring.io.
173
180
174
-
Before we accept a non-trivial patch or pull request we will need you to [sign the Contributor License Agreement](https://cla.pivotal.io/sign/spring). 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.
181
+
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.
175
182
176
-
##Initial Contributors
183
+
== Initial Contributors
177
184
178
185
Spring Data for Apache Cassandra was initially created and supported by the following
179
186
companies and individuals:
180
187
181
188
* David Webb
182
189
* Matthew Adams
183
190
* John McPeek
184
-
*[Prowave Consulting](http://www.prowaveconsulting.com) - David Webb
185
-
*[SciSpike](http://www.scispike.com) - Matthew Adams
191
+
* http://www.prowaveconsulting.com[Prowave Consulting] - David Webb
192
+
* http://www.scispike.com[SciSpike] - Matthew Adams
193
+
194
+
== Running CI tasks locally
195
+
196
+
Since this pipeline is purely Docker-based, it's easy to:
197
+
198
+
* Debug what went wrong on your local machine.
199
+
* Test out a a tweak to your `test.sh` script before sending it out.
200
+
* Experiment against a new image before submitting your pull request.
201
+
202
+
All of these use cases are great reasons to essentially run what the CI server does on your local machine.
203
+
204
+
IMPORTANT: To do this you must have Docker installed on your machine.
205
+
206
+
1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-cassandra-github adoptopenjdk/openjdk8:latest /bin/bash`
207
+
+
208
+
This will launch the Docker image and mount your source code at `spring-data-cassandra-github`.
209
+
+
210
+
2. `cd spring-data-cassandra-github`
211
+
+
212
+
Next, run your tests from inside the container:
213
+
+
214
+
3. `./mvnw clean dependency:list test -Dsort` (or whatever profile you need to test out)
215
+
216
+
Since the container is binding to your source, you can make edits from your IDE and continue to run build jobs.
217
+
218
+
If you need to test the `build.sh` script, do this:
219
+
220
+
1. `docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-cassandra-github adoptopenjdk/openjdk8:latest /bin/bash`
221
+
+
222
+
This will launch the Docker image and mount your source code at `spring-data-cassandra-github`.
223
+
+
224
+
2. `cd spring-data-cassandra-github`
225
+
+
226
+
Next, try to package everything up from inside the container:
0 commit comments