This is the neo4cl Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Mar 15 07:05:17 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
neo4cl
Basic library for interacting with Neo4J
James Fleming <james@electronic-quill.net>
Apache license 2.0
usocket
(system).
trivial-utf-8
(system).
ieee-floats
(system).
package.lisp
(file).
logging.lisp
(file).
conditions.lisp
(file).
binary-file.lisp
(file).
packstream-structures.lisp
(file).
packstream-encoding.lisp
(file).
packstream-decoding.lisp
(file).
bolt.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
neo4cl/neo4cl.asd
neo4cl/package.lisp
neo4cl/logging.lisp
neo4cl/conditions.lisp
neo4cl/binary-file.lisp
neo4cl/packstream-structures.lisp
neo4cl/packstream-encoding.lisp
neo4cl/packstream-decoding.lisp
neo4cl/bolt.lisp
neo4cl/logging.lisp
package.lisp
(file).
neo4cl
(system).
*log-stream*
(special variable).
*loglevel*
(special variable).
*loglevels*
(special variable).
log-message
(function).
make-timestamp
(function).
neo4cl/conditions.lisp
logging.lisp
(file).
neo4cl
(system).
bolt-error
(condition).
category
(reader method).
category
(reader method).
category
(reader method).
category
(reader method).
category
(reader method).
category
(reader method).
category
(reader method).
client-error
(condition).
database-error
(condition).
message
(reader method).
message
(reader method).
message
(reader method).
message
(reader method).
message
(reader method).
message
(reader method).
message
(reader method).
packstream-error
(condition).
service-error
(condition).
title
(reader method).
title
(reader method).
title
(reader method).
title
(reader method).
transient-error
(condition).
client-notification
(condition).
neo4cl/binary-file.lisp
conditions.lisp
(file).
neo4cl
(system).
int-bytes
(function).
twos-complement
(function).
twos-complement-signed
(function).
neo4cl/packstream-structures.lisp
binary-file.lisp
(file).
neo4cl
(system).
date
(class).
datetime
(class).
datetimezoneid
(class).
duration
(class).
end-node-id
(reader method).
localdatetime
(class).
localtime
(class).
node
(class).
node-id
(reader method).
node-labels
(reader method).
node-properties
(reader method).
path
(class).
point2d
(class).
point3d
(class).
relationship
(class).
relationship-id
(reader method).
relationship-properties
(reader method).
relationship-type
(reader method).
relationship-type
(reader method).
start-node-id
(reader method).
timestructure
(class).
unbound-relationship
(class).
+packstream-false+
(constant).
+packstream-null+
(constant).
+packstream-true+
(constant).
days
(reader method).
days
(reader method).
id
(reader method).
indices
(reader method).
months
(reader method).
nanoseconds
(reader method).
nanoseconds
(reader method).
nanoseconds
(reader method).
nanoseconds
(reader method).
nanoseconds
(reader method).
nanoseconds
(reader method).
nodes
(reader method).
properties
(reader method).
rels
(reader method).
seconds
(reader method).
seconds
(reader method).
seconds
(reader method).
seconds
(reader method).
srid
(reader method).
srid
(reader method).
tz-id
(reader method).
tz-offset-seconds
(reader method).
tz-offset-seconds
(reader method).
x
(reader method).
x
(reader method).
y
(reader method).
y
(reader method).
z
(reader method).
neo4cl/packstream-encoding.lisp
packstream-structures.lisp
(file).
neo4cl
(system).
alist-p
(function).
encode-alist
(function).
encode-boolean
(function).
encode-element
(generic function).
encode-float
(function).
encode-hash-table
(function).
encode-integer
(function).
encode-list
(function).
encode-null
(function).
encode-string
(function).
integer-to-bytes
(function).
vectorise-list
(function).
neo4cl/packstream-decoding.lisp
packstream-encoding.lisp
(file).
neo4cl
(system).
decode-dictionary
(function).
decode-element
(function).
decode-int
(function).
decode-list
(function).
decode-string
(function).
decode-structure
(function).
get-element-length
(function).
get-list-length
(function).
get-string-length
(function).
identify-marker
(function).
identify-structure-node
(function).
read-float
(function).
read-signed-integer
(function).
vector-to-date
(function).
vector-to-datetime
(function).
vector-to-datetimezoneid
(function).
vector-to-duration
(function).
vector-to-localdatetime
(function).
vector-to-localtime
(function).
vector-to-node
(function).
vector-to-point2d
(function).
vector-to-point3d
(function).
vector-to-relationship
(function).
vector-to-time
(function).
neo4cl/bolt.lisp
packstream-decoding.lisp
(file).
neo4cl
(system).
bolt-auth-basic
(class).
bolt-auth-none
(class).
bolt-protocol
(class).
bolt-protocol-4-3
(class).
bolt-server
(class).
bolt-session
(class).
bolt-transaction-autocommit
(generic function).
connect
(generic function).
connection
(reader method).
connection-id
(reader method).
disconnect
(generic function).
establish-bolt-session
(generic function).
hostname
(reader method).
major-version
(reader method).
major-version
(reader method).
minor-version
(reader method).
minor-version
(reader method).
neo4j-4-3-9
(class).
neo4j-version
(reader method).
(setf neo4j-version)
(writer method).
neo4j-version
(class).
port
(reader method).
+bolt-announce-protocol+
(special variable).
+bolt-begin+
(constant).
+bolt-commit+
(constant).
+bolt-discard+
(constant).
+bolt-failure+
(constant).
+bolt-goodbye+
(constant).
+bolt-hello+
(constant).
+bolt-ignored+
(constant).
+bolt-pull+
(constant).
+bolt-record+
(constant).
+bolt-reset+
(constant).
+bolt-rollback+
(constant).
+bolt-route+
(constant).
+bolt-run+
(constant).
+bolt-success+
(constant).
+bolt-termination-chunk+
(special variable).
add-auth-to-extra
(generic function).
auth-token
(reader method).
bolt-auth-token
(class).
bolt-hello
(generic function).
bolt-protocol-version
(reader method).
bolt-pull
(function).
encrypted
(reader method).
parse-autocommit-tx-response
(generic function).
parse-server-hello
(generic function).
password
(reader method).
patch-release
(reader method).
read-bolt-chunk-from-stream
(generic function).
read-bolt-message-from-stream
(generic function).
read-tx-responses
(function).
scheme
(reader method).
send-packstream
(generic function).
timeout
(reader method).
username
(reader method).
username
(reader method).
Packages are listed by definition order.
neo4cl
common-lisp
.
bolt-auth-basic
(class).
bolt-auth-none
(class).
bolt-error
(condition).
bolt-protocol
(class).
bolt-protocol-4-3
(class).
bolt-server
(class).
bolt-session
(class).
bolt-transaction-autocommit
(generic function).
category
(generic reader).
client-error
(condition).
connect
(generic function).
connection
(generic reader).
connection-id
(generic reader).
database-error
(condition).
date
(class).
datetime
(class).
datetimezoneid
(class).
disconnect
(generic function).
duration
(class).
end-node-id
(generic reader).
establish-bolt-session
(generic function).
hostname
(generic reader).
localdatetime
(class).
localtime
(class).
major-version
(generic reader).
message
(generic reader).
minor-version
(generic reader).
neo4j-4-3-9
(class).
neo4j-version
(generic reader).
(setf neo4j-version)
(generic writer).
neo4j-version
(class).
node
(class).
node-id
(generic reader).
node-properties
(generic reader).
packstream-error
(condition).
path
(class).
point2d
(class).
point3d
(class).
port
(generic reader).
relationship
(class).
relationship-id
(generic reader).
relationship-properties
(generic reader).
relationship-type
(generic reader).
service-error
(condition).
start-node-id
(generic reader).
timestructure
(class).
title
(generic reader).
transient-error
(condition).
unbound-relationship
(class).
*log-stream*
(special variable).
*loglevel*
(special variable).
*loglevels*
(special variable).
+bolt-announce-protocol+
(special variable).
+bolt-begin+
(constant).
+bolt-commit+
(constant).
+bolt-discard+
(constant).
+bolt-failure+
(constant).
+bolt-goodbye+
(constant).
+bolt-hello+
(constant).
+bolt-ignored+
(constant).
+bolt-pull+
(constant).
+bolt-record+
(constant).
+bolt-reset+
(constant).
+bolt-rollback+
(constant).
+bolt-route+
(constant).
+bolt-run+
(constant).
+bolt-success+
(constant).
+bolt-termination-chunk+
(special variable).
+packstream-false+
(constant).
+packstream-null+
(constant).
+packstream-true+
(constant).
add-auth-to-extra
(generic function).
alist-p
(function).
auth-token
(generic reader).
bolt-auth-token
(class).
bolt-hello
(generic function).
bolt-protocol-version
(generic reader).
bolt-pull
(function).
client-notification
(condition).
days
(generic reader).
decode-dictionary
(function).
decode-element
(function).
decode-int
(function).
decode-list
(function).
decode-string
(function).
decode-structure
(function).
encode-alist
(function).
encode-boolean
(function).
encode-element
(generic function).
encode-float
(function).
encode-hash-table
(function).
encode-integer
(function).
encode-list
(function).
encode-null
(function).
encode-string
(function).
encrypted
(generic reader).
get-element-length
(function).
get-list-length
(function).
get-string-length
(function).
id
(generic reader).
identify-marker
(function).
identify-structure-node
(function).
indices
(generic reader).
int-bytes
(function).
integer-to-bytes
(function).
log-message
(function).
make-timestamp
(function).
months
(generic reader).
nanoseconds
(generic reader).
nodes
(generic reader).
parse-autocommit-tx-response
(generic function).
parse-server-hello
(generic function).
password
(generic reader).
patch-release
(generic reader).
properties
(generic reader).
read-bolt-chunk-from-stream
(generic function).
read-bolt-message-from-stream
(generic function).
read-float
(function).
read-signed-integer
(function).
read-tx-responses
(function).
rels
(generic reader).
scheme
(generic reader).
seconds
(generic reader).
send-packstream
(generic function).
srid
(generic reader).
timeout
(generic reader).
twos-complement
(function).
twos-complement-signed
(function).
tz-id
(generic reader).
tz-offset-seconds
(generic reader).
username
(generic reader).
vector-to-date
(function).
vector-to-datetime
(function).
vector-to-datetimezoneid
(function).
vector-to-duration
(function).
vector-to-localdatetime
(function).
vector-to-localtime
(function).
vector-to-node
(function).
vector-to-point2d
(function).
vector-to-point3d
(function).
vector-to-relationship
(function).
vector-to-time
(function).
vectorise-list
(function).
x
(generic reader).
y
(generic reader).
z
(generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Perform an autocommit transaction.
:parameters argument can be either an alist or a hash-table. alist is typically the low-overhead option, but it’ll break if any of the values are null.
bolt-session
) (query string
) &key parameters) ¶packstream-error
)) ¶bolt-error
)) ¶service-error
)) ¶database-error
)) ¶transient-error
)) ¶client-notification
)) ¶client-error
)) ¶Create a connection to a Neo4j server
Return a 2-element list:
- usocket:stream-socket instance containing the TCP connection.
- bolt-protocol instance indicating the version of the Bolt protocol to use in this session.
bolt-server
)) ¶bolt-session
)) ¶The network connection object for this session.
bolt-session
)) ¶The connection ID supplied by the server in response to a Hello message.
Disconnect from the Neo4j server.
bolt-session
)) ¶relationship
)) ¶ID of the start-node for this relationship.
Connect to a Neo4j server, take care of all the handshaking, and return a bolt-session instance, containing everything we need henceforth.
bolt-server
)) ¶bolt-server
)) ¶The host on which Neo4j is listening. Default is localhost.
neo4j-version
)) ¶automatically generated reader method
bolt-protocol
)) ¶automatically generated reader method
packstream-error
)) ¶bolt-error
)) ¶service-error
)) ¶database-error
)) ¶transient-error
)) ¶client-notification
)) ¶client-error
)) ¶neo4j-version
)) ¶automatically generated reader method
bolt-protocol
)) ¶automatically generated reader method
bolt-session
)) ¶bolt-session
)) ¶The version of the Neo4j database to which this session is connected. This is determined in a separate operation after the ‘handshake‘ method creates and initialises this object. Initial value should not be valid for any client use.
bolt-server
)) ¶The port-number on which Neo4j is listening. Default is 7687.
relationship
)) ¶ID for the relationship.
relationship
)) ¶Properties recorded within this relationship
unbound-relationship
)) ¶This is just called ‘type‘ in the spec, but this conflicts with a reserved word in CL.
relationship
)) ¶Neo4j type of this relationship.
relationship
)) ¶ID of the start-node for this relationship.
database-error
)) ¶transient-error
)) ¶client-notification
)) ¶client-error
)) ¶node
)) ¶The node’s labels, represented as a list of strings.
keyword
.
The server reported an error relating to a Bolt session.
The Client sent a bad request - changing the request might yield a successful outcome. Effect on transaction: rollback.
error
.
The database failed to service the request. Effect on transaction: rollback.
error
.
Some kind of issue relating to Packstream serialisation/deserialisation.
Conditions _not_ reported from Neo4J, like connection refused
The database cannot service the request right now, retrying later might yield a successful outcome. Effect on transaction: rollback.
error
.
Authentication token for basic auth.
Indicates to the server that the ’basic’ authentication scheme is expected.
"basic"
The username with which we’re authenticating to the Neo4j server. Default is neo4j.
string
"neo4j"
:username
This slot is read-only.
Authentication token for the ’none’ authentication scheme.
Indicates to the server that the ’none’ authentication scheme is requested.
"none"
Represents a version of the Bolt protocol. Subclasses are used for specialising methods according to the protocol version.
For more detail about the protocol itself, see https://7687.org/bolt/bolt-protocol-message-specification-4.html
Bolt protocol version 4.3
A Neo4j speaker, using the Bolt protocol.
The host on which Neo4j is listening. Default is localhost.
string
"localhost"
:hostname
This slot is read-only.
The port-number on which Neo4j is listening. Default is 7687.
integer
7687
:port
port
.
This slot is read-only.
Whether the Neo4j server is using TLS encryption.
boolean
:encrypted
This slot is read-only.
The timeout on creating connections, in seconds.
integer
20
:timeout
This slot is read-only.
Authentication credentials.
neo4cl::bolt-auth-token
(make-instance (quote neo4cl:bolt-auth-none) :username "neo4j")
:auth-token
This slot is read-only.
Composite object containing everything you need to know about this session.
The network connection object for this session.
usocket:stream-usocket
(error "connection attribute is mandatory.")
:connection
This slot is read-only.
The connection ID supplied by the server in response to a Hello message.
string
""
:connection-id
This slot is read-only.
The version of the Bolt protocol in effect for this session.
neo4cl:bolt-protocol
(error "bolt-protocol-version attribute is mandatory.")
:bolt-protocol-version
This slot is read-only.
The version of the Neo4j database to which this session is connected. This is determined in a separate operation after the ‘handshake‘ method creates and initialises this object. Initial value should not be valid for any client use.
neo4cl:neo4j-version
(make-instance (quote neo4cl:neo4j-version))
:neo4j-version
An instant capturing the date, but not the time, nor the time zone.
An instant capturing the date, the time, and the time zone. The time zone information is specified with a zone offset.
Seconds since the adjusted Unix epoch. This is not UTC.
integer
:seconds
This slot is read-only.
integer
:nanoseconds
This slot is read-only.
Offset in seconds from UTC.
integer
:tz-offset-seconds
This slot is read-only.
An instant capturing the date, the time, and the time zone. The time zone information is specified with a zone identifier.
A temporal amount. This captures the difference in time between two instants. Can be negative.
integer
:nanoseconds
This slot is read-only.
An instant capturing the date and the time, but not the time zone.
An instant capturing the time of day, but not the date, nor the time zone.
Nanoseconds since midnight.
integer
:nanoseconds
This slot is read-only.
Neo4j version 4.3.9
Represents a version of the Neo4j database. Subclasses are used for specialising client methods according to the database version.
integer
:class
0
This slot is read-only.
integer
:class
0
This slot is read-only.
integer
:class
0
This slot is read-only.
Snapshot of a node within a graph database
Node identifier. Mostly useful for correlating with relationships.
integer
:node-id
This slot is read-only.
The node’s labels, represented as a list of strings.
list
:node-labels
This slot is read-only.
The node’s properties, as a hash-table.
hash-table
:node-properties
This slot is read-only.
Represents a path between nodes.
Represents a single location in 2-dimensional space.
Represents a single location in 3-dimensional space.
Snapshot of a relationship within a graph database
ID for the relationship.
integer
:relationship-id
This slot is read-only.
ID of the start-node for this relationship.
integer
:start-node-id
This slot is read-only.
ID of the start-node for this relationship.
integer
:end-node-id
This slot is read-only.
Neo4j type of this relationship.
string
:relationship-type
This slot is read-only.
Properties recorded within this relationship
hash-table
:relationship-properties
This slot is read-only.
An instant capturing the time of day, and the timezone, but not the date. Named ‘time‘ in the spec, but this conflicts with a reserved word in CL.
Nanoseconds since midnight. This time is not UTC.
integer
:nanoseconds
This slot is read-only.
Offset in seconds from UTC.
integer
:tz-offset-seconds
This slot is read-only.
A relationship without information of start and end node id. It is used internally for Path serialization.
This is just called ‘type‘ in the spec, but this conflicts with a reserved word in CL.
string
:relationship-type
This slot is read-only.
The documented type is Dictionary, so it’s represented here as a hash-table.
hash-table
:properties
This slot is read-only.
Check whether the argument is actually an alist.
Send a PULL message to the server.
Parse a Dictionary structure from a byte-vector, given its starting offset.
Return 3 values:
- hash-table: the Dictionary contents. Keys are always strings, so the test is #’equal.
- integer: the number of bytes the dict occupies in the vector, _excluding_ its header.
- integer: number of bytes the header occupies in the vector.
It’s an alist because the Packstream spec states that a Dictionary can contain multiple instances of the same key; an alist can accommodate this, but a hash-table can’t.
General dispatcher for parsing a Packstream element, given a vector of octets and the starting offset.
Returns a 3-element list:
- the parsed object, as whatever CL type is most applicable.
- integer: the number of octets in the vector occupied by the element itself.
- integer: the number of octets occupied by the element’s marker.
Parse an integer from the vector, using the starting offset to find it.
Return a 3-element list:
- integer: the number itself.
- integer: the number of octets in the vector occupied by the integer.
- integer: the number of octets occupied by the header.
Parse a list from the vector, using the starting offset to find it.
Return 3 values:
- list the list itself.
- integer: the number of octets in the vector occupied by the list.
- integer: the number of octets occupied by the header.
Parse a string from the vector, using the starting offset to find it.
Return 3 values:
- string: the string itself
- integer: the number of octets in the vector occupied by the string.
- integer: the number of octets occupied by the header.
It’s true that you could get the number of octets via ‘length‘, but I’m including this here for consistency with the rest of the decode-<type> functions. This avoids the need to keep track of different return values for different types.
Unpack a structure. Returns a 3-element list:
- A 1-dimensional array, with an element in that dimension for each field in the structure.
- integer: the number of octets in the vector occupied by the element itself.
- integer: the number of octets occupied by the element’s marker.
Note that this function assumes <16 fields, because v1 of the Packstream spec doesn’t define a
marker byte for larger structures.
Packstream type: Dictionary.
Assumes a proper alist, in which the car of each pair is a string.
Return a vector containing a Packstream Boolean.
:true evaluates to true, and :false evaluates to false. Otherwise, the argument will be evaluated as a normal boolean.
Encode floating-point numbers into 64-bit binary format, per IEEE 754.
Packstream type: Dictionary.
Encode an integer into a vector containing a packstream Int.
Packstream type: List.
Return a vector containing a Packstream Null.
Packstream type: String. Description: unicode text, UTF-8
Parse the 1/2/3-octet marker in a vector, using the offset to locate the start of the marker.
Return a 2-element list:
- integer: length of the element.
- integer: marker-length.
By calculating and returning the marker’s length here, we avoid the need for the client function
to derive it after the fact, from the element itself.
Arguments:
- Vector of unsigned-byte octets.
- Starting position of the marker within the vector.
- Upper nibble for identifying 8-bit length markers.
- Octet for identifying 16-bit markers, in #xnn hexadecimal format.
- Octet for identifying 32 markers, in #xnn hexadecimal format.
Convenience function, wrapped around get-element-length.
Convenience function, wrapped around get-element-length.
What kind of thing does this marker denote? Returns a string with its name.
Doesn’t provide any details about how to handle it, just what *kind* of thing it is,
so we can decide what to do next.
What kind of structure is this? Return its name as a string.
Note that each tag-byte corresponds to an ASCII character hinting at the name.
Returns bytes from given (positive) integer least significant byte first.
Transform an integer into a list of 8-bit unsigned bytes.
Intended for use with negative integers.
The ‘bytes‘ argument is the number of octets in the output vector,
so for a 16-bit number you should specify 2.
The ‘marker‘ argument should be one of #xc8, #xc9, #xca or #xcb.
Heavily inspired by cl-binary-file:write-integer.
Parse an integer from the vector, using the starting offset to find it.
The non-pattern name is due to a collision with the standard function ‘decode-float‘.
- float the float itself
- integer: the number of octets in the vector occupied by the string.
- integer: the number of octets occupied by the header.
Reads and returns signed integer from a vector of octets.
‘offset‘ is the start of the integer, not its marker.
‘bytes‘ is the number of octets used for encoding the number, e.g. 2 means a 16-bit integer.
Heavily inspired by cl-binary-file:read-integer.
Digest the output of read-bolt-messages-from-stream (plural version), which should be a list of vectors.
Return a list of lists, each representing a row of data, plus an alist of metadata.
Expects its client function to have already sent a PULL message.
Returns two’s complement of given value. Bytes is size of value in bytes.
Returns signed integer. Value is in two’s complement format and result has bytes * 8 bits.
Take a 1-field array, and return a ’date instance.
Take a 3-field array, and return a ’datetime instance.
Take a 3-field array, and return a ’datetimezoneid instance.
Take a 4-field array, and return a ’duration instance.
Take a 2-field array, and return a ’localdatetime instance.
Take a 1-field array, and return a ’localtime instance.
Take a 3-element array, and return a ’node instance.
Take a 3-field array, and return a ’point2d instance.
Take a 4-field array, and return a ’point3d instance.
Take a 5-field array, and return a ’relationship instance.
Take a 2-field array, and return a ’timestructure instance.
Take a list of values, and concatenate them all into a single vector.
Beware: uses recursion, so excessively long lists run the risk of blowing the stack.
Add the details from this authentication token to that ’extras’ hash-table.
bolt-auth-basic
) (hash hash-table
)) ¶bolt-auth-token
) (hash hash-table
)) ¶bolt-server
)) ¶Authentication credentials.
Connect to the Neo4j server, authenticate, and ascertain the server version.
Return a bolt-session instance, which contains the connection, the bolt version and the Neo4j version.
stream-usocket
) (protocol bolt-protocol-4-3
) (auth-token bolt-auth-token
)) ¶Hello method specialised on Bolt v4.3.
For details, see https://7687.org/bolt/bolt-protocol-message-specification-4.html#version-43
bolt-session
)) ¶The version of the Bolt protocol in effect for this session.
Encode a thing into Packstream format. Note that an empty list will be encoded as Null, not as a zero-element list.
localdatetime
)) ¶datetimezoneid
)) ¶timestructure
)) ¶list
)) ¶hash-table
)) ¶string
)) ¶float
)) ¶double-float
)) ¶integer
)) ¶(eql :false)
)) ¶(eql :true)
)) ¶(eql :null)
)) ¶bolt-server
)) ¶Whether the Neo4j server is using TLS encryption.
unbound-relationship
)) ¶automatically generated reader method
id
.
duration
)) ¶automatically generated reader method
localdatetime
)) ¶automatically generated reader method
datetimezoneid
)) ¶automatically generated reader method
datetime
)) ¶automatically generated reader method
timestructure
)) ¶Nanoseconds since midnight. This time is not UTC.
Process the server’s response to a RUN message requesting an auto-commit transaction.
On success, returns an alist with two elements:
- fields (List<String>) = list of field names to expect in the return result.
- t_first (Integer) = time in ms until the first record will be available.
stream-usocket
) (protocol-version bolt-protocol-4-3
)) ¶Process the server’s response to a HELLO message.
More of a helper function, wrapped around parse-bolt-hello
stream-usocket
) (protocol-version bolt-protocol-4-3
)) ¶bolt-auth-basic
)) ¶The password with which we’re authenticating to the Neo4j server. Default is neo4j.
neo4j-version
)) ¶automatically generated reader method
unbound-relationship
)) ¶The documented type is Dictionary, so it’s represented here as a hash-table.
Read a single Bolt chunk from the stream.
If length is >0, return a 1-dimention array of type (unsigned-byte 8).
If its length is 0, i.e. it’s an end-of-message chunk, return nil.
stream
) (protocol bolt-protocol
)) ¶Read a bolt message from the connection stream, and return a vector of octets for parsing.
Expects to receive a stream, so if you’re handling a usocket:stream-usocket object, you’ll need to pass it the value of (usocket:socket-stream obj).
stream
) (protocol bolt-protocol
) &optional acc) ¶bolt-auth-token
)) ¶automatically generated reader method
duration
)) ¶automatically generated reader method
localdatetime
)) ¶Seconds since the Unix epoch.
datetimezoneid
)) ¶Seconds since the adjusted Unix epoch. This is not UTC.
Send Packstream data to a Bolt server.
stream-usocket
) (protocol bolt-protocol
) (data list
)) ¶Accept data in the form of a list of vectors.
bolt-server
)) ¶The timeout on creating connections, in seconds.
datetimezoneid
)) ¶Identifier for a specific time zone, such as ’Europe/Paris’.
datetime
)) ¶Offset in seconds from UTC.
timestructure
)) ¶Offset in seconds from UTC.
bolt-auth-basic
)) ¶The username with which we’re authenticating to the Neo4j server. Default is neo4j.
bolt-auth-none
)) ¶The username with which we’re authenticating to the Neo4j server. Default is neo4j.
There are notifications about the request sent by the client. Effect on transaction: none.
condition
.
Parent class for authentication tokens, to be subclassed for each auth scheme.
Jump to: | (
A B C D E F G H I L M N P R S T U V X Y Z |
---|
Jump to: | (
A B C D E F G H I L M N P R S T U V X Y Z |
---|
Jump to: | *
+
A B C D E H I M N P R S T U X Y Z |
---|
Jump to: | *
+
A B C D E H I M N P R S T U X Y Z |
---|
Jump to: | B C D F L N P R S T U |
---|
Jump to: | B C D F L N P R S T U |
---|