独特特性

我们的目标是构建一款专为大型语言模型（LLMs）量身定制的高性能知识图谱，优先考虑极低的延迟，以确保通过我们的图数据库快速高效地传递信息。

🆕 FalkorDB 是首个可查询的属性图数据库，利用稀疏矩阵来表示图中的邻接矩阵以及使用线性代数进行查询。

核心特性

• 稀疏矩阵表示：采用稀疏矩阵来表示邻接矩阵，优化存储和性能。

• 线性代数查询：运用线性代数执行查询，提升计算效率。

• 符合属性图模型：支持带有属性的节点和关系，遵循属性图模型。

• OpenCypher支持：兼容OpenCypher查询语言，包括专有扩展，以实现高级查询功能。

欢迎访问演示，了解FalkorDB的实际应用。

文档

官方文档 | 客户端 | 命令 | 📊 最新性能基准测试

社区与支持

• 讨论区：加入我们在GitHub Discussions上的社区讨论，提问、分享想法并与其他用户交流。

• 贡献：我们欢迎各位的贡献！详情请参阅我们的贡献指南。

• 许可证：本项目采用服务器端公共许可证v1（SSPLv1）。详细信息请参阅LICENSE文件。

开始使用

步骤1

要快速试用FalkorDB，请使用Docker启动一个实例：

docker run -p 6379:6379 -p 3000:3000 -it --rm -v ./data:/var/lib/falkordb/data falkordb/falkordb

步骤2

然后打开浏览器，访问 http://localhost:3000。

您也可以使用任何支持的客户端库与FalkorDB交互。

MotoGP联赛示例

在本示例中，我们将使用FalkorDB Python客户端创建一个小型图，用于表示参加MotoGP联赛的部分摩托车车手和车队。创建图后，我们将查询数据以探索其结构和关系。

from falkordb import FalkorDB

# 连接到FalkorDB
db = FalkorDB(host='localhost', port=6379)

# 创建'MotoGP'图
g = db.select_graph('MotoGP')
g.query("""CREATE (:Rider {name:'Valentino Rossi'})-[:rides]->(:Team {name:'Yamaha'}),
                  (:Rider {name:'Dani Pedrosa'})-[:rides]->(:Team {name:'Honda'}),
                  (:Rider {name:'Andrea Dovizioso'})-[:rides]->(:Team {name:'Ducati'})""")

# 查询哪位车手代表雅马哈？
res = g.query("""MATCH (r:Rider)-[:rides]->(t:Team)
                 WHERE t.name = 'Yamaha'
                 RETURN r.name""")

for row in res.result_set:
	print(row[0])

# 输出： “Valentino Rossi”

# 查询有多少位车手代表杜卡迪车队？
res = g.query("""MATCH (r:Rider)-[:rides]->(t:Team {name:'Ducati'})
                 RETURN count(r)""")

print(res.result_set[0][0])
# 输出： 1

开始构建

编译

请确保完成以下要求：

1️⃣ 克隆FalkorDB仓库：git clone --recurse-submodules -j8 https://github.com/FalkorDB/FalkorDB.git

• Ubuntu系统：运行 apt-get install build-essential cmake m4 automake peg libtool autoconf python3 python3-pip
• Alpine系统：运行 apk add build-base cmake m4 automake libtool autoconf python3 py3-pip peg git libgomp openssl-dev
• OS X系统：确认已安装homebrew，并运行 brew install cmake m4 automake peg libtool autoconf。
  • OS X工具链自带的Clang版本不支持OpenMP，而这是FalkorDB的要求。一种解决方法是运行 brew install gcc g++，并按照屏幕提示更新符号链接。请注意，这将影响整个系统——如果无法全局更改，也可以设置CC和CXX环境变量。

2️⃣ 在项目目录下运行 make 进行编译。

恭喜！编译后的二进制文件位于 bin/<arch>/src/falkordb.so。

运行测试

首先，从 tests 目录运行 pip install -r requirements.txt 来安装所需的 Python 包。

注意：如果 redis-server 已在 PATH 中，只需执行 make test。否则，请执行 REDIS_SERVER=<redis-server-location> make test。若需更详细的输出，可运行 make test V=1。

在 Docker 中构建

FalkorDB 的构建系统在 Docker 容器中运行。有关详细构建说明，请参阅此处。

将 FalkorDB 加载到 Redis 中

FalkorDB 由 Redis 托管，因此您需要先将其作为模块加载到 Redis 服务器中。

注意：最新版本的 FalkorDB 需要 Redis 7.4。

💡 我们建议在启动时让 Redis 自动加载 FalkorDB，方法是将以下内容添加到您的 redis.conf 文件中：

loadmodule /path/to/module/src/falkordb.so

在上述行中，请将 /path/to/module/src/falkordb.so 替换为 FalkorDB 库的实际路径。 如果 Redis 以服务形式运行，您必须确保 redis 用户（默认）具有访问 falkordb.so 所需的文件/文件夹权限。

或者，您也可以使用以下命令行参数语法让 Redis 加载 FalkorDB：

~/$ redis-server --loadmodule /path/to/module/src/falkordb.so

最后，您还可以使用 MODULE LOAD 命令。不过请注意，MODULE LOAD 是一个危险的命令，出于安全考虑，未来可能会被阻止或弃用。

成功加载 FalkorDB 后，您的 Redis 日志应显示类似以下内容的行：

...
30707:M 20 Jun 02:08:12.314 * Module 'graph' loaded from <redacted>/src/falkordb.so
...

如果服务器无法启动，并出现类似以下的错误信息：

# Module /usr/lib/redis/modules/falkordb.so failed to load: libgomp.so.1: cannot open shared object file: No such file or directory
# Can't load module from /usr/lib/redis/modules/falkordb.so: server aborting

则表明系统缺少 OpenMP 运行时依赖项。您可以在 Ubuntu 上通过 apt-get install libgomp1、在 RHEL/CentOS 上通过 yum install libgomp、以及在 OSX 上通过 brew install libomp 来安装它。

使用 FalkorDB

您可以从任何 Redis 客户端调用 FalkorDB 的命令。以下是几种方法：

使用 redis-cli

$ redis-cli
127.0.0.1:6379> GRAPH.QUERY social "CREATE (:person {name: 'roi', age: 33, gender: 'male', status: 'married'})"

使用其他客户端

您可以通过客户端发送原始 Redis 命令来与 FalkorDB 交互。

注意：具体操作方式可能因所使用的客户端而异。

示例：使用 Python 客户端与 FalkorDB 交互

以下代码片段展示了如何使用 falkordb-py 从 Python 中使用 FalkorDB：

from falkordb import FalkorDB

# 连接到 FalkorDB
db = FalkorDB(host='localhost', port=6379)

# 选择社交图谱
g = db.select_graph('social')

reply = g.query("CREATE (:person {name:'roi', age:33, gender:'male', status:'married'})")

客户端库

注意：部分语言拥有支持 FalkorDB 命令的客户端库：

官方客户端

项目	语言	许可证	作者	星数	包管理器	备注
jfalkordb	Java	BSD	FalkorDB		Maven
falkordb-py	Python	MIT	FalkorDB		pypi
falkordb-ts	Node.JS	MIT	FalkorDB		npm
falkordb-rs	Rust	MIT	FalkorDB		Crate
falkordb-go	Go	BSD	FalkorDB		GitHub
NFalkorDB	C#	Apache-2.0	FalkorDB		nuget

其他客户端

项目	语言	许可证	作者	星标	包管理器	备注
nredisstack	.NET	MIT	Redis		nuget
redisgraph-rb	Ruby	BSD	Redis		GitHub
redgraph	Ruby	MIT	pzac		GitHub
redisgraph-go	Go	BSD	Redis		GitHub
rueidis	Go	Apache 2.0	Rueian		GitHub
[ioredisgraph][ioredisgraph-url]	JavaScript	ISC	[Jonah][ioredisgraph-author]	[![ioredisgraph-stars]][ioredisgraph-url]	[GitHub][ioredisgraph-url]
@hydre/rgraph	JavaScript	MIT	Sceat		GitHub
[php-redis-graph][php-redis-graph-url]	PHP	MIT	[KJDev][php-redis-graph-author]	[![php-redis-graph-stars]][php-redis-graph-url]	[GitHub][php-redis-graph-url]
[redisgraph_php][redisgraph_php-url]	PHP	MIT	[jpbourbon][redisgraph_php-author]	[![redisgraph_php-stars]][redisgraph_php-url]	[GitHub][redisgraph_php-url]
[redisgraph-ex][redisgraph-ex-url]	Elixir	MIT	[crflynn][redisgraph-ex-author]	[![redisgraph-ex-stars]][redisgraph-ex-url]	[GitHub][redisgraph-ex-url]
[redisgraph-rs][redisgraph-rs-url]	Rust	MIT	[malte-v][redisgraph-rs-author]	[![redisgraph-rs-stars]][redisgraph-rs-url]	[GitHub][redisgraph-rs-url]
[redis_graph][redis_graph-url]	Rust	BSD	[tompro][redis_graph-author]	[![redis_graph-stars]][redis_graph-url]	[GitHub][redis_graph-url]
[rustis][rustis-url]	Rust	MIT	[Dahomey Technologies][rustis-author]	[![rustis-stars]][rustis-url]	Crate	文档
[NRedisGraph][NRedisGraph-url]	C#	BSD	[tombatron][NRedisGraph-author]	[![NRedisGraph-stars]][NRedisGraph-url]	[GitHub][NRedisGraph-url]
[RedisGraph.jl][RedisGraph.jl-url]	Julia	MIT	[xyxel][RedisGraph.jl-author]	[![RedisGraph.jl-stars]][RedisGraph.jl-url]	[GitHub][RedisGraph.jl-url]

