# FalkorDB

Describes Keryn 0.5.2 and keryn-rules 0.8.0.

> Write the evidence graph to FalkorDB through a Keryn relay: endpoint, token, and what is sent.

Source: https://keryn.dev/docs/reference/connectors/falkordb/

The graph is the evidence graph of one scan. Without a relay, download it as an openCypher script and load it yourself with `redis-cli`, FalkorDB Browser or any openCypher client.

## Endpoint and protocol

| Fact | Value |
|---|---|
| Endpoint | `<Relay address>/graph` on a Keryn relay that has `FALKORDB_URL` set. A browser cannot speak the Redis protocol, so the relay runs the statements. |
| Key | the *Relay token* as `Authorization: Bearer` |
| Writes | idempotent `MERGE` statements, in order, so sending the same scan again updates the graph instead of duplicating it |
| Without a relay | download the graph as an openCypher script instead. That is a local file; nothing is sent. |
| Page can reach it | if the relay is on `*.workers.dev`, `*.vercel.app`, `*.netlify.app` or `*.supabase.co`, or on localhost |

## Fields

| Field | Kind | Default | Notes |
|---|---|---|---|
| Relay address (optional) | address |  | A Keryn relay with FALKORDB_URL set. Without one, download the graph as Cypher. |
| Relay token (optional) | secret |  |  |
| Graph | text | `keryn` |  |

How keys and values are stored is on the [connectors overview](https://keryn.dev/docs/reference/connectors/#storage).

## What leaves your machine

> **Leaves your machine, only when you press Send and have entered a relay address:** The statements go to the relay you entered, and to nowhere else. No code excerpts are included.
>
> - Statements that create Scan, Finding, File, Rule, Taxon, Component nodes: the scan's subject and revision, file paths, rule ids, each finding's id, severity, message, line, engine, proof level, verdict and taxonomy ids, and each AI component's key, name, kind, category, provider and the files that use it.
> - Relationships: REPORTED, IN_FILE, VIOLATES, TAGGED, RELATES_TO, INVENTORIED, USES.
> - The relay token, as the bearer.

*Generated from the product's connector catalog (monorepo 27434c1bb57f) by `tools/extract-product-facts.mjs`.*
