This is the cl-neo4j Reference Manual, version 0.4, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:29:55 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-neo4jneo4j RESTful Client Interface
Mikhail Novikov <freiksenet@gmail.com>
Kevin Raison <last name @ chatsubo dot net>
neo4j RESTful Client Interface and higher order extensible CL wrapper for it.
0.4
alexandria (system).
anaphora (system).
split-sequence (system).
drakma (system).
babel (system).
cl-json (system).
cl-ppcre (system).
src (module).
Modules are listed depth-first from the system components tree.
cl-neo4j/srccl-neo4j (system).
package.lisp (file).
utilities.lisp (file).
conditions.lisp (file).
requests.lisp (file).
restapi.lisp (file).
wrapper.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-neo4j/cl-neo4j.asdcl-neo4j/src/package.lispcl-neo4j/src/utilities.lispcl-neo4j/src/conditions.lispcl-neo4j/src/requests.lispcl-neo4j/src/restapi.lispcl-neo4j/src/wrapper.lispcl-neo4j/src/utilities.lisppackage.lisp (file).
src (module).
decode-neo4j-json-output (function).
encode-neo4j-json-payload (generic function).
format-neo4j-query (function).
urlencode (function).
cl-neo4j/src/conditions.lisputilities.lisp (file).
src (module).
index-entry-not-found-error (condition).
index-not-found-error (condition).
invalid-data-sent-error (condition).
node-not-found-error (condition).
path-not-found-error (condition).
property-not-found-error (condition).
relationship-not-found-error (condition).
unable-to-delete-node-error (condition).
unknown-return-type-error (condition).
json (reader method).
(setf json) (writer method).
property (reader method).
property (reader method).
property (reader method).
(setf property) (writer method).
(setf property) (writer method).
(setf property) (writer method).
status (reader method).
(setf status) (writer method).
uri (reader method).
uri (reader method).
uri (reader method).
uri (reader method).
uri (reader method).
uri (reader method).
uri (reader method).
uri (reader method).
uri (reader method).
(setf uri) (writer method).
(setf uri) (writer method).
(setf uri) (writer method).
(setf uri) (writer method).
(setf uri) (writer method).
(setf uri) (writer method).
(setf uri) (writer method).
(setf uri) (writer method).
(setf uri) (writer method).
cl-neo4j/src/requests.lispconditions.lisp (file).
src (module).
*neo4j-host* (special variable).
*neo4j-port* (special variable).
%make-neo4j-request (function).
*default-request-handler* (special variable).
basic-handler (function).
basic-handler (class).
close-handler (generic function).
copy-neo4j-request (function).
def-neo4j-fun (macro).
handle-request (generic function).
handler-host (reader method).
(setf handler-host) (writer method).
handler-port (reader method).
(setf handler-port) (writer method).
make-neo4j-request (function).
neo4j-request (structure).
neo4j-request-p (function).
request-method (reader).
(setf request-method) (writer).
request-payload (reader).
(setf request-payload) (writer).
request-uri (reader).
(setf request-uri) (writer).
send-request (generic function).
with-neo4j-database (macro).
with-request-handler (macro).
cl-neo4j/src/restapi.lisprequests.lisp (file).
src (module).
add-to-index (function).
create-index (function).
create-node (function).
create-relationship (function).
del-node-properties (function).
del-node-property (function).
del-relationship-properties (function).
del-relationship-property (function).
delete-index (function).
delete-node (function).
delete-relationship (function).
get-node (function).
get-node-properties (function).
get-node-property (function).
get-node-relationships (function).
get-path (function).
get-paths (function).
get-relationship (function).
get-relationship-properties (function).
get-relationship-property (function).
get-relationships-types (function).
lookup-index (function).
query-index (function).
remove-from-index (function).
set-node-properties (function).
set-node-property (function).
set-relationship-properties (function).
set-relationship-property (function).
traverse (function).
list-indexes (function).
cl-neo4j/src/wrapper.lisprestapi.lisp (file).
src (module).
*default-node-constructor* (special variable).
*default-relationship-constructor* (special variable).
node-add-to-index (generic function).
node-create (function).
node-delete (generic function).
node-get-by-id (function).
node-id (reader method).
(setf node-id) (writer method).
node-properties (generic function).
(setf node-properties) (writer method).
node-property (generic function).
(setf node-property) (generic function).
node-query-index (function).
node-relationships (generic function).
node-remove-from-index (generic function).
node-traverse (generic function).
print-object (method).
print-object (method).
relationship-add-to-index (generic function).
relationship-create (generic function).
relationship-delete (generic function).
relationship-end (generic function).
relationship-get-by-id (function).
relationship-id (reader method).
(setf relationship-id) (writer method).
relationship-properties (generic function).
(setf relationship-properties) (writer method).
relationship-property (generic function).
(setf relationship-property) (generic function).
relationship-query-index (function).
relationship-remove-from-index (generic function).
relationship-start (generic function).
relationship-traverse (generic function).
relationship-type (generic function).
(setf relationship-type) (writer method).
standard-node (class).
standard-relationship (class).
%relationship-end-id (reader method).
(setf %relationship-end-id) (writer method).
%relationship-start-id (reader method).
(setf %relationship-start-id) (writer method).
extract-id-from-link (function).
make-standard-node (function).
make-standard-relationship (function).
normalize-alist (function).
Packages are listed by definition order.
cl-neo4j-wrapperalexandria.
anaphora.
cl-neo4j.
common-lisp.
split-sequence.
*default-node-constructor* (special variable).
*default-relationship-constructor* (special variable).
node-add-to-index (generic function).
node-create (function).
node-delete (generic function).
node-get-by-id (function).
node-id (generic reader).
(setf node-id) (generic writer).
node-properties (generic function).
(setf node-properties) (generic writer).
node-property (generic function).
(setf node-property) (generic function).
node-query-index (function).
node-relationships (generic function).
node-remove-from-index (generic function).
node-traverse (generic function).
relationship-add-to-index (generic function).
relationship-create (generic function).
relationship-delete (generic function).
relationship-end (generic function).
relationship-get-by-id (function).
relationship-id (generic reader).
(setf relationship-id) (generic writer).
relationship-properties (generic function).
(setf relationship-properties) (generic writer).
relationship-property (generic function).
(setf relationship-property) (generic function).
relationship-query-index (function).
relationship-remove-from-index (generic function).
relationship-start (generic function).
relationship-traverse (generic function).
relationship-type (generic function).
(setf relationship-type) (generic writer).
standard-node (class).
standard-relationship (class).
%relationship-end-id (generic reader).
(setf %relationship-end-id) (generic writer).
%relationship-start-id (generic reader).
(setf %relationship-start-id) (generic writer).
extract-id-from-link (function).
make-standard-node (function).
make-standard-relationship (function).
normalize-alist (function).
cl-neo4jalexandria.
anaphora.
common-lisp.
drakma.
json.
json-rpc.
*neo4j-host* (special variable).
*neo4j-port* (special variable).
add-to-index (function).
create-index (function).
create-node (function).
create-relationship (function).
del-node-properties (function).
del-node-property (function).
del-relationship-properties (function).
del-relationship-property (function).
delete-index (function).
delete-node (function).
delete-relationship (function).
get-node (function).
get-node-properties (function).
get-node-property (function).
get-node-relationships (function).
get-path (function).
get-paths (function).
get-relationship (function).
get-relationship-properties (function).
get-relationship-property (function).
get-relationships-types (function).
index-entry-not-found-error (condition).
index-not-found-error (condition).
invalid-data-sent-error (condition).
lookup-index (function).
node-not-found-error (condition).
path-not-found-error (condition).
property-not-found-error (condition).
query-index (function).
relationship-not-found-error (condition).
remove-from-index (function).
set-node-properties (function).
set-node-property (function).
set-relationship-properties (function).
set-relationship-property (function).
traverse (function).
unable-to-delete-node-error (condition).
unknown-return-type-error (condition).
%make-neo4j-request (function).
*default-request-handler* (special variable).
basic-handler (function).
basic-handler (class).
close-handler (generic function).
copy-neo4j-request (function).
decode-neo4j-json-output (function).
def-neo4j-fun (macro).
encode-neo4j-json-payload (generic function).
format-neo4j-query (function).
handle-request (generic function).
handler-host (generic reader).
(setf handler-host) (generic writer).
handler-port (generic reader).
(setf handler-port) (generic writer).
json (generic reader).
(setf json) (generic writer).
list-indexes (function).
make-neo4j-request (function).
neo4j-request (structure).
neo4j-request-p (function).
property (generic reader).
(setf property) (generic writer).
request-method (reader).
(setf request-method) (writer).
request-payload (reader).
(setf request-payload) (writer).
request-uri (reader).
(setf request-uri) (writer).
send-request (generic function).
status (generic reader).
(setf status) (generic writer).
uri (generic reader).
(setf uri) (generic writer).
urlencode (function).
with-neo4j-database (macro).
with-request-handler (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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.
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*
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*
Returns relationship with given id or nil otherwise.
Returns list of nodes in the index with key and value.
Adds node to index with key and value.
standard-node) index key value) ¶integer) index key value) ¶Deletes a node. Cascade deletes the node even if node had relationships (deleting them too).
standard-node) &key cascade) ¶integer) &key cascade) ¶standard-node)) ¶automatically generated reader method
id.
standard-node)) ¶automatically generated writer method
id.
Returns plist of properties of the node.
standard-node)) ¶automatically generated reader method
integer)) ¶standard-node)) ¶automatically generated writer method
Returns value of the property of the node. Returns nil if property is undefined.
standard-node) property) ¶integer) property) ¶Sets a value of the property of the node to value. Value of nil deletes property.
standard-node) property) ¶integer) property) ¶Returns list of node relations, optionally filtered by list of possible types and direction. This is a factory method, accepts *default-node-constructor*
standard-node) &key types direction) ¶integer) &key constructor types direction) ¶Removes node from index. Optionally removes only from index with key and value.
standard-node) index &optional key value) ¶integer) index &optional key value) ¶standard-node) &rest keys) ¶integer) &rest keys &key constructor &allow-other-keys) ¶Adds Relationship to index with key and value.
standard-relationship) index key value) ¶integer) index key value) ¶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
standard-node) (node2 standard-node) type &rest keys) ¶integer) (node2 integer) type &key constructor properties direction initial-indexes) ¶Deletes a relationship.
standard-relationship)) ¶integer)) ¶Returns end node of relationship.
standard-relationship)) ¶integer)) ¶standard-relationship)) ¶automatically generated reader method
id.
standard-relationship)) ¶automatically generated writer method
id.
Returns plist of relationship properties.
standard-relationship)) ¶automatically generated reader method
integer)) ¶standard-relationship)) ¶automatically generated writer method
Returns value of the property of the relationship. Returns nil if property is undefined.
standard-relationship) property) ¶integer) property) ¶Sets a value of the property of the relationship to value. Value of nil deletes property.
standard-relationship) property) ¶integer) property) ¶Removes relationship from index. Optionally removes only from index with key and value.
standard-relationship) index &optional key value) ¶integer) index &optional key value) ¶Returns start node of relationship.
standard-relationship)) ¶integer)) ¶standard-node) &rest keys) ¶integer) &rest keys &key constructor &allow-other-keys) ¶Returns type of the relationship.
standard-relationship)) ¶automatically generated reader method
type.
integer)) ¶standard-relationship)) ¶automatically generated writer method
type.
standard-node) stream) ¶standard-relationship) stream) ¶error.
(setf json).
json.
(setf uri).
uri.
(setf %relationship-end-id).
%relationship-end-id.
(setf %relationship-start-id).
%relationship-start-id.
print-object.
relationship-add-to-index.
relationship-delete.
relationship-end.
(setf relationship-id).
relationship-id.
(setf relationship-properties).
relationship-properties.
(setf relationship-property).
relationship-property.
relationship-remove-from-index.
relationship-start.
(setf relationship-type).
relationship-type.
:id
:properties
common-lisp.
:type
:start
:end
uri.
standard-relationship)) ¶automatically generated reader method
standard-relationship)) ¶automatically generated writer method
standard-relationship)) ¶automatically generated reader method
standard-relationship)) ¶automatically generated writer method
Closes the handler. Handler should do finalization operarions - batch handler sends the request at this point.
basic-handler)) ¶(eql :relationship)) &key) ¶(eql :object)) &key) ¶(eql :relationship-url-single)) &key host port) ¶(eql :relationship-url)) &key host port) ¶(eql :node-url-single)) &key host port) ¶(eql :node-url)) &key host port) ¶Main interface for the handlers, make-neo4j-request uses it.
basic-handler) request error-handlers) ¶symbol) request error-handlers) ¶basic-handler)) ¶automatically generated reader method
host.
basic-handler)) ¶automatically generated writer method
host.
basic-handler)) ¶automatically generated reader method
port.
basic-handler)) ¶automatically generated writer method
port.
invalid-data-sent-error)) ¶invalid-data-sent-error)) ¶json.
relationship-not-found-error)) ¶relationship-not-found-error)) ¶node-not-found-error)) ¶node-not-found-error)) ¶unknown-return-type-error)) ¶unknown-return-type-error)) ¶Governs how handler sends the request.
basic-handler) request) ¶unknown-return-type-error)) ¶unknown-return-type-error)) ¶path-not-found-error)) ¶path-not-found-error)) ¶uri.
index-entry-not-found-error)) ¶index-entry-not-found-error)) ¶uri.
index-not-found-error)) ¶index-not-found-error)) ¶uri.
property-not-found-error)) ¶property-not-found-error)) ¶uri.
relationship-not-found-error)) ¶relationship-not-found-error)) ¶uri.
unable-to-delete-node-error)) ¶unable-to-delete-node-error)) ¶uri.
node-not-found-error)) ¶node-not-found-error)) ¶uri.
invalid-data-sent-error)) ¶invalid-data-sent-error)) ¶uri.
unknown-return-type-error)) ¶unknown-return-type-error)) ¶uri.
| Jump to: | %
(
A B C D E F G H J L M N P Q R S T U W |
|---|
| Jump to: | %
(
A B C D E F G H J L M N P Q R S T U W |
|---|
| Jump to: | *
E H I J M P S T U |
|---|
| Jump to: | *
E H I J M P S T U |
|---|
| Jump to: | B C F I M N P R S U W |
|---|
| Jump to: | B C F I M N P R S U W |
|---|