gremlex

v0.3.2

gremlex

gremlex v0.3.2 Gremlex.Graph View Source

Functions for traversing and mutating the Graph.

Graph operations are stored in a queue which can be created with g/0. Mosts functions return the queue so that they can be chained together similar to how Gremlin queries work.

Example:

g.V(1).values("name")

Would translate to

g |> v(1) |> values("name")

Note: This module doesn’t actually execute any queries, it just allows you to build one. For query execution see Gremlex.Client.query/1

Link to this section Summary

Types

t()

Functions

add_e(graph, edge)

Appends an addE command to the traversal. Returns a graph to allow chaining

add_namespace(graph)

Adds a namespace as property

add_namespace(graph, ns)
add_v(graph, id)

Appends an addV command to the traversal. Returns a graph to allow chaining

aggregate(graph, aggregate)

Appends an aggregate command to the traversal. Returns a graph to allow chaining

and_(graph)
anonymous()
as(graph, name)
barrier(graph)
barrier(graph, max_barrier_size)
both(graph)
both(graph, labels)
both_e(graph)
both_e(graph, labels)
both_v(graph)
both_v(graph, labels)
by(graph, value)
cap(graph, cap)
coalesce(graph, traversals)
coin(graph, probability)

Appends a coin command to the traversal. Takes in a graph and a probability modifier as parameters. Returns a graph to allow chaining

constant(graph, constant)
count(graph)
cyclic_path(graph)
dedup(graph)
drop(graph)
e(graph)

Appends values the E command allowing you to select an edge. Returns a graph to allow chaining

e(graph, id)
encode(graph)

Compiles a graph into the Gremlin query

eq(graph, number)
fold(graph)
fold(graph, traversal)
from(graph, name)
g()

Start of graph traversal. All graph operations are stored in a queue

group(graph)
group_count(graph)
group_count(graph, key)

Appends groupCount command to the traversal. Takes in a graph and the name of the key that will hold the aggregated grouping. Returns a graph to allow chainig

has(graph, key, value)
has_id(graph, id)
has_key(graph, key)
has_label(graph, label)
has_namespace(graph)
has_namespace(graph, ns)
has_next(graph)
has_not(graph, key)
id(graph)
identity(graph)
in_(graph)
in_(graph, edge)
in_e(graph)
in_e(graph, edges)
in_v(graph)
in_v(graph, labels)
inject(graph, target)
is(graph, value)
iterate(graph)
key(graph)
loops(graph)
max(graph)
min(graph)
next(graph)
next(graph, numberOfResults)
not_(graph, traversal)
or_(graph)
out(graph)
out(graph, labels)
out_e(graph)
out_e(graph, edges)
out_v(graph)
out_v(graph, labels)
path(graph)
properties(graph)
properties(graph, key)

Appends properties command to the traversal. Returns a graph to allow chaining

property(graph, key)
property(graph, key, value)

Appends property command to the traversal. Returns a graph to allow chaining

property(graph, atom, key, value)
repeat(graph, traversal)
select(graph, names)
simple_path(graph)
store(graph, store)

Appends the store command to the traversal. Takes in a graph and the name of the side effect key that will hold the aggregate. Returns a graph to allow chaining

sum(graph)
tail(graph)
tail(graph, size)
to(graph, target)
to_bulk_set(graph)
to_list(graph)
to_set(graph)
try_next(graph)
unfold(graph)
unfold(graph, traversal)
until(graph, traversal)
v(graph)

Appends values the V command allowing you to select a vertex. Returns a graph to allow chaining

v(graph, id)

Appends values the V command allowing you to select a vertex. Returns a graph to allow chaining

value_map(graph)

Appends valueMap command to the traversal. Returns a graph to allow chaining

value_map(graph, value)
values(graph, key)

Appends values command to the traversal. Returns a graph to allow chaining

where(graph, traversal)
within(range)

Creates a within predicate that will match at least one of the values provided. Takes in a range or a list as the values. Examples:

g.V().has('age', within(1..18))
g.V().has('name', within(["some", "value"]))
without(range)

Creates a without predicate that will filter out values that match the values provided. Takes in a range or a list as the values. Examples:

g.V().has('age', without(18..30))
g.V().has('name', without(["any", "value"]))

Link to this section Types

Link to this section Functions

Link to this function add_e(graph, edge) View Source 
add_e(Gremlex.Graph.t(), any()) :: Gremlex.Graph.t()

Appends an addE command to the traversal. Returns a graph to allow chaining.

Link to this function add_namespace(graph) View Source 
add_namespace(Gremlex.Graph.t()) :: Gremlex.Graph.t()

Adds a namespace as property

