ultipa-go-sdk

module
v1.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 17, 2023 License: GPL-3.0

README

Ultipa GO SDK

Installation


go get github.com/ultipa/ultipa-go-sdk
go mod tidy

Document

Read Ultipa Go SDK document ultipa.com

Create Client


import (
    "github.com/ultipa/ultipa-go-sdk/sdk"
    "github.com/ultipa/ultipa-go-sdk/sdk/api"
    "github.com/ultipa/ultipa-go-sdk/sdk/configuration"
)

config := configuration.NewUltipaConfig(&configuration.UltipaConfig{
    Hosts: []string{"127.0.0.1:60061"},
    Username: "root",
    Password: "root",
    DefaultGraph: "default",
})

client, err = sdk.NewUltipa(config)

Send UQL and get result

resp, err := client.UQL("find().nodes() return nodes limit 1", nil)
nodes := resp.alias("nodes").asNodes()

UQLResponse Interface

  • Alias(alias string) : *DataItem
  • Alias(index int) : *DataItem

DataItem Interface

  • asNodes() : (nodes []*structs.Node, schemas map[string]*structs.Schema, err error)
  • asEdges() : (edges []*structs.Edge, schemas map[string]*structs.Schema, err error)
  • asPaths() : (paths []*structs.Path, err error)
  • asTable() : (table *structs.Table, err error)
  • asArray() : (arr *structs.Array, err error)
  • asAttr() : (arr *structs.Array, err error)
  • asGraphs() : (graphs []*structs.Graph, err error)
  • asSchemas() : (schemas []*structs.Schema, err error)
  • asAlgos() : ([]*structs.Algo, error)
  • asAny() : (interface{}, error)

Batch Insert

Check Go Transporter For Details


Trouble Shooting

grpc issues

This sdk depends on Protocol Buffer and grpc, so we need to compile the proto file first:
go install google.golang.org/grpc/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest

then execute the build shell:
cd ./rpc
sh ./build-proto.sh

after this, remove protoc-gen-go and protoc-gen-go-grpc dependencies from go.mod

Directories

Path Synopsis
sdk
Package sdk provide Ultipa functions to drive ultipa servers
Package sdk provide Ultipa functions to drive ultipa servers
api

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL