Official Clients

Project Docs Language License Author Package
falkordb-py Pydoc Python MIT FalkorDB pypi
falkordb-ts JSDoc Node.JS MIT FalkorDB npm
jfalkordb javadocs Java BSD FalkorDB maven
falkordb-rs docs.rs Rust MIT FalkorDB crates
falkordb-go godoc Go BSD FalkorDB Github
falkordb-php readme PHP MIT FalkorDB Github
NFalkorDB readme C# Apache-2.0 FalkorDB nuget

Official Object-Graph Mapping (OGM) Libraries

FalkorDB provides official Object-Graph Mapping (OGM) libraries that allow you to work with graph data using native language objects and structures.

Project Docs Language License Author Package
falkordb-py-orm readme Python MIT FalkorDB GitHub
falkordb-go-orm readme Go MIT FalkorDB GitHub
spring-data-falkordb readme Java Apache-2.0 FalkorDB GitHub

Additional Clients

Note: Some clients below were originally developed for RedisGraph. While many may work with FalkorDB due to protocol compatibility, they are not officially tested or supported. For best results, use the official FalkorDB clients listed above.

Implementing a client

Information on some of the tasks involved in writing a FalkorDB client can be found in the Client Specification.

Frequently Asked Questions 5
Which client library should I use for my project?

Use the official client for your language: falkordb-py (Python), falkordb-ts (Node.js), jfalkordb (Java), falkordb-rs (Rust), falkordb-go (Go), falkordb-php (PHP), or NFalkorDB (C#). These are actively maintained by the FalkorDB team and support both RESP and Bolt protocols.

Are the old RedisGraph clients compatible with FalkorDB?

Many community clients originally built for RedisGraph may work with FalkorDB due to protocol compatibility, but they are not officially tested or supported. For best results and access to the latest features, use the official FalkorDB clients listed in the table above.

Does FalkorDB support Object-Graph Mapping (OGM)?

Yes. FalkorDB offers official OGM libraries for Python (falkordb-py-orm), Go (falkordb-go-orm), and Java (spring-data-falkordb). These let you work with graph data using native language objects instead of writing raw Cypher queries.

What connection protocols does FalkorDB support?

FalkorDB supports both the RESP protocol (Redis Serialization Protocol) and the Bolt protocol (used by Neo4j-compatible tools). You can configure the Bolt port using the BOLT_PORT configuration parameter.

Where can I find API documentation for each client?

Each official client has dedicated documentation: Python has Pydoc, Node.js has JSDoc, Java has Javadocs, Rust has docs.rs, and Go has GoDoc. Links are in the table above.