ArangoGraph

avokka.arangodb.ArangoGraph
See theArangoGraph companion object
trait ArangoGraph[F[_]]

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Abstract methods

Add an additional vertex collection to the graph.

Add an additional vertex collection to the graph.

Attributes

def create(edgeDefinitions: List[GraphEdgeDefinition], orphanCollections: List[String], waitForSync: Boolean): F[ArangoResponse[GraphInfo]]

Create a new graph in the graph module

Create a new graph in the graph module

Value parameters

edgeDefinitions

An array of definitions for the relations of the graph.

orphanCollections

An array of additional vertex collections. Documents within these collections do not have edges within this graph.

waitForSync

define if the request should wait until everything is synced to disc. Will change the success response code.

Attributes

Returns

new graph information

def drop(dropCollections: Boolean): F[ArangoResponse[Boolean]]

Drop the graph

Drop the graph

Value parameters

dropCollections

Drop collections of this graph as well. Collections will only be dropped if they are not used in other graphs.

Attributes

Returns

deletion result

Get graph information

Get graph information

Attributes

graph name

graph name

Attributes

def removeVertexCollection(collection: CollectionName, dropCollection: Boolean): F[ArangoResponse[GraphInfo]]

Remove a vertex collection form the graph.

Remove a vertex collection form the graph.

Value parameters

dropCollection

Drop the collection as well. Collection will only be dropped if it is not used in other graphs.

Attributes

Returns

graph information

Lists all vertex collections used in this graph

Lists all vertex collections used in this graph

Attributes