FalkorDB

https://docs.falkordb.com
Admin
FalkorDB is a low-latency, scalable graph database platform designed for developers working with...
Tokens:1,598,038
Snippets:9,096
Trust Score:8.2
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start Multi-Zone Cluster with Go net/http

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/cluster-multi-zone/start

Go example using net/http to start a multi-zone cluster. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Multi-Zone/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Start FalkorDB Free Instance with Go net/http

Source: https://docs.falkordb.com/cloud/api-reference/free/free/start

Go example using net/http to start a FalkorDB free instance. Reads and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Install langchain-falkordb and langchain-openai

Source: https://docs.falkordb.com/genai-tools/langchain

Install the FalkorDB LangChain integration and the OpenAI integration used in the examples.

```bash
pip install langchain-falkordb

```

```bash
pip install langchain-openai

```

--------------------------------

### Start FalkorDB instance with Go

Source: https://docs.falkordb.com/cloud/api-reference/free/free/start

Go example to start a stopped Falkordb free instance. Creates a POST request with a Cookie header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-free-customer-hosted/falkordb-free-falkordb-customer-hosted-model-omnistrate-multi-tenancy/free/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Start Multi-Zone Cluster with JavaScript fetch

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/cluster-multi-zone/start

JavaScript example using fetch to start a multi-zone cluster. Parses the response as JSON and logs it.

```javascript
const options = {method: 'POST', headers: {Cookie: '<cookie>'}};

fetch('https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Multi-Zone/{id}/start', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Go GET backup repository

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/backup-repositories/get-a-specific-backup-repository

Go example using net/http to GET a backup repository. Adds the cookie header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3001/api/backups/repositories/{name}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "token=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Run FalkorDB locally with Docker

Source: https://docs.falkordb.com/agentic-memory/cognee

Runs a local FalkorDB instance with ports 6379 and 3000 exposed. Use this before installing Cognee to have a database available for the quick start example.

```bash
docker run -p 6379:6379 -p 3000:3000 -it --rm falkordb/falkordb:latest

```

--------------------------------

### Quick Start Example with Mem0 and FalkorDB

Source: https://docs.falkordb.com/agentic-memory/mem0

Complete example that registers the FalkorDB plugin, configures Mem0 with FalkorDB as the graph store and OpenAI as the LLM, adds memories for a user, and searches them.

```python
from mem0_falkordb import register
register()

from mem0 import Memory

config = {
    "graph_store": {
        "provider": "falkordb",
        "config": {
            "host": "localhost",
            "port": 6379,
            "database": "mem0",
        },
    },
    "llm": {
        "provider": "openai",
        "config": {"model": "gpt-4o-mini"},
    },
}

m = Memory.from_config(config)

# Add memories for a user
m.add("I love pizza", user_id="alice")
m.add("Alice is a software engineer", user_id="alice")
m.add("Alice works on AI projects", user_id="alice")

# Search the memory
results = m.search("what does alice like?", user_id="alice")
print(results)

```

--------------------------------

### Install GraphRAG SDK and Start FalkorDB

Source: https://docs.falkordb.com/graphrag

Install the GraphRAG SDK with LiteLLM support and start a local FalkorDB instance using Docker. Run these commands before using the SDK.

```bash
pip install graphrag-sdk[litellm]
docker run -p 6379:6379 falkordb/falkordb
```

--------------------------------

### Start instance with Go

Source: https://docs.falkordb.com/cloud/api-reference/enterprise-byoa/single-zone/start

Uses net/http to POST to the start endpoint. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-byoa-byoa/falkordb-enterprise-byoa-falkordb-byoa-model-omnistrate-dedicated-tenancy/single-Zone/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Python setup for creating a FalkorDB cluster

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/create-a-new-falkordb-cluster

Starts a Python example for creating a FalkorDB cluster using the requests library. It imports requests and sets the API endpoint URL to http://localhost:3001/api/clusters/. The snippet is incomplete and does not include the request payload or the actual POST call.

```python
import requests

