sekisamu / indradb

A graph database written in rust

IndraDB

A graph database written in rust.

IndraDB consists of a server and an underlying library. Most users would use the server, which is available via releases as pre-compiled binaries. But if you're a rust developer that wants to embed a graph database directly in your application, you can use the library.

Features

• Support for directed and typed graphs.
• Support for queries with multiple hops.
• Cross-language support via Cap'n Proto, or direct embedding as a library.
• Support for JSON-based properties tied to vertices and edges.
• Pluggable underlying datastores, with built-in support for in-memory-only and rocksdb. Postgresql is available separately.
• Written in rust!

IndraDB's original design is heavily inspired by TAO, facebook's graph datastore. In particular, IndraDB emphasizes simplicity of implementation and query semantics, and is similarly designed with the assumption that it may be representing a graph large enough that full graph processing is not possible. IndraDB departs from TAO (and most graph databases) in its support for properties.

For more details, see the homepage.

Getting started

• Download the latest release for your platform.
• Add the binaries to your PATH.
• Start the app: indradb

This should start an in-memory-only datastore, where all work will be wiped out when the server is shutdown. You can persist your work with one of the alternative datastores.

In-memory

By default, IndraDB starts an in-memory datastore that does not persist to disk. This is useful for kicking the tires. If you want to use the in-memory datastore, do not set the DATABASE_URL, or just set it to memory://. e.g.: DATABASE_URL=memory:// indradb

RocksDB

If you want to use the rocksdb-backed datastore, set the DATABASE_URL environment variable; e.g.: DATABASE_URL=rocksdb://database.rdb indradb.

Environment variables

Applications are configured via environment variables:

• DATABASE_URL: The connection string to the underlying database.
• PORT: The port to run the server on. Defaults to 27615.

Additional environment variables available when using the RocksDB datastore:

• ROCKSDB_MAX_OPEN_FILES: Sets the number of maximum open files to have open in RocksDB.
• ROCKSDB_BULK_LOAD_OPTIMIZED: If set to true, RocksDB will be configured to optimize for bulk loading of data, likely at the detriment of any other kind of workload.

Install from source

If you don't want to use the pre-built releases, you can build/install from source:

• Install rust. IndraDB should work with any of the rust variants (stable, nightly, beta.)
• Make sure you have gcc 5+ installed.
• Clone the repo: git clone [e-mail]:indradb/indradb.git.
• Build/install it: cargo install.

Running tests

Use make test to run the test suite. Note that this will run the full test suite across the entire workspace, including tests for all datastore implementations. Similarly, you can run make bench to run the full benchmarking suite.

You can filter which tests run via the TEST_NAME environment variable. e.g. TEST_NAME=create_vertex make test will run tests with create_vertex in the name across all datastore implementations.