cl-neo4j

API Reference

cl-neo4j

neo4j RESTful Client Interface

CL-NEO4J

  • Condition UNKNOWN-RETURN-TYPE-ERROR  (ERROR)
  • Condition INVALID-DATA-SENT-ERROR  (ERROR)
  • Condition NODE-NOT-FOUND-ERROR  (ERROR)
  • Condition UNABLE-TO-DELETE-NODE-ERROR  (ERROR)
  • Condition RELATIONSHIP-NOT-FOUND-ERROR  (ERROR)
  • Condition PROPERTY-NOT-FOUND-ERROR  (ERROR)
  • Condition INDEX-NOT-FOUND-ERROR  (ERROR)
  • Condition INDEX-ENTRY-NOT-FOUND-ERROR  (ERROR)
  • Condition PATH-NOT-FOUND-ERROR  (ERROR)
  • Variable *NEO4J-HOST*
    "localhost"
  • Variable *NEO4J-PORT*
    7474
  • Function GET-NODE (&key node-id)
  • Function CREATE-NODE (&key properties)
  • Function DELETE-NODE (&key node-id)
  • Function SET-NODE-PROPERTIES (&key node-id properties)
  • Function GET-NODE-PROPERTIES (&key node-id)
  • Function DEL-NODE-PROPERTIES (&key node-id)
  • Function SET-NODE-PROPERTY (&key node-id property value)
  • Function GET-NODE-PROPERTY (&key node-id property)
  • Function DEL-NODE-PROPERTY (&key node-id property)
  • Function GET-RELATIONSHIP (&key relationship-id)
  • Function CREATE-RELATIONSHIP (&key node-id to-node-id relationship-type properties)
  • Function DELETE-RELATIONSHIP (&key relationship-id)
  • Function SET-RELATIONSHIP-PROPERTIES (&key relationship-id properties)
  • Function GET-RELATIONSHIP-PROPERTIES (&key relationship-id)
  • Function DEL-RELATIONSHIP-PROPERTIES (&key relationship-id)
  • Function SET-RELATIONSHIP-PROPERTY (&key relationship-id property value)
  • Function GET-RELATIONSHIP-PROPERTY (&key relationship-id property)
  • Function DEL-RELATIONSHIP-PROPERTY (&key relationship-id property)
  • Function GET-NODE-RELATIONSHIPS (&key node-id direction types)
  • Function GET-RELATIONSHIPS-TYPES (&key)
  • Function CREATE-INDEX (&key (type :node) name config)
  • Function DELETE-INDEX (&key (type :node) name)
  • Function ADD-TO-INDEX (&key (type :node) name key value object-id)
  • Function REMOVE-FROM-INDEX (&key (type :node) name key value object-id)
  • Function LOOKUP-INDEX (&key (type :node) name key value)
  • Function QUERY-INDEX (&key (type :node) name query)
  • Function TRAVERSE (&key node-id (return-type :node) (max-depth 1) (order :depth-first) uniqueness relationships prune-evaluator return-filter)
  • Function GET-PATH (&key node-id to-node-id relationships (max-depth 3) (algorithm :shortest-path))
  • Function GET-PATHS (&key node-id to-node-id relationships (max-depth 3) (algorithm :shortest-path))

