my_arangoex

v0.1.0

my_arangoex v0.1.0 MyArangoex.Graph

ArangoDB Graph methods

Summary

Functions

create(endpoint, graph_name, edge_definitions \\ [], orphan_collections \\ [])

Create a graph

drop(endpoint, graph_name)

Drop a graph

edge(endpoint, graph_name, collection_name, edge_key)

Get an edge

edge_create(endpoint, graph_name, collection_name, edge)

Create an edge

edge_definition_delete(endpoint, graph_name, edge_definition_name)

Remove an edge definition from the graph

edge_definition_replace(endpoint, graph_name, edge_definition_name, edge_definition)

Replace an edge definition

edge_delete(endpoint, graph_name, collection_name, edge_key)

Remove an edge

edge_replace(endpoint, graph_name, collection_name, edge_key, edge)

Replace an edge

edge_update(endpoint, graph_name, collection_name, edge_key, edge_body)

Modify an edge

edges(endpoint, graph_name)

List edge definitions

extend_edge_definintions(endpoint, graph_name, edge_definition)

Add edge definition

graph(endpoint, graph_name)

Get a graph

graphs(endpoint)

List all graphs

vertex(endpoint, graph_name, collection_name, vertex_key)

Get a vertex

vertex_collection_create(endpoint, graph_name, vertex_collection)

Add vertex collection

vertex_collection_delete(endpoint, graph_name, collection_name)

Remove vertex collection

vertex_collections(endpoint, graph_name)

List vertex collections

vertex_create(endpoint, graph_name, collection_name, vertex_body)

Create a vertex

vertex_delete(endpoint, graph_name, collection_name, vertex_key)

Remove a vertex

vertex_replace(endpoint, graph_name, collection_name, vertex_key, vertex_body)

Replace a vertex

vertex_update(endpoint, graph_name, collection_name, vertex_key, vertex_body)

Modify a vertex

Functions

create(endpoint, graph_name, edge_definitions \\ [], orphan_collections \\ []) 
create(MyArangoex.Endpoint.t, String.t, [MyArangoex.Graph.EdgeDefinition.t], [String.t]) :: MyArangoex.ok_error(map)

Create a graph

POST /_api/gharial

drop(endpoint, graph_name) 
drop(MyArangoex.Endpoint.t, String.t) :: MyArangoex.ok_error(map)

Drop a graph

DELETE /_api/gharial/{graph-name}

edge(endpoint, graph_name, collection_name, edge_key) 
edge(MyArangoex.Endpoint.t, String.t, String.t, String.t) :: MyArangoex.ok_error(map)

Get an edge

GET /_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}

edge_create(endpoint, graph_name, collection_name, edge) 
edge_create(MyArangoex.Endpoint.t, String.t, String.t, MyArangoex.Graph.Edge.t) :: MyArangoex.ok_error(map)

Create an edge

POST /_api/gharial/{graph-name}/edge/{collection-name}

edge_definition_delete(endpoint, graph_name, edge_definition_name) 
edge_definition_delete(MyArangoex.Endpoint.t, String.t, String.t) :: MyArangoex.ok_error(map)

Remove an edge definition from the graph

DELETE /_api/gharial/{graph-name}/edge/{definition-name}

edge_definition_replace(endpoint, graph_name, edge_definition_name, edge_definition) 
edge_definition_replace(MyArangoex.Endpoint.t, String.t, String.t, MyArangoex.Graph.EdgeDefinition.t) :: MyArangoex.ok_error(map)

Replace an edge definition

PUT /_api/gharial/{graph-name}/edge/{definition-name}

edge_delete(endpoint, graph_name, collection_name, edge_key) 
edge_delete(MyArangoex.Endpoint.t, String.t, String.t, String.t) :: MyArangoex.ok_error(map)

Remove an edge

DELETE /_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}

edge_replace(endpoint, graph_name, collection_name, edge_key, edge) 
edge_replace(MyArangoex.Endpoint.t, String.t, String.t, String.t, MyArangoex.Graph.Edge.t) :: MyArangoex.ok_error(map)

Replace an edge

PUT /_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}

edge_update(endpoint, graph_name, collection_name, edge_key, edge_body) 
edge_update(MyArangoex.Endpoint.t, String.t, String.t, String.t, map) :: MyArangoex.ok_error(map)

Modify an edge

PATCH /_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}

edges(endpoint, graph_name) 
edges(MyArangoex.Endpoint.t, String.t) :: MyArangoex.ok_error(map)

List edge definitions

GET /_api/gharial/{graph-name}/edge

extend_edge_definintions(endpoint, graph_name, edge_definition) 
extend_edge_definintions(MyArangoex.Endpoint.t, String.t, MyArangoex.Graph.EdgeDefinition.t) :: MyArangoex.ok_error(map)

Add edge definition

POST /_api/gharial/{graph-name}/edge

graph(endpoint, graph_name) 
graph(MyArangoex.Endpoint.t, String.t) :: MyArangoex.ok_error(map)

Get a graph

GET /_api/gharial/{graph-name}

graphs(endpoint) 
graphs(MyArangoex.Endpoint.t) :: MyArangoex.ok_error(map)

List all graphs

GET /_api/gharial

vertex(endpoint, graph_name, collection_name, vertex_key) 
vertex(MyArangoex.Endpoint.t, String.t, String.t, String.t) :: MyArangoex.ok_error(map)

Get a vertex

GET /_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}

vertex_collection_create(endpoint, graph_name, vertex_collection) 
vertex_collection_create(MyArangoex.Endpoint.t, String.t, MyArangoex.Graph.VertexCollection.t) :: MyArangoex.ok_error(map)

Add vertex collection

POST /_api/gharial/{graph-name}/vertex

vertex_collection_delete(endpoint, graph_name, collection_name) 
vertex_collection_delete(MyArangoex.Endpoint.t, String.t, String.t) :: MyArangoex.ok_error(map)

Remove vertex collection

DELETE /_api/gharial/{graph-name}/vertex/{collection-name}

vertex_collections(endpoint, graph_name) 
vertex_collections(MyArangoex.Endpoint.t, String.t) :: MyArangoex.ok_error(map)

List vertex collections

GET /_api/gharial/{graph-name}/vertex

vertex_create(endpoint, graph_name, collection_name, vertex_body) 
vertex_create(MyArangoex.Endpoint.t, String.t, String.t, map) :: MyArangoex.ok_error(map)

Create a vertex

POST /_api/gharial/{graph-name}/vertex/{collection-name}

vertex_delete(endpoint, graph_name, collection_name, vertex_key) 
vertex_delete(MyArangoex.Endpoint.t, String.t, String.t, String.t) :: MyArangoex.ok_error(map)

Remove a vertex

DELETE /_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}

vertex_replace(endpoint, graph_name, collection_name, vertex_key, vertex_body) 
vertex_replace(MyArangoex.Endpoint.t, String.t, String.t, String.t, map) :: MyArangoex.ok_error(map)

Replace a vertex

PUT /_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}

vertex_update(endpoint, graph_name, collection_name, vertex_key, vertex_body) 
vertex_update(MyArangoex.Endpoint.t, String.t, String.t, String.t, map) :: MyArangoex.ok_error(map)

Modify a vertex

PATCH /_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}