avokka-site
API
Generated with
avokka-site/avokka/avokka.arangodb/avokka.arangodb.protocol/ArangoClient/Impl

Impl

avokka.arangodb.protocol.ArangoClient$.Impl
abstract class Impl[F[_]](configuration: ArangoConfiguration)(implicit F: MonadThrow[F], L: MessageLogger[F]) extends ArangoClient[F]

Abstract implementation of client execute methods, send method is left to akka or fs2

Type parameters

F

effect

Value parameters

F

monad

L

logger

configuration

client configuration

Attributes

Graph
Supertypes
trait ArangoClient[F]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def database(name: DatabaseName): ArangoDatabase[F]

database api

database api

Attributes

Definition Classes
override 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

Definition Classes
override 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

Definition Classes
override 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

Definition Classes
override 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

Definition Classes
protected def handleResponse[O : VPackDecoder](response: ByteVector): F[ArangoResponse[O]]
protected def handleResponseSequence[O : VPackDecoder](response: ByteVector): F[ArangoResponse[Vector[O]]]
override def login(username: String, password: String): F[ArangoResponse[Error]]

authenticate with arango server

authenticate with arango server

Attributes

Definition Classes

Concrete fields

override val db: ArangoDatabase[F]

configured database api

configured database api

Attributes

override val server: ArangoServer[F]

arangodb server api

arangodb server api

Attributes

override val system: ArangoDatabase[F]

_system database api

_system database api

Attributes

Generated with