https://github.com/mschae/boltex

Elixir driver for the neo4j bolt protocol
https://github.com/mschae/boltex

bolt elixir graph-database neo4j

Last synced: 2 months ago
JSON representation

Elixir driver for the neo4j bolt protocol

• Host: GitHub
• URL: https://github.com/mschae/boltex
• Owner: mschae
• License: other
• Created: 2016-07-15T14:53:50.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2019-02-02T18:26:56.000Z (almost 6 years ago)
• Last Synced: 2024-05-08T21:04:18.885Z (7 months ago)
• Topics: bolt, elixir, graph-database, neo4j
• Language: Elixir
• Size: 133 KB
• Stars: 29
• Watchers: 3
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neo4j - neo4j-elixir-driver - Elixir driver for the neo4j bolt protocol (Bolt)

README

        
# Boltex

[![Build Status](https://travis-ci.org/mschae/boltex.svg?branch=master)](https://travis-ci.org/mschae/boltex)

[![Inline docs](http://inch-ci.org/github/mschae/boltex.svg?branch=master)](http://inch-ci.org/github/mschae/boltex)

[![Coverage Status](https://coveralls.io/repos/github/mschae/boltex/badge.svg?branch=master)](https://coveralls.io/github/mschae/boltex?branch=master)

Elixir implementation of the Bolt protocol and corresponding PackStream

protocol. Both is being used by Neo4J.

This is a very bare-bone protocol implementation. Error handling, acknowledging

errors, recovering sessions etc. has to be implemented upstream.

The current version supports both version 1 and 2 of Bolt protocol. Version 2 is currently only used by Neo4j and there is no documentation available yet.  

For v1 documentation see: https://boltprotocol.org/v1/

*Warning: This is currently WIP and only in the wild to gather feedback!*

If you want to use Boltex in production I highly recommend using connection

pooling. You can either use the feature-rich

[Bolt.Sips](https://github.com/florinpatrascu/bolt_sips) or check out the

[example DBConnection implementation](https://github.com/mschae/boltex_db_connection).

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:

  1. Add boltex to your list of dependencies in `mix.exs`:

        def deps do

          [{:boltex, "~> 0.5.0"}]

        end

  2. Ensure boltex is started before your application:

        def application do

          [applications: [:boltex]]

        end

## Try it out!

```elixir

Boltex.test 'localhost', 7687, "MATCH (n) RETURN n"

```

## License

Copyright 2016 Michael Schaefermeyer

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.