Graph Database Configuration

Graphiti supports two graph database backends: Neo4j and FalkorDB. This guide covers installation and configuration options for both databases across different deployment scenarios.

Neo4j

Neo4j is the primary graph database backend for Graphiti. Version 5.26 or higher is required for full functionality.

Neo4j Community Edition

Neo4j Community Edition is free and suitable for development, testing, and smaller production workloads.

Installation via Neo4j Desktop

The simplest way to install Neo4j is via Neo4j Desktop, which provides a user-friendly interface to manage Neo4j instances and databases.

1. Download and install Neo4j Desktop
2. Create a new project
3. Add a new database (Local DBMS)
4. Set a password for the neo4j user
5. Start the database

Docker Installation

For containerized deployments:

$
docker run \
>
    --name neo4j-community \
>
    -p 7474:7474 -p 7687:7687 \
>
    -e NEO4J_AUTH=neo4j/your_password \
>
    -e NEO4J_PLUGINS='["apoc"]' \
>
    neo4j:5.26-community

Configuration

Set the following environment variables:

$
export NEO4J_URI=bolt://localhost:7687
>
export NEO4J_USER=neo4j
>
export NEO4J_PASSWORD=your_password

Connection in Python

1
from graphiti_core import Graphiti
2
3
graphiti = Graphiti(
4
    neo4j_uri="bolt://localhost:7687",
5
    neo4j_user="neo4j", 
6
    neo4j_password="your_password"
7
)

Neo4j AuraDB (Cloud)

Neo4j AuraDB is a fully managed cloud service that handles infrastructure, backups, and updates automatically.

Setup

1. Sign up for Neo4j Aura
2. Create a new AuraDB instance
3. Note down the connection URI and credentials
4. Download the connection details or copy the connection string

Configuration

AuraDB connections use the neo4j+s:// protocol for secure connections:

$
export NEO4J_URI=neo4j+s://your-instance.databases.neo4j.io
>
export NEO4J_USER=neo4j
>
export NEO4J_PASSWORD=your_generated_password

Connection in Python

1
from graphiti_core import Graphiti
2
3
graphiti = Graphiti(
4
    neo4j_uri="neo4j+s://your-instance.databases.neo4j.io",
5
    neo4j_user="neo4j",
6
    neo4j_password="your_generated_password"
7
)

Neo4j Enterprise Edition

Neo4j Enterprise Edition provides advanced features including clustering, hot backups, and performance optimizations.

Installation

Enterprise Edition requires a commercial license. Installation options include:

• Neo4j Desktop: Add Enterprise Edition license key
• Docker: Use neo4j:5.26-enterprise image with license
• Server Installation: Download from Neo4j website with valid license

Docker with Enterprise Features

$
docker run \
>
    --name neo4j-enterprise \
>
    -p 7474:7474 -p 7687:7687 \
>
    -e NEO4J_AUTH=neo4j/your_password \
>
    -e NEO4J_PLUGINS='["apoc"]' \
>
    -e NEO4J_ACCEPT_LICENSE_AGREEMENT=yes \
>
    neo4j:5.26-enterprise

Parallel Runtime Configuration

Enterprise Edition supports parallel runtime for improved query performance:

$
export USE_PARALLEL_RUNTIME=true

Connection in Python

1
import os
2
from graphiti_core import Graphiti
3
4
# Enable parallel runtime for Enterprise Edition
5
os.environ['USE_PARALLEL_RUNTIME'] = 'true'
6
7
graphiti = Graphiti(
8
    neo4j_uri="bolt://localhost:7687",
9
    neo4j_user="neo4j",
10
    neo4j_password="your_password"
11
)

FalkorDB

FalkorDB configuration requires version 1.1.2 or higher.

Docker Installation

The simplest way to run FalkorDB is via Docker:

$
docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest

This command:

• Exposes FalkorDB on port 6379 (Redis protocol)
• Provides a web interface on port 3000
• Runs in foreground mode for easy testing

Configuration

Set the following environment variables for FalkorDB (optional):

$
export FALKORDB_HOST=localhost          # Default: localhost
>
export FALKORDB_PORT=6379              # Default: 6379
>
export FALKORDB_USERNAME=              # Optional: usually not required
>
export FALKORDB_PASSWORD=              # Optional: usually not required

Connection in Python

1
from graphiti_core import Graphiti
2
from graphiti_core.driver.falkordb_driver import FalkorDriver
3
4
# FalkorDB connection using FalkorDriver
5
falkor_driver = FalkorDriver(
6
    host='localhost',        # or os.environ.get('FALKORDB_HOST', 'localhost')
7
    port='6379',            # or os.environ.get('FALKORDB_PORT', '6379')
8
    username=None,          # or os.environ.get('FALKORDB_USERNAME', None)
9
    password=None           # or os.environ.get('FALKORDB_PASSWORD', None)
10
)
11
12
graphiti = Graphiti(graph_driver=falkor_driver)