Gstore System(also called gStore) is a graph database engine for managing large graph-structured data, which is open-source and targets at Linux operation systems.

The whole project is written in C++, with the help of some libraries such as readline, antlr, and so on.

 

Getting Started

Compile from Source

This system is really user-friendly and you can pick it up in several minutes. Remember to check your platform where you want to run this system by viewing System Requirements. After all are verified, please get this project’s source code. There are several ways to do this:

• type  git clone https://github.com/pkumod/gStore.git  in your terminal or use git GUI to acquire it

• download the zip from this repository and extract it

• fork this repository in your github account

Then you need to compile the project, for the first time you need to type  make pre  to prepare the  ANTLR  library and some Lexer/Parser programs. Later you do not need to type this command again, just type  make  in the gStore root directory, and all executables will be generated. For faster compiling speed, use   make -j4  instead, using how many threads is up to your machine. To check the correctness of the program, please type  make test  command.

The first strategy is suggested to get the source code because you can easily acquire the updates ot the code by typing  git pull  in the home directory of gStore repository. In addition, you can directly check the version of code by typing  git log  to see the commits logs. If you want to use code from other branches instead of master branch, like 'dev' branch, then: clone the master branch and type  git checkout dev  in your terminal, or clone the dev branch directly by typing  git clone -b dev .

 

Deploy via Docker

You can easily deploy gStore via Docker. We provide both of Dockerfile and docker image. Please see Install Guide.

Run

To run gStore, please type  bin/gbuild database_name dataset_path  to build a database named by yourself. And you can use bin/gquery database_name command to query a existing database.

What is more, bin/ghttp is a wonderful tool designed for you, as a database server which can be accessed via HTTP protocol. Notice that all commands should be typed in the root directory of gStore.

A detailed description can be found at How To Use in this document.

 

Advanced Help

If you want to understand the details of the gStore system, or you want to try some advanced operations(for example, using the API, server/client), please see the chapters below.

• Basic Introduction: introduce the theory and features of gStore

• Install Guide: instructions on how to install this system

• How To Use: detailed information about using the gStore system

• HTTP API: guide you to develop applications based on our HTTP API

• Socket API: guide you to develop applications based on our Socket API

• Use gStore in Web: show you how to use gStore in a simple web project

• FAQ: Frequently asked questions

• Recipe Book: a series of short essays addressing recurring challenges in using gStore to realize applications

 

Other Business

You are welcome to report any advice or errors in the github Issues part of this repository, if not requiring in-time reply. However, if you want to urgent on us to deal with your reports, please email bookug@qq.com to submit your suggestions and report bugs to us by emailing to gStoreDB@gmail.com. 

Graph database engine is a new area and we are still trying to go further. And we hope more and more people will support or even join us. You can support in many ways:

• watch/star our project

• fork this repository and submit pull requests to us

• download and use this system, report bugs or suggestions

• ...