ArangoDB
Package avokka-arangodb contains:
- core models of the arangodb protocol
- arangodb dsl build with generic effect F[_] with constraints of cats
- an AQL custom string interpolator
You need to depends on the akka or the fs2 module to use the client.
Configuration
An instance of ArangoConfiguration
is needed to get an arangodb client.
A typesafe config reference is included :
avokka {
host = "localhost"
port = 8529
username = ""
password = ""
database = "_system"
chunk-length = 30000
read-buffer-size = 256000
connect-timeout = "10s"
reply-timeout = "30s"
}
import avokka.arangodb.ArangoConfiguration
// load configuration from defaults
val configuration = ArangoConfiguration.load()
Implementation
ArangoDB client can use akka or fs2 implementation :
Refer to the documentation of each module for usage.
Usage
The common entry class is a ArangoClient[F]
.
Property client.db
is an instance of ArangoDatabase[F]
for the database configured in ArangoConfiguration.database
The majority of API calls return an instance of ArangoResponse[T]
, with a header
property and a body: T
property.