falkordb/falkordb-server repository overview

This is the proposed README content for the falkordb/falkordb-server Docker Hub page.

This version is optimized for production and server environments as it only contains the FalkorDB engine, resulting in a lighter-weight image compared to the full falkordb/falkordb image, which includes the FalkorDB Browser UI.

⁠FalkorDB Server Docker Image (falkordb/falkordb-server) 💾

This image provides the FalkorDB Property Graph Database server only. It is a lightweight container suitable for production deployments, CI/CD environments, or scenarios where the database engine is required without the integrated FalkorDB Browser UI.

⁠About FalkorDB

Our objective is to create an outstanding Knowledge Graph specifically for Large Language Models (LLM) that boasts exceptionally low latency, ensuring swift delivery of information through our Graph Database, known as KG-RAG.

FalkorDB is the first queryable Property Graph database to use sparse matrices to represent the adjacency matrix in graphs and linear algebra to query the graph.

⁠Primary Features

• Adopting the Property Graph Model: Supports Nodes (vertices) and Relationships (edges) that may have attributes. Nodes can have multiple labels, and relationships have a relationship type.
• Sparse Matrix Representation: Graphs are represented as sparse adjacency matrices, optimizing storage and performance.
• Linear Algebra Querying: Queries are translated into linear algebra expressions for enhanced computational efficiency.
• OpenCypher Support: Compatible with the OpenCypher query language, including proprietary extensions.

⁠Quickstart (Server Only)

To quickly try out the FalkorDB server, launch an instance using Docker. This command exposes the database on the standard Redis port, 6379.

docker run -p 6379:6379 -it --rm falkordb/falkordb-server:latest

⁠Recommended Usage with Persistent Data

For persistent data storage, map a local volume to the container's data path (/var/lib/falkordb/data):

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

⁠Interacting with the Server

Once running, you can connect to FalkorDB on port 6379 using redis-cli or any of the supported client libraries.

⁠Example using redis-cli:

1. Connect to the running instance:

   redis-cli
   

   Copy
2. Run a sample query using the GRAPH.QUERY command:

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

   Copy

⁠Example using a Python client:

FalkorDB supports interactions through raw Redis commands.

import redis
r = redis.StrictRedis(host='localhost', port=6379)
reply = r.execute_command('GRAPH.QUERY', 'social', "CREATE (:person {name:'roi', age:33})")
print(reply)

⁠Documentation & Support

• Documentation: For comprehensive information on installation, features, and the query language, visit the official FalkorDB Documentation⁠.
• Source Code: Check out the source code and contribute on GitHub⁠.
• FalkorDB Browser: If you require a visualization tool, you can run the FalkorDB Browser Docker Image⁠ separately and configure it to connect to this server instance.
• License: This project is licensed under the Server Side Public License v1 (SSPLv1).