ArangoClient

avokka.arangodb.protocol.ArangoClient
See theArangoClient companion object
trait ArangoClient[F[_]]

ArangoDB client

Type parameters

F

effect

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Arango
trait Arango[F]
class Impl[F]

Members list

Value members

Abstract methods

database api

database api

Attributes

def db: ArangoDatabase[F]

configured database api

configured database api

Attributes

def execute(header: Header): F[Header]

send a arangodb request without body and receive a arangodb response without body (HEAD)

send a arangodb request without body and receive a arangodb response without body (HEAD)

Value parameters

header

arango request header

Attributes

Returns

arango header

def execute[O : VPackDecoder](header: Header): F[ArangoResponse[O]]

send a arangodb request without body and receive arangodb response

send a arangodb request without body and receive arangodb response

Type parameters

O

output body type

Value parameters

header

arango header

Attributes

Returns

arango response

def execute[P : VPackEncoder, O : VPackDecoder](request: ArangoRequest[P]): F[ArangoResponse[O]]

send a arangodb request with a body payload and receive arangodb response

send a arangodb request with a body payload and receive arangodb response

Type parameters

O

output body type

P

payload body type

Value parameters

request

arango request

Attributes

Returns

arango response

def executeSequence[O : VPackDecoder](header: Header): F[ArangoResponse[Vector[O]]]

send a arangodb request without body and receive arangodb response as velocypack sequence

send a arangodb request without body and receive arangodb response as velocypack sequence

Type parameters

O

output body inner type

Value parameters

header

arango header

Attributes

Returns

arango response

def login(username: String, password: String): F[ArangoResponse[Error]]

authenticate with arango server

authenticate with arango server

Attributes

arangodb server api

arangodb server api

Attributes

_system database api

_system database api

Attributes