= Auto configuration for Spring Data Aerospike

image:https://img.shields.io/maven-central/v/com.aerospike/spring-data-aerospike-starters.svg?maxAge=259200["maven", link="https://search.maven.org/#search%7Cga%7C1%7Ca%3A%22spring-data-aerospike-starters%22"] image:https://github.com/aerospike-community/spring-data-aerospike-starters/workflows/Build%20project/badge.svg["build", link="https://github.com/aerospike-community/spring-data-aerospike-starters/actions?query=branch%3Amaster"]

:repo-master: https://github.com/aerospike-community/spring-data-aerospike-starters/blob/master

== Versions compatibility table

|=== |spring-data-aerospike-starters |spring-data-aerospike |aerospike-client |aerospike-reactor-client |0.15.x, 0.16.x |4.8.x |7.2.x |7.1.x

|0.14.x |4.7.x |7.2.x |7.1.x

|0.13.x |4.6.x |7.2.x |7.1.x

|0.12.x |4.5.x |7.1.x |7.0.x

|0.11.x |4.4.x |7.0.x |7.0.x

|0.10.x |4.3.x |6.1.x |6.1.x

|0.9.x |4.0.x |6.1.x |6.1.x

|0.8.x |3.5.x |6.1.x |6.1.x

|0.7.x |3.4.x |5.1.x |5.1.x

|0.5.x, 0.6.x |2.4.x |4.4.x |4.4.x |===

== Usage

=== Maven configuration

Add the Maven dependency for reactive repository:

[source,xml]

or non-reactive repository:

[source,xml]

=== Minimal configuration

Specify Aerospike server hosts and namespace:

[source,properties]

spring.aerospike.hosts=aerospike-1-server-ip:3000,aerospike-2-server-ip:3000 spring.data.aerospike.namespace=TEST

== Configuration options

All available properties for configuring Aerospike client can be checked in {repo-master}/spring-boot-autoconfigure-data-aerospike/src/main/java/org/springframework/boot/autoconfigure/aerospike/AerospikeProperties.java[AerospikeProperties].

Properties for configuring spring-data-aerospike can be checked in {repo-master}/spring-boot-autoconfigure-data-aerospike/src/main/java/org/springframework/boot/autoconfigure/data/aerospike/AerospikeDataProperties.java[AerospikeDataProperties].

To disable Aerospike repositories use: [source,properties]

spring.data.aerospike.repositories.type=NONE

== Example

You can find usage example in {repo-master}/spring-boot-starter-data-aerospike-example[spring-boot-starter-data-aerospike-example] module.

Both reactive and sync examples are based on embedded-aerospike dependency usage (which requires docker to be running on the machine). This is the only requirement to be able to run the tests on your machine.

If you want to run the tests in these modules against your Aerospike instance follow the steps:

. Update application.properties file with the required Aerospike settings (host, port, namespace). This will point spring-data to your Aerospike instance. . Update with bootstrap.properties file with embedded.containers.enabled=false. This will disable setup of embedded Aerospike.