Connect to your instance

​

Find your connection details

1. In the sidebar, open Deployments > Instances and select your instance.
2. Open the Connectivity tab. The Endpoint card shows the endpoint as host:port. Select the copy icon to copy it.
3. Open the Instance Details tab. Under Parameter, find the FalkorDB User (by default falkordb) and the FalkorDB Password. Select Show to see the password, or the copy icon to copy it. On paid tiers, this section also shows whether TLS is enabled.

​

Open FalkorDB Browser

1. Wait until the instance status is Running.
2. On the instance page, or on the Instances list with the instance selected, select Connect.
3. FalkorDB Browser opens in a new tab with the Host, Port, Username, and TLS Secured Connection setting filled in. Enter your Password and select Log in.

​

Connect with redis-cli

redis-cli -h <host> -p <port> --user falkordb --pass "$FALKORDB_PASSWORD" \
  GRAPH.QUERY social "CREATE (:Person {name: 'Alice'}) RETURN 1"

​

Connect with a client library

from falkordb import FalkorDB

db = FalkorDB(
    host="<host>",
    port=<port>,
    username="falkordb",
    password="<password>",
    ssl=True,
)
graph = db.select_graph("social")
result = graph.query("MATCH (p:Person) RETURN p.name")
print(result.result_set)

import { FalkorDB } from "falkordb";

const db = await FalkorDB.connect({
  username: "falkordb",
  password: "<password>",
  socket: { host: "<host>", port: <port>, tls: true },
});
const graph = db.selectGraph("social");
const result = await graph.query("MATCH (p:Person) RETURN p.name");
console.log(result.data);
await db.close();

​

Troubleshooting