> ## Documentation Index
> Fetch the complete documentation index at: https://docs.falkordb.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> FalkorDB is a graph database that speaks the Redis protocol. Queries are issued as OpenCypher through the GRAPH.QUERY and GRAPH.RO_QUERY commands, not over Bolt or a SQL connection.
> FalkorDB implements a subset of OpenCypher with proprietary extensions. Do not assume Neo4j-only syntax or procedures are available — check /cypher/cypher-support and /cypher/known-limitations before using a clause.
> FalkorDB is the successor to RedisGraph, but they are separate products. Do not present RedisGraph commands, versions, or limitations as current FalkorDB behavior.
> Use the official clients listed in /getting-started/clients rather than generic Redis or Neo4j drivers, and prefer the language the user is already working in.
> Configuration parameters are set with GRAPH.CONFIG SET or at startup; cite the exact parameter name from /getting-started/configuration rather than inventing one.
> This site covers four products: FalkorDB (core), FalkorDB Cloud, FalkorDB Enterprise, and the GraphRAG SDK. Name which one an answer applies to, since setup and operations differ.

# Client Libraries

> Official FalkorDB client libraries for Python, Node.js, Java, Rust, Go, PHP, and C# with Object-Graph Mapping (OGM) support for Spring Data, and additional community clients.

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

## 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][falkordb-py-orm-url]  | [readme][falkordb-py-orm-docs] | Python   | MIT        | [FalkorDB][falkordb-url] | [GitHub][falkordb-py-orm-url] |
| [falkordb-go-orm][falkordb-go-orm-url]  | [readme][falkordb-go-orm-docs] | Go       | MIT        | [FalkorDB][falkordb-url] | [GitHub][falkordb-go-orm-url] |
| [spring-data-falkordb][spring-data-url] | [readme][spring-data-docs]     | Java     | Apache-2.0 | [FalkorDB][falkordb-url] | [GitHub][spring-data-url]     |

## 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.

