Installation
Install Graphiti with FalkorDB support:Prerequisites
Run FalkorDB with Docker
The fastest way to get started:- FalkorDB on port 6379 (Redis protocol)
- FalkorDB Browser UI on port 3000
Run with Docker Compose
From the Graphiti repository:Configuration
Environment Variables
.env
Basic Setup
Initialize Graphiti with FalkorDB:Custom Database Name
FalkorDB supports multiple graphs (databases) per instance:Driver Implementation
The FalkorDriver (graphiti_core/driver/falkordb_driver.py:109) provides:
- Redis Protocol: Uses FalkorDB’s async Redis client
- Multi-tenancy: Support for multiple graphs in a single instance
- RedisSearch: Fulltext search using RedisSearch syntax
- Lightweight: Embedded or standalone deployment options
Connection Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
host | str | "localhost" | FalkorDB server host |
port | int | 6379 | FalkorDB server port |
username | str | None | None | Authentication username (optional) |
password | str | None | None | Authentication password (optional) |
database | str | "default_db" | Graph database name |
falkor_db | FalkorDB | None | None | Existing FalkorDB client instance |
Fulltext Search
FalkorDB uses RedisSearch syntax for fulltext queries:- Sanitizes special characters
- Removes stopwords
- Builds RedisSearch-compatible query strings
Index Management
Graphiti automatically creates:- Range Indices: On UUID, timestamps, and group_id fields
- Fulltext Indices: On entity/edge facts and episode content
Complete Example
When to Use FalkorDB
Choose FalkorDB if you:- Need a lightweight, Redis-based solution
- Want simpler deployment (single binary)
- Prefer RedisSearch for fulltext indexing
- Need embedded database capabilities
- Are prototyping or building smaller-scale applications
- Need enterprise-grade production features
- Require advanced graph algorithms
- Need clustering and high availability
- Want extensive tooling and ecosystem support
Production Considerations
- Persistence: Configure Redis persistence (AOF/RDB) for data durability
- Memory: FalkorDB is in-memory; ensure adequate RAM for your dataset
- Clustering: Use Redis Cluster for horizontal scaling
- Monitoring: Use Redis monitoring tools (RedisInsight, etc.)