neo4j/seabolt

Name: seabolt

Owner: Neo4j

Description: Neo4j connector library for C [WORK IN PROGRESS]

Created: 2017-11-28 16:48:52.0

Updated: 2018-05-24 17:19:47.0

Pushed: 2018-05-24 17:19:46.0

Homepage:

Size: 563

Language: C++

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Seabolt

Seabolt is a Neo4j connector library for C. The library will support multiple versions of the Bolt protocol through the new Connector API and will provide a base layer for a number of language drivers.

This project is a work in progress, so we're not yet able to accept issues or contributions. Sorry!

Requirements

This project requires the following tools/libraries to be installed in order to be built. General installation instructions can be found in the following sections.

  1. CMake 3.9.1
  2. OpenSSL Development Libraries
Linux (Ubuntu)
  1. Install all required components via `apt install git build-essential cmake libssl-dev`
MacOS X
  1. Install XCode,
  2. Install XCode Command Line Tools via xcode-select --install
  3. Install CMake brew install cmake
  4. Install OpenSSL brew install openssl
Windows

Currently windows builds also depend on OpenSSL, however support for windows secure sockets is in our roadmap.

  1. Install Visual Studio 2017 with VC++ support,
  2. Install CMake via choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
  3. Install OpenSSL Win32 using https://slproweb.com/download/Win32OpenSSL-1_1_0g.exe
  4. Install OpenSSL Win64 using https://slproweb.com/download/Win64OpenSSL-1_1_0g.exe
Building
Linux / MacOS X

To build the project, run either the make_debug.sh or the make_release.sh script from the project root directory. This will compile and deposit project artifacts in the build/bin and build/lib directories. To create distributable packages, use make_packages.sh instead.

Docs

To build the docs, the make_docs.sh script is available. The docs build process uses Sphinx, Breathe and Doxygen. These can be installed as follows:

do apt install doxygen

p install --user sphinx breathe
Running

To run a query, use the following…

_PASSWORD=password build/bin/seabolt "UNWIND range(1, 1000000) AS n RETURN n"

By default, this will simply display stats for the query execution. The following environment variables can be used:

_SECURE=0|1
_HOST=<host name, IPv4 or IPv6 address>
_PORT=7687
_USER=neo4j
_PASSWORD=password
_LOG=0|1|2

This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.