Spring Data for Pivotal GemFire
The primary goal of the Spring Data for Pivotal GemFire project is to make it easier to build highly scalable, Spring powered applications using Pivotal GemFire as the underlying distributed, in-memory data management platform.
Examples
For examples on using the Spring Data for Pivotal GemFire, see the spring-gemfire-examples project.
Getting Help
Read the main project website along with the User Guide.
Look at the source code and the JavaDocs.
For more detailed questions, visit StackOverflow.
If you are new to Spring as well as Spring Data for Pivotal GemFire, look for information about Spring projects.
Quick Start
For developers in a hurry, you can download the JAR using:
-
Maven:
<dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-gemfire</artifactId> <version>${version}</version> </dependency> <!-- nightly builds --> <repository> <id>spring-maven-snapshot</id> <name>Spring Maven SNAPSHOT Repository</name> <url>https://repo.spring.io/snapshot</url> <snapshots><enabled>true</enabled></snapshots> </repository> <!-- milestones/release candidates--> <repository> <id>spring-maven-milestone</id> <name>Spring Maven Milestone Repository</name> <url>https://repo.spring.io/milestone</url> </repository>
-
Gradle:
repositories { mavenRepo name: "spring-snapshot", urls: "https://repo.spring.io/snapshot" mavenRepo name: "spring-milestone", urls: "https://repo.spring.io/milestone" mavenRepo name: "spring-plugins" , urls: "https://repo.spring.io/plugins-release" } dependencies { compile "org.springframework.data:spring-data-geode:${version}" }
-
Configure a Pivotal GemFire cache and Region (REPLICATE, PARTITION and so on):
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:gfe="http://www.springframework.org/schema/gemfire" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xsi:schemaLocation=" http://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/gemfire https://www.springframework.org/schema/gemfire/spring-gemfire.xsd"> <gfe:cache/> <gfe:partitioned-region id="ExampleRegion" copies="2"> <bean id="gemfireTemplate" class="org.springframework.data.gemfire.GemfireTemplate" p:region-ref="ExampleRegion"/> </beans>
-
Use the Region to read/write data:
region.put(Long.valueOf(1), new Person("Jon", "Doe"));
-
And/Or
GemFireTemplate
to interact with Pivotal GemFire:
template.query("person = 1");
Building
Spring Data for Pivotal GemFire uses Maven as its build system. To compile the project, simply type the following Maven command from the root folder:
mvn clean install
Contributing
Here are some ways for you to get involved in the community:
-
Get involved with the Spring community on the Spring Community Forums (StackOverflow). Please help out on the forum by responding to questions and joining the debate.
-
Create JIRA tickets for bugs and new features and comment and vote on the bugs you are interested in.
-
GitHub is for social coding. If you want to write code, we encourage contributions through pull requests from 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 subscribing to spring.io.
Before we accept a non-trivial patch or pull request we will need you to 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.
Running CI tasks locally
Since this pipeline is purely Docker-based, it’s easy to:
-
Debug what went wrong on your local machine.
-
Test out a a tweak to your
test.sh
script before sending it out. -
Experiment against a new image before submitting your pull request.
All of these use cases are great reasons to essentially run what the CI server does on your local machine.
Important
|
To do this you must have Docker installed on your machine. |
-
docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-gemfire-github adoptopenjdk/openjdk8:latest /bin/bash
This will launch the Docker image and mount your source code at
spring-data-gemfire-github
. -
cd spring-data-gemfire-github
Next, run your tests from inside the container:
-
./mvnw clean dependency:list test -Dsort
(or whatever profile you need to test out)
Since the container is binding to your source, you can make edits from your IDE and continue to run build jobs.
If you test building the artifact, do this:
-
docker run -it --mount type=bind,source="$(pwd)",target=/spring-data-gemfire-github adoptopenjdk/openjdk8:latest /bin/bash
This will launch the Docker image and mount your source code at
spring-data-gemfire-github
. -
cd spring-data-gemfire-github
Next, try to package everything up from inside the container:
-
./mvnw -Pci,snapshot -Dmaven.test.skip=true clean package
Note
|
Docker containers can eat up disk space fast! From time to time, run docker system prune to clean out old images.
|