| Project                                | Language   | License    | Author                                | Package                                  |
| -------------------------------------- | ---------- | ---------- | ------------------------------------- | ---------------------------------------- |
| [nredisstack][nredisstack-url]         | .NET       | MIT        | [Redis][redis-url]                    | [nuget][nredisstack-package]             |
| [falkordb\_ex][falkordb_ex-url]        | Elixir     | MIT        | [Sebastian][falkordb_ex-author]       | [GitHub][falkordb_ex-url]                |
| [redisgraph-rb][redisgraph-rb-url]     | Ruby       | BSD        | [Redis][redisgraph-rb-author]         | [GitHub][redisgraph-rb-url]              |
| [redgraph][redgraph-url]               | Ruby       | MIT        | [pzac][redgraph-author]               | [GitHub][redgraph-url]                   |
| [redisgraph-go][redisgraph-go-url]     | Go         | BSD        | [Redis][redisgraph-go-author]         | [GitHub][redisgraph-go-url]              |
| [rueidis][rueidis-url]                 | Go         | Apache 2.0 | [Rueian][rueidis-author]              | [GitHub][rueidis-url]                    |
| [ioredisgraph][ioredisgraph-url]       | JavaScript | ISC        | [Jonah][ioredisgraph-author]          | [GitHub][ioredisgraph-url]               |
| [@hydre/rgraph][rgraph-url]            | JavaScript | MIT        | [Sceat][rgraph-author]                | [GitHub][rgraph-url]                     |
| [drivine][drivine-url]                 | TypeScript | Apache 2.0 | [liberation-data][drivine-author]     | [npm][drivine-package]                   |
| [php-redis-graph][php-redis-graph-url] | PHP        | MIT        | [KJDev][php-redis-graph-author]       | [GitHub][php-redis-graph-url]            |
| [redisgraph\_php][redisgraph_php-url]  | PHP        | MIT        | [jpbourbon][redisgraph_php-author]    | [GitHub][redisgraph_php-url]             |
| [redisgraph-ex][redisgraph-ex-url]     | Elixir     | MIT        | [crflynn][redisgraph-ex-author]       | [GitHub][redisgraph-ex-url]              |
| [redisgraph-rs][redisgraph-rs-url]     | Rust       | MIT        | [malte-v][redisgraph-rs-author]       | [GitHub][redisgraph-rs-url]              |
| [redis\_graph][redis_graph-url]        | Rust       | BSD        | [tompro][redis_graph-author]          | [GitHub][redis_graph-url]                |
| [rustis][rustis-url]                   | Rust       | MIT        | [Dahomey Technologies][rustis-author] | [Crate](https://crates.io/crates/rustis) |
| [NRedisGraph][NRedisGraph-url]         | C#         | BSD        | [tombatron][NRedisGraph-author]       | [GitHub][NRedisGraph-url]                |
| [RedisGraph.jl][RedisGraph.jl-url]     | Julia      | MIT        | [xyxel][RedisGraph.jl-author]         | [GitHub][RedisGraph.jl-url]              |

[redis-url]: https://redis.com

[falkordb-url]: https://www.falkordb.com

[falkordb-py-url]: https://github.com/falkordb/falkordb-py

[falkordb-py-package]: https://pypi.python.org/pypi/falkordb

[falkordb-py-docs]: https://falkordb-py.readthedocs.io/en/latest/

[jfalkordb-url]: https://github.com/falkordb/jfalkordb

[jfalkordb-package]: https://search.maven.org/artifact/com.falkordb/jfalkordb

[jfalkordb-docs]: https://www.javadoc.io/doc/com.falkordb/jfalkordb

[falkordb-ts-url]: https://github.com/falkordb/falkordb-ts

[falkordb-ts-package]: https://www.npmjs.com/package/falkordb

[falkordb-ts-docs]: https://www.npmjs.com/package/falkordb

[falkordb-rs-url]: https://github.com/falkordb/falkordb-rs

[falkordb-rs-package]: https://crates.io/crates/falkordb

[falkordb-rs-docs]: https://docs.rs/falkordb/latest/falkordb

[falkordb-go-url]: https://github.com/falkordb/falkordb-go

[falkordb-go-package]: https://github.com/falkordb/falkordb-go

[falkordb-go-docs]: https://pkg.go.dev/github.com/FalkorDB/falkordb-go

[falkordb-php-url]: https://github.com/FalkorDB/falkordb-php

[falkordb-php-package]: https://github.com/FalkorDB/falkordb-php

[falkordb-php-docs]: https://github.com/FalkorDB/falkordb-php#readme

[nredisstack-url]: https://github.com/redis/nredisstack

[nredisstack-package]: https://www.nuget.org/packages/nredisstack/

[falkordb_ex-url]: https://github.com/georgfaust/falkordb_ex

[falkordb_ex-author]: https://github.com/georgfaust

[NFalkorDB-url]: https://github.com/falkordb/NFalkorDB

[NFalkorDB-package]: https://www.nuget.org/packages/NFalkorDB

[NFalkorDB-docs]: https://github.com/FalkorDB/NFalkorDB/blob/master/README.md

[node-redis-url]: https://github.com/redis/node-redis

[node-redis-package]: https://www.npmjs.com/package/redis

[redisgraph-rb-author]: https://redislabs.com

[redisgraph-rb-url]: https://github.com/RedisGraph/redisgraph-rb

[redgraph-author]: https://github.com/pzac

[redgraph-url]: https://github.com/pzac/redgraph

[redisgraph-go-author]: https://redislabs.com

[redisgraph-go-url]: https://github.com/RedisGraph/redisgraph-go

[rueidis-url]: https://github.com/rueian/rueidis

[rueidis-author]: https://github.com/rueian

[rgraph-author]: https://github.com/Sceat

[rgraph-url]: https://github.com/HydreIO/rgraph

[ioredisgraph-author]: https://github.com/Jonahss

[ioredisgraph-url]: https://github.com/Jonahss/ioredisgraph

[php-redis-graph-author]: https://github.com/kjdev

[php-redis-graph-url]: https://github.com/kjdev/php-redis-graph

[redisgraph_php-author]: https://github.com/jpbourbon

[redisgraph_php-url]: https://github.com/jpbourbon/redisgraph_php

[redisgraph-ex-author]: https://github.com/crflynn

[redisgraph-ex-url]: https://github.com/crflynn/redisgraph-ex

[redisgraph-rs-author]: https://github.com/malte-v

[redisgraph-rs-url]: https://github.com/malte-v/redisgraph-rs

[redis_graph-author]: https://github.com/tompro

[redis_graph-url]: https://github.com/tompro/redis_graph

[NRedisGraph-author]: https://github.com/tombatron

[NRedisGraph-url]: https://github.com/tombatron/NRedisGraph

[RedisGraph.jl-author]: https://github.com/xyxel

[RedisGraph.jl-url]: https://github.com/xyxel/RedisGraph.jl

[rustis-url]: https://github.com/dahomey-technologies/rustis

[rustis-author]: https://github.com/dahomey-technologies

[drivine-url]: https://github.com/liberation-data/drivine

[drivine-author]: https://github.com/liberation-data

[drivine-package]: https://www.npmjs.com/package/@liberation-data/drivine

[falkordb-py-orm-url]: https://github.com/FalkorDB/falkordb-py-orm

[falkordb-py-orm-docs]: https://github.com/FalkorDB/falkordb-py-orm#readme

[falkordb-go-orm-url]: https://github.com/FalkorDB/falkordb-go-orm

[falkordb-go-orm-docs]: https://github.com/FalkorDB/falkordb-go-orm#readme

[spring-data-url]: https://github.com/FalkorDB/spring-data-falkordb

[spring-data-docs]: https://github.com/FalkorDB/spring-data-falkordb#readme

## Implementing a client

Information on some of the tasks involved in writing a FalkorDB client can be found in the [Client Specification](/design/client-spec).

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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.
  </Accordion>

  <Accordion title="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](/getting-started/configuration#bolt_port).
  </Accordion>

  <Accordion title="Where can I find API documentation for each client?">
    Each official client has dedicated documentation: Python has [Pydoc](https://falkordb-py.readthedocs.io), Node.js has [JSDoc](https://www.npmjs.com/package/falkordb), Java has [Javadocs](https://www.javadoc.io/doc/com.falkordb/jfalkordb), Rust has [docs.rs](https://docs.rs/falkordb), and Go has [GoDoc](https://pkg.go.dev/github.com/FalkorDB/falkordb-go). Links are in the table above.
  </Accordion>
</AccordionGroup>