Common Lisp Package: CL-NEO4J-WRAPPER

README:

FUNCTION

Public

NODE-CREATE (&KEY (CONSTRUCTOR *DEFAULT-NODE-CONSTRUCTOR*) PROPERTIES INITIAL-CONNECTIONS INITIAL-INDEXES)

Creates a new node in the graph. Returns created node. constructor is a constructor for nodes. By default it uses *default-node-constructor*. properties are plist of node properties. initial-connections are list of lists of node (or ids), type and direction that node should be connected to. initial-indexes are list of lists of index name, key and value of indexes that node should be added to.

NODE-GET-BY-ID (ID &KEY (CONSTRUCTOR *DEFAULT-NODE-CONSTRUCTOR*))

Returns a node with given id or nil otherwise. This is a factory method, it accepts keyword argument constructor whcih is defaulted to *default-node-constructor*

NODE-QUERY-INDEX (INDEX KEY VALUE &KEY (CONSTRUCTOR *DEFAULT-NODE-CONSTRUCTOR*))

Returns list of nodes in the index with key and value. This is a factory method, it accepts keyword argument constructor which is defaulted to *default-node-constructor*

RELATIONSHIP-GET-BY-ID (ID &KEY (CONSTRUCTOR *DEFAULT-NODE-CONSTRUCTOR*))

Returns relationship with given id or nil otherwise.

RELATIONSHIP-QUERY-INDEX (INDEX KEY VALUE &KEY (CONSTRUCTOR *DEFAULT-RELATIONSHIP-CONSTRUCTOR*))

Returns list of nodes in the index with key and value.

Private

Undocumented

MAKE-STANDARD-NODE (ALIST)

MAKE-STANDARD-RELATIONSHIP (ALIST)

NORMALIZE-ALIST (ALIST)

GENERIC-FUNCTION

Public

NODE-ADD-TO-INDEX (NODE INDEX KEY VALUE)

Adds node to index with key and value.

NODE-DELETE (NODE &KEY CASCADE)

Deletes a node. Cascade deletes the node even if node had relationships (deleting them too).

NODE-PROPERTY (NODE PROPERTY)

Returns value of the property of the node. Returns nil if property is undefined.

SETFNODE-PROPERTY (VALUE NODE PROPERTY)

Sets a value of the property of the node to value. Value of nil deletes property.

NODE-RELATIONSHIPS (NODE &KEY TYPES DIRECTION (CONSTRUCTOR *DEFAULT-RELATIONSHIP-CONSTRUCTOR*))

Returns list of node relations, optionally filtered by list of possible types and direction. This is a factory method, accepts *default-node-constructor*

NODE-REMOVE-FROM-INDEX (NODE INDEX &OPTIONAL KEY VALUE)

Removes node from index. Optionally removes only from index with key and value.

NODE-TRAVERSE (NODE &KEY ORDER UNIQUENESS RELATIONSHIPS PRUNE-EVALUATOR RETURN-FILTER MAX-DEPTH (CONSTRUCTOR *DEFAULT-NODE-CONSTRUCTOR*) &ALLOW-OTHER-KEYS)

RELATIONSHIP-ADD-TO-INDEX (RELATIONSHIP INDEX KEY VALUE)

Adds Relationship to index with key and value.

RELATIONSHIP-CREATE (NODE1 NODE2 TYPE &KEY PROPERTIES DIRECTION INITIAL-INDEXES (CONSTRUCTOR *DEFAULT-RELATIONSHIP-CONSTRUCTOR*) (DIRECTION FROM))

Creates new relationship in a graph. Returns created relationship. If any step fails it tries to cleanup after itself. constructor is a constructor for relationships. By default it uses *default-relationship-constructor*. properties are plist of relationship properties. direction indicates a direction of relation from the point of view of node1. initial-indexes are list of lists of index name, key and value of indexes that node should be added to

RELATIONSHIP-DELETE (RELATIONSHIP)

Deletes a relationship.

RELATIONSHIP-END (RELATIONSHIP)

Returns end node of relationship.

RELATIONSHIP-PROPERTY (RELATIONSHIP PROPERTY)

Returns value of the property of the relationship. Returns nil if property is undefined.

SETFRELATIONSHIP-PROPERTY (VALUE RELATIONSHIP PROPERTY)

Sets a value of the property of the relationship to value. Value of nil deletes property.

RELATIONSHIP-REMOVE-FROM-INDEX (RELATIONSHIP INDEX &OPTIONAL KEY VALUE)

Removes relationship from index. Optionally removes only from index with key and value.

RELATIONSHIP-START (RELATIONSHIP)

Returns start node of relationship.

RELATIONSHIP-TRAVERSE (NODE &KEY ORDER UNIQUENESS RELATIONSHIPS PRUNE-EVALUATOR RETURN-FILTER MAX-DEPTH (CONSTRUCTOR *DEFAULT-RELATIONSHIP-CONSTRUCTOR*) &ALLOW-OTHER-KEYS)

SLOT-ACCESSOR

Public

NODE-PROPERTIES (NODE)

The Returns plist of properties of the node.

SETFNODE-PROPERTIES (NEW-VALUE OBJECT)

Set the Returns plist of properties of the node.

RELATIONSHIP-PROPERTIES (RELATIONSHIP)

The Returns plist of relationship properties.

SETFRELATIONSHIP-PROPERTIES (NEW-VALUE OBJECT)

Set the Returns plist of relationship properties.

RELATIONSHIP-TYPE (RELATIONSHIP)

The Returns type of the relationship.

SETFRELATIONSHIP-TYPE (NEW-VALUE OBJECT)

Set the Returns type of the relationship.

Undocumented

NODE-ID (OBJECT)

SETFNODE-ID (NEW-VALUE OBJECT)

RELATIONSHIP-ID (OBJECT)

SETFRELATIONSHIP-ID (NEW-VALUE OBJECT)

Private

Undocumented

%RELATIONSHIP-END-ID (OBJECT)

SETF%RELATIONSHIP-END-ID (NEW-VALUE OBJECT)

%RELATIONSHIP-START-ID (OBJECT)

SETF%RELATIONSHIP-START-ID (NEW-VALUE OBJECT)

VARIABLE

Public

Undocumented

*DEFAULT-NODE-CONSTRUCTOR*

*DEFAULT-RELATIONSHIP-CONSTRUCTOR*

CLASS

Public

Undocumented

STANDARD-NODE

STANDARD-RELATIONSHIP