Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmcvetta/neoism
Neo4j client for Golang
https://github.com/jmcvetta/neoism
Last synced: about 2 months ago
JSON representation
Neo4j client for Golang
- Host: GitHub
- URL: https://github.com/jmcvetta/neoism
- Owner: jmcvetta
- Created: 2012-07-12T07:42:33.000Z (over 12 years ago)
- Default Branch: develop
- Last Pushed: 2020-02-16T09:28:03.000Z (almost 5 years ago)
- Last Synced: 2024-07-31T20:50:51.084Z (4 months ago)
- Language: Go
- Size: 817 KB
- Stars: 390
- Watchers: 25
- Forks: 57
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-go - neoism - Neo4j client for Golang. (Database Drivers / NoSQL Database Drivers)
- awesome-go-storage - neoism - Neo4j client for Golang (Database Drivers)
- awesome-neo4j - neoism - Client for Golang. (REST API / Other)
- awesome-go - neoism - Neo4j client for Golang - ★ 344 (Database Drivers)
- awesome-go-extra - neoism - 07-12T07:42:33Z|2020-02-16T09:28:03Z| (Generators / NoSQL Database Drivers)
- awesome-go-storage - neoism - Neo4j client for Golang (Database Drivers)
README
neoism - Neo4j client for Go
===========================
Package `neoism` is a [Go](http://golang.org) client library providing access to
the [Neo4j](http://www.neo4j.org) graph database via its REST API.
# Status
| System | Status |
|-----------|:-----------------------------------------------------------------------------------------------------------------------:|
| Travis CI | [](https://travis-ci.org/jmcvetta/neoism) |
| CircleCI | [](https://circleci.com/gh/jmcvetta/neoism) |
| Coveralls | [](https://coveralls.io/r/jmcvetta/neoism) |
| Codecov | [](https://codecov.io/gh/jmcvetta/neoism) |
This driver is fairly complete, and may now be suitable for general use. The
code has an extensive set of integration tests, but little real-world testing.
YMMV; use in production at your own risk.
# Requirements
[Go 1.1](http://golang.org/doc/go1.1) or later is required.
Tested against Neo4j 2.2.4 and Go 1.4.1.
# Installation
## Development
```
go get -v github.com/jmcvetta/neoism
```
## Stable
Neoism is versioned using [`gopkg.in`](http://gopkg.in).
Current release is `v1`
```
go get gopkg.in/jmcvetta/neoism.v1
```
# Documentation
See [GoDoc](http://godoc.org/github.com/jmcvetta/neoism) or
[Go Walker](http://gowalker.org/github.com/jmcvetta/neoism) for
automatically generated documentation.
# Usage
## Connect to Neo4j Database
```go
db, err := neoism.Connect("http://localhost:7474/db/data")
```
## Create a Node
```go
n, err := db.CreateNode(neoism.Props{"name": "Captain Kirk"})
```
## Issue a Cypher Query
```go
// res will be populated with the query results. It must be a slice of structs.
res := []struct {
// `json:` tags matches column names in query
A string `json:"a.name"`
Rel string `json:"type(r)"`
B string `json:"b.name"`
}{}
// cq holds the Cypher query itself (required), any parameters it may have
// (optional), and a pointer to a result object (optional).
cq := neoism.CypherQuery{
// Use backticks for long statements - Cypher is whitespace indifferent
Statement: `
MATCH (a:Person)-[r]->(b)
WHERE a.name = {name}
RETURN a.name, type(r), b.name
`,
Parameters: neoism.Props{"name": "Dr McCoy"},
Result: &res,
}
// Issue the query.
err := db.Cypher(&cq)
// Get the first result.
r := res[0]
```
## Issue Cypher queries with a transaction
```go
tx, err := db.Begin(qs)
if err != nil {
// Handle error
}
cq0 := neoism.CypherQuery{
Statement: `MATCH (a:Account) WHERE a.uuid = {account_id} SET balance = balance + {amount}`,
Parameters: neoism.Props{"uuid": "abc123", amount: 20},
}
err = db.Cypher(&cq0)
if err != nil {
// Handle error
}
cq1 := neoism.CypherQuery{
Statement: `MATCH (a:Account) WHERE a.uuid = {account_id} SET balance = balance + {amount}`,
Parameters: neoism.Props{"uuid": "def456", amount: -20},
}
err = db.Cypher(&cq1)
if err != nil {
// Handle error
}
err := tx.Commit()
if err != nil {
// Handle error
}
```
# Roadmap
## Completed:
* Node (create/edit/relate/delete/properties)
* Relationship (create/edit/delete/properties)
* Legacy Indexing (create/edit/delete/add node/remove node/find/query)
* Cypher queries
* Batched Cypher queries
* Transactional endpoint (Neo4j 2.0)
* Node labels (Neo4j 2.0)
* Schema index (Neo4j 2.0)
* Authentication (Neo4j 2.2)
## To Do:
* Streaming API support - see Issue [#22](https://github.com/jmcvetta/neoism/issues/22)
* ~~Unique Indexes~~ - probably will not expand support for legacy indexing.
* ~~Automatic Indexes~~ - "
* High Availability
* Traversals - May never be supported due to security concerns. From the
manual: "The Traversal REST Endpoint executes arbitrary Groovy code under
the hood as part of the evaluators definitions. In hosted and open
environments, this can constitute a security risk."
* Built-In Graph Algorithms
* Gremlin
# Testing
Neoism's test suite respects, but does not require, a `NEO4J_URL` environment
variable. By default it assumes Neo4j is running on `localhost:7474`, with
username `neo4j` and password `foobar`.
```bash
export NEO4J_URL=http://your_user:[email protected]/db/data/
go test -v .
```
If you are using a fresh untouched Neo4j instance, you can use the included
`set_neo4j_password.sh` script to set the password to that expected by Neoism's
tests:
```bash
sh set_neo4j_password.sh
```
# Support
Support and consulting services are available from [Silicon Beach Heavy
Industries](http://siliconheavy.com).
# Contributing
Contributions in the form of Pull Requests are gladly accepted. Before
submitting a PR, please ensure your code passes all tests, and that your
changes do not decrease test coverage. I.e. if you add new features also add
corresponding new tests.
# License
This is Free Software, released under the terms of the [GPL
v3](http://www.gnu.org/copyleft/gpl.html).