How helixdb/helix-db works
HelixDB is a graph database with transactional graph queries, vector search, and BM25 full-text search. A typical workflow is to build a query with an SDK or CLI, send it to a running instance, execute it through the query service and interpreter, and receive results. The planner and index lifecycle provide important internal layers. Relationships below are limited to README statements and sampled-source references; unsampled subsystem connections are omitted.
Main entry points: query_service.rs Query Service · interpreter/mod.rs Query Interpreter · pipeline.rs Query Planner · index_lifecycle/mod.rs Index Lifecycle
Components 17
Clients and CLI
- Language SDKs
sdks - Helix CLI
crates/cli/src/commands/query.rs
Service Boundary
- Database Server
crates/server/src/main.rs - Query Service
crates/db/src/query_service.rs
Query Runtime
- Query Planner
crates/planner/src/relational/pipeline.rs - Logical Pipelines
crates/planner/src/logical/access/pipeline.rs - Physical Plan
crates/planner/src/physical/pipeline.rs - Query Interpreter
crates/db/src/execution/interpreter/mod.rs
Storage and Search
- Storage Access
crates/db/src/execution/interpreter/storage.rs - Graph Encoding
crates/db/src/encoding/mod.rs - Transactional Graph Data
crates/db/src - Vector Search
crates/db/src/search/vector - BM25 Text Search
crates/db/src/search/text
Index Lifecycle
- Index Lifecycle
crates/db/src/index_lifecycle/mod.rs - Index Operation Queue
crates/db/src/index_lifecycle/queue
Other components
- Application Developer
- Object Storage
Connections 19
- Application Developer → Language SDKs: builds queries
README.md - Application Developer → Helix CLI: runs commands
README.md - Language SDKs → Database Server: sends requests
README.md - Helix CLI → Database Server: queries instance
README.md - Database Server → Query Service: handles queries
- Query Service → Query Interpreter: executes queries
crates/db/src/query_service.rs - Query Service → Query Planner: plans requests
- Query Service → Query Planner: supports Cypher
crates/db/src/query_service.rs - Query Planner → Logical Pipelines: uses logical operators
crates/planner/src/relational/pipeline.rs - Query Planner → Physical Plan: selects physical strategies
crates/planner/src/relational/pipeline.rs - Query Interpreter → Storage Access: reads and writes
crates/db/src/execution/interpreter/storage.rs - Storage Access → Graph Encoding: uses encoded keys
crates/db/src/execution/interpreter/storage.rs - Query Interpreter → Vector Search: supports vector queries
crates/db/src/execution/interpreter/mod.rs - Query Interpreter → BM25 Text Search: supports text queries
- Index Lifecycle → Index Operation Queue: manages operations
crates/db/src/index_lifecycle/mod.rs - Index Operation Queue → Object Storage: persists queue data
- Index Lifecycle → Vector Search: maintains search indexes
- Index Lifecycle → BM25 Text Search: maintains search indexes
- Storage Access → Transactional Graph Data: accesses records
crates/db/src/execution/interpreter/storage.rs