The cl-neo4j Reference Manual

This is the cl-neo4j Reference Manual, version 0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:11:50 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-neo4j

neo4j RESTful Client Interface

Maintainer

Mikhail Novikov <>

Author

Kevin Raison <>

Long Description

neo4j RESTful Client Interface and higher order extensible CL wrapper for it.

Version

0.4

Dependencies
  • alexandria (system).
  • anaphora (system).
  • split-sequence (system).
  • drakma (system).
  • babel (system).
  • cl-json (system).
  • cl-ppcre (system).
Source

cl-neo4j.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-neo4j/src

Source

cl-neo4j.asd.

Parent Component

cl-neo4j (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 cl-neo4j/cl-neo4j.asd

Source

cl-neo4j.asd.

Parent Component

cl-neo4j (system).

ASDF Systems

cl-neo4j.

Packages

cl-neo4j-system.


4.1.2 cl-neo4j/src/package.lisp

Source

cl-neo4j.asd.

Parent Component

src (module).

Packages

4.1.3 cl-neo4j/src/utilities.lisp

Dependency

package.lisp (file).

Source

cl-neo4j.asd.

Parent Component

src (module).

Internals

4.1.4 cl-neo4j/src/conditions.lisp

Dependency

utilities.lisp (file).

Source

cl-neo4j.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 cl-neo4j/src/requests.lisp

Dependency

conditions.lisp (file).

Source

cl-neo4j.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.6 cl-neo4j/src/restapi.lisp

Dependency

requests.lisp (file).

Source

cl-neo4j.asd.

Parent Component

src (module).

Public Interface
Internals

list-indexes (function).


4.1.7 cl-neo4j/src/wrapper.lisp

Dependency

restapi.lisp (file).

Source

cl-neo4j.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-neo4j-system

Source

cl-neo4j.asd.

Use List
  • asdf/interface.
  • common-lisp.

5.2 cl-neo4j-wrapper

Source

package.lisp.

Use List
  • alexandria.
  • anaphora.
  • cl-neo4j.
  • common-lisp.
  • split-sequence.
Public Interface
Internals

5.3 cl-neo4j

Source

package.lisp.

Use List
  • alexandria.
  • anaphora.
  • common-lisp.
  • drakma.
  • json.
  • json-rpc.
Used By List

cl-neo4j-wrapper.

Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Special variables

Special Variable: *default-node-constructor*
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Special Variable: *default-relationship-constructor*
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Special Variable: *neo4j-host*
Package

cl-neo4j.

Source

requests.lisp.

Special Variable: *neo4j-port*
Package

cl-neo4j.

Source

requests.lisp.


6.1.2 Ordinary functions

Function: add-to-index (&key type name key value object-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: create-index (&key type name config)
Package

cl-neo4j.

Source

restapi.lisp.

Function: create-node (&key properties)
Package

cl-neo4j.

Source

restapi.lisp.

Function: create-relationship (&key node-id to-node-id relationship-type properties)
Package

cl-neo4j.

Source

restapi.lisp.

Function: del-node-properties (&key node-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: del-node-property (&key node-id property)
Package

cl-neo4j.

Source

restapi.lisp.

Function: del-relationship-properties (&key relationship-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: del-relationship-property (&key relationship-id property)
Package

cl-neo4j.

Source

restapi.lisp.

Function: delete-index (&key type name)
Package

cl-neo4j.

Source

restapi.lisp.

Function: delete-node (&key node-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: delete-relationship (&key relationship-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-node (&key node-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-node-properties (&key node-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-node-property (&key node-id property)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-node-relationships (&key node-id direction types)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-path (&key node-id to-node-id relationships max-depth algorithm)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-paths (&key node-id to-node-id relationships max-depth algorithm)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-relationship (&key relationship-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-relationship-properties (&key relationship-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-relationship-property (&key relationship-id property)
Package

cl-neo4j.

Source

restapi.lisp.

Function: get-relationships-types (&key)
Package

cl-neo4j.

Source

restapi.lisp.

Function: lookup-index (&key type name key value)
Package

cl-neo4j.

Source

restapi.lisp.

Function: node-create (&key 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.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: node-get-by-id (id &key 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*

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: node-query-index (index key value &key 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*

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: query-index (&key type name query)
Package

cl-neo4j.

Source

restapi.lisp.

Function: relationship-get-by-id (id &key constructor)

Returns relationship with given id or nil otherwise.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: relationship-query-index (index key value &key constructor)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: remove-from-index (&key type name key value object-id)
Package

cl-neo4j.

Source

restapi.lisp.

Function: set-node-properties (&key node-id properties)
Package

cl-neo4j.

Source

restapi.lisp.

Function: set-node-property (&key node-id property value)
Package

cl-neo4j.

Source

restapi.lisp.

Function: set-relationship-properties (&key relationship-id properties)
Package

cl-neo4j.

Source

restapi.lisp.

Function: set-relationship-property (&key relationship-id property value)
Package

cl-neo4j.

Source

restapi.lisp.

Function: traverse (&key node-id return-type max-depth order uniqueness relationships prune-evaluator return-filter)
Package

cl-neo4j.

Source

restapi.lisp.


6.1.3 Generic functions

Generic Function: node-add-to-index (node index key value)

Adds node to index with key and value.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: node-add-to-index ((node standard-node) index key value)
Method: node-add-to-index ((node integer) index key value)
Generic Function: node-delete (node &key cascade)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: node-delete ((node standard-node) &key cascade)
Method: node-delete ((node integer) &key cascade)
Generic Reader: node-id (object)
Package

cl-neo4j-wrapper.

Methods
Reader Method: node-id ((standard-node standard-node))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

id.

Generic Writer: (setf node-id) (object)
Package

cl-neo4j-wrapper.

Methods
Writer Method: (setf node-id) ((standard-node standard-node))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

id.

Generic Function: node-properties (node)

Returns plist of properties of the node.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Reader Method: node-properties ((standard-node standard-node))

automatically generated reader method

Target Slot

properties.

Method: node-properties ((node integer))
Generic Writer: (setf node-properties) (object)
Package

cl-neo4j-wrapper.

Methods
Writer Method: (setf node-properties) ((standard-node standard-node))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

properties.

Generic Function: node-property (node property)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: node-property ((node standard-node) property)
Method: node-property ((node integer) property)
Generic Function: (setf node-property) (node property)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: (setf node-property) ((node standard-node) property)
Method: (setf node-property) ((node integer) property)
Generic Function: node-relationships (node &key types direction constructor)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: node-relationships ((node standard-node) &key types direction)
Method: node-relationships ((node integer) &key constructor types direction)
Generic Function: node-remove-from-index (node index &optional key value)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: node-remove-from-index ((node standard-node) index &optional key value)
Method: node-remove-from-index ((node integer) index &optional key value)
Generic Function: node-traverse (node &key order uniqueness relationships prune-evaluator return-filter max-depth constructor &allow-other-keys)
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: node-traverse ((node standard-node) &rest keys)
Method: node-traverse ((node integer) &rest keys &key constructor &allow-other-keys)
Generic Function: relationship-add-to-index (relationship index key value)

Adds Relationship to index with key and value.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-add-to-index ((relationship standard-relationship) index key value)
Method: relationship-add-to-index ((relationship integer) index key value)
Generic Function: relationship-create (node1 node2 type &key properties direction initial-indexes constructor)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-create ((node1 standard-node) (node2 standard-node) type &rest keys)
Method: relationship-create ((node1 integer) (node2 integer) type &key constructor properties direction initial-indexes)
Generic Function: relationship-delete (relationship)

Deletes a relationship.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-delete ((relationship standard-relationship))
Method: relationship-delete ((relationship integer))
Generic Function: relationship-end (relationship)

Returns end node of relationship.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-end ((relationship standard-relationship))
Method: relationship-end ((relationship integer))
Generic Reader: relationship-id (object)
Package

cl-neo4j-wrapper.

Methods
Reader Method: relationship-id ((standard-relationship standard-relationship))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

id.

Generic Writer: (setf relationship-id) (object)
Package

cl-neo4j-wrapper.

Methods
Writer Method: (setf relationship-id) ((standard-relationship standard-relationship))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

id.

Generic Function: relationship-properties (relationship)

Returns plist of relationship properties.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Reader Method: relationship-properties ((standard-relationship standard-relationship))

automatically generated reader method

Target Slot

properties.

Method: relationship-properties ((relationship integer))
Generic Writer: (setf relationship-properties) (object)
Package

cl-neo4j-wrapper.

Methods
Writer Method: (setf relationship-properties) ((standard-relationship standard-relationship))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

properties.

Generic Function: relationship-property (relationship property)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-property ((relationship standard-relationship) property)
Method: relationship-property ((relationship integer) property)
Generic Function: (setf relationship-property) (relationship property)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: (setf relationship-property) ((relationship standard-relationship) property)
Method: (setf relationship-property) ((relationship integer) property)
Generic Function: relationship-remove-from-index (relationship index &optional key value)

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

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-remove-from-index ((relationship standard-relationship) index &optional key value)
Method: relationship-remove-from-index ((relationship integer) index &optional key value)
Generic Function: relationship-start (relationship)

Returns start node of relationship.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-start ((relationship standard-relationship))
Method: relationship-start ((relationship integer))
Generic Function: relationship-traverse (node &key order uniqueness relationships prune-evaluator return-filter max-depth constructor &allow-other-keys)
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Method: relationship-traverse ((node standard-node) &rest keys)
Method: relationship-traverse ((node integer) &rest keys &key constructor &allow-other-keys)
Generic Function: relationship-type (relationship)

Returns type of the relationship.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Methods
Reader Method: relationship-type ((standard-relationship standard-relationship))

automatically generated reader method

Target Slot

type.

Method: relationship-type ((relationship integer))
Generic Writer: (setf relationship-type) (object)
Package

cl-neo4j-wrapper.

Methods
Writer Method: (setf relationship-type) ((standard-relationship standard-relationship))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

type.


6.1.4 Standalone methods

Method: print-object ((object standard-node) stream)
Source

wrapper.lisp.

Method: print-object ((object standard-relationship) stream)
Source

wrapper.lisp.


6.1.5 Conditions

Condition: index-entry-not-found-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Condition: index-not-found-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Condition: invalid-data-sent-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: json
Initargs

:json

Readers

json.

Writers

(setf json).

Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Condition: node-not-found-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Slot: property
Initargs

:property

Readers

property.

Writers

(setf property).

Condition: path-not-found-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Condition: property-not-found-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Condition: relationship-not-found-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Slot: property
Initargs

:property

Readers

property.

Writers

(setf property).

Condition: unable-to-delete-node-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Condition: unknown-return-type-error
Package

cl-neo4j.

Source

conditions.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: uri
Initargs

:uri

Readers

uri.

Writers

(setf uri).

Slot: property
Initargs

:property

Readers

property.

Writers

(setf property).

Slot: status
Initargs

:status

Readers

status.

Writers

(setf status).


6.1.6 Classes

Class: standard-node
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

node-id.

Writers

(setf node-id).

Slot: properties
Initargs

:properties

Readers

node-properties.

Writers

(setf node-properties).

Class: standard-relationship
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

relationship-id.

Writers

(setf relationship-id).

Slot: properties
Initargs

:properties

Readers

relationship-properties.

Writers

(setf relationship-properties).

Slot: type
Package

common-lisp.

Initargs

:type

Readers

relationship-type.

Writers

(setf relationship-type).

Slot: start-id
Initargs

:start

Readers

%relationship-start-id.

Writers

(setf %relationship-start-id).

Slot: end-id
Initargs

:end

Readers

%relationship-end-id.

Writers

(setf %relationship-end-id).


6.2 Internals


6.2.1 Special variables

Special Variable: *default-request-handler*
Package

cl-neo4j.

Source

requests.lisp.


6.2.2 Macros

Macro: def-neo4j-fun (name lambda-list method &rest args)
Package

cl-neo4j.

Source

requests.lisp.

Macro: with-neo4j-database ((host port) &rest body)
Package

cl-neo4j.

Source

requests.lisp.

Macro: with-request-handler (handler &body body)
Package

cl-neo4j.

Source

requests.lisp.


6.2.3 Ordinary functions

Function: %make-neo4j-request (&key method uri payload)
Package

cl-neo4j.

Source

requests.lisp.

Function: basic-handler (&key host port)
Package

cl-neo4j.

Source

requests.lisp.

Function: copy-neo4j-request (instance)
Package

cl-neo4j.

Source

requests.lisp.

Function: decode-neo4j-json-output (json)
Package

cl-neo4j.

Source

utilities.lisp.

Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: format-neo4j-query (host port resource &key db-postfix)
Package

cl-neo4j.

Source

utilities.lisp.

Function: list-indexes (&key type)
Package

cl-neo4j.

Source

restapi.lisp.

Function: make-neo4j-request (method uri payload error-handlers &key request-handler)
Package

cl-neo4j.

Source

requests.lisp.

Function: make-standard-node (alist)
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: make-standard-relationship (alist)
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Function: neo4j-request-p (object)
Package

cl-neo4j.

Source

requests.lisp.

Function: normalize-alist (alist)
Package

cl-neo4j-wrapper.

Source

wrapper.lisp.

Reader: request-method (instance)
Writer: (setf request-method) (instance)
Package

cl-neo4j.

Source

requests.lisp.

Target Slot

method.

Reader: request-payload (instance)
Writer: (setf request-payload) (instance)
Package

cl-neo4j.

Source

requests.lisp.

Target Slot

payload.

Reader: request-uri (instance)
Writer: (setf request-uri) (instance)
Package

cl-neo4j.

Source

requests.lisp.

Target Slot

uri.

Function: urlencode (string)
Package

cl-neo4j.

Source

utilities.lisp.


6.2.4 Generic functions

Generic Reader: %relationship-end-id (object)
Package

cl-neo4j-wrapper.

Methods
Reader Method: %relationship-end-id ((standard-relationship standard-relationship))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

end-id.

Generic Writer: (setf %relationship-end-id) (object)
Package

cl-neo4j-wrapper.

Methods
Writer Method: (setf %relationship-end-id) ((standard-relationship standard-relationship))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

end-id.

Generic Reader: %relationship-start-id (object)
Package

cl-neo4j-wrapper.

Methods
Reader Method: %relationship-start-id ((standard-relationship standard-relationship))

automatically generated reader method

Source

wrapper.lisp.

Target Slot

start-id.

Generic Writer: (setf %relationship-start-id) (object)
Package

cl-neo4j-wrapper.

Methods
Writer Method: (setf %relationship-start-id) ((standard-relationship standard-relationship))

automatically generated writer method

Source

wrapper.lisp.

Target Slot

start-id.

Generic Function: close-handler (handler)

Closes the handler. Handler should do finalization operarions - batch handler sends the request at this point.

Package

cl-neo4j.

Source

requests.lisp.

Methods
Method: close-handler ((handler basic-handler))
Generic Function: encode-neo4j-json-payload (object encode-type &key host port)
Package

cl-neo4j.

Source

utilities.lisp.

Methods
Method: encode-neo4j-json-payload (object (encode-type (eql :relationship)) &key)
Method: encode-neo4j-json-payload (object (encode-type (eql :object)) &key)
Method: encode-neo4j-json-payload (object (encode-type (eql :relationship-url-single)) &key host port)
Method: encode-neo4j-json-payload (object (encode-type (eql :relationship-url)) &key host port)
Method: encode-neo4j-json-payload (object (encode-type (eql :node-url-single)) &key host port)
Method: encode-neo4j-json-payload (object (encode-type (eql :node-url)) &key host port)
Method: encode-neo4j-json-payload (object encode-type &key)
Generic Function: handle-request (handler request error-handlers)

Main interface for the handlers, make-neo4j-request uses it.

Package

cl-neo4j.

Source

requests.lisp.

Methods
Method: handle-request ((handler basic-handler) request error-handlers)
Method: handle-request ((handler symbol) request error-handlers)
Generic Reader: handler-host (object)
Package

cl-neo4j.

Methods
Reader Method: handler-host ((basic-handler basic-handler))

automatically generated reader method

Source

requests.lisp.

Target Slot

host.

Generic Writer: (setf handler-host) (object)
Package

cl-neo4j.

Methods
Writer Method: (setf handler-host) ((basic-handler basic-handler))

automatically generated writer method

Source

requests.lisp.

Target Slot

host.

Generic Reader: handler-port (object)
Package

cl-neo4j.

Methods
Reader Method: handler-port ((basic-handler basic-handler))

automatically generated reader method

Source

requests.lisp.

Target Slot

port.

Generic Writer: (setf handler-port) (object)
Package

cl-neo4j.

Methods
Writer Method: (setf handler-port) ((basic-handler basic-handler))

automatically generated writer method

Source

requests.lisp.

Target Slot

port.

Generic Reader: json (condition)
Generic Writer: (setf json) (condition)
Package

cl-neo4j.

Methods
Reader Method: json ((condition invalid-data-sent-error))
Writer Method: (setf json) ((condition invalid-data-sent-error))
Source

conditions.lisp.

Target Slot

json.

Generic Reader: property (condition)
Generic Writer: (setf property) (condition)
Package

cl-neo4j.

Methods
Reader Method: property ((condition relationship-not-found-error))
Writer Method: (setf property) ((condition relationship-not-found-error))
Source

conditions.lisp.

Target Slot

property.

Reader Method: property ((condition node-not-found-error))
Writer Method: (setf property) ((condition node-not-found-error))
Source

conditions.lisp.

Target Slot

property.

Reader Method: property ((condition unknown-return-type-error))
Writer Method: (setf property) ((condition unknown-return-type-error))
Source

conditions.lisp.

Target Slot

property.

Generic Function: send-request (handler request)

Governs how handler sends the request.

Package

cl-neo4j.

Source

requests.lisp.

Methods
Method: send-request ((handler basic-handler) request)
Generic Reader: status (condition)
Generic Writer: (setf status) (condition)
Package

cl-neo4j.

Methods
Reader Method: status ((condition unknown-return-type-error))
Writer Method: (setf status) ((condition unknown-return-type-error))
Source

conditions.lisp.

Target Slot

status.

Generic Reader: uri (condition)
Generic Writer: (setf uri) (condition)
Package

cl-neo4j.

Methods
Reader Method: uri ((condition path-not-found-error))
Writer Method: (setf uri) ((condition path-not-found-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition index-entry-not-found-error))
Writer Method: (setf uri) ((condition index-entry-not-found-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition index-not-found-error))
Writer Method: (setf uri) ((condition index-not-found-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition property-not-found-error))
Writer Method: (setf uri) ((condition property-not-found-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition relationship-not-found-error))
Writer Method: (setf uri) ((condition relationship-not-found-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition unable-to-delete-node-error))
Writer Method: (setf uri) ((condition unable-to-delete-node-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition node-not-found-error))
Writer Method: (setf uri) ((condition node-not-found-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition invalid-data-sent-error))
Writer Method: (setf uri) ((condition invalid-data-sent-error))
Source

conditions.lisp.

Target Slot

uri.

Reader Method: uri ((condition unknown-return-type-error))
Writer Method: (setf uri) ((condition unknown-return-type-error))
Source

conditions.lisp.

Target Slot

uri.


6.2.5 Structures

Structure: neo4j-request
Package

cl-neo4j.

Source

requests.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: method
Package

common-lisp.

Readers

request-method.

Writers

(setf request-method).

Slot: uri
Readers

request-uri.

Writers

(setf request-uri).

Slot: payload
Readers

request-payload.

Writers

(setf request-payload).


6.2.6 Classes

Class: basic-handler

Basic handler that just sends request to the database.

Package

cl-neo4j.

Source

requests.lisp.

Direct methods
Direct slots
Slot: host
Initargs

:host

Readers

handler-host.

Writers

(setf handler-host).

Slot: port
Initargs

:port

Readers

handler-port.

Writers

(setf handler-port).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   J   L   M   N   P   Q   R   S   T   U   W  
Index Entry  Section

%
%make-neo4j-request: Private ordinary functions
%relationship-end-id: Private generic functions
%relationship-end-id: Private generic functions
%relationship-start-id: Private generic functions
%relationship-start-id: Private generic functions

(
(setf %relationship-end-id): Private generic functions
(setf %relationship-end-id): Private generic functions
(setf %relationship-start-id): Private generic functions
(setf %relationship-start-id): Private generic functions
(setf handler-host): Private generic functions
(setf handler-host): Private generic functions
(setf handler-port): Private generic functions
(setf handler-port): Private generic functions
(setf json): Private generic functions
(setf json): Private generic functions
(setf node-id): Public generic functions
(setf node-id): Public generic functions
(setf node-properties): Public generic functions
(setf node-properties): Public generic functions
(setf node-property): Public generic functions
(setf node-property): Public generic functions
(setf node-property): Public generic functions
(setf property): Private generic functions
(setf property): Private generic functions
(setf property): Private generic functions
(setf property): Private generic functions
(setf relationship-id): Public generic functions
(setf relationship-id): Public generic functions
(setf relationship-properties): Public generic functions
(setf relationship-properties): Public generic functions
(setf relationship-property): Public generic functions
(setf relationship-property): Public generic functions
(setf relationship-property): Public generic functions
(setf relationship-type): Public generic functions
(setf relationship-type): Public generic functions
(setf request-method): Private ordinary functions
(setf request-payload): Private ordinary functions
(setf request-uri): Private ordinary functions
(setf status): Private generic functions
(setf status): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions
(setf uri): Private generic functions

A
add-to-index: Public ordinary functions

B
basic-handler: Private ordinary functions

C
close-handler: Private generic functions
close-handler: Private generic functions
copy-neo4j-request: Private ordinary functions
create-index: Public ordinary functions
create-node: Public ordinary functions
create-relationship: Public ordinary functions

D
decode-neo4j-json-output: Private ordinary functions
def-neo4j-fun: Private macros
del-node-properties: Public ordinary functions
del-node-property: Public ordinary functions
del-relationship-properties: Public ordinary functions
del-relationship-property: Public ordinary functions
delete-index: Public ordinary functions
delete-node: Public ordinary functions
delete-relationship: Public ordinary functions

E
encode-neo4j-json-payload: Private generic functions
encode-neo4j-json-payload: Private generic functions
encode-neo4j-json-payload: Private generic functions
encode-neo4j-json-payload: Private generic functions
encode-neo4j-json-payload: Private generic functions
encode-neo4j-json-payload: Private generic functions
encode-neo4j-json-payload: Private generic functions
encode-neo4j-json-payload: Private generic functions
extract-id-from-link: Private ordinary functions

F
format-neo4j-query: Private ordinary functions
Function, %make-neo4j-request: Private ordinary functions
Function, (setf request-method): Private ordinary functions
Function, (setf request-payload): Private ordinary functions
Function, (setf request-uri): Private ordinary functions
Function, add-to-index: Public ordinary functions
Function, basic-handler: Private ordinary functions
Function, copy-neo4j-request: Private ordinary functions
Function, create-index: Public ordinary functions
Function, create-node: Public ordinary functions
Function, create-relationship: Public ordinary functions
Function, decode-neo4j-json-output: Private ordinary functions
Function, del-node-properties: Public ordinary functions
Function, del-node-property: Public ordinary functions
Function, del-relationship-properties: Public ordinary functions
Function, del-relationship-property: Public ordinary functions
Function, delete-index: Public ordinary functions
Function, delete-node: Public ordinary functions
Function, delete-relationship: Public ordinary functions
Function, extract-id-from-link: Private ordinary functions
Function, format-neo4j-query: Private ordinary functions
Function, get-node: Public ordinary functions
Function, get-node-properties: Public ordinary functions
Function, get-node-property: Public ordinary functions
Function, get-node-relationships: Public ordinary functions
Function, get-path: Public ordinary functions
Function, get-paths: Public ordinary functions
Function, get-relationship: Public ordinary functions
Function, get-relationship-properties: Public ordinary functions
Function, get-relationship-property: Public ordinary functions
Function, get-relationships-types: Public ordinary functions
Function, list-indexes: Private ordinary functions
Function, lookup-index: Public ordinary functions
Function, make-neo4j-request: Private ordinary functions
Function, make-standard-node: Private ordinary functions
Function, make-standard-relationship: Private ordinary functions
Function, neo4j-request-p: Private ordinary functions
Function, node-create: Public ordinary functions
Function, node-get-by-id: Public ordinary functions
Function, node-query-index: Public ordinary functions
Function, normalize-alist: Private ordinary functions
Function, query-index: Public ordinary functions
Function, relationship-get-by-id: Public ordinary functions
Function, relationship-query-index: Public ordinary functions
Function, remove-from-index: Public ordinary functions
Function, request-method: Private ordinary functions
Function, request-payload: Private ordinary functions
Function, request-uri: Private ordinary functions
Function, set-node-properties: Public ordinary functions
Function, set-node-property: Public ordinary functions
Function, set-relationship-properties: Public ordinary functions
Function, set-relationship-property: Public ordinary functions
Function, traverse: Public ordinary functions
Function, urlencode: Private ordinary functions

G
Generic Function, %relationship-end-id: Private generic functions
Generic Function, %relationship-start-id: Private generic functions
Generic Function, (setf %relationship-end-id): Private generic functions
Generic Function, (setf %relationship-start-id): Private generic functions
Generic Function, (setf handler-host): Private generic functions
Generic Function, (setf handler-port): Private generic functions
Generic Function, (setf json): Private generic functions
Generic Function, (setf node-id): Public generic functions
Generic Function, (setf node-properties): Public generic functions
Generic Function, (setf node-property): Public generic functions
Generic Function, (setf property): Private generic functions
Generic Function, (setf relationship-id): Public generic functions
Generic Function, (setf relationship-properties): Public generic functions
Generic Function, (setf relationship-property): Public generic functions
Generic Function, (setf relationship-type): Public generic functions
Generic Function, (setf status): Private generic functions
Generic Function, (setf uri): Private generic functions
Generic Function, close-handler: Private generic functions
Generic Function, encode-neo4j-json-payload: Private generic functions
Generic Function, handle-request: Private generic functions
Generic Function, handler-host: Private generic functions
Generic Function, handler-port: Private generic functions
Generic Function, json: Private generic functions
Generic Function, node-add-to-index: Public generic functions
Generic Function, node-delete: Public generic functions
Generic Function, node-id: Public generic functions
Generic Function, node-properties: Public generic functions
Generic Function, node-property: Public generic functions
Generic Function, node-relationships: Public generic functions
Generic Function, node-remove-from-index: Public generic functions
Generic Function, node-traverse: Public generic functions
Generic Function, property: Private generic functions
Generic Function, relationship-add-to-index: Public generic functions
Generic Function, relationship-create: Public generic functions
Generic Function, relationship-delete: Public generic functions
Generic Function, relationship-end: Public generic functions
Generic Function, relationship-id: Public generic functions
Generic Function, relationship-properties: Public generic functions
Generic Function, relationship-property: Public generic functions
Generic Function, relationship-remove-from-index: Public generic functions
Generic Function, relationship-start: Public generic functions
Generic Function, relationship-traverse: Public generic functions
Generic Function, relationship-type: Public generic functions
Generic Function, send-request: Private generic functions
Generic Function, status: Private generic functions
Generic Function, uri: Private generic functions
get-node: Public ordinary functions
get-node-properties: Public ordinary functions
get-node-property: Public ordinary functions
get-node-relationships: Public ordinary functions
get-path: Public ordinary functions
get-paths: Public ordinary functions
get-relationship: Public ordinary functions
get-relationship-properties: Public ordinary functions
get-relationship-property: Public ordinary functions
get-relationships-types: Public ordinary functions

H
handle-request: Private generic functions
handle-request: Private generic functions
handle-request: Private generic functions
handler-host: Private generic functions
handler-host: Private generic functions
handler-port: Private generic functions
handler-port: Private generic functions

J
json: Private generic functions
json: Private generic functions

L
list-indexes: Private ordinary functions
lookup-index: Public ordinary functions

M
Macro, def-neo4j-fun: Private macros
Macro, with-neo4j-database: Private macros
Macro, with-request-handler: Private macros
make-neo4j-request: Private ordinary functions
make-standard-node: Private ordinary functions
make-standard-relationship: Private ordinary functions
Method, %relationship-end-id: Private generic functions
Method, %relationship-start-id: Private generic functions
Method, (setf %relationship-end-id): Private generic functions
Method, (setf %relationship-start-id): Private generic functions
Method, (setf handler-host): Private generic functions
Method, (setf handler-port): Private generic functions
Method, (setf json): Private generic functions
Method, (setf node-id): Public generic functions
Method, (setf node-properties): Public generic functions
Method, (setf node-property): Public generic functions
Method, (setf node-property): Public generic functions
Method, (setf property): Private generic functions
Method, (setf property): Private generic functions
Method, (setf property): Private generic functions
Method, (setf relationship-id): Public generic functions
Method, (setf relationship-properties): Public generic functions
Method, (setf relationship-property): Public generic functions
Method, (setf relationship-property): Public generic functions
Method, (setf relationship-type): Public generic functions
Method, (setf status): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, (setf uri): Private generic functions
Method, close-handler: Private generic functions
Method, encode-neo4j-json-payload: Private generic functions
Method, encode-neo4j-json-payload: Private generic functions
Method, encode-neo4j-json-payload: Private generic functions
Method, encode-neo4j-json-payload: Private generic functions
Method, encode-neo4j-json-payload: Private generic functions
Method, encode-neo4j-json-payload: Private generic functions
Method, encode-neo4j-json-payload: Private generic functions
Method, handle-request: Private generic functions
Method, handle-request: Private generic functions
Method, handler-host: Private generic functions
Method, handler-port: Private generic functions
Method, json: Private generic functions
Method, node-add-to-index: Public generic functions
Method, node-add-to-index: Public generic functions
Method, node-delete: Public generic functions
Method, node-delete: Public generic functions
Method, node-id: Public generic functions
Method, node-properties: Public generic functions
Method, node-properties: Public generic functions
Method, node-property: Public generic functions
Method, node-property: Public generic functions
Method, node-relationships: Public generic functions
Method, node-relationships: Public generic functions
Method, node-remove-from-index: Public generic functions
Method, node-remove-from-index: Public generic functions
Method, node-traverse: Public generic functions
Method, node-traverse: Public generic functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, property: Private generic functions
Method, property: Private generic functions
Method, property: Private generic functions
Method, relationship-add-to-index: Public generic functions
Method, relationship-add-to-index: Public generic functions
Method, relationship-create: Public generic functions
Method, relationship-create: Public generic functions
Method, relationship-delete: Public generic functions
Method, relationship-delete: Public generic functions
Method, relationship-end: Public generic functions
Method, relationship-end: Public generic functions
Method, relationship-id: Public generic functions
Method, relationship-properties: Public generic functions
Method, relationship-properties: Public generic functions
Method, relationship-property: Public generic functions
Method, relationship-property: Public generic functions
Method, relationship-remove-from-index: Public generic functions
Method, relationship-remove-from-index: Public generic functions
Method, relationship-start: Public generic functions
Method, relationship-start: Public generic functions
Method, relationship-traverse: Public generic functions
Method, relationship-traverse: Public generic functions
Method, relationship-type: Public generic functions
Method, relationship-type: Public generic functions
Method, send-request: Private generic functions
Method, status: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions
Method, uri: Private generic functions

N
neo4j-request-p: Private ordinary functions
node-add-to-index: Public generic functions
node-add-to-index: Public generic functions
node-add-to-index: Public generic functions
node-create: Public ordinary functions
node-delete: Public generic functions
node-delete: Public generic functions
node-delete: Public generic functions
node-get-by-id: Public ordinary functions
node-id: Public generic functions
node-id: Public generic functions
node-properties: Public generic functions
node-properties: Public generic functions
node-properties: Public generic functions
node-property: Public generic functions
node-property: Public generic functions
node-property: Public generic functions
node-query-index: Public ordinary functions
node-relationships: Public generic functions
node-relationships: Public generic functions
node-relationships: Public generic functions
node-remove-from-index: Public generic functions
node-remove-from-index: Public generic functions
node-remove-from-index: Public generic functions
node-traverse: Public generic functions
node-traverse: Public generic functions
node-traverse: Public generic functions
normalize-alist: Private ordinary functions

P
print-object: Public standalone methods
print-object: Public standalone methods
property: Private generic functions
property: Private generic functions
property: Private generic functions
property: Private generic functions

Q
query-index: Public ordinary functions

R
relationship-add-to-index: Public generic functions
relationship-add-to-index: Public generic functions
relationship-add-to-index: Public generic functions
relationship-create: Public generic functions
relationship-create: Public generic functions
relationship-create: Public generic functions
relationship-delete: Public generic functions
relationship-delete: Public generic functions
relationship-delete: Public generic functions
relationship-end: Public generic functions
relationship-end: Public generic functions
relationship-end: Public generic functions
relationship-get-by-id: Public ordinary functions
relationship-id: Public generic functions
relationship-id: Public generic functions
relationship-properties: Public generic functions
relationship-properties: Public generic functions
relationship-properties: Public generic functions
relationship-property: Public generic functions
relationship-property: Public generic functions
relationship-property: Public generic functions
relationship-query-index: Public ordinary functions
relationship-remove-from-index: Public generic functions
relationship-remove-from-index: Public generic functions
relationship-remove-from-index: Public generic functions
relationship-start: Public generic functions
relationship-start: Public generic functions
relationship-start: Public generic functions
relationship-traverse: Public generic functions
relationship-traverse: Public generic functions
relationship-traverse: Public generic functions
relationship-type: Public generic functions
relationship-type: Public generic functions
relationship-type: Public generic functions
remove-from-index: Public ordinary functions
request-method: Private ordinary functions
request-payload: Private ordinary functions
request-uri: Private ordinary functions

S
send-request: Private generic functions
send-request: Private generic functions
set-node-properties: Public ordinary functions
set-node-property: Public ordinary functions
set-relationship-properties: Public ordinary functions
set-relationship-property: Public ordinary functions
status: Private generic functions
status: Private generic functions

T
traverse: Public ordinary functions

U
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
uri: Private generic functions
urlencode: Private ordinary functions

W
with-neo4j-database: Private macros
with-request-handler: Private macros


A.3 Variables

Jump to:   *  
E   H   I   J   M   P   S   T   U  
Index Entry  Section

*
*default-node-constructor*: Public special variables
*default-relationship-constructor*: Public special variables
*default-request-handler*: Private special variables
*neo4j-host*: Public special variables
*neo4j-port*: Public special variables

E
end-id: Public classes

H
host: Private classes

I
id: Public classes
id: Public classes

J
json: Public conditions

M
method: Private structures

P
payload: Private structures
port: Private classes
properties: Public classes
properties: Public classes
property: Public conditions
property: Public conditions
property: Public conditions

S
Slot, end-id: Public classes
Slot, host: Private classes
Slot, id: Public classes
Slot, id: Public classes
Slot, json: Public conditions
Slot, method: Private structures
Slot, payload: Private structures
Slot, port: Private classes
Slot, properties: Public classes
Slot, properties: Public classes
Slot, property: Public conditions
Slot, property: Public conditions
Slot, property: Public conditions
Slot, start-id: Public classes
Slot, status: Public conditions
Slot, type: Public classes
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Public conditions
Slot, uri: Private structures
Special Variable, *default-node-constructor*: Public special variables
Special Variable, *default-relationship-constructor*: Public special variables
Special Variable, *default-request-handler*: Private special variables
Special Variable, *neo4j-host*: Public special variables
Special Variable, *neo4j-port*: Public special variables
start-id: Public classes
status: Public conditions

T
type: Public classes

U
uri: Public conditions
uri: Public conditions
uri: Public conditions
uri: Public conditions
uri: Public conditions
uri: Public conditions
uri: Public conditions
uri: Public conditions
uri: Public conditions
uri: Private structures


A.4 Data types

Jump to:   B   C   F   I   M   N   P   R   S   U   W  
Index Entry  Section

B
basic-handler: Private classes

C
cl-neo4j: The cl-neo4j system
cl-neo4j: The cl-neo4j package
cl-neo4j-system: The cl-neo4j-system package
cl-neo4j-wrapper: The cl-neo4j-wrapper package
cl-neo4j.asd: The cl-neo4j/cl-neo4j․asd file
Class, basic-handler: Private classes
Class, standard-node: Public classes
Class, standard-relationship: Public classes
Condition, index-entry-not-found-error: Public conditions
Condition, index-not-found-error: Public conditions
Condition, invalid-data-sent-error: Public conditions
Condition, node-not-found-error: Public conditions
Condition, path-not-found-error: Public conditions
Condition, property-not-found-error: Public conditions
Condition, relationship-not-found-error: Public conditions
Condition, unable-to-delete-node-error: Public conditions
Condition, unknown-return-type-error: Public conditions
conditions.lisp: The cl-neo4j/src/conditions․lisp file

F
File, cl-neo4j.asd: The cl-neo4j/cl-neo4j․asd file
File, conditions.lisp: The cl-neo4j/src/conditions․lisp file
File, package.lisp: The cl-neo4j/src/package․lisp file
File, requests.lisp: The cl-neo4j/src/requests․lisp file
File, restapi.lisp: The cl-neo4j/src/restapi․lisp file
File, utilities.lisp: The cl-neo4j/src/utilities․lisp file
File, wrapper.lisp: The cl-neo4j/src/wrapper․lisp file

I
index-entry-not-found-error: Public conditions
index-not-found-error: Public conditions
invalid-data-sent-error: Public conditions

M
Module, src: The cl-neo4j/src module

N
neo4j-request: Private structures
node-not-found-error: Public conditions

P
Package, cl-neo4j: The cl-neo4j package
Package, cl-neo4j-system: The cl-neo4j-system package
Package, cl-neo4j-wrapper: The cl-neo4j-wrapper package
package.lisp: The cl-neo4j/src/package․lisp file
path-not-found-error: Public conditions
property-not-found-error: Public conditions

R
relationship-not-found-error: Public conditions
requests.lisp: The cl-neo4j/src/requests․lisp file
restapi.lisp: The cl-neo4j/src/restapi․lisp file

S
src: The cl-neo4j/src module
standard-node: Public classes
standard-relationship: Public classes
Structure, neo4j-request: Private structures
System, cl-neo4j: The cl-neo4j system

U
unable-to-delete-node-error: Public conditions
unknown-return-type-error: Public conditions
utilities.lisp: The cl-neo4j/src/utilities․lisp file

W
wrapper.lisp: The cl-neo4j/src/wrapper․lisp file