Neo4j driver for Elixir.

Bolt.Sips is an Elixir driver for Neo4j, providing many useful features:

• using the Bolt protocol, the Elixir implementation - the Neo4j's newest network protocol, designed for high-performance; latest Bolt versions, are supported.
• Can connect to a standalone Neo4j server (:direct mode) or to a Neo4j causal cluster, using the bolt+routing or the newer neo4j schemes; connecting in :routing mode.
• Provides the user with the ability to create and manage distinct ad-hoc role-based connections to one or more Neo4j servers/databases
• Supports transactions, simple and complex Cypher queries with or w/o parameters
• Multi-tenancy
• Supports Neo4j versions: 3.0.x/3.1.x/3.2.x/3.4.x/3.5.x/4.0.x/4.1.x/4.2.x

Note: Regarding Neo4j 4, stream capabilities are not yet supported.

Table of Contents

• Installation
  • Getting Started
  • Basic usage
  • Configuration
    • Direct mode
    • Routing
    • Role-based connections
    • Multi tenancy
• Using Cypher
• Temporal and spatial types
• Transactions
• Encoding
• Routing, in detail
• Multi tenancy, in detail
• Using Bolt.Sips with Phoenix
• More examples

Installation

Available in Hex, the package can be added to your list of dependencies, in the: mix.exs:

def deps do
  [{:bolt_sips, "~> 2.0"}]
end

Basic usage

Provided you have access to a running Neo4j server, and a project where you just added the :bolt_sips dependency, run an iex session inside the project's folder, and once inside the shell, follow this simple step-by-step example.

Start an iex session:

Erlang/OTP 21 [erts-10.2.3] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [hipe]
Interactive Elixir (1.8.1) - press Ctrl+C to exit (type h() ENTER for help)

iex» {:ok, _neo} = Bolt.Sips.start_link(url: "bolt://neo4j:[email protected]")
{:ok, #PID<0.237.0>}

iex» conn = Bolt.Sips.conn()
#PID<0.242.0>

iex» Bolt.Sips.query!(conn, "return 1 as n") |>
...» Bolt.Sips.Response.first()
%{"n" => 1}

Please see the docs for more examples and details about this driver.

Testing

You'll need a running Neo4j server, for running the tests. Please verify that you do not store critical data on this server, as its contents will be wiped clean when the tests are running.

If you have docker available on your system, you can start an instance before running the test suite:

docker run --rm -p 7687:7687 -e 'NEO4J_AUTH=neo4j/test' neo4j:3.0.6

Neo4j versions used for test: 3.0, 3.1, 3.4, 3.5

mix test

For the stubs using boltkit, you will have to install Python 3.7 and run: pip install boltkit. After this you can run any tests tagged with :boltkit. Example:

mix test test/boltkit_test.exs --include boltkit

or:

mix test --only boltkit

Special thanks

• Michael Schaefermeyer (@mschae), for the initial version of the Bolt protocol in Elixir: mschae/boltex

Contributors

As reported by Github: contributions to master, excluding merge commits

Contributing

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Test (mix test)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create new Pull Request

License

Copyright 2016-2020 the original author or authors

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.