Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
222 changes: 222 additions & 0 deletions cloud/connecting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
---
title: "Connecting to FalkorDB Cloud"
parent: "Cloud DBaaS"
nav_order: 6
description: "Step-by-step guide for connecting to FalkorDB Cloud using Python, Node.js, Java, Rust, Go, and redis-cli. Covers endpoint URL, TLS, authentication, and Bolt protocol connections."
---

# Connecting to FalkorDB Cloud

This guide walks you through obtaining your connection details from the FalkorDB Cloud dashboard and connecting using each supported client library.

---

## 1. Obtain Your Connection Details

After creating a FalkorDB Cloud instance:

1. Log in to the [FalkorDB Cloud Dashboard](https://app.falkordb.cloud)
2. Select your instance
3. Copy the **connection URL** from the instance details panel

Your connection URL follows this format:

```
falkor[s]://<username>:<password>@<host>:<port>
```
Comment on lines +22 to +26

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 1a98ac9 by updating the documented connection URL format to falkor[s]://<username>:<password>@<host>:<port> in cloud/connecting.md.

Comment thread
coderabbitai[bot] marked this conversation as resolved.

**Key details:**
- **Host** — Your instance's hostname (e.g., `my-instance-abc123.falkordb.cloud`)
- **Port** — Typically `6379`
- **Username / Password** — The credentials you set when creating the instance
- **TLS** — Enabled by default on Startup, Pro, and Enterprise tiers

> **Free Tier:** TLS is not available on the Free tier. Use `redis://` (unencrypted) connections.

---

## 2. Connect with Client Libraries

### Python

```bash
pip install falkordb
```

```python
from falkordb import FalkorDB

# TLS connection (Startup / Pro / Enterprise)
db = FalkorDB(
host='my-instance.falkordb.cloud',
port=6379,
username='default',
password='your-password',
ssl=True
)

graph = db.select_graph('myGraph')
result = graph.query("MATCH (n) RETURN n LIMIT 5")
for record in result.result_set:
print(record)
```

For the Free tier (no TLS):

```python
db = FalkorDB(
host='my-instance.falkordb.cloud',
port=6379,
username='default',
password='your-password'
)
```

### Node.js

```bash
npm install falkordb
```

```javascript
import { FalkorDB } from 'falkordb';

const db = await FalkorDB.connect({
username: 'default',
password: 'your-password',
socket: {
host: 'my-instance.falkordb.cloud',
port: 6379,
tls: true
}
});

const graph = db.selectGraph('myGraph');
const result = await graph.query("MATCH (n) RETURN n LIMIT 5");
console.log(result);

await db.close();
```

### Java

```xml
<dependency>
<groupId>com.falkordb</groupId>
<artifactId>jfalkordb</artifactId>
<version>0.8.0</version>
</dependency>
```

```java
import com.falkordb.Driver;
import com.falkordb.FalkorDB;
import com.falkordb.Graph;

Driver driver = FalkorDB.driver("my-instance.falkordb.cloud", 6379);
Graph graph = driver.graph("myGraph");
var result = graph.query("MATCH (n) RETURN n LIMIT 5");
```

### Rust

```toml
[dependencies]
falkordb = "0.3"
```

```rust
use falkordb::FalkorDB;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let db = FalkorDB::connect_async(
"falkordb://default:your-password@my-instance.falkordb.cloud:6379?ssl=true"
).await?;

let graph = db.select_graph("myGraph");
let result = graph.query("MATCH (n) RETURN n LIMIT 5").execute().await?;
println!("{:?}", result);

Ok(())
}
```

### Go

```go
package main

import (
"fmt"
"github.com/FalkorDB/falkordb-go"
)

func main() {
db, err := falkordb.Connect(
"my-instance.falkordb.cloud:6379",
falkordb.WithAuth("default", "your-password"),
falkordb.WithTLS(nil),
)
if err != nil {
panic(err)
}

graph := db.SelectGraph("myGraph")
result, err := graph.Query("MATCH (n) RETURN n LIMIT 5")
if err != nil {
panic(err)
}
fmt.Println(result)
}
```

### redis-cli

```bash
# TLS connection
redis-cli -h my-instance.falkordb.cloud -p 6379 \
--user default --pass your-password --tls \
GRAPH.QUERY myGraph "MATCH (n) RETURN n LIMIT 5"

# Free tier (no TLS)
redis-cli -h my-instance.falkordb.cloud -p 6379 \
--user default --pass your-password \
GRAPH.QUERY myGraph "MATCH (n) RETURN n LIMIT 5"
```

---

## 3. Bolt Protocol

FalkorDB Cloud also supports the [Bolt protocol](/integration/bolt-support), commonly used by Neo4j-compatible tools and drivers.

Connect using Bolt on port **7687**:

```
bolt://my-instance.falkordb.cloud:7687
```
Comment on lines +196 to +198

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add language specifier to code block.

The fenced code block should specify a language for proper syntax highlighting and markdown compliance.

📝 Proposed fix
-```
+```text
 bolt://my-instance.falkordb.cloud:7687
</details>

As per coding guidelines, fenced code blocks should have a language specified (markdownlint MD040).

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 202-202: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cloud/connecting.md` around lines 202 - 204, The fenced code block containing
"bolt://my-instance.falkordb.cloud:7687" is missing a language specifier; update
the block in cloud/connecting.md to include a language (e.g., use ```text or
```none) so the fence becomes ```text followed by the URL and closing ```,
satisfying markdownlint MD040.


This allows you to use tools like Neo4j Desktop, Neo4j Browser, or any Bolt-compatible driver with your FalkorDB Cloud instance.

---

## Troubleshooting

| Issue | Solution |
|:---|:---|
| `Connection refused` | Verify the hostname and port; check your instance is running in the dashboard |
| `SSL/TLS error` | Ensure you're using TLS for paid tiers; Free tier does not support TLS |
| `Authentication failed` | Double-check username and password; reset credentials in the dashboard if needed |
| `Timeout` | Check network connectivity; ensure your firewall allows outbound connections on port 6379 |

For more help, see the [Troubleshooting guide](/operations/docker#troubleshooting) or contact [FalkorDB Support](https://www.falkordb.com/contact-us/).

---

## Related Pages

- [Client Libraries](/getting-started/clients) — Full list of official and community clients
- [Getting Started](/getting-started) — Local setup and first queries
- [Cloud Overview](/cloud) — FalkorDB Cloud tiers and features
- [Bolt Support](/integration/bolt-support) — Bolt protocol details
5 changes: 5 additions & 0 deletions cloud/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@ The Enterprise Tier is fully optimized for mission-critical applications, provid
[![Learn More](https://img.shields.io/badge/Learn%20More-8A2BE2?style=for-the-badge)](/cloud/enterprise-tier)
[![Watch Demo](https://img.shields.io/badge/Watch%20Demo-black?style=for-the-badge)](https://youtu.be/fu_8CLFKYSs?si=G7K6dN1i5tyqXTfC)

---

## Connecting to FalkorDB Cloud

Ready to connect? See the [Cloud Connection Guide](/cloud/connecting) for step-by-step instructions with Python, Node.js, Java, Rust, Go, and redis-cli.
{% include faq_accordion.html
title="Frequently Asked Questions"
q1="What cloud providers does FalkorDB support?"
Expand Down