Bolt (neodriver_eio.Neodriver

val hello_tag : int

Message tag of HELLO (0x01).

val logon_tag : int

Message tag of LOGON (0x6A).

val logoff_tag : int

Message tag of LOGOFF (0x6B).

val reset_tag : int

Message tag of RESET (0x0F).

val run_tag : int

Message tag of RUN (0x10).

val begin_tag : int

Message tag of BEGIN (0x11).

val commit_tag : int

Message tag of COMMIT (0x12).

val rollback_tag : int

Message tag of ROLLBACK (0x13).

val discard_tag : int

Message tag of DISCARD (0x2F).

val pull_tag : int

Message tag of PULL (0x3F).

val record_tag : int

Message tag of RECORD (0x71).

val success_tag : int

Message tag of SUCCESS (0x70).

val failure_tag : int

Message tag of FAILURE (0x7F).

val ignored_tag : int

Message tag of IGNORED (0x7E).

val send : 
  Transport.t ->
  tag:int ->
  Neodriver_packstream.Packstream.value list ->
  (unit, Neodriver_core.Errors.t) Stdlib.result

Pack a message with the given tag and fields and send it.

returns
Error _ if the message cannot be written.

val recv : 
  Transport.t ->
  (int * Neodriver_packstream.Packstream.value option, Neodriver_core.Errors.t)
    Stdlib.result

Read one message and return its (tag, payload), where payload is the message's single field (none if the message carries no fields).

returns
Error _ on timeout, end-of-file, or a malformed message.

val recv_fields : 
  Transport.t ->
  (int * Neodriver_packstream.Packstream.value list, Neodriver_core.Errors.t)
    Stdlib.result

Read one message and return its (tag, fields). For a RECORD the fields are the record's values.

returns
Error _ on timeout, end-of-file, or a malformed message.

val respond : 
  Transport.t ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Read a response message and interpret it: SUCCESS metadata is returned as Ok _; a FAILURE is mapped to Error (Neo4j _) via its code and message; an IGNORED (or any other tag) is an error.

val hello : 
  Transport.t ->
  headers:Neodriver_packstream.Packstream.value ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Send a HELLO message with headers and read the response.

val logon : 
  Transport.t ->
  auth:Neodriver_packstream.Packstream.value ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Send a LOGON message with the authentication map auth and read the response.

val logoff : 
  Transport.t ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Send a LOGOFF message and read the response.

val run : 
  Transport.t ->
  query:string ->
  parameters:Neodriver_packstream.Packstream.value ->
  extra:Neodriver_packstream.Packstream.value ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Send a RUN message for query with the given parameters and extra map, and read the response.

val begin_ : 
  Transport.t ->
  extra:Neodriver_packstream.Packstream.value ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Send a BEGIN message with the extra map (mode, db, bookmarks, tx_metadata, tx_timeout) and read the response.

val commit : 
  Transport.t ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Send a COMMIT message and read the response (its metadata carries the bookmark).

val rollback : 
  Transport.t ->
  (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
    Stdlib.result

Send a ROLLBACK message and read the response.

val pull : 
  Transport.t ->
  extra:Neodriver_packstream.Packstream.value ->
  (Neodriver_packstream.Packstream.value list list
   * (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
       Stdlib.result,
    Neodriver_core.Errors.t)
    Stdlib.result

Send a PULL message with the extra map (e.g. n, qid) and read the result: all RECORD messages up to the terminal message. Returns the records delivered so far and the terminal outcome — Ok summary on SUCCESS, Error _ on a server FAILURE/IGNORED (the records delivered before the failure are kept, so a mid-stream error can be surfaced after buffering).

val discard : 
  Transport.t ->
  extra:Neodriver_packstream.Packstream.value ->
  (Neodriver_packstream.Packstream.value list list
   * (Neodriver_packstream.Packstream.value, Neodriver_core.Errors.t)
       Stdlib.result,
    Neodriver_core.Errors.t)
    Stdlib.result

Send a DISCARD message with the extra map and read the result (same shape as pull, though records are normally empty).

val metadata_has_more : Neodriver_packstream.Packstream.value -> bool

Whether a summary metadata map carries has_more = true.