Spring Data Aerospike

The primary goal of the 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.

The Spring Data Aerospike 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 Aerospike project provides integration with the Aerospike document database. Key functional areas of Spring Data Aerospike are a POJO centric model for interacting with a Aerospike DBCollection and easily writing a repository style data access layer.

Getting Help

For a comprehensive treatment of all the Spring Data Aerospike features, please refer to:

• the User Guide
• the JavaDocs have extensive comments in them as well.
• the home page of Spring Data Aerospike contains links to articles and other resources.
• for more detailed questions, use Spring Data Aerospike on Stackoverflow.

If you are new to Spring as well as to Spring Data, look for information about Spring projects.

Quick Start

Maven configuration

Add the Maven dependency:

<dependency>
  <groupId>com.aerospike</groupId>
  <artifactId>spring-data-aerospike</artifactId>
  <version>1.0.2.RELEASE</version>
</dependency>

The Aersopike Spring Data connector depends on the Aerospike Client and the Aerospike Helper projects:

<dependency>
  <groupId>com.aerospike</groupId>
  <artifactId>aerospike-client</artifactId>
  <version>3.3.4</version>
</dependency>

<dependency>
  <groupId>com.aerospike</groupId>
  <artifactId>aerospike-helper-java</artifactId>
  <version>1.2</version>
</dependency>

Note that the 1.2 version of the Aerospike Helper requires Aerospike server 3.12+ as it takes advantage of the PredExp feature for performing queries. Use version 1.1 of the Aerospike Helper for earlier versions of the Aerospike Server.

AerospikeTemplate

AerospikeTemplate is the central support class for Aerospike database operations. It provides:

• Basic POJO mapping support to and from Bins
• Convenience methods to interact with the store (insert object, update objects) and Aerospike specific ones.
• Connection affinity callback
• Exception translation into Spring's technology agnostic DAO exception hierarchy.

Spring Data repositories

To simplify the creation of data repositories Spring Data Aerospike 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.

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:

public interface PersonRepository extends CrudRepository<Person, Long> {

  List<Person> findByLastname(String lastname);

  List<Person> findByFirstnameLike(String firstname);
}

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.

You can have Spring automatically create a proxy for the interface by using the following JavaConfig:

@Configuration
@EnableAerospikeRepositories(basePackageClasses = PersonRepository.class)
class ApplicationConfig extends AbstractAerospikeDataConfiguration {
	
	@Override
    protected Collection<Host> getHosts() {
    	return Collections.singleton(new Host("localhost", 3000));
    }
    
    @Override
    protected String nameSpace() {
    	return "bar";
    }
	
}

This sets up a connection to a local Aerospike instance and enables the detection of Spring Data repositories (through @EnableAerospikeRepositories). The same configuration would look like this in XML:

<bean id="template" class="org.springframework.data.aerospike.core.AerospikeTemplate">
  <constructor-arg>
    <bean class="com.aerospike.client.AerospikeClient">
       <constructor-arg value="policy" />
       <constructor-arg value="localhost" />
       <constructor-arg value="3000" />
    </bean>
  </constructor-arg>
  <constructor-arg value="database" />
</bean>

<aerospike:repositories base-package="com.acme.repository" />

This will find the repository interface and register a proxy object in the container. You can use it as shown below:

@Service
public class MyService {

  private final PersonRepository repository;

  @Autowired
  public MyService(PersonRepository repository) {
    this.repository = repository;
  }

  public void doWork() {

     repository.deleteAll();

     Person person = new Person();
     person.setFirstname("Oliver");
     person.setLastname("Gierke");
     person = repository.save(person);

     List<Person> lastNameResults = repository.findByLastname("Gierke");
     List<Person> firstNameResults = repository.findByFirstnameLike("Oli*");
 }
}

Contributing to Spring Data

Here are some ways for you to get involved in the community:

• Get involved with the Spring community on Stackoverflow and help out on the spring-data-Aerospike tag by responding to questions and joining the debate.
• Create 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 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's 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. Active contributors might be asked to join the core team, and given the ability to merge pull requests.