许可证

根据服务器端公共许可证 v1 (SSPLv1) 授权。请参阅 LICENSE。

支持我们的工作

⭐️ 如果您觉得这个仓库很有帮助，请考虑给它点个赞！

↗️ 图、图数据库、RAG、graphrag、检索增强生成、信息检索、自然语言处理、大语言模型、嵌入、语义搜索

FalkorDB 快速上手指南

FalkorDB 是一款超高性能的多租户图数据库，专为大语言模型（LLM）、Agent 记忆、云安全和欺诈检测等场景设计。它是首个利用稀疏矩阵表示邻接矩阵并采用线性代数进行查询的可查询属性图数据库。

环境准备

系统要求

• 操作系统: Linux (Ubuntu/Alpine), macOS
• Redis 版本: 需要 Redis 7.4 或更高版本（FalkorDB 作为 Redis 模块运行）
• 硬件架构: x86_64 或 ARM64

前置依赖

如果您计划从源码编译，请确保安装以下构建工具：

• Ubuntu/Debian:

  apt-get install build-essential cmake m4 automake peg libtool autoconf python3 python3-pip libgomp1
  

• Alpine Linux:

  apk add build-base cmake m4 automake libtool autoconf python3 py3-pip peg git libgomp openssl-dev
  

• macOS (需使用 Homebrew):

  brew install cmake m4 automake peg libtool autoconf gcc
  

  注意: macOS 默认 Clang 不支持 OpenMP，建议安装 gcc 并配置环境变量 CC 和 CXX，或使用 Docker 构建。

---

安装步骤

推荐使用 Docker 进行快速部署，这是最简便的方式。

方法一：使用 Docker 运行（推荐）

直接拉取镜像并启动容器，映射数据卷以持久化数据：

docker run -p 6379:6379 -p 3000:3000 -it --rm -v ./data:/var/lib/falkordb/data falkordb/falkordb

• -p 6379:6379: Redis 协议端口
• -p 3000:3000: Web UI 界面端口
• 启动后，可在浏览器访问 http://localhost:3000 使用图形化界面。

方法二：作为模块加载到现有 Redis

如果您已有 Redis 7.4 环境，可下载编译好的 .so 文件并在 redis.conf 中添加：

loadmodule /path/to/module/src/falkordb.so

或者通过命令行启动：

redis-server --loadmodule /path/to/module/src/falkordb.so

提示: 确保运行 Redis 的用户对 .so 文件有读取权限，且系统已安装 libgomp 运行时库。

---

基本使用

FalkorDB 兼容 OpenCypher 查询语言。您可以使用任何 Redis 客户端或官方提供的多语言客户端进行交互。

示例：使用 Python 客户端操作图数据

以下示例演示如何创建包含摩托车手和车队关系的图，并进行查询。

1. 安装 Python 客户端:

   pip install falkordb
   

2. 编写代码 (main.py):

from falkordb import FalkorDB

# 1. 连接到 FalkorDB
db = FalkorDB(host='localhost', port=6379)

# 2. 选择或创建名为 'MotoGP' 的图
g = db.select_graph('MotoGP')

# 3. 创建节点和关系 (Rider rides Team)
g.query("""CREATE 
    (:Rider {name:'Valentino Rossi'})-[:rides]->(:Team {name:'Yamaha'}),
    (:Rider {name:'Dani Pedrosa'})-[:rides]->(:Team {name:'Honda'}),
    (:Rider {name:'Andrea Dovizioso'})-[:rides]->(:Team {name:'Ducati'})
""")

# 4. 查询：哪位车手效力于 Yamaha 车队？
res = g.query("""MATCH (r:Rider)-[:rides]->(t:Team)
                 WHERE t.name = 'Yamaha'
                 RETURN r.name""")

print("Yamaha riders:")
for row in res.result_set:
    print(row[0])

# 5. 查询：Ducati 车队有多少位车手？
res = g.query("""MATCH (r:Rider)-[:rides]->(t:Team {name:'Ducati'})
                 RETURN count(r)""")

print(f"Ducati rider count: {res.result_set[0][0]}")

3. 运行结果:

   Yamaha riders:
   Valentino Rossi
   Ducati rider count: 1
   

其他使用方式

• Redis CLI: 直接使用 GRAPH.QUERY 命令。

  redis-cli
  127.0.0.1:6379> GRAPH.QUERY social "CREATE (:person {name: 'roi', age: 33})"
  

• 官方客户端支持: Java, Node.js, Rust, Go, C# 等语言均有官方维护的客户端库，详见 FalkorDB 文档。