Commands

FalkorDB Features

FalkorDB is a graph database that exposes its functionality using the openCypher query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval.

FalkorDB API

Command details can be retrieved by filtering for the module or for a specific command, e.g., GRAPH.QUERY. The details include the syntax for the commands, where:

  • Optional arguments are enclosed in square brackets, for example [timeout].
  • Additional optional arguments are indicated by an ellipsis: ...

Most commands require a graph key name as their first argument.

Frequently Asked Questions 5
What query language does FalkorDB use?

FalkorDB uses the openCypher query language, an open standard for graph query languages. Most of the Cypher specification is supported.

How are FalkorDB commands structured?

FalkorDB commands are Redis module commands prefixed with GRAPH. (e.g., GRAPH.QUERY, GRAPH.DELETE). Most commands require a graph key name as their first argument.

What does the square bracket notation mean in command syntax?

Square brackets like [timeout] indicate optional arguments. An ellipsis (...) after optional arguments means additional optional parameters may follow.

Do I need to create a graph before querying it?

No. FalkorDB automatically creates a graph when you first run a GRAPH.QUERY command against a new graph key name. There is no separate ‘CREATE GRAPH’ command.

Can I use FalkorDB with any Redis client?

Yes. Since FalkorDB is a Redis module, you can use any Redis client to send commands. However, dedicated FalkorDB client libraries (Python, JavaScript, Java, Rust) provide higher-level abstractions for easier use.


Table of contents