url = "http://localhost:3001/api/clusters/"
```

--------------------------------

### Start instance with Go

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/multi-zone/start

Uses net/http to POST to the start endpoint with a Cookie header. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /api/metrics/ - System-wide metrics request examples

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/metrics/get-system-wide-metrics-including-cpu-memory-and-cluster-stats

Examples for making a GET request to the /api/metrics/ endpoint in various languages. All require a JWT token stored in an HTTP-only cookie named 'token'.

```bash
curl --request GET \
  --url http://localhost:3001/api/metrics/ \
  --cookie token=
```

```python
import requests

url = "http://localhost:3001/api/metrics/"

headers = {"cookie": "token="}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {cookie: 'token='}};

fetch('http://localhost:3001/api/metrics/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/api/metrics/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "token=",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3001/api/metrics/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "token=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("http://localhost:3001/api/metrics/")
  .header("cookie", "token=")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/metrics/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["cookie"] = 'token='

response = http.request(request)
puts response.read_body
```

--------------------------------

### POST /{component}/{id}/start

Source: https://docs.falkordb.com/cloud/api-reference/introduction

Start a deployment instance. Returns 202 Accepted and completes asynchronously.

```APIDOC
## [POST] /2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/{tier}/{deployment}/{component}/{id}/start

### Description
Start a deployment instance. Returns 202 Accepted and completes asynchronously.

### Method
POST

### Endpoint
`/{component}/{id}/start`

### Parameters
#### Path Parameters
- **tier** (string) - Required - Service tier (e.g., Enterprise, Pro, Startup, Free).
- **deployment** (string) - Required - Deployment model (e.g., BYOA, dedicated, multi-tenant).
- **component** (string) - Required - Component name (e.g., standalone, single-zone, multi-zone, cluster).
- **id** (string) - Required - Instance ID.

#### Query Parameters
- **subscriptionId** (string) - Required - Subscription ID.

### Response
#### Success Response (202 Accepted)
Accepted. Operation completes in background.

#### Response Example
```
{
  "id": "string",
  "status": "starting"
}
```
```

--------------------------------

### Start multi-zone instance with Go net/http

Source: https://docs.falkordb.com/cloud/api-reference/enterprise-byoa/multi-zone/start

Go example using net/http to start a multi-zone instance. Creates a POST request with a Cookie header and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-byoa-byoa/falkordb-enterprise-byoa-falkordb-byoa-model-omnistrate-dedicated-tenancy/multi-Zone/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Start standalone instance with Go

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/standalone/start

Uses Go's net/http to POST to the start endpoint. Reads the response body and prints it; errors are ignored.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/standalone/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Get node information - GET /api/graph/{graph}/{node} - Example response

Source: https://docs.falkordb.com/integration/rest

Example JSON response for retrieving node information. Contains node details including ID, labels, properties, and relationships.

```json
{
  "result": {
    "data": [
      {
        "node": {
          "id": 1,
          "labels": ["Person"],
          "properties": {
            "name": "John Doe",
            "age": 30
          }
        },
        "relationships": []
      }
    ]
  }
}
```

--------------------------------

### Install SDK and start FalkorDB

Source: https://docs.falkordb.com/graphrag/graphrag-accuracy-benchmark

Install the GraphRAG SDK version 1.3.0 with the litellm extra and start a FalkorDB container with ports 6379 and 3000 exposed. These commands are the first step to reproduce the benchmark results.

```bash
pip install graphrag-sdk[litellm]==1.3.0
```

```bash
docker run -d -p 6379:6379 -p 3000:3000 --name falkordb falkordb/falkordb:latest
```

--------------------------------

### Start instance with Go net/http

Source: https://docs.falkordb.com/cloud/api-reference/pro/single-zone/start

Go example using net/http to start a single-zone FalkorDB instance. Creates a POST request with a Cookie header and prints the response body. Replace {id} with the instance ID.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/single-Zone/{id}/start"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Python GET /api/system/cluster-resources

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split

Python example using the requests library to call the GET /api/system/cluster-resources endpoint. It sets the cookie header with a token and prints the response text. Works with the same endpoint and authentication as the other language examples.

```python
import requests

url = "http://localhost:3001/api/system/cluster-resources"

headers = {"cookie": "token="}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Ruby Net::HTTP GET /api/system/cluster-resources

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split

Ruby example using Net::HTTP to make a GET request to /api/system/cluster-resources. Sets the cookie header with a token and prints the response body. The endpoint and authentication are the same as other language examples.

```ruby
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/system/cluster-resources")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["cookie"] = 'token='

response = http.request(request)
puts response.read_body
```

--------------------------------

### Start instance with Ruby

Source: https://docs.falkordb.com/cloud/api-reference/enterprise-byoa/single-zone/start

Uses net/http to POST to the start endpoint. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-byoa-byoa/falkordb-enterprise-byoa-falkordb-byoa-model-omnistrate-dedicated-tenancy/single-Zone/{id}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Cookie"] = '<cookie>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Java Unirest GET /api/system/cluster-resources

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split

Java example using Unirest HTTP library to perform a GET request to /api/system/cluster-resources. Sets the cookie header with a token and stores the response as a string. The endpoint and authentication are the same as other language examples.

```java
HttpResponse<String> response = Unirest.get("http://localhost:3001/api/system/cluster-resources")
  .header("cookie", "token=")
  .asString();
```

--------------------------------

### PHP cURL GET /api/system/cluster-resources

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split

PHP example using cURL to make a GET request to the /api/system/cluster-resources endpoint. Uses CURLOPT_PORT, CURLOPT_COOKIE, and other options. It prints the response or an error message. The endpoint and authentication are the same as other language examples.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3001",
  CURLOPT_URL => "http://localhost:3001/api/system/cluster-resources",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "token=",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Go example to create a backup schedule

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/backup-schedules/create-a-new-backup-schedule

Uses the net/http package to send a POST request with a JSON payload. Reads and prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3001/api/clusters/{clusterName}/backups/schedules/"

	payload := strings.NewReader("{\n  \"scheduleName\": \"<string>\",\n  \"frequency\": \"<string>\",\n  \"backupMethod\": \"datafile\",\n  \"backupPolicyName\": \"<string>\",\n  \"retentionPeriod\": \"<string>\",\n  \"startingDeadlineMinutes\": 123,\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("cookie", "token=")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go GET /api/system/cluster-resources

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split

Go example using the net/http package to make a GET request to /api/system/cluster-resources. Sets the cookie header with a token but does not handle errors. It reads the response body and prints it. The endpoint and authentication are the same as other language examples.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3001/api/system/cluster-resources"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "token=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Multi-tenant loading example output

Source: https://docs.falkordb.com/operations/migration/neo4j-to-falkordb

Example output from the multi-tenant loading process, showing tenant directories found, per-tenant processing, and completion summary.

```text
🗂️  Found 3 tenant directories: ['tenant_cloudserve', 'tenant_learnhub', 'tenant_shopfast']
   Each will be loaded into a separate graph

================================================================================
📊 Processing tenant: cloudserve
   Target graph: MYAPP_cloudserve
   Source directory: csv_output/tenant_cloudserve
================================================================================
...
✅ Completed loading tenant 'cloudserve' in 0:00:02.345

================================================================================
✅ Multi-graph loading complete!
   Loaded 3 tenants into separate graphs
   Total time: 0:00:07.891
================================================================================

```

--------------------------------

### JavaScript Fetch GET /api/system/cluster-resources

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split

JavaScript example using the Fetch API to make a GET request to /api/system/cluster-resources. Sets the cookie header with a token, parses the response as JSON, and logs it to the console. The same endpoint and authentication as other language examples.

```javascript
const options = {method: 'GET', headers: {cookie: 'token='}};

fetch('http://localhost:3001/api/system/cluster-resources', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### Describe instance with Go net/http

Source: https://docs.falkordb.com/cloud/api-reference/enterprise-byoa/single-zone/describe

Go example using net/http to describe a single-zone instance. Reads the response body and prints it.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-byoa-byoa/falkordb-enterprise-byoa-falkordb-byoa-model-omnistrate-dedicated-tenancy/single-Zone/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Start Multi-Zone Cluster with Java Unirest

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/cluster-multi-zone/start

Java example using Unirest to start a multi-zone cluster. Returns the response as a string.

```java
HttpResponse<String> response = Unirest.post("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Multi-Zone/{id}/start")
  .header("Cookie", "<cookie>")
  .asString();
```

--------------------------------

### Go example to upgrade a cluster

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/clusters/upgrade-a-cluster-falkordb-version-andor-addon-componentdefinition

Uses the net/http package to send a POST request with the upgrade payload. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3001/api/clusters/{clusterName}/upgrade"

	payload := strings.NewReader("{\n  \"version\": \"<string>\",\n  \"componentDefinition\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("cookie", "token=")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Graphiti Python client examples

Source: https://docs.falkordb.com/agentic-memory/graphiti

This section covers advanced search capabilities, temporal queries, multi-tenant setups, and configuration for the Graphiti client. It includes usage examples for searching, time-based queries, and initializing the client with various options.

```python
# Node search - find specific entities
nodes = await graphiti.retrieve_nodes(
    query="Alice",
    num_results=10
)

# Episode search - find specific conversations/events
episodes = await graphiti.retrieve_episodes(
    query="conference meeting",
    num_results=5
)

# Combined hybrid search
results = await graphiti.search(
    query="project collaboration",
    num_results=10
)
```

```python
from datetime import datetime

# Get the state of knowledge at a specific time
results = await graphiti.search(
    query="What projects was Alice working on?",
    reference_time=datetime(2024, 3, 1),
    num_results=5
)
```

```python
# User 1's graph
graphiti_user1 = Graphiti(
    uri="falkor://localhost:6379",
    graph_name="user1_memory"
)

# User 2's graph
graphiti_user2 = Graphiti(
    uri="falkor://localhost:6379",
    graph_name="user2_memory"
)
```

```python
graphiti = Graphiti(
    uri="falkor://localhost:6379",
    username="your-username",  # For authenticated instances
    password="your-password",
    graph_name="my_graph",     # Custom graph name
    llm_provider="openai",     # LLM provider for entity extraction
    embedding_provider="openai" # Embedding provider for vector search
)
```

```python
from graphiti_core.llm_client import OpenAIClient

llm_client = OpenAIClient(
    api_key="your-openai-key",
    model="gpt-4",
    temperature=0.7
)

graphiti = Graphiti(
    uri="falkor://localhost:6379",
    llm_client=llm_client
)
```

--------------------------------

### Install GraphRAG-SDK and run FalkorDB

Source: https://docs.falkordb.com/genai-tools/graphrag-sdk

Install the GraphRAG-SDK with LiteLLM and PDF support, then start a local FalkorDB instance on port 6379.

```bash
pip install "graphrag-sdk[litellm,pdf]"
docker run -p 6379:6379 falkordb/falkordb

```

--------------------------------

### Go: Start multi-zone backup with net/http

Source: https://docs.falkordb.com/cloud/api-reference/pro/multi-zone/backup

Sends a POST request using the standard net/http package. Requires a valid session cookie. The backup runs asynchronously and does not interrupt the instance.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-pro-customer-hosted/falkordb-pro-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}/backup"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Cookie", "<cookie>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Get graph information response

Source: https://docs.falkordb.com/integration/rest

Example response for the GET /api/graph/{graph}/info endpoint, showing a list of labels in the graph.

```json
{
  "result": {
    "data": [
      {"(label)": "Person"},
      {"(label)": "Company"}
    ]
  }
}
```

--------------------------------

### GET /api/system/cluster-resources

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/system/get-aggregated-cluster-cpumemorystorage-capacity-and-deployment-vs-support-usage-split

This code snippet documents the GET /api/system/cluster-resources endpoint, including its authorization requirements, response schema, and example responses.

```APIDOC
## GET /api/system/cluster-resources

### Description
Retrieves aggregated cluster CPU, memory, and storage capacity, along with usage split between deployments and support components.

### Method
GET

### Endpoint
/api/system/cluster-resources

### Parameters
#### Authorization
- **token** (string, cookie) - Required - JWT token stored in HTTP-only cookie

### Response
#### Success Response (200)
- **timestamp** (string<date-time>) - Required - Timestamp of the response.
- **cpu** (object) - Required - CPU usage details.
- **memory** (object) - Required - Memory usage details.
- **storage** (object) - Required - Storage usage details.
- **availableForDeployments** (object) - Required - Resources available for deployments.
- **supportBreakdown** (object[]) - Required - Breakdown of support component usage.
- **scope** (object) - Required - Scope of the cluster resources.
- **notes** (string[]) - Required - Additional notes.

#### Response Example
```json
{
  "timestamp": "2023-11-07T05:31:56Z",
  "cpu": {
    "total": 123,
    "usedByDeployments": 123,
    "usedBySupport": 123,
    "usedTotal": 123,
    "available": 123,
    "breakdown": {
      "system": 123,
      "falkordbEnterprise": 123,
      "falkordbDeployments": 123,
      "other": 123,
      "available": 123
    }
  },
  "memory": {
    "total": 123,
    "usedByDeployments": 123,
    "usedBySupport": 123,
    "usedTotal": 123,
    "available": 123,
    "breakdown": {
      "system": 123,
      "falkordbEnterprise": 123,
      "falkordbDeployments": 123,
      "other": 123,
      "available": 123
    }
  },
  "storage": {
    "capacityKnown": true,
    "total": 123,
    "usedByDeployments": 123,
    "usedBySupport": 123,
    "usedTotal": 123,
    "available": 123,
    "breakdown": {
      "system": 123,
      "falkordbEnterprise": 123,
      "falkordbDeployments": 123,
      "other": 123,
      "available": 123
    }
  },
  "availableForDeployments": {
    "cpu": 123,
    "memory": 123,
    "storage": 123,
    "limitingResource": "cpu"
  },
  "supportBreakdown": [
    {
      "component": "<string>",
      "cpu": 123,
      "memory": 123,
      "storage": 123,
      "podCount": 123,
      "persistentVolumeClaimCount": 123
    }
  ],
  "scope": {
    "mode": "cluster-wide",
    "namespaces": [
      "<string>"
    ]
  },
  "notes": [
    "<string>"
  ]
}
```

#### Error Response (500)
- **error** (string) - Error description.
- **statusCode** (number) - HTTP status code.
- **message** (string) - Error message.

#### Error Response Example
```json
{
  "error": "<string>",
  "statusCode": 123,
  "message": "<string>"
}
```
```

--------------------------------

### POST /resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-startup-customer-hosted/falkordb-startup-falkordb-customer-hosted-model-omnistrate-multi-tenancy/standalone/{id}/start

Source: https://docs.falkordb.com/cloud/api-reference/startup/standalone/start

Starts a standalone FalkorDB instance by its ID.

```APIDOC
## POST /resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-startup-customer-hosted/falkordb-startup-falkordb-customer-hosted-model-omnistrate-multi-tenancy/standalone/{id}/start

### Description
Starts a standalone FalkorDB instance identified by the given ID.

### Method
POST

### Endpoint
`https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-startup-customer-hosted/falkordb-startup-falkordb-customer-hosted-model-omnistrate-multi-tenancy/standalone/{id}/start`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the standalone instance to start.

#### Headers
- **Cookie** (string) - Required - Authentication cookie for the request.

### Request Example
No request body is required.

### Response
#### Success Response (200)
No response body is documented.

#### Response Example
No response example is provided.
```

--------------------------------

### Graphiti with FalkorDB quick start example

Source: https://docs.falkordb.com/agentic-memory/graphiti

Complete Python example that initializes Graphiti with a FalkorDB connection, builds indices, adds an episode, searches the graph, and closes the connection. Requires Python 3.10+, a FalkorDB instance, and an OpenAI API key.

```python
import asyncio
from datetime import datetime
from graphiti_core import Graphiti
from graphiti_core.nodes import EpisodeType

async def main():
    # Initialize Graphiti with FalkorDB
    graphiti = Graphiti(
        uri="falkor://localhost:6379",  # Your FalkorDB connection string
        # For FalkorDB Cloud:
        # uri="falkor://your-instance.falkordb.cloud:6379",
        # username="default",
        # password="your-password"
    )

    # Build indices (run once during setup)
    await graphiti.build_indices_and_constraints()

    # Add an episode (information to be stored in the graph)
    episode_body = """
    Alice met Bob at the AI conference in San Francisco on March 15, 2024.
    They discussed the latest developments in graph databases and decided to 
    collaborate on a new project using FalkorDB.
    """

    await graphiti.add_episode(
        name="Conference Meeting",
        episode_body=episode_body,
        episode_type=EpisodeType.text,
        reference_time=datetime(2024, 3, 15),
        source_description="Conference notes"
    )

    # Search the knowledge graph
    search_results = await graphiti.search(
        query="What did Alice and Bob discuss?",
        num_results=5
    )

    print("Search Results:")
    for result in search_results:
        print(f"- {result}")

    # Close the connection
    await graphiti.close()

# Run the example
asyncio.run(main())
```

--------------------------------

### Start Multi-Zone Cluster with PHP cURL

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/cluster-multi-zone/start

PHP example using cURL to start a multi-zone cluster. Prints the response or a cURL error.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Multi-Zone/{id}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Cookie: <cookie>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

--------------------------------

### Go example for switchover

Source: https://docs.falkordb.com/enterprise/api-reference/endpoints/cluster-operations/promote-a-replica-to-primary-switchover

Go example using the net/http package to send a POST request to the switchover endpoint. It sets the cookie and content-type headers and prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3001/api/clusters/{clusterName}/ops/switchover"

	payload := strings.NewReader("{\n  \"instanceName\": \"<string>\",\n  \"candidateName\": \"<string>\",\n  \"componentName\": \"falkordb\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("cookie", "token=")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Quick start with Cognee and FalkorDB

Source: https://docs.falkordb.com/agentic-memory/cognee

Complete quick start example that configures FalkorDB as both vector and graph database, adds sample text, cognifies it, and searches using graph completion. Requires Python 3.11–3.13 and a running FalkorDB instance.

```python
import asyncio
import os
import pathlib
from os import path
from cognee import config, prune, add, cognify, search, SearchType

# Import the register module to enable FalkorDB support
from cognee_community_hybrid_adapter_falkor import register  # noqa: F401

async def main():
    # Set up local directories
    system_path = pathlib.Path(__file__).parent
    config.system_root_directory(path.join(system_path, ".cognee_system"))
    config.data_root_directory(path.join(system_path, ".cognee_data"))

    # Configure relational database
    config.set_relational_db_config({
        "db_provider": "sqlite",
    })

    # Configure FalkorDB as both vector and graph database
    config.set_vector_db_config({
        "vector_db_provider": "falkor",
        "vector_db_url": os.getenv("GRAPH_DB_URL", "localhost"),
        "vector_db_port": int(os.getenv("GRAPH_DB_PORT", "6379")),
    })
    config.set_graph_db_config({
        "graph_database_provider": "falkor",
        "graph_database_url": os.getenv("GRAPH_DB_URL", "localhost"),
        "graph_database_port": int(os.getenv("GRAPH_DB_PORT", "6379")),
    })

    # Optional: Clean previous data
    await prune.prune_data()
    await prune.prune_system(metadata=True)

    # Add and process your content
    text_data = """
    Sarah is a software engineer at TechCorp. She specializes in machine learning
    and has been working on implementing graph-based recommendation systems.
    Sarah recently collaborated with Mike on a new project using FalkorDB.
    Mike is the lead data scientist at TechCorp.
    """

    await add(text_data)
    await cognify()

    # Search using graph completion
    search_results = await search(
        query_type=SearchType.GRAPH_COMPLETION,
        query_text="What does Sarah work on?"
    )

    print("Search Results:")
    for result in search_results:
        print("\n" + result)

# Run the example
asyncio.run(main())

```

--------------------------------

### Start Multi-Zone Cluster with Python requests

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/cluster-multi-zone/start

Python example using the requests library to start a multi-zone cluster. The response body is printed.

```python
import requests

url = "https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Multi-Zone/{id}/start"

headers = {"Cookie": "<cookie>"}

response = requests.post(url, headers=headers)

print(response.text)
```

--------------------------------

### Start instance with Ruby

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/multi-zone/start

Uses Net::HTTP to POST to the start endpoint with a Cookie header. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/multi-Zone/{id}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Cookie"] = '<cookie>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Start Multi-Zone Cluster with Ruby Net::HTTP

Source: https://docs.falkordb.com/cloud/api-reference/enterprise/cluster-multi-zone/start

Ruby example using Net::HTTP to start a multi-zone cluster. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.omnistrate.cloud/2022-09-01-00/resource-instance/sp-JvkxkPhinN/falkordb/v1/prod/falkordb-enterprise-customer-hosted/falkordb-enterprise-falkordb-customer-hosted-model-omnistrate-dedicated-tenancy/cluster-Multi-Zone/{id}/start")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Cookie"] = '<cookie>'

response = http.request(request)
puts response.read_body
```
Tokens:
Raw