The Rust implementation of falkordb

Developer Guide

Quick Start with Dev Container (Recommended)

The easiest way to get started is using the development container, which includes all dependencies pre-installed:

1. Install Docker and VS Code
2. Install the Dev Containers extension
3. Open this project in VS Code
4. Click "Reopen in Container" when prompted (or press F1 and select "Dev Containers: Reopen in Container")
5. Wait for the container to build (first time takes ~10-15 minutes)
6. Start developing! All dependencies are ready to use.

See .devcontainer/README.md for more details.

Manual Setup

If you prefer to set up the environment manually:

Build

cargo build

Dependencies:

GraphBLAS & RediSearch must be built and installed before building this project.

• building GraphBLAS

  ./graphblas.sh
``

or

```bash
  make static CMAKE_OPTIONS='-DGRAPHBLAS_COMPACT=1 -DCMAKE_POSITION_INDEPENDENT_CODE=on'
  sudo make install

• building RediSearch

  ./redisearch.sh

• pytest - create virtualenv and install tests/requirements.txt

The virtual environment should be activated before running tests.

  python3 -m venv venv
  source venv/bin/activate
  pip install -r  tests/requirements.txt

Testing

• run e2e tests with pytest tests/test_e2e.py tests/test_functions.py -vv
• run tck tests with pytest tests/tck/test_tck.py -s

There is an option to run only part of the TCK tests and stop on the first fail

TCK_INCLUDE=tests/tck/features/expressions/list pytest tests/tck/test_tck.py -s

To run all passing TCK tests use:

TCK_DONE=tck_done.txt pytest tests/tck/test_tck.py -s

• run unit tests with cargo test -p graph

• benchmark