The Rust implementation of falkordb

Developer Guide

Build

dependencies:

• building GraphBLAS

GraphBLAS must be built and installed before building this project.

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

• 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

• build with cargo build
• 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

Query Visualizer User Guide

Overview

The Query Visualizer is a terminal-based application for interactively exploring the results of FalkorDB queries. It provides a tree view of query execution steps, allows searching through results, and supports step-by-step navigation.

Features

• Query Execution: Enter and run Cypher queries against a FalkorDB database.
• Tree Visualization: View the structure of query results as a tree.
• Step Navigation: Move forward and backward through result steps.
• Search: Filter steps using custom Python expressions.
• Query History: Navigate through previously entered queries.

Getting Started

Running the App

1. Ensure FalkorDB server is running and accessible.
2. Run the application:

   python tests/record.py

3. Optionally, run it as a server

   textual serve tests/record.py

Interface Guide

Main Components

• Query Label: Displays the last executed query.
• Search Input: Enter a Python expression to filter steps (e.g., x == 5).
• Tree View: Shows the result structure. Each node represents a step or result.
• Step Label & Progress Bar: Indicates the current step and progress.
• Query Input: Enter a new Cypher query to execute.

Controls

Navigating Steps

• Left Arrow: Move to the previous step.
• Right Arrow: Move to the next step.

Searching Steps

• Focus the "Search" input (Tab to navigate).
• Enter a Python expression using result variable names (e.g., x == 3 and y > 5).
• Press Enter to jump to the next step matching the condition.

Running Queries

• Focus the "Enter query" input.
• Type your Cypher query and press Enter to execute.
• Use Up/Down arrows to navigate query history.

Tree Interaction

• The tree updates to highlight the current step.
• The label shows the environment (i.e., variable values) for the selected step.

Example Usage

1. Start the app.
2. Enter a query like:

   UNWIND range(1, 10) AS x UNWIND range(x, 10) AS y RETURN x, y
   

3. Use the arrow keys to step through results.
4. Use the search box to filter steps (e.g., x == 5).

Notes

• The search uses Python's eval(); use valid expressions and variable names as shown in the tree.
• The app maintains a history of queries for easy recall.