ArangoWal

avokka.arangodb.ArangoWal
See theArangoWal companion object
trait ArangoWal[F[_]]

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

def tail(global: Boolean, from: Option[String], to: Option[String], lastScanned: Option[String], chunkSize: Option[Int], syncerId: Option[Int], serverId: Option[Int], clientInfo: Option[String]): F[ArangoResponse[Vector[Wal]]]

Tail recent server operations

Tail recent server operations

Value parameters

chunkSize

Approximate maximum size of the returned result.

clientInfo

Short description of the client, used for informative purposes only.

from

Exclusive lower bound tick value for results. On successive calls to this API you should set this to the value returned with the x-arango-replication-lastincluded header (Unless that header contains 0).

global

Whether operations for all databases should be included. When set to false only the operations for the current database are included. The value true is only valid on the _system database. The default is false.

lastScanned

Should be set to the value of the x-arango-replication-lastscanned header or alternatively 0 on first try. This allows the rocksdb engine to break up large transactions over multiple responses.

serverId

Id of the client machine. If syncerId is unset, the server will use this to keep operations until the client has fetched them. Must be a positive integer. Note this or syncerId is required to have a chance at fetching reading all operations with the rocksdb storage engine.

syncerId

Id of the client used to tail results. The server will use this to keep operations until the client has fetched them. Must be a positive integer. Note this or serverId is required to have a chance at fetching reading all operations with the rocksdb storage engine.

to

Inclusive upper bound tick value for results.

Attributes

Returns

data from the server’s write-ahead log (also named replication log)