gremgoser

gremgoser

gremgoser is a fast, efficient, and easy-to-use client for the TinkerPop graph database stack. It is a Gremlin language driver which uses WebSockets to interface with Gremlin Server and has a strong emphasis on concurrency and scalability. gremgoser started as a fork of gremgo. The main difference is gremgoser supports serializing and de-serializing interfaces in/out of a graph as well as Vertex and edge creation from Go interfaces. Please keep in mind that gremgoser is still under heavy development and might change until v1.0 release. gremgoser also fixes all panics that could happen in gremgo. The latest code also removed the storage of username and password in clear text in memory.

Installation

go get github.com/intwinelabs/gremgoser

Documentation

• GoDoc

Struct Tags

• To serialize data in and out of the graph you must supply proper graph struct tags for each field of the struct you would like to serialize:
  • partitionKey - graph:"partitionKeyName,partitionKey"
  • bool - graph:"boolName,bool"
  • string - graph:"stringName,string"
  • int, int8, int16, int32, int64 - graph:"numberName,number"
  • uint, uint8, uint16, uint32, uint64 - graph:"numberName,number"
  • float32, float64 - graph:"numberName,number"
  • struct - graph:"structName,struct"
  • []bool - graph:"boolName,[]bool"
  • []string - graph:"stringName,[]string"
  • []int, []int8, []int16, []int32, []int64 - graph:"numberName,[]number"
  • []uint, []uint8, []uint16, []uint32, []uint64 - graph:"numberName,[]number"
  • []float32, []float64 - graph:"numberName,[]number"
  • []struct - graph:"structName,[]struct"

Project Management

• v1.0

Build Status

• TravisCI

Coverage Status

• Coveralls

Contributing

• Reporting Issues - When reporting issues on GitHub please include your host OS (Ubuntu 12.04, Fedora 19, etc) sudo lsb_release -a, the output of uname -a, go version, tinkerpop server and version. Please include the steps required to reproduce the problem. This info will help us review and fix your issue faster.
• We welcome your pull requests - We are always thrilled to receive pull requests, and do our best to process them as fast as possible.
  • Not sure if that typo is worth a pull request? Do it! We will appreciate it.
  • If your pull request is not accepted on the first try, don't be discouraged! We will do our best to give you feedback on what to improve.
  • We're trying very hard to keep gremgoser lean and focused. We don't want it to do everything for everybody. This means that we might decide against incorporating a new feature. However, we encourage you to fork our repo and implement it on top of gremgoser.
  • Any changes or improvements should be documented as a GitHub issue before we add it to the project and anybody starts working on it.
• Please check for existing issues first - If it does add a quick "+1". This will help prioritize the most common problems and requests.

Example

This is a example of a secure connection with authentication. The example also shows the ability to pass a interface to create a Vertex in the graph as well as the ability to create Edges between interfaces. This also shows de-serialization of interface from the graph.

package main

import (
	"fmt"

	"github.com/davecgh/go-spew/spew"
	"github.com/google/uuid"
	"github.com/intwinelabs/gremgoser"
	"github.com/intwinelabs/logger"
)

var log = logger.New()

type X float32

type XX struct {
	Y string
}

type Person struct {
	Id     uuid.UUID `graph:"id,string"`
	PID    string    `graph:"pid,string"`
	Name   string    `graph:"name,string"`
	Age    int       `graph:"age,number"`
	Active bool      `graph:"active,bool"`
	Vect   []float32 `graph:"vect,[]number"`
	Test   []string  `graph:"test,[]string"`
	Foo    X         `graph:"foo,number"`
	Bar    XX         `graph:"bar,struct"`
}

func main() {
	errs := make(chan error)
	

	uri := "wss://gremlin.server:443/"
	user := "username"
	pass := "password"

	conf := gremgoser.NewClientConfig(uri)
	conf.SetDebug()
	conf.SetVerbose()
	conf.SetLogger(log)
	conf.SetAuthentication(user, pass)
	g, errs := gremgoser.NewClient(conf)
	
	go func(chan error) {
		err := <-errs
		log.Fatal("Lost connection to the database: " + err.Error())
	}(errs) // Example of connection error handling logic

	res, err := g.Execute( // Sends a query to Gremlin Server with bindings
		"g.V()",
		map[string]string{},
		map[string]string{},
	)

	if err != nil {
		fmt.Println(err)
		return
	}

	spew.Dump(res)

	// Add a person
	p := Person{
		Id:   uuid.New(),
		PID:  "testID",
		Name: "Ted",
		Age:  48,
		Vect: []float32{1.566864, 0.234},
		Test: []string{"one", "two", "three", "four"},
		Foo:  0.233,
	}

	res2, err := g.AddV("person", p)

	if err != nil {
		fmt.Println(err)
		return
	}

	spew.Dump(res2)

	// Add a person
	p2 := Person{
		Id:   uuid.New(),
		PID:  "testID",
		Name: "Donald",
		Age:  72,
	}

	res3, err := g.AddV("person", p2)

	if err != nil {
		fmt.Println(err)
		return
	}

	spew.Dump(res3)

	// Ted Likes Donald
	res4, err := g.AddE("likes", p, p2)
	if err != nil {
		fmt.Println(err)
		return
	}

	spew.Dump(res4)

	// Lets ask the graph for p back as a new instance of a Person
	id := p.Id.String()
	p3 := []Person{}
	q := fmt.Sprintf("g.V('%s')", id)
	//q = "g.V()"
	fmt.Println(q)
	err = g.Get(q, &p3)
	if err != nil {
		fmt.Println(err)
		return
	}
	spew.Dump(p3)
}

License

Copyright (c) 2018 Intwine Labs, Inc.

Copyright (c) 2016 Marcus Engvall

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.