Spring Data ArangoDB - Getting Started

Supported versions

Spring Data ArangoDB is compatible with all supported stable versions of ArangoDB server, see Product Support End-of-life Announcements.


To use Spring Data ArangoDB in your project, your build automation tool needs to be configured to include and use the Spring Data ArangoDB dependency. Example with Maven (substitute x.x.x with the latest Spring Data ArangoDB version):


There is a demonstration app, which contains common use cases and examples of how to use Spring Data ArangoDB’s functionality.


You can use Java to configure your Spring Data environment as show below. Setting up the underlying driver (ArangoDB.Builder) with default configuration automatically loads a properties file arangodb.properties, if it exists in the classpath.

@EnableArangoRepositories(basePackages = { "com.company.mypackage" })
public class MyConfiguration extends AbstractArangoConfiguration {

  public ArangoDB.Builder arango() {
    return new ArangoDB.Builder();

  public String database() {
    // Name of the database to be used
    return "example-database";


The driver is configured with some default values:

property-key description default value
arangodb.host ArangoDB host
arangodb.port ArangoDB port 8529
arangodb.timeout socket connect timeout(millisecond) 0
arangodb.user Basic Authentication User  
arangodb.password Basic Authentication Password  
arangodb.useSsl use SSL connection false

To customize the configuration, the parameters can be changed in the Java code.

public ArangoDB.Builder arango() {
  ArangoDB.Builder arango = new ArangoDB.Builder()
  return arango;

In addition you can use the arangodb.properties or a custom properties file to supply credentials to the driver.

Properties file


Custom properties file

public ArangoDB.Builder arango() {
  InputStream in = MyClass.class.getResourceAsStream("my.properties");
  ArangoDB.Builder arango = new ArangoDB.Builder()
  return arango;