CL-NEO4J-WRAPPER

  • Variable *DEFAULT-NODE-CONSTRUCTOR*
    'cl-neo4j-wrapper::make-standard-node
  • Variable *DEFAULT-RELATIONSHIP-CONSTRUCTOR*
    'cl-neo4j-wrapper::make-standard-relationship
  • Function 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.
  • Function 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*
  • Generic-Function NODE-DELETE (node &key)
    Deletes a node. Cascade deletes the node even if node had relationships (deleting them too).
  • Method NODE-DELETE ((node integer) &key cascade)
  • Method NODE-DELETE ((node integer) &key cascade)
  • Method NODE-DELETE ((node integer) &key cascade)
  • Generic-Function NODE-PROPERTIES (node)
    Returns plist of properties of the node.
  • Method NODE-PROPERTIES ((node integer))
  • Method NODE-PROPERTIES ((node integer))
  • Method NODE-PROPERTIES ((node integer))
  • Generic-Function NODE-PROPERTY (node property)
    Returns value of the property of the node. Returns nil if property is undefined.
  • Method NODE-PROPERTY ((node integer) property)
  • Method NODE-PROPERTY ((node integer) property)
  • Method NODE-PROPERTY ((node integer) property)
  • Generic-Function (setf NODE-PROPERTY) (value node property)
    Sets a value of the property of the node to value. Value of nil deletes property.
  • Method (setf NODE-PROPERTY) (value (node integer) property)
  • Method (setf NODE-PROPERTY) (value (node integer) property)
  • Method (setf NODE-PROPERTY) (value (node integer) property)
  • Generic-Function NODE-RELATIONSHIPS (node &key types direction)
    Returns list of node relations, optionally filtered by list of possible types and direction. This is a factory method, accepts *default-node-constructor*
  • Method NODE-RELATIONSHIPS ((node integer) &key (constructor *default-relationship-constructor*) types direction)
  • Method NODE-RELATIONSHIPS ((node integer) &key (constructor *default-relationship-constructor*) types direction)
  • Method NODE-RELATIONSHIPS ((node integer) &key (constructor *default-relationship-constructor*) types direction)
  • Generic-Function NODE-ADD-TO-INDEX (node index key value)
    Adds node to index with key and value.
  • Method NODE-ADD-TO-INDEX ((node integer) index key value)
  • Method NODE-ADD-TO-INDEX ((node integer) index key value)
  • Method NODE-ADD-TO-INDEX ((node integer) index key value)
  • Generic-Function NODE-REMOVE-FROM-INDEX (node index &optional key value)
    Removes node from index. Optionally removes only from index with key and value.
  • Method NODE-REMOVE-FROM-INDEX ((node integer) index &optional key value)
  • Method NODE-REMOVE-FROM-INDEX ((node integer) index &optional key value)
  • Method NODE-REMOVE-FROM-INDEX ((node integer) index &optional key value)
  • Function 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*
  • Generic-Function NODE-TRAVERSE (node &key order uniqueness relationships prune-evaluator return-filter max-depth)
  • Method NODE-TRAVERSE ((node integer) &rest keys &key (constructor *default-node-constructor*) &allow-other-keys)
  • Method NODE-TRAVERSE ((node integer) &rest keys &key (constructor *default-node-constructor*) &allow-other-keys)
  • Method NODE-TRAVERSE ((node integer) &rest keys &key (constructor *default-node-constructor*) &allow-other-keys)
  • Generic-Function RELATIONSHIP-CREATE (node1 node2 type &key properties direction initial-indexes)
    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
  • Method RELATIONSHIP-CREATE ((node1 integer) (node2 integer) type &key (constructor *default-relationship-constructor*) properties (direction :from) initial-indexes)
  • Method RELATIONSHIP-CREATE ((node1 integer) (node2 integer) type &key (constructor *default-relationship-constructor*) properties (direction :from) initial-indexes)
  • Method RELATIONSHIP-CREATE ((node1 integer) (node2 integer) type &key (constructor *default-relationship-constructor*) properties (direction :from) initial-indexes)
  • Function RELATIONSHIP-GET-BY-ID (id &key (constructor *default-node-constructor*))
    Returns relationship with given id or nil otherwise.
  • Generic-Function RELATIONSHIP-DELETE (relationship)
    Deletes a relationship.
  • Method RELATIONSHIP-DELETE ((relationship integer))
  • Method RELATIONSHIP-DELETE ((relationship integer))
  • Method RELATIONSHIP-DELETE ((relationship integer))
  • Generic-Function RELATIONSHIP-START (relationship)
    Returns start node of relationship.
  • Method RELATIONSHIP-START ((relationship integer))
  • Method RELATIONSHIP-START ((relationship integer))
  • Method RELATIONSHIP-START ((relationship integer))
  • Generic-Function RELATIONSHIP-END (relationship)
    Returns end node of relationship.
  • Method RELATIONSHIP-END ((relationship integer))
  • Method RELATIONSHIP-END ((relationship integer))
  • Method RELATIONSHIP-END ((relationship integer))
  • Generic-Function RELATIONSHIP-TYPE (relationship)
    Returns type of the relationship.
  • Method RELATIONSHIP-TYPE ((relationship integer))
  • Method RELATIONSHIP-TYPE ((relationship integer))
  • Method RELATIONSHIP-TYPE ((relationship integer))
  • Generic-Function RELATIONSHIP-PROPERTIES (relationship)
    Returns plist of relationship properties.
  • Method RELATIONSHIP-PROPERTIES ((relationship integer))
  • Method RELATIONSHIP-PROPERTIES ((relationship integer))
  • Method RELATIONSHIP-PROPERTIES ((relationship integer))
  • Generic-Function RELATIONSHIP-PROPERTY (relationship property)
    Returns value of the property of the relationship. Returns nil if property is undefined.
  • Method RELATIONSHIP-PROPERTY ((relationship integer) property)
  • Method RELATIONSHIP-PROPERTY ((relationship integer) property)
  • Method RELATIONSHIP-PROPERTY ((relationship integer) property)
  • Generic-Function (setf RELATIONSHIP-PROPERTY) (value relationship property)
    Sets a value of the property of the relationship to value. Value of nil deletes property.
  • Method (setf RELATIONSHIP-PROPERTY) (value (relationship integer) property)
  • Method (setf RELATIONSHIP-PROPERTY) (value (relationship integer) property)
  • Method (setf RELATIONSHIP-PROPERTY) (value (relationship integer) property)
  • Generic-Function RELATIONSHIP-ADD-TO-INDEX (relationship index key value)
    Adds Relationship to index with key and value.
  • Method RELATIONSHIP-ADD-TO-INDEX ((relationship integer) index key value)
  • Method RELATIONSHIP-ADD-TO-INDEX ((relationship integer) index key value)
  • Method RELATIONSHIP-ADD-TO-INDEX ((relationship integer) index key value)
  • Generic-Function RELATIONSHIP-REMOVE-FROM-INDEX (relationship index &optional key value)
    Removes relationship from index. Optionally removes only from index with key and value.
  • Method RELATIONSHIP-REMOVE-FROM-INDEX ((relationship integer) index &optional key value)
  • Method RELATIONSHIP-REMOVE-FROM-INDEX ((relationship integer) index &optional key value)
  • Method RELATIONSHIP-REMOVE-FROM-INDEX ((relationship integer) index &optional key value)
  • Function RELATIONSHIP-QUERY-INDEX (index key value &key (constructor *default-relationship-constructor*))
    Returns list of nodes in the index with key and value.
  • Generic-Function RELATIONSHIP-TRAVERSE (node &key order uniqueness relationships prune-evaluator return-filter max-depth)
  • Method RELATIONSHIP-TRAVERSE ((node integer) &rest keys &key (constructor *default-relationship-constructor*) &allow-other-keys)
  • Method RELATIONSHIP-TRAVERSE ((node integer) &rest keys &key (constructor *default-relationship-constructor*) &allow-other-keys)
  • Method RELATIONSHIP-TRAVERSE ((node integer) &rest keys &key (constructor *default-relationship-constructor*) &allow-other-keys)
  • Class STANDARD-NODE
    ID   Accessor: NODE-ID
    PROPERTIES   Accessor: NODE-PROPERTIES
  • Method NODE-DELETE ((node standard-node) &key cascade)
  • Method NODE-PROPERTY ((node standard-node) property)
  • Method (setf NODE-PROPERTY) (value (node standard-node) property)
  • Method NODE-RELATIONSHIPS ((node standard-node) &key types direction)
  • Method NODE-ADD-TO-INDEX ((node standard-node) index key value)
  • Method NODE-REMOVE-FROM-INDEX ((node standard-node) index &optional key value)
  • Method NODE-TRAVERSE ((node standard-node) &rest keys)
  • Class STANDARD-RELATIONSHIP
    ID   Accessor: RELATIONSHIP-ID
    PROPERTIES   Accessor: RELATIONSHIP-PROPERTIES
    TYPE   Accessor: RELATIONSHIP-TYPE
    START-ID   Accessor: %RELATIONSHIP-START-ID
    END-ID   Accessor: %RELATIONSHIP-END-ID
  • Method RELATIONSHIP-CREATE ((node1 standard-node) (node2 standard-node) type &rest keys)
  • Method RELATIONSHIP-DELETE ((relationship standard-relationship))
  • Method RELATIONSHIP-START ((relationship standard-relationship))
  • Method RELATIONSHIP-END ((relationship standard-relationship))
  • Method RELATIONSHIP-PROPERTY ((relationship standard-relationship) property)
  • Method (setf RELATIONSHIP-PROPERTY) (value (relationship standard-relationship) property)
  • Method RELATIONSHIP-ADD-TO-INDEX ((relationship standard-relationship) index key value)
  • Method RELATIONSHIP-REMOVE-FROM-INDEX ((relationship standard-relationship) index &optional key value)
  • Method RELATIONSHIP-TRAVERSE ((node standard-node) &rest keys)