Go to file
bookug 84dbb166c3 update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
.debug add insertion and deletion;move new version here 2016-09-16 16:56:18 +08:00
.objs add insertion and deletion;move new version here 2016-09-16 16:56:18 +08:00
.tmp add insertion and deletion;move new version here 2016-09-16 16:56:18 +08:00
COVERAGE fix bugs in gclient 2017-02-08 16:29:53 +08:00
Database move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
KVstore move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
Main update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
Parser support JSON result 2017-02-28 20:32:01 +08:00
Query move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
Server move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
Signature move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
StringIndex version 0.4.0 2017-01-16 14:12:57 +08:00
Util update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
VSTree move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
api update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
bin add insertion and deletion;move new version here 2016-09-16 16:56:18 +08:00
data move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
docs update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
lib add insertion and deletion;move new version here 2016-09-16 16:56:18 +08:00
logs update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
test move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
tools version 0.4.0 2017-01-16 14:12:57 +08:00
.gitignore merge newest devGstore 2016-05-16 03:16:22 +08:00
LICENSE add LICENSE for branch master 2017-03-23 13:33:53 +08:00
NOTES.md update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
README.md update the docs; fix bugs in gconsole and api 2017-03-26 23:21:56 +08:00
init.conf move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00
makefile move devGstore to gStore and go on working on github instead of git osc; 2017-03-23 21:32:41 +08:00

README.md

Gstore System

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. Only source tarballs are provided currently, which means you have to compile the source code if you want to use our system.

The formal help document is in Handbook.

We have built an IRC channel named #gStore on freenode, and you can also come to our website: gStore.

Getting Started

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:

  • download the zip from this repository and extract it

  • fork this repository in your github account

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

Then you need to compile the project, just type make in the gStore root directory, and all executables will be ok. 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/gconsole is a wonderful tool designed for you, providing all operations you need to use gStore. Notice that all commands should be typed in the root directory of gStore, and your database name should not end with ".db".


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.


Other Business

We have written a series of short essays addressing recurring challenges in using gStore to realize applications, which are placed in Recipe Book.

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 to chenjiaqi93@163.com to submit your suggestions and report bugs to us by emailing to zengli-bookug@pku.edu.cn. A full list of our whole team is in Mailing List.

There are some restrictions when you use the current gStore project, you can see them on Limit Description.

Sometimes you may find some strange phenomena(but not wrong case), or something hard to understand/solve(don't know how to do next), then do not hesitate to visit the Frequently Asked Questions page.

Graph database engine is a new area and we are still trying to go further. Things we plan to do next is in Future Plan chapter, 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

  • ...

People who inspire us or contribute to this project will be listed in the Thanks List chapter.

This whole document is divided into different pieces, and each them is stored in a markdown file. You can see/download the combined markdown file in help_markdown, and for html file, please go to help_html. What is more, we also provide help file in pdf format, and you can visit it in help_pdf.