Java JavaScript ANTLR HTML CSS
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
gradle/wrapper Update Gradle and dependency versions Jul 20, 2017
intellij_configs
src
.coveralls.yml Test Coverage (#8) Sep 22, 2017
.gitignore
.travis.yml Test Coverage (#8) Sep 22, 2017
CONTRIBUTING.md Add contributing guidelines May 5, 2017
LICENSE add Apache License 2.0 notice Apr 29, 2017
README.md
build.gradle add skipped and failed test logging to gradle (#73) Dec 19, 2017
gradlew
settings.gradle Reorganize and cleanup files Oct 8, 2016

README.md

Graphflow

Build Status Coverage Status

Graphflow is an in-memory graph database that supports continuous queries. Graphflow's query language is based on openCypher. Currently Graphflow supports a subset of queries expressible in openCypher. In addition it supports several extensions to openCypher for expressing continuous queries. Throughout the code base and documentation, we refer to this extended version of openCypher as openCypher++.

A key feature of Graphflow is the use of the worst-case optimal Generic Join algorithm to do one-time and continuous match queries.

Build steps

Graphflow requires Java 8, and uses Gradle as its build tool.

  • Do a full clean build: ./gradlew clean build installDist
  • Subsequent builds: ./gradlew build installDist
  • Build without tests: ./gradlew build installDist -x test

Running the Server and CLI

Gradle creates helper scripts for running the server and the client. Once the build is successful, run the scripts in two different terminals.

  • Start Graphflow server:
    ./build/install/graphflow/bin/graphflow-server
  • Start Graphflow CLI:
    ./build/install/graphflow/bin/graphflow-cli

The CLI can now be used to interact with the server using openCypher++ queries.

The Graphflow server logs to stdout by default. To change the logging mechanism, provide a custom log4j2 config file:

export GRAPHFLOW_SERVER_OPTS="-Dlog4j.configurationFile=file:/path/to/log4j2.properties"  
./build/install/graphflow/bin/graphflow-server

Publishing Maven artifacts

Run the following command:

./gradlew publishToMavenLocal

Using in Maven projects

In the pom.xml, add the following entry:

<dependency>
  <groupId>ca.waterloo.dsg</groupId>
  <artifactId>graphflow</artifactId>
  <version>0.1.0</version>
</dependency>

Using in Gradle projects

In the build.gradle file, add the mavenLocal() entry to the repositories { ... } section and add the following dependency:

compile group: 'ca.waterloo.dsg', name: 'graphflow', version: '0.1.0'

Licensing

Graphflow is an open source software under the Apache 2.0 license.