neo4j_bolt 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.rspec +3 -0
- data/.travis.yml +6 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +34 -0
- data/LICENSE +674 -0
- data/README.md +50 -0
- data/Rakefile +6 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/lib/neo4j_bolt/version.rb +3 -0
- data/lib/neo4j_bolt.rb +880 -0
- data/neo4j_bolt.gemspec +30 -0
- metadata +73 -0
data/README.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# Neo4jBolt
|
2
|
+
|
3
|
+
A Neo4j/Bolt driver written in pure Ruby.
|
4
|
+
|
5
|
+
🚀 **Streaming support!** Neo4j sends responses in chunks of max. 64 kb. When running queries, specify a block to obtain rows as soon as they arrive.
|
6
|
+
|
7
|
+
## Supported and unsupported aspects
|
8
|
+
|
9
|
+
| | Supported | Unsupported |
|
10
|
+
|-|-|-
|
11
|
+
| Neo4j | 4.4 | 1.x 2.x 3.x <br /> 4.0 4.1 4.2 4.3 <br /> 5.x |
|
12
|
+
| Bolt | 4.4 | 1 2 3 4.0 4.1 4.2 4.3 |
|
13
|
+
|
14
|
+
|
15
|
+
## Installation
|
16
|
+
|
17
|
+
Add this line to your application's Gemfile:
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
gem 'neo4j_bolt'
|
21
|
+
```
|
22
|
+
|
23
|
+
And then execute:
|
24
|
+
|
25
|
+
$ bundle install
|
26
|
+
|
27
|
+
Or install it yourself as:
|
28
|
+
|
29
|
+
$ gem install neo4j_bolt
|
30
|
+
|
31
|
+
## Usage
|
32
|
+
|
33
|
+
In order to use this gem, you need a running Neo4j database. You can start one using the following command:
|
34
|
+
|
35
|
+
```
|
36
|
+
docker run --rm --env NEO4J_AUTH=none --publish 7687:7687 neo4j:4.4-community
|
37
|
+
```
|
38
|
+
|
39
|
+
TODO: Write usage instructions here
|
40
|
+
|
41
|
+
## Development
|
42
|
+
|
43
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
44
|
+
|
45
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
46
|
+
|
47
|
+
## Contributing
|
48
|
+
|
49
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/specht/neo4j_bolt.
|
50
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "neo4j_bolt"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
include Neo4jBolt
|
15
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED