gremgo

README

gremgo

gremgo 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. Please keep in mind that gremgo is still under heavy development and although effort is being made to fully cover gremgo with reliable tests, bugs may be present in several areas.

Installation

go get github.com/qasaur/gremgo

Documentation

• GoDoc

Example

package main

import (
	"fmt"
	"log"

	"github.com/qasaur/gremgo"
)

func main() {
	dialer := gremgo.NewDialer("127.0.0.1:8182") // Returns a WebSocket dialer to connect to Gremlin Server
	g, err := gremgo.Dial(dialer) // Returns a gremgo client to interact with
	if err != nil {
		fmt.Println(err)
    	return
	}
	res, err := g.Execute( // Sends a query to Gremlin Server with bindings
		"g.V(x)",
		map[string]string{"x": "1234"},
	)
	if err != nil {
		fmt.Println(err)
    	return
	}
	fmt.Println(res)
}

License

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.

Documentation

Index

• type Client
  • func Dial(conn dialer) (c Client, err error)
  • func (c *Client) Execute(query string, bindings, rebindings map[string]string) (resp interface{}, err error)
  • func (c *Client) ExecuteFile(path string, bindings, rebindings map[string]string) (resp interface{}, err error)
• type Ws
  • func NewDialer(host string) (dialer *Ws)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a container for the gremgo client.

func Dial

func Dial(conn dialer) (c Client, err error)

Dial returns a gremgo client for interaction with the Gremlin Server specified in the host IP.

func (*Client) Execute

func (c *Client) Execute(query string, bindings, rebindings map[string]string) (resp interface{}, err error)

Execute formats a raw Gremlin query, sends it to Gremlin Server, and returns the result.

func (*Client) ExecuteFile

func (c *Client) ExecuteFile(path string, bindings, rebindings map[string]string) (resp interface{}, err error)

ExecuteFile takes a file path to a Gremlin script, sends it to Gremlin Server, and returns the result.

type Ws

type Ws struct {
	// contains filtered or unexported fields
}

Ws is the dialer for a WebSocket connection

func NewDialer

func NewDialer(host string) (dialer *Ws)

NewDialer returns a WebSocket dialer to use when connecting to Gremlin Server