Skip to content
Merged
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
3 changes: 3 additions & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
ACL
AGPLv
AGPLv3
AOF
AST
Aldis
Expand Down Expand Up @@ -39,6 +41,7 @@ Dropzone
Embedder
FOF
FOREACH
foreach
Falkor
FalkorDB
FalkorDB's
Expand Down
17 changes: 13 additions & 4 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
remote_theme: just-the-docs/just-the-docs
title: FalkorDB Docs
description: The FalkorDB documentation
url: "https://docs.falkordb.com"
logo: "/images/falkor-logo.png"
logo_link: "https://www.falkordb.com"
favicon_ico: "/images/favicon.ico"
Expand All @@ -11,9 +12,9 @@ color_scheme: dark

aux_links:
"Docs Repository":
- "//github.com/falkordb/docs"
- "https://github.com/falkordb/docs"
"FalkorDB Repository":
- "//github.com/falkordb/falkordb"
- "https://github.com/falkordb/falkordb"


# Makes Aux links open in a new tab. Default is false
Expand All @@ -25,10 +26,18 @@ nav_enabled: true
plugins:
- jekyll-sitemap
- jekyll-redirect-from
- jekyll-seo-tag

exclude:
- README.md
- Gemfile
- Gemfile.lock
- node_modules
- vendor

# Footer last edited timestamp
last_edit_timestamp: true
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
last_edit_timestamp: true
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/core/Time.html

# Footer "Edit this page on GitHub" link text
gh_edit_link: true
Expand Down
3 changes: 1 addition & 2 deletions cloud/free-tier.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@ The free tier provides everything you need to explore FalkorDB and build initial
| **Cloud Providers** | AWS, GCP | AWS, GCP | AWS, GCP | AWS, GCP, Azure |
| **Call-to-Action** | [Sign up](https://app.falkordb.cloud/signup) | [Sign up](https://app.falkordb.cloud/signup) | [Sign up](https://app.falkordb.cloud/signup) | [Contact Us](mailto:info@falkordb.com) |

### Terms

## Terms
> ⚠️ Free instances that aren't utilized for 1 day will be stopped, and deleted after 7 days.
Need an extension? Speak to [sales](https://www.falkordb.com/get-a-demo/)

Expand Down
2 changes: 1 addition & 1 deletion commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ has_children: true

## FalkorDB Features

FalkorDB exposes graph database functionality within Redis using the [openCypher](https://opencypher.org/) query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval.
FalkorDB is a graph database that exposes its functionality using the [openCypher](https://opencypher.org/) query language. Its basic commands accept openCypher queries, while additional commands are exposed for configuration or metadata retrieval.

## FalkorDB API

Expand Down
8 changes: 4 additions & 4 deletions design/client-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Each is emitted as a 2-array:
2) column name (string)
```

The first element is the [ColumnType enum](https://github.com/FalkorDB/FalkorDB/blob/master/src/resultset/formatters/resultset_formatter.h#L14-L19), which as of RedisGraph v2.1.0 will always be `COLUMN_SCALAR`. This element is retained for backwards compatibility, and may be ignored by the client unless RedisGraph versions older than v2.1.0 must be supported.
The first element is the [ColumnType enum](https://github.com/FalkorDB/FalkorDB/blob/master/src/resultset/formatters/resultset_formatter.h#L14-L19), which as of FalkorDB v2.1.0 will always be `COLUMN_SCALAR`. This element is retained for backwards compatibility, and may be ignored by the client unless FalkorDB versions older than v2.1.0 must be supported.

### Reading result rows

Expand Down Expand Up @@ -189,7 +189,7 @@ It is the client's responsibility to store the [ValueType enum](https://github.c
The `ValueType` for the first entry is `VALUE_NODE`. The node representation contains 3 top-level elements:

1. The node's internal ID.
2. An array of all label IDs associated with the node (currently, each node can have either 0 or 1 labels, though this restriction may be lifted in the future).
2. An array of all label IDs associated with the node (nodes can have zero or more labels).
3. An array of all properties the node contains. Properties are represented as 3-arrays - [property key ID, `ValueType`, value].

```sh
Expand Down Expand Up @@ -232,11 +232,11 @@ The final top-level member of the GRAPH.QUERY reply is the execution statistics.
The statistics always include query execution time, while any combination of the other elements may be included depending on how the graph was modified.

1. "Labels added: (integer)"
2. "Labels removed: (integer)" (since RedisGraph 2.10)
2. "Labels removed: (integer)"
3. "Nodes created: (integer)"
4. "Nodes deleted: (integer)"
5. "Properties set: (integer)"
6. "Properties removed: (integer)" (since RedisGraph 2.10)
6. "Properties removed: (integer)"
7. "Relationships created: (integer)"
8. "Relationships deleted: (integer)"
9. "Indices created: (integer)"
Expand Down
6 changes: 3 additions & 3 deletions design/third-party.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,13 @@ Below is a list of these libraries along with their respective licenses.
- **License**: [Apache License 2.0](https://github.com/RoaringBitmap/CRoaring?tab=License-1-ov-file#readme)

### 11. RedisGraph
- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/)
- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) or [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)

### 12. Redis
- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/)
- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) or [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)

### 13. RediSearch
- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/)
- **License**: [RSALv2](https://redis.io/legal/rsalv2-agreement/) or [SSPLv1](https://redis.io/legal/server-side-public-license-sspl/) or [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html)

---

Expand Down
2 changes: 2 additions & 0 deletions getting-started/clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ FalkorDB provides official Object-Graph Mapping (OGM) libraries that allow you t

## Additional Clients

**Note:** Some clients below were originally developed for RedisGraph. While many may work with FalkorDB due to protocol compatibility, they are not officially tested or supported. For best results, use the official FalkorDB clients listed above.

| Project | Language | License | Author | Package |
| --------------------------------------------------------- | ---------- | ---------- | ------------------------------------------- | ---------------------------------------- |
| [nredisstack][nredisstack-url] | .NET | MIT | [Redis][redis-url] | [nuget][nredisstack-package] |
Expand Down
4 changes: 2 additions & 2 deletions operations/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
title: "OpenTelemetry Integration"
nav_order: 5
parent: Operations
description: "Comprehensive guide for setting up OpenTelemetry observability and tracing with FalkorDB Python applications"
description: "Guide for setting up OpenTelemetry tracing with FalkorDB Python applications"
redirect_from:
- /opentelemetry.html
- /opentelemetry
---

# OpenTelemetry Tracing with FalkorDB-py Guide

This guide explains how to set up and use OpenTelemetry (OTel) to monitor and trace your FalkorDB Python applications.
This guide explains how to set up and use OpenTelemetry (OTel) tracing to monitor your FalkorDB Python applications.

## Overview

Expand Down
2 changes: 1 addition & 1 deletion udfs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ load_graph(g)
compute_jaccard_sim(g)
```

The scripts load our two UDF libraries `collection` and `similarity`, construct a graph, and compute Jaccard similarity between `Alice` and every other node in the graph via the query:
The scripts load our two UDF libraries, `collection` and `similarity`, construct a graph, and compute Jaccard similarity between `Alice` and every other node in the graph via the query:

```bash
MATCH (alice:Person {name: 'Alice'}), (n)
Expand Down
Loading