package gremlin

  1. Overview
  2. Docs
Gremlin Client Library

Install

Dune Dependency

Authors

Maintainers

Sources

0.1.1.tar.gz
md5=d6d34be20f43e9ff4c6b18159e99ea2c
sha512=42b39f19eb57d1f30b8e078457078e0d2dda35e538cc7fc28bc65d4cac6ebe8ad08f81fcd5f5e7e151c3cbfcd4ab9f9b09cba1608682fdda08eab0b5761b0bbe

Description

This is an Apache Tinkerpop3 Gremlin client library.

See the official tinkerpop3 and gremlin docs:

  • http://tinkerpop.apache.org/docs/current/

This client library is implemented following the driver provider requirements:

  • http://tinkerpop.apache.org/docs/current/dev/provider/#_graph_driver_provider_requirements

Published: 26 Jul 2019

README

OCaml Gremlin Client

Overview

This is a very rough Apache Tinkerpop3 Gremlin client library written in OCaml. It was implemented using the Graph Driver Provider Requirements.

Given this is my first public OCaml library and I was fairly rushed, it's not pretty.

I'd like to improve it which probably means completely refactoring it but I'm not sure when I'll get the chance. In the meantime, any suggestions or PRs are welcome.

Instructions

Build/Install

git clone https://github.com/bramford/ocaml-gremlin
cd ocaml-gremlin
opam pin add .

Usage

Assuming you're running a gremlin server on localhost:8182, in a toplevel such as utop:

#require "gremlin";;

let conn =
    Gremlin.Websocket.new_connection
    (Uri.of_string "http://localhost:8182/gremlin")

(* Add vertices *)
let add_vertices = Lwt_main.run (
  Gremlin.Websocket.run_queries_transaction
    conn
    ["g.addV('user').property('name', 'foo')";
    "g.addV('user').property('name', 'bar')";]
)

(* Get vertices *)
let get_vertices =
  Lwt_main.run (
    Gremlin.Websocket.run_query
      conn
      "g.V()"
  )
;;

See examples/ for other examples.

To do

There's obviously a lot to improve but here are some starting points:

  • [ ] Properly close gremlin session on completion

  • [ ] Handle streamed responses

  • [ ] Add interface documentation (e.g. odoc)

  • [ ] Implement proper logging (e.g. using Logs)

  • [ ] Improve types and results

  • [ ] Abstract internals and types properly

  • [ ] Refactor/improve response handler (currently uses Lwt_stream but poorly)

  • [ ] Refactor response JSON checking/parsing

  • [ ] Improve concurrency (currently all serial using Lwt_list.map_s)

  • [ ] Support other serialization formats (e.g. bytecode)

  • [ ] Support Traversal OpProcessor

  • [ ] Support REST interface

  • [ ] MirageOS compatibility

Dependencies (11)

  1. websocket-lwt-unix >= "2.13"
  2. websocket >= "2.13"
  3. yojson >= "1.7.0"
  4. ppx_let >= "v0.12.0"
  5. lwt_ppx >= "1.2.2"
  6. lwt >= "4.2.1"
  7. dune >= "1.10.0"
  8. core >= "v0.12.3" & < "v0.15"
  9. containers >= "2.6"
  10. conduit-lwt-unix >= "1.4.0" & < "5.0.0"
  11. ocaml >= "4.07.1"

Dev Dependencies

None

Used by

None

Conflicts

None

OCaml

Innovation. Community. Security.