Skip to content

Commit 814133e

Browse files
danshalev7danshalev7
authored
Merge pull request #315 from FalkorDB/browser-docs
Add a Browser documentation page
2 parents 184c6b6 + 8e80bcb commit 814133e

File tree

2 files changed

+137
-0
lines changed

2 files changed

+137
-0
lines changed

‎.wordlist.txt‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Benchmarking
1010
Booleans
1111
booleans
1212
CLI
13+
Cmd
1314
CMD
15+
Ctrl
1416
CSC
1517
CSV
1618
CSVs
@@ -25,6 +27,7 @@ DateTime
2527
DELUSER
2628
distro
2729
Ducati
30+
Dropzone
2831
Embedder
2932
FOF
3033
FOREACH
@@ -72,6 +75,7 @@ Lipman
7275
LlamaIndex
7376
LocalDateTime
7477
LocalTime
78+
localStorage
7579
Lovitz
7680
MEM
7781
Miesha
@@ -80,11 +84,13 @@ NRedisGraph
8084
NaN
8185
NFalkorDB
8286
NEXTAUTH
87+
NextAuth
8388
NodeJS
8489
Nostem
8590
NumItems
8691
OMP
8792
OpenAI
93+
OpenAPI
8894
OpenCypher
8995
OpenTelemetry
9096
opentelemetry
@@ -123,6 +129,7 @@ TF
123129
TTY
124130
TypeScript
125131
UI
132+
UX
126133
UNIQIE
127134
URIs
128135
UUID

‎browser/readme-browser.md‎

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title: "Browser"
3+
description: "FalkorDB Browser web UI documentation"
4+
nav_order: 9
5+
permalink: /browser/
6+
---
7+
8+
# FalkorDB Graph Visualization Tool (Browser)
9+
FalkorDB's Browser provides a web UI for exploring, querying, and managing FalkorDB graphs. It allows developers to interact with graphs loaded to FalkorDB, explore how specific queries behave, and review the current data model. FalkorDB Browser integrates within the main FalkorDB Docker container and through the Cloud service.
10+
11+
![FalkorDB Browser GIF_01-26(1)](https://github.com/user-attachments/assets/af4f4d1c-111a-46a4-8442-8c08c037014f)
12+
13+
---
14+
15+
## Main Features
16+
17+
### Graph exploration (Graph page)
18+
| Feature | Description |
19+
| --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
20+
| Interactive graph canvas | Visualizes query results containing nodes and edges as an interactive graph. Supports pan, zoom, and interaction with nodes and relationships. Toggles visibility by labels and relationship types. |
21+
| Element search (in-canvas search) | Search nodes and edges by node properties (string prefix match), IDs, relationship type, and labels. Jump to, zoom to, and select the match. |
22+
| Data and inspection panel | Selecting an element opens a side panel for inspecting its properties. This panel supports editing workflows (see "Data manipulation"). |
23+
| Entity Creation Tools | Add a node, an edge, or both to the current graph from the canvas view. |
24+
25+
### Querying
26+
| Feature | Description |
27+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
28+
| Cypher query editor (Monaco) | The editor-style experience for writing Cypher includes keyboard shortcuts: Run (Enter and Cmd/Ctrl + Enter in the query-history editor) and Insert newline (Shift + Enter). The editor includes Cypher keyword and function completion based on the Browser's built-in lists. |
29+
| Results views | Graph view for node and edge results. Table view for tabular results. |
30+
| Query metadata | The Metadata tab shows query metadata text, explain plan (rendered as a nested tree), and profile output (rendered as a nested tree). |
31+
32+
### Query history
33+
| Feature | Description |
34+
| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
35+
| Persistent query history | Stores in browser localStorage. |
36+
| History browser dialog | Allows you to search and filter previous queries, filter by graph name, and delete single queries, multi-select delete, or delete all queries. |
37+
| Per-query metadata | Review metadata, explain, and profile for past queries. |
38+
<img width="1419" height="825" alt="query-history-eye-candy" src="https://github.com/user-attachments/assets/be000961-f456-4b04-adf0-96f754b7447a" />
39+
40+
41+
### Data manipulation (nodes/relationships)
42+
| Feature | Description |
43+
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
44+
| Create and delete operations | Create node and create relationship flows from the Graph UI. Delete elements (node or relationship) from the Graph UI. |
45+
| Edit labels | Edit labels through API routes (the UI provides label management components). |
46+
47+
### Graph management
48+
| Feature | Description |
49+
| ---------------- | -------------------------------------------------------------------------------------------------------- |
50+
| Create graphs | Create graphs from the UI. |
51+
| Delete graphs | Delete graphs (supports deleting multiple selected graphs). |
52+
| Duplicate graphs | Create a copy of an existing graph (including data). |
53+
| Export graphs | Download a .dump file via the Browser (/api/graph/:graph/export). |
54+
| Upload data | Upload data through the "Upload Data" dialog, which supports drag-and-drop file selection (Dropzone UI). |
55+
56+
### Graph Info panel
57+
| Feature | Description |
58+
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
59+
| Memory Usage tracking | Exposes current memory utilization of the graph in MB. |
60+
| Node Label tracking | Displays all node labels in the graph and controls style visualization for labels. Click on a node label to trigger a query that visualizes nodes from this label. |
61+
| Edge Type tracking | Displays all edge types in the graph. Click on an edge type to trigger a graph query showing only nodes connected through this edge type. |
62+
| Property Keys tracking | Displays all property keys in the graph. Click on a key to issue a query that shows nodes and edges where the property exists (not NULL). |
63+
<img width="1419" height="825" alt="falkordb-browser-eye-candy" src="https://github.com/user-attachments/assets/74375cd1-c704-40a9-9339-f1f885135a75" />
64+
65+
---
66+
67+
### API Documentation
68+
| Feature | Description |
69+
| ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
70+
| Built-in Swagger UI | Available at /docs. Loads the Browser's OpenAPI spec from /api/swagger. "Try it out" enabled. Adds an X-JWT-Only: true header when calling endpoints from Swagger UI. |
71+
72+
<img width="1419" height="825" alt="browser-api-doc-eye-candy" src="https://github.com/user-attachments/assets/35b0ca72-83f7-4f16-927c-413bf5f65593" />
73+
74+
75+
### Authentication & access control
76+
| Feature | Description |
77+
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
78+
| Authentication | Uses NextAuth (credentials-backed) for authentication. |
79+
| Role-aware UI capabilities | Read-Only users cannot create graphs. Admin users can access database configuration and user-management sections in settings. |
80+
81+
### Settings
82+
| Section | Description |
83+
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
84+
| Browser settings | Query execution defaults and limits: timeout, result limit, run default query on load. User experience: content persistence (auto-save and restore), display-text priority (controls which node property appears as the node caption). Graph info refresh interval. Tutorial replay. |
85+
| DB configurations (Admin) | View and update server configuration values. Some runtime configurations remain read-only. |
86+
| Users (Admin) | List users and adjust roles. Add and delete users. |
87+
| Personal Access Tokens | Generate tokens (with optional expiration). Tokens appear once at creation (copy-to-clipboard UX). Revoke existing tokens. |
88+
<!--
89+
### Optional “Chat” (English → Cypher)
90+
If enabled, the Browser includes a **Chat panel** that streams responses from a text-to-cypher service.
91+
- The UI sends messages to `/api/chat` and processes server-sent events.
92+
- Chat configuration lives in Settings (model + secret key).
93+
- The chat backend URL is controlled by `CHAT_URL`.
94+
-->
95+
96+
---
97+
98+
## Common Workflows
99+
### Running and visualizing queries
100+
| Step | Action |
101+
| ---- | -------------------------------------------------------------------------------------- |
102+
| 1 | Go to Graphs and select a graph. |
103+
| 2 | Write a Cypher query in the editor and run it. |
104+
| 3 | Inspect results in the Graph tab (interactive canvas) or Table tab (rows and columns). |
105+
| 4 | Use Labels and Relationships toggles to focus the canvas. |
106+
107+
[NEED GIF HERE]
108+
109+
### Inspecting and editing elements
110+
| Step | Action |
111+
| ---- | -------------------------------------------------------------------------------------- |
112+
| 1 | Click a node or edge in the canvas. |
113+
| 2 | Use the Data panel to inspect properties and apply create or delete actions as needed. |
114+
115+
### Working with query history
116+
| Step | Action |
117+
| ---- | ---------------------------------------------------------------------- |
118+
| 1 | Open Query History and filter by graph or search for a previous query. |
119+
| 2 | Select a query and review Metadata, Explain, or Profile. |
120+
121+
[NEED GIF HERE]
122+
123+
### Exporting graph data
124+
| Step | Action |
125+
| ---- | ------------------------------------------- |
126+
| 1 | Open graph management and select a graph. |
127+
| 2 | Click Export Data to download a `.dump` file. |
128+
129+
[NEED GIF HERE]
130+

0 commit comments

Comments
 (0)