{"id":13508757,"url":"https://github.com/florinpatrascu/bolt_sips","last_synced_at":"2025-05-16T13:06:02.645Z","repository":{"id":39520736,"uuid":"66721200","full_name":"florinpatrascu/bolt_sips","owner":"florinpatrascu","description":"Neo4j driver for Elixir","archived":false,"fork":false,"pushed_at":"2023-11-18T19:47:32.000Z","size":1269,"stargazers_count":262,"open_issues_count":4,"forks_count":48,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-05-10T12:16:22.325Z","etag":null,"topics":["bolt","driver","elixir","graph-database","graphdb","neo4j","neo4j-driver"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/florinpatrascu.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-08-27T15:27:26.000Z","updated_at":"2025-04-15T05:24:13.000Z","dependencies_parsed_at":"2023-11-18T20:31:12.583Z","dependency_job_id":"2746fbbe-b098-4b91-9ceb-631e6b9b7eb2","html_url":"https://github.com/florinpatrascu/bolt_sips","commit_stats":{"total_commits":188,"total_committers":14,"mean_commits":"13.428571428571429","dds":0.276595744680851,"last_synced_commit":"e89073a1d70d9510d89c07e27a7e1f1358606cfa"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/florinpatrascu%2Fbolt_sips","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/florinpatrascu%2Fbolt_sips/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/florinpatrascu%2Fbolt_sips/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/florinpatrascu%2Fbolt_sips/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/florinpatrascu","download_url":"https://codeload.github.com/florinpatrascu/bolt_sips/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254535827,"owners_count":22087399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bolt","driver","elixir","graph-database","graphdb","neo4j","neo4j-driver"],"created_at":"2024-08-01T02:00:58.007Z","updated_at":"2025-05-16T13:06:02.581Z","avatar_url":"https://github.com/florinpatrascu.png","language":"Elixir","funding_links":[],"categories":["ORM and Datamapping","Connectors","Bolt"],"sub_categories":["Bolt"],"readme":"\u003cimg src=\"assets/logo_transparent.png\" alt=\"logo\" width=\"240\"/\u003e\n\n# Neo4j driver for Elixir.\n\n[![Build Status](https://travis-ci.org/florinpatrascu/bolt_sips.svg?branch=master)](https://travis-ci.org/florinpatrascu/bolt_sips)\n[![Hex.pm](https://img.shields.io/hexpm/dt/bolt_sips.svg?maxAge=2592000)](https://hex.pm/packages/bolt_sips)\n[![Hexdocs.pm](https://img.shields.io/badge/api-hexdocs-brightgreen.svg)](https://hexdocs.pm/bolt_sips)\n\n`Bolt.Sips` is an Elixir driver for [Neo4j](https://neo4j.com/developer/graph-database/), providing many useful features:\n\n- using the Bolt protocol, the Elixir implementation - the Neo4j's newest network protocol, designed for high-performance; latest Bolt versions, are supported.\n- 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.\n- Provides the user with the ability to create and manage distinct ad-hoc `role-based` connections to one or more Neo4j servers/databases\n- Supports transactions, simple and complex Cypher queries with or w/o parameters\n- Multi-tenancy\n- 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\n\nNotes:\n\n- Regarding Neo4j 4, stream capabilities are not yet supported.\n- If you're seeking a substitute driver, here's a compilation of repositories:\n  - https://github.com/sagastume/boltx\n\n## Table of Contents\n\n- [Installation](#installation)\n  - [Getting Started](docs/getting-started.md#starting-the-driver)\n  - [Basic usage](docs/getting-started.md#usage)\n  - [Configuration](docs/features/configuration.md)\n    - [Direct mode](docs/features/configuration.md#direct-mode)\n    - [Routing](docs/features/configuration.md#routing-mode)\n    - [Role-based connections](docs/features/configuration.md#role-based-connections)\n    - [Multi tenancy](docs/features/configuration.md#multi-tenancy)\n- [Using Cypher](docs/features/using-cypher.md)\n- [Temporal and spatial types](docs/features/using-temporal-and-spatial-types.md)\n- [Transactions](docs/features/about-transactions.md)\n- [Encoding](docs/features/about-encoding.md)\n- [Routing, in detail](docs/features/routing.md)\n- [Multi tenancy, in detail](docs/features/multi-tenancy.md)\n- [Using Bolt.Sips with Phoenix](docs/features/using-with-phoenix.md)\n- [More examples](docs/examples/readme.md)\n\n### Installation\n\n[Available in Hex](https://hex.pm/packages/bolt_sips), the package can be added to your list of dependencies, in the: `mix.exs`:\n\n```elixir\ndef deps do\n  [{:bolt_sips, \"~\u003e 2.0\"}]\nend\n```\n\n### Basic usage\n\nProvided 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.\n\nStart an iex session:\n\n```elixir\nErlang/OTP 21 [erts-10.2.3] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [hipe]\nInteractive Elixir (1.8.1) - press Ctrl+C to exit (type h() ENTER for help)\n\niex\u003e {:ok, _neo} = Bolt.Sips.start_link(url: \"bolt://neo4j:test@localhost\")\n{:ok, #PID\u003c0.237.0\u003e}\n\niex\u003e conn = Bolt.Sips.conn()\n#PID\u003c0.242.0\u003e\n\niex\u003e Bolt.Sips.query!(conn, \"return 1 as n\") |\u003e\n...\u003e Bolt.Sips.Response.first()\n%{\"n\" =\u003e 1}\n```\n\nPlease see the docs for more examples and details about this driver.\n\n### Testing\n\nYou'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.\n\nIf you have docker available on your system, you can start an instance before running the test suite:\n\n```shell\ndocker run --rm -p 7687:7687 -e 'NEO4J_AUTH=neo4j/test' neo4j:3.0.6\n```\n\nNeo4j versions used for test: 3.0, 3.1, 3.4, 3.5\n\n```shell\nmix test\n```\n\nFor the stubs using [boltkit](https://github.com/neo4j-drivers/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:\n\n```shell\nmix test test/boltkit_test.exs --include boltkit\n```\n\nor:\n\n```shell\nmix test --only boltkit\n```\n\n### Special thanks\n\n- Michael Schaefermeyer (@mschae), for the initial version of the Bolt protocol in Elixir: [mschae/boltex](https://github.com/mschae/boltex)\n\n### Contributors\n\nAs reported by Github: [contributions to master, excluding merge commits](https://github.com/florinpatrascu/bolt_sips/graphs/contributors)\n\n### Contributing\n\n- [Fork it](https://github.com/florinpatrascu/bolt_sips/fork)\n- Create your feature branch (`git checkout -b my-new-feature`)\n- Test (`mix test`)\n- Commit your changes (`git commit -am 'Add some feature'`)\n- Push to the branch (`git push origin my-new-feature`)\n- Create new Pull Request\n\n### License\n\n```txt\nCopyright 2016-2020 the original author or authors\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflorinpatrascu%2Fbolt_sips","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflorinpatrascu%2Fbolt_sips","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflorinpatrascu%2Fbolt_sips/lists"}