Link to this function add_namespace(graph, ns) View Source 
add_namespace(Gremlex.Graph.t(), any()) :: Gremlex.Graph.t()
Link to this function add_v(graph, id) View Source 
add_v(Gremlex.Graph.t(), any()) :: Gremlex.Graph.t()

Appends an addV command to the traversal. Returns a graph to allow chaining.

Link to this function aggregate(graph, aggregate) View Source 
aggregate(Gremlex.Graph.t(), String.t()) :: Gremlex.Graph.t()

Appends an aggregate command to the traversal. Returns a graph to allow chaining.

Link to this function barrier(graph, max_barrier_size) View Source 
barrier(Gremlex.Graph.t(), non_neg_integer()) :: Gremlex.Graph.t()
Link to this function coalesce(graph, traversals) View Source 
coalesce(Gremlex.Graph.t(), List.t() | String.t()) :: Gremlex.Graph.t()
Link to this function coin(graph, probability) View Source 
coin(Gremlex.Graph.t(), Float.t()) :: Gremlex.Graph.t()

Appends a coin command to the traversal. Takes in a graph and a probability modifier as parameters. Returns a graph to allow chaining.

Link to this function e(graph) View Source 
e(Gremlex.Graph.t()) :: Gremlex.Graph.t()

Appends values the E command allowing you to select an edge. Returns a graph to allow chaining.

Link to this function encode(graph) View Source 
encode(Gremlex.Graph.t()) :: String.t()

Compiles a graph into the Gremlin query.

Link to this function g() View Source 
g() :: Gremlex.Graph.t()

Start of graph traversal. All graph operations are stored in a queue.

Link to this function group_count(graph, key) View Source 
group_count(Gremlex.Graph.t(), String.t()) :: Gremlex.Graph.t()

Appends groupCount command to the traversal. Takes in a graph and the name of the key that will hold the aggregated grouping. Returns a graph to allow chainig.

Link to this function has_label(graph, label) View Source 
has_label(Gremlex.Graph.t(), any()) :: Gremlex.Graph.t()
Link to this function has_namespace(graph) View Source 
has_namespace(Gremlex.Graph.t()) :: Gremlex.Graph.t()
Link to this function has_namespace(graph, ns) View Source 
has_namespace(Gremlex.Graph.t(), any()) :: Gremlex.Graph.t()
Link to this function properties(graph, key) View Source 
properties(Gremlex.Graph.t(), String.t()) :: Gremlex.Graph.t()

Appends properties command to the traversal. Returns a graph to allow chaining.

Link to this function property(graph, key, value) View Source 
property(Gremlex.Graph.t(), String.t(), any()) :: Gremlex.Graph.t()

Appends property command to the traversal. Returns a graph to allow chaining.

Link to this function property(graph, atom, key, value) View Source 
property(Gremlex.Graph.t(), atom(), String.t(), any()) :: Gremlex.Graph.t()
property(Gremlex.Graph.t(), atom(), String.t(), any()) :: Gremlex.Graph.t()
property(Gremlex.Graph.t(), atom(), String.t(), any()) :: Gremlex.Graph.t()
Link to this function store(graph, store) View Source 
store(Gremlex.Graph.t(), String.t()) :: Gremlex.Graph.t()

Appends the store command to the traversal. Takes in a graph and the name of the side effect key that will hold the aggregate. Returns a graph to allow chaining.

Link to this function v(graph) View Source 
v(Gremlex.Graph.t()) :: Gremlex.Graph.t()
v(number()) :: Gremlex.Vertex.t()

Appends values the V command allowing you to select a vertex. Returns a graph to allow chaining.

Link to this function v(graph, id) View Source 
v(Gremlex.Graph.t(), Gremlex.Vertex.t()) :: Gremlex.Graph.t()
v(Gremlex.Graph.t(), number()) :: Gremlex.Graph.t()
v(Gremlex.Graph.t(), List.t() | String.t()) :: Gremlex.Graph.t()

Appends values the V command allowing you to select a vertex. Returns a graph to allow chaining.

Link to this function value_map(graph) View Source 
value_map(Gremlex.Graph.t()) :: Gremlex.Graph.t()

Appends valueMap command to the traversal. Returns a graph to allow chaining.

Link to this function values(graph, key) View Source 
values(Gremlex.Graph.t(), String.t()) :: Gremlex.Graph.t()

Appends values command to the traversal. Returns a graph to allow chaining.

Link to this function within(range) View Source

Creates a within predicate that will match at least one of the values provided. Takes in a range or a list as the values. Examples:

g.V().has('age', within(1..18))
g.V().has('name', within(["some", "value"]))
Link to this function without(range) View Source

Creates a without predicate that will filter out values that match the values provided. Takes in a range or a list as the values. Examples:

g.V().has('age', without(18..30))
g.V().has('name', without(["any", "value"]))