Installation

You can simply install Goblinoid from PyPI:

$ pip3 install goblinoid

Once your Goblinoid is installed you can access its CLI using:

$ goblinoid --help

Usage - Schema creation

Goblinoid allows you to automatically create schema based on models defined in your source code. To automatically generate schema definition, you need to point Goblinoid to the correct module of your application that holds all defined models for your application:

$ goblinoid-cli --module-import 'myapp.graph.models' --models-iterable 'ALL_MODELS' --schema-file schema.groovy

It’s important to state that your package/module is importable for the CLI (you might want to adjust PYTHONPATH to accomplish that in some cases). Goblinoid automatically creates a Groovy script that you can run to create schema.

It is recommended to also provide the --schema-vertex-identifier option. In that case Goblinoid automatically creates a vertex with label goblinoid_schema_meta that holds provided identifier and datetime when the schema creation was performed. This allows you to keep graph metadata for later debugging or ensuring your services that communicate with the graph instance use required schema version.

By default, Goblinoid disables JanusGraph’s schema maker. It is recommended having the schema maker disabled so all vertexes and edges that are added to the graph database respect the provided schema and there are not created additional schema entries. You can avoid this behaviour by specifying the --keep-schema-maker flag. See the official documentation for more info.