Table of Contents

*db*

This dynamic var holds the currently used database.

add-listener

Usage: (add-listener g l)

Adds a listener to an EventGraph.
Can be passed either a GraphChangedListener or a hash-map that is compatible with graph-listener.

as-map

Usage: (as-map elem)

Transforms an element to a Clojure hash-map.

as-read-only

Usage: (as-read-only)
       (as-read-only item)

When called with no arguments, this fn sets *db* to be a read-only version of itself.
When called with one argument (Graph, Vertex, Edge or Index), it returns a read only version of it.

clear!

Usage: (clear!)

Clears *db* of all nodes and edges.

create-automatic-index!

Usage: (create-automatic-index! kname class keys)

create-manual-index!

Usage: (create-manual-index! kname class)

current-buffer-size

Usage: (current-buffer-size)

Current Transaction Buffer Size

drop-index!

Usage: (drop-index! kname)

event-graph

Usage: (event-graph graph)

get-edges

Usage: (get-edges vertex dir)
       (get-edges vertex dir label)

Gets the edges from a vertex given the direction (:in or :out) and an optional filtering label (as a keyword).

get-ends

Usage: (get-ends vertex dir label)
       (get-ends vertex dir)

In case you don't want to get the edges that meet a requirement but the vertices at the end of those, use get-ends just like get-edges.

get-id

Usage: (get-id elem)

get-index

Usage: (get-index kname class)

get-indices

Usage: (get-indices)

Returns the indices of the graph.

get-label

Usage: (get-label edge)

get-link

Usage: (get-link v1 v2)

If vertex1 and vertex2 are connected by an edge, it returns that edge.

get-max-buffer-size

Usage: (get-max-buffer-size)

Get Max Transaction Buffer Size

get-raw-graph

Usage: (get-raw-graph eg)

Returns the graph wrapped by an EventGraph.

get-vertex

Usage: (get-vertex edge dir)

Gets the :in or :out vertex from an edge.

get-vertices

Usage: (get-vertices)

Returns all the vertices.

graph-listener

Usage: (graph-listener {:keys [edge-add edge-prop-changed edge-prop-remove edge-remove vertex-add vertex-prop-changed vertex-prop-remove vertex-remove graph-cleared]})

Creates a GraphChangedListener object by being passed a hash-map of functions to be used. All the functions are optional.
Notation: vx = vertex; e = edge; k = key; v = val
Signatures:
edge-add [e]
edge-prop-changed[e k v] 
edge-prop-remove [e k v]
edge-remove [e]
vertex-add [vx]
vertex-prop-changed [vx k v]
vertex-prop-remove [vx k v]
vertex-remove [vx]
graph-cleared []

iget

Usage: (iget index key val)

Gets an element from an index.

index-class

Usage: (index-class i)

index-name

Usage: (index-name i)

index-type

Usage: (index-type i)

Returns whether the given index is :automatic or :manual.

iput

Usage: (iput index key val element)

Puts an element from an index.

iremove

Usage: (iremove index key val element)

Removes an element from an index.

link!

Usage: (link! id v1 label props v2)
       (link! v1 label props v2)
       (link! v1 label v2)

Adds an edge between vertex1 and vertex 2 given a vector like [label props-map]. The label must be a keyword and props-map can be nil.

linked?

Usage: (linked? v1 v2)

Tells whether or not two vertices have an edge between them.

load-edge

Usage: (load-edge id)

load-vertex

Usage: (load-vertex id)

migrate-graph!

Usage: (migrate-graph! g1 g2)

passoc!

Usage: (passoc! elem prop v)
       (passoc! elem prop v & kvs)

Assocs an element's property (given as a keyword).

pdissoc!

Usage: (pdissoc! elem prop)

Dissocs an element's property (given as a keyword).

pget

Usage: (pget elem prop)

Retrieves an element's property (given as a keyword).

pkeys

Usage: (pkeys elem)

Returns an element's keys as keywords.

pvals

Usage: (pvals elem)

Returns an element's vals.

read-graph-json!

Usage: (read-graph-json! input-stream)
       (read-graph-json! input-stream buffer-size)

Reads GraphSON formatted data into the current *db*.

read-graph-ml!

Usage: (read-graph-ml! input-stream & {:keys [buffer-size vertex-id-key edge-id-key edge-label-key]})

Reads GraphML formatted data into the current *db*.
All the keys are optional.

remove!

Usage: (remove! elem)

Removes either a vertex or an edge from the Graph.

set-db!

Usage: (set-db! graph-db)

Given a Graph instance (like OrientGraph, TinkerGraph, etc), sets it as the global DB.

set-max-buffer-size

Usage: (set-max-buffer-size buffer-size)

Set Max Transaction Buffer Size

shutdown!

Usage: (shutdown!)

tinker-graph

Usage: (tinker-graph)
       (tinker-graph dir)

unlink!

Usage: (unlink! v1 v2)

Removes the edge between two vertices.

vertex

Usage: (vertex id props)
       (vertex id)
       (vertex)

Adds a vertex to the database. If given a hash-map, sets the properties of the vertex.

with-db

Usage: (with-db graph-db & forms)

Evaluates the given forms with the given Graph DB bound to *db*.

with-tx

Usage: (with-tx & forms)

Evaluates the given forms inside a transaction.

write-graph-json!

Usage: (write-graph-json! out-stream & {:keys [vertex-props edge-props show-types]})

Writes GraphSON formatted data from the current *db*.
All the keys are optional.

write-graph-ml!

Usage: (write-graph-ml! out-stream & {:keys [vertex-types edge-types normalize]})

Writes GraphML formatted data from the current *db*.
All the keys are optional.