graph-migration-tool

This tool allows you to migrate existing database to a graph database

Conversions supported:
- json to gremlin
- json to graph
- sql to graph

Installation (CLI)

> npm i -g graphdb-migration-tool

Usage (CLI)

Usage: graphdb-migration-tool [options] [command]

Options:

-V, --version output the version number
-h, --help output usage information

Commands:

jsontogremlin
jsontograph
sqltograph

Installation (Lib)

> npm i --save graphdb-migration-tool

Usage (Lib)

``js
var graphtool = require('graphdb-migration-tool');
var result = graphtool.jsonToGraph(json,template);

//or ES6
import {jsonToGraph} from 'graphdb-migration-tool';
`

$3


`json5
{
"dialect":"mssql", //dialect to use, 'mysql'|'sqlite'|'postgres'|'mssql'
"username": "test",
"password": "password",
"host": "server",
"database": "database",
"options": {
"encrypt": true //set to true if you need encryption
}
}
`

$3

`json
{
"host":"server",
"password":"password",
"user": "username",
"port": "443",
"ssl": true
}
`

Note: For Azure cosmos graph DB , user is 'dbs/{dbName}/colls/{collectionName}' and password is its secretKey

Template

To transform data to a graph, you need to transform the data into vertex and edge format.

Using a template you can convert a single data object into one/many vertexes and edges

We use handlebars to convert input to vertex / edge format

$3

template:

`hbs
{
"vertices":[
{
"label": "vertexLabel",
"properties":{
"id": "{{myId}}",
"name": "{{myName}}"
}
},
{
"label": "vertexLabel",
"properties":{
"id": "{{myFriendId}}",
"name": "{{myFriendName}}"
}
}
],
"edges":[
{
"label": "friend",
"from": "{{myId}}",
"to": "{{myFriendId}}",
"properties": {
"value" : {{friendshipLvl}}
}
}
]
}

`

Note: You can specify as many vertices and edges as you want as long as it transforms to Vertex-Edge format

Input Data(a single entity from array of data):

`json
{
"myId": "1",
"myName": "abc",
"myFriendId": "2",
"myFriendName": "xyz",
"friendshipLvl": 3
}
`

Transformed Data:

`json
{
"vertices":[
{
"label": "vertexLabel",
"properties":{
"id": "1",
"name": "abc"
}
},
{
"label": "vertexLabel",
"properties":{
"id": "2",
"name": "xyz"
}
}
],
"edges":[
{
"label": "friend",
"from": "1",
"to": "2",
"properties": {
"value" : 3
}
}
]
}
`

Vertex-Edge Format

This is a custom format inspired from the way Azure Cosmos Graph DB stores data. We use this format to convert it to gremlin queries so you need to provide a template which transforms to vertex-edge format

Model for Vertex and Edge
`ts
export interface Vertex {
label: string; //label for the vertex
type: 'vertex';
properties: {
id: string;
[key: string]: any; //Represents all the properties you wish to add to the vertex
};
}

export interface Edge {
label: string; //label for the edge
type: 'edge';
to: string; //id of vertex from which you want the edge to start
from: string; //id of vertex to which you want the edge to end
properties?: {
id?: string;
[key: string]: any; //Represents all the properties you wish to add to the edge
};
}

`

Vertex-Edge Format expects you specify an array of vertices and edges

`json
{
"vertices":[
{
"label": "vertexLabel",
"properties":{
"id": "1",
"name": "abc"
}
},
{
"label": "vertexLabel",
"properties":{
"id": "2",
"name": "xyz"
}
}
],
"edges":[
{
"label": "friend",
"from": "1",
"to": "2",
"properties": {
"value" : 3
}
}
]
}
``