Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add h1 to all pages and set unique description #38

Merged
merged 15 commits into from
Apr 24, 2024
2 changes: 2 additions & 0 deletions References.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Learn more about the Technology behind FalkorDB
nav_order: 998
---

# References

* [FalkorDB Blog](https://www.falkordb.com/blog)

* Video
Expand Down
10 changes: 5 additions & 5 deletions bolt_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ nav_order: 10
description: "Connecting to FalkorDB using BOLT protocol."
---

## [EXPERIMENTAL] BOLT protocol support for FalkorDB
# [EXPERIMENTAL] BOLT protocol support for FalkorDB

FalkorDB provides an experimental support for querying using BOLT drivers.
We intend to extend the support in the future versions, the current version is not meant to be used in production.
This guide will walk you through the process of connecting to FalkorDB using the [BOLT protocol](https://en.wikipedia.org/wiki/Bolt_(network_protocol))

### Prerequisites
## Prerequisites

Before you begin, ensure that you have a FalkorDB instance up and running.
You can use our Docker image for this purpose.
Expand All @@ -19,7 +19,7 @@ You can use our Docker image for this purpose.
docker run -p 6379:6379 -p 7678:7678 -p 3000:3000 -it -e REDIS_ARGS="--requirepass falkordb" -e FALKORDB_ARGS="BOLT_PORT 7678" --rm falkordb/falkordb:latest
```

#### Ports
### Ports
- 6379 - FalkorDB
- 7678 - Bolt
- 3000 - Falkor-Browser
Expand All @@ -30,7 +30,7 @@ Additionally, install the necessary BOLT drivers:
pip install neo4j
```

### Step 1: Create a `main.py` File
## Step 1: Create a `main.py` File

Create a main.py file with the following content and adjust the connection uri, authentication parameters and database name according to your FalkorDB setup. This script demonstrates a simple query that returns the numbers from 1 to 10. Customize the query as needed for your specific use case.

Expand All @@ -48,7 +48,7 @@ for record in records:
print(record["i"])
```

### Step 2: Run the script
## Step 2: Run the script

Execute the script by running the following command in your terminal:

Expand Down
2 changes: 1 addition & 1 deletion clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: >
FalkorDB Clients
---

## Official Clients
# Official Clients

| Project | Language | License | Author | Package |
| --------------------------------------------------------- | ---------- | ---------- | ------------------------------------------- | ---------------------------------------- |
Expand Down
6 changes: 3 additions & 3 deletions commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ nav_order: 3
has_children: true
---

## Overview
# Overview

### FalkorDB Features
## FalkorDB Features

FalkorDB exposes graph database functionality within Redis using the [openCypher](https://opencypher.org/) query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval.

### FalkorDB API
## FalkorDB API

Command details can be retrieved by filtering for the [module](/commands/?group=graph) or for a specific command, e.g., `GRAPH.QUERY`.
The details include the syntax for the commands, where:
Expand Down
2 changes: 2 additions & 0 deletions configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: >
FalkorDB supports multiple module configuration parameters.
---

# Configuration

FalkorDB supports [Redis configuration](https://redis.io/docs/management/config/) and multiple module configuration parameters.
Some of these parameters can only be set at load-time, while other parameters can be set either on load-time or on run-time.

Expand Down
Loading