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 data stores 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 an Aerospike DBCollection and easily writing a repository style data access layer.

Documentation

The documentation for this project can be found on javadoc.io.

Demo Projects

1. Demo project with detailed guides is located here.

2. Demo project example with a step-by-step tutorial can be found here.

Getting Started blog posts

1. Simple Web Application Using Java, Spring Boot, Aerospike and Docker
2. How to setup spring-data-aerospike in Spring Boot application
3. Basic error handling in spring-data-aerospike
4. How to create secondary index in Spring Data Aerospike
5. Caching with Spring Boot and Aerospike
6. Spring Data Aerospike: Reactive Repositories

Spring Data Aerospike compatibility

Quick Start

Maven configuration

Add the Maven dependency:

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

The Aerospike Spring Data connector depends on the Aerospike Client project:

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

Dependency will be provided for you by spring-data-aerospike, so no need to declare it additionally.

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 AerospikeRepository<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 AerospikeRepository 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 "TEST";
    }
}

This sets up a connection to a local Aerospike instance and enables the detection of Spring Data repositories (through @EnableAerospikeRepositories).

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");
        repository.save(person);

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

Getting Help

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

• the User Guide
• 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.

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 Github issue 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 Github ticket as well covering the specific issue you are addressing.
• Watch for upcoming articles by subscribing to Aerospike Standup.