From 50c4348a1f894740e475a2716e6f1c622dfeacb4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:05:29 +0000 Subject: [PATCH 01/38] Update docs.json --- docs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs.json b/docs.json index 02cf077..512ef69 100644 --- a/docs.json +++ b/docs.json @@ -263,6 +263,7 @@ } }, "seo": { + "indexing": "all", "metatags": { "description": "HelixDB Documentation to get you started with HelixDB", "keywords": "HelixDB, Documentation, Getting Started, CLI, SDK, Guides, Features, Blogs, RAG, Database, Database, Graph Database, Vector Database, AI, Agents, LLMs, Knowledge Graphs, Retrieval Augmented Generation, Knowledge Graphs, AI Agents, Document databases", @@ -272,7 +273,6 @@ "og:description": "HelixDB Documentation", "og:type": "website", "og:site_name": "HelixDB Documentation", - "indexing": "all", "category": "Technology", "language": "en", "author": "HelixDB" From e1a7c1ceff706b4b6aaa763b8bb3bd57540b580b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:05:36 +0000 Subject: [PATCH 02/38] Update documentation/cli-v2/getting-started.mdx --- documentation/cli-v2/getting-started.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/cli-v2/getting-started.mdx b/documentation/cli-v2/getting-started.mdx index 95ebf64..e279020 100644 --- a/documentation/cli-v2/getting-started.mdx +++ b/documentation/cli-v2/getting-started.mdx @@ -1,6 +1,6 @@ --- -title: "Getting Started" -description: "Install, configure, and set up the Helix CLI v2 for your development workflow" +title: "Getting started with HelixDB CLI v2" +description: "Step-by-step guide to install, configure, and deploy your first HelixDB instance with CLI v2" icon: "rocket" --- From 88c680d11dcaecb536c2a56f3a656a12ca85e7d3 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:05:43 +0000 Subject: [PATCH 03/38] Update documentation/cli-v2/getting-started.mdx --- documentation/cli-v2/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/cli-v2/getting-started.mdx b/documentation/cli-v2/getting-started.mdx index e279020..c3db6d7 100644 --- a/documentation/cli-v2/getting-started.mdx +++ b/documentation/cli-v2/getting-started.mdx @@ -13,7 +13,7 @@ icon: "rocket" - + Use the official installer script to automatically download and set up the Helix CLI: ```bash From b8ba80fc43ae59dd975ce07787f961a0df79e5e4 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:05:47 +0000 Subject: [PATCH 04/38] Update documentation/cli-v2/getting-started.mdx --- documentation/cli-v2/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/cli-v2/getting-started.mdx b/documentation/cli-v2/getting-started.mdx index c3db6d7..eb07e61 100644 --- a/documentation/cli-v2/getting-started.mdx +++ b/documentation/cli-v2/getting-started.mdx @@ -27,7 +27,7 @@ curl -sSL https://install.helix-db.com | bash - + ```bash helix init ``` From d1ddb06402684aa64659bc5f3528acd5033d72fd Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:05:53 +0000 Subject: [PATCH 05/38] Update documentation/cli-v2/getting-started.mdx --- documentation/cli-v2/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/cli-v2/getting-started.mdx b/documentation/cli-v2/getting-started.mdx index eb07e61..3e68ef9 100644 --- a/documentation/cli-v2/getting-started.mdx +++ b/documentation/cli-v2/getting-started.mdx @@ -33,7 +33,7 @@ helix init ``` - + Inside the schema.hx file, create your schema. ```js N::User { From f76ae5f1dade94afe9b222c367db55ae8a771b6d Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:05:58 +0000 Subject: [PATCH 06/38] Update documentation/cli-v2/getting-started.mdx --- documentation/cli-v2/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/cli-v2/getting-started.mdx b/documentation/cli-v2/getting-started.mdx index 3e68ef9..0419f66 100644 --- a/documentation/cli-v2/getting-started.mdx +++ b/documentation/cli-v2/getting-started.mdx @@ -57,7 +57,7 @@ QUERY getUser(name: String) => - + ```bash helix push dev ``` From ad655345238f403e2dd99961878f454dcf1ce0cf Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:06:04 +0000 Subject: [PATCH 07/38] Update documentation/cli-v2/getting-started.mdx --- documentation/cli-v2/getting-started.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/cli-v2/getting-started.mdx b/documentation/cli-v2/getting-started.mdx index 0419f66..5aa8bf8 100644 --- a/documentation/cli-v2/getting-started.mdx +++ b/documentation/cli-v2/getting-started.mdx @@ -63,7 +63,7 @@ helix push dev ``` - + **Create a user** ```bash curl -X POST http://localhost:6969/createUser -d '{"name": "John Doe", "email": "john.doe@example.com"}' From b12b510e70c4b692e9497917f49444e0480dd45e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:06:14 +0000 Subject: [PATCH 08/38] Update documentation/hql/hql.mdx --- documentation/hql/hql.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/hql/hql.mdx b/documentation/hql/hql.mdx index 5ffc04b..8be0315 100644 --- a/documentation/hql/hql.mdx +++ b/documentation/hql/hql.mdx @@ -1,11 +1,11 @@ --- title: "What is HelixQL?" +description: "Learn about HelixQL, a strongly typed compiled query language for graph and vector operations in HelixDB" sidebarTitle: "What is HQL?" icon: "book-open" --- -HelixQL is a strongly typed, compiled query language for HelixDB. -It was inspired from a combination of Gremlin, Cypher and Rust. +HelixQL is a strongly typed, compiled query language for HelixDB that combines the best features of Gremlin, Cypher, and Rust to provide type-safe graph and vector queries. ## Why yet another query language? From 08217c88016ef2973fba533f719320447638f773 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:06:25 +0000 Subject: [PATCH 09/38] Update documentation/hql/hql.mdx --- documentation/hql/hql.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/documentation/hql/hql.mdx b/documentation/hql/hql.mdx index 8be0315..f28b047 100644 --- a/documentation/hql/hql.mdx +++ b/documentation/hql/hql.mdx @@ -7,16 +7,16 @@ icon: "book-open" HelixQL is a strongly typed, compiled query language for HelixDB that combines the best features of Gremlin, Cypher, and Rust to provide type-safe graph and vector queries. -## Why yet another query language? +## Why use HelixQL instead of other query languages? -Over the past few years, we've used Gremlin extensively for graph queries. -It's powerful and very expressive, but it's also extremely verbose and horrible to read after any substantial complexity. +HelixQL addresses key limitations found in existing graph query languages: -The other major issue is that it's obviously completely dynamic and is parsed at runtime when the query is executed. -This leads to a horrible developer experience, not knowing if the query is valid until runtime. +- **Type safety**: Queries are validated at compile time, catching errors before runtime +- **Readability**: Clean, concise syntax that remains readable even for complex queries +- **Performance**: Compiled queries execute faster than dynamically parsed alternatives +- **Developer experience**: IDE support with autocomplete and type checking -Building a new query language from scratch is obviously a big undertaking, -but we thought it was a necessary step to improve the developer experience and make building with graphs better. +Unlike Gremlin's verbose syntax or Cypher's runtime parsing, HelixQL provides a modern, type-safe approach to graph querying. **Example Query Syntax:** From 70b9b38fc1cbb0fae4fac0b2a57e18de1e9bfdd7 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:06:31 +0000 Subject: [PATCH 10/38] Update documentation/hql/hql.mdx --- documentation/hql/hql.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/hql/hql.mdx b/documentation/hql/hql.mdx index f28b047..faaa98c 100644 --- a/documentation/hql/hql.mdx +++ b/documentation/hql/hql.mdx @@ -18,7 +18,9 @@ HelixQL addresses key limitations found in existing graph query languages: Unlike Gremlin's verbose syntax or Cypher's runtime parsing, HelixQL provides a modern, type-safe approach to graph querying. -**Example Query Syntax:** +## How do I write a HelixQL query? + +HelixQL queries follow a simple, declarative syntax: ```js QUERY QueryName(param1: Type, param2: Type) => From b66adb9b49bebb0a1764b4e4faf4820728eda3af Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:06:36 +0000 Subject: [PATCH 11/38] Update documentation/hql/hql.mdx --- documentation/hql/hql.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/hql/hql.mdx b/documentation/hql/hql.mdx index faaa98c..34a8549 100644 --- a/documentation/hql/hql.mdx +++ b/documentation/hql/hql.mdx @@ -28,7 +28,7 @@ QUERY QueryName(param1: Type, param2: Type) => RETURN result ``` -#### Components +### Query components - `QUERY`: Keyword to start a query definition - `QueryName`: Identifier for the query From 9bb5f7beba0df6456fd8bff91921eb16c20f08d0 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:06:47 +0000 Subject: [PATCH 12/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index e49df0b..214bda0 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -1,13 +1,10 @@ --- title: 'Python SDK' -description: 'Getting started with HelixDBs Python SDK.' +description: 'Complete guide to using the HelixDB Python SDK for graph and vector operations with code examples' icon: 'python' --- -[**helix-py**](https://github.com/HelixDB/helix-py) is a Python library for interacting with [helix-db](https://github.com/HelixDB/helix-db), -a powerful graph-vector database written in Rust. It provides both a simple query interface and a PyTorch-like -front-end for defining and executing custom graph queries and vector-based operations. This makes it -well-suited for use cases such as similarity search, knowledge graph construction, and machine learning pipelines. +Use the [helix-py](https://github.com/HelixDB/helix-py) Python SDK to interact with HelixDB, a high-performance graph-vector database. The SDK provides a simple query interface and PyTorch-like API for defining custom graph queries and vector operations, making it ideal for similarity search, knowledge graphs, and machine learning pipelines. ## Installation From 427403dd9019159f9dc755744b71b799483b3d4c Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:06:53 +0000 Subject: [PATCH 13/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index 214bda0..27d3d10 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -6,7 +6,9 @@ icon: 'python' Use the [helix-py](https://github.com/HelixDB/helix-py) Python SDK to interact with HelixDB, a high-performance graph-vector database. The SDK provides a simple query interface and PyTorch-like API for defining custom graph queries and vector operations, making it ideal for similarity search, knowledge graphs, and machine learning pipelines. -## Installation +## How do I install the Python SDK? + +Install helix-py using your preferred Python package manager: From 72f9b77f9086cf852158a82d637b2de80660b2ab Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:00 +0000 Subject: [PATCH 14/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index 27d3d10..ee0daa9 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -22,8 +22,9 @@ pip install helix-py -## Client -To setup a simple `Client` to interface with a running helix instance: +## How do I connect to HelixDB with Python? + +Set up a `Client` to connect to your HelixDB instance: ```python Python import helix From 189b3ebeb22313669f530313af5a88c4b6392811 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:09 +0000 Subject: [PATCH 15/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index ee0daa9..760661c 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -38,10 +38,9 @@ db.query('add_user', {"name": "John", "age": 20}) The default port is `6969`, but you can change it by passing in the `port` parameter. For cloud instances, you can pass in the `api_endpoint` parameter. -## Queries -[**helix-py**](https://github.com/HelixDB/helix-py) allows users to define a PyTorch-like manner, similar to how -you would define a neural network's forward pass. You can use built-in queries in `helix/client.py` -to get started with inserting and search vectors, or you can define your own queries for more complex workflows. +## How do I execute queries with the Python SDK? + +Define queries in a PyTorch-like manner, similar to neural network forward passes. Use built-in queries for common operations or define custom queries for complex workflows. **Pytorch-like Query** From 7adb1e66cc7ff1d15d332bb7d743c8ced7d81e5a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:16 +0000 Subject: [PATCH 16/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index 760661c..8535878 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -42,9 +42,9 @@ For cloud instances, you can pass in the `api_endpoint` parameter. Define queries in a PyTorch-like manner, similar to neural network forward passes. Use built-in queries for common operations or define custom queries for complex workflows. -**Pytorch-like Query** +### PyTorch-like query definition -Given a HelixQL query like this: +Match your HelixQL queries with Python classes: ```rust query.hx QUERY add_user(name: String, age: I64) => usr <- AddV({name: name, age: age}) From 1881c026452fbfcaba7b3aa79116856ae97ad51a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:25 +0000 Subject: [PATCH 17/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index 8535878..f590361 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -73,9 +73,9 @@ db.query(add_user("John", 20)) Make sure that the `Query.query` method returns a list of objects. -## Instance -To setup a simple `Instance` that manages and automatically starts and stops a helix instance with respect -to the lifetime of the script: +## How do I manage HelixDB instances with Python? + +Use the `Instance` class to manage HelixDB lifecycle automatically within your Python scripts: ```python Python from helix.instance import Instance From 89e9f3feb0431aec4cf01988af59bf6e5b8b4327 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:32 +0000 Subject: [PATCH 18/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index f590361..9e1575c 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -102,8 +102,9 @@ and from there you can interact with the instance using `Client`. The instance will be automatically stopped when the script exits. -## Providers -Helix has LLM interfaces for popular LLM providers. +## How do I use LLM providers with HelixDB? + +Integrate popular LLM providers directly with HelixDB using built-in provider interfaces. **Available providers**: - `OpenAIProvider` From 60b888e26e6c9a23fe36b59a4ed4581344be779e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:38 +0000 Subject: [PATCH 19/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index 9e1575c..13535db 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -159,8 +159,9 @@ anthropic_llm.enable_mcps("helix-mcp", url="https://your-remote-mcp/...") - Anthropic local streamable MCP is not supported; use a URL-based MCP. -## Embedders -Helix has embedder interfaces for popular embedding providers. +## How do I generate embeddings with HelixDB? + +Use built-in embedder interfaces to generate vector embeddings from popular providers. Available embedders: - `OpenAIEmbedder` From b107d7e1dec741cf45409f4f5327ae91dcabf458 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:44 +0000 Subject: [PATCH 20/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index 13535db..6729f7b 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -188,9 +188,9 @@ voyage_embedder = VoyageAIEmbedder() vec = voyage_embedder.embed("query text", input_type="query") ``` -## Chunking +## How do I chunk text for embeddings? -Helix uses [Chonkie](https://chonkie.ai/) chunking methods to split text into manageable pieces for processing and embedding: +Split text into manageable pieces using [Chonkie](https://chonkie.ai/) chunking methods: ```python from helix import Chunk From 815279bc9494f8c5af15a115bc2d3b51f9d63c2b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:07:54 +0000 Subject: [PATCH 21/38] Update documentation/sdks/helix-py.mdx --- documentation/sdks/helix-py.mdx | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/documentation/sdks/helix-py.mdx b/documentation/sdks/helix-py.mdx index 6729f7b..0954890 100644 --- a/documentation/sdks/helix-py.mdx +++ b/documentation/sdks/helix-py.mdx @@ -209,10 +209,9 @@ batch_chunks = Chunk.sentence_chunk(texts) You can find all the different chunking examples inside of [Chunking Feature](../../features/chunking/helix-chunking). -## Loader -The loader (`helix/loader.py`) currently supports `.parquet`, `.fvecs`, and `.csv` data. Simply pass in the path to your -file or files and the columns you want to process and the loader does the rest for you and is easy to integrate with -your queries +## How do I load data into HelixDB? + +The loader supports `.parquet`, `.fvecs`, and `.csv` files. Pass your file path and column names to automatically load data into your queries. ## More Information For more information, check out our [examples](https://github.com/HelixDB/helix-py/tree/main/examples)! From e8754b17dde927f2c3b938ad7107521fa7933132 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:04 +0000 Subject: [PATCH 22/38] Update documentation/hql/vectors/searching.mdx --- documentation/hql/vectors/searching.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/hql/vectors/searching.mdx b/documentation/hql/vectors/searching.mdx index f865bde..51f865f 100644 --- a/documentation/hql/vectors/searching.mdx +++ b/documentation/hql/vectors/searching.mdx @@ -1,12 +1,12 @@ --- -title: "Vector Search" -description: "Search for vectors in your graph using cosine similarity." +title: "Vector search" +description: "How to perform vector similarity search in HelixDB using cosine similarity with code examples" icon: "magnifying-glass" --- -## Search Vectors using `SearchV`   +## How do I search for similar vectors in HelixDB? -Search for vectors in your graph. +Use `SearchV` to find vectors similar to your query vector using cosine similarity. ```rust SearchV(vector, limit) From 036c2828d96e8025bab539e765289ff4197bfdcb Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:13 +0000 Subject: [PATCH 23/38] Update documentation/hql/create/addN.mdx --- documentation/hql/create/addN.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/hql/create/addN.mdx b/documentation/hql/create/addN.mdx index f04f6d9..4d6e5d5 100644 --- a/documentation/hql/create/addN.mdx +++ b/documentation/hql/create/addN.mdx @@ -1,12 +1,12 @@ --- -title: "Nodes" -description: "Learn how to create nodes in your graph." +title: "Create nodes" +description: "How to create nodes in your HelixDB graph with AddN including examples for empty nodes, parameterized nodes, and predefined properties" icon: "draw-circle" --- -## Create Nodes using `AddN`   +## How do I create nodes in HelixDB? -Create new nodes in your graph. +Use `AddN` to create new nodes in your graph with optional properties. ```rust AddN From 813a1148249760d9ecb27920c882ca0f0de3cfd1 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:23 +0000 Subject: [PATCH 24/38] Update documentation/hql/select/selectN.mdx --- documentation/hql/select/selectN.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/documentation/hql/select/selectN.mdx b/documentation/hql/select/selectN.mdx index 8e7a2f5..8c74931 100644 --- a/documentation/hql/select/selectN.mdx +++ b/documentation/hql/select/selectN.mdx @@ -1,12 +1,12 @@ --- -title: "Nodes" -description: "Learn how to select nodes in your graph." +title: "Select nodes" +description: "How to select and query nodes in your HelixDB graph by ID or type with code examples" icon: "draw-circle" --- -## `N`   Nodes +## How do I select nodes in HelixDB? -Select nodes from your graph to begin traversal. +Use `N` to select nodes from your graph by ID or type to begin traversals. ```rust N(node_id) From e0cce5719a6445acff5127542416caae0f867eb8 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:30 +0000 Subject: [PATCH 25/38] Update documentation/getting-started/graph-database.mdx --- documentation/getting-started/graph-database.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/getting-started/graph-database.mdx b/documentation/getting-started/graph-database.mdx index cf46da1..3dad4c9 100644 --- a/documentation/getting-started/graph-database.mdx +++ b/documentation/getting-started/graph-database.mdx @@ -6,9 +6,9 @@ icon: 'chart-network' A graph database is a type of database that stores data using a graph structure, where information is represented through **nodes** (data points) and **edges** (relationships between nodes). Unlike traditional databases that use tables or documents, graph databases excel at managing highly connected data and complex relationships. -## How Graph Databases Work +## How do graph databases work? -Graph databases are built on two fundamental concepts: +Graph databases store data using two fundamental concepts: 1. **Nodes** - These are the entities or objects in your data (like people, products, or locations) 2. **Edges** (or relationships) - These are the connections between nodes that describe how they relate to each other From 700e92e3fb9842c921bcebac6b31ba8589aaaaf3 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:35 +0000 Subject: [PATCH 26/38] Update documentation/getting-started/graph-database.mdx --- documentation/getting-started/graph-database.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/getting-started/graph-database.mdx b/documentation/getting-started/graph-database.mdx index 3dad4c9..bfcbc44 100644 --- a/documentation/getting-started/graph-database.mdx +++ b/documentation/getting-started/graph-database.mdx @@ -28,7 +28,7 @@ In this simple example: - Edges show relationships like friendships, employment, and product interactions - Both nodes and edges can have properties (additional data attributes) -## Common Use Cases +## What are graph databases used for? ### 1. Social Networks Perfect for modeling: From 85f508f82770a1c25a8abe365b7f0753515572f1 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:46 +0000 Subject: [PATCH 27/38] Update documentation/getting-started/graph-database.mdx --- documentation/getting-started/graph-database.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/getting-started/graph-database.mdx b/documentation/getting-started/graph-database.mdx index bfcbc44..7ca1450 100644 --- a/documentation/getting-started/graph-database.mdx +++ b/documentation/getting-started/graph-database.mdx @@ -58,9 +58,9 @@ Great for: - AI and machine learning - Research and discovery -## When to Use a Graph Database +## When should I use a graph database? -Consider using a graph database when: +Use a graph database when: - Your data has many interconnected relationships - You need to perform complex queries involving multiple relationships From 33779edd305082993b25b855f8dff89ae5ca9c1a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:52 +0000 Subject: [PATCH 28/38] Update documentation/getting-started/graph-database.mdx --- documentation/getting-started/graph-database.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/getting-started/graph-database.mdx b/documentation/getting-started/graph-database.mdx index 7ca1450..2477c4d 100644 --- a/documentation/getting-started/graph-database.mdx +++ b/documentation/getting-started/graph-database.mdx @@ -70,7 +70,7 @@ Use a graph database when: -## Benefits Over Traditional Databases +## What are the benefits of graph databases? 1. **Performance**: Faster for relationship-heavy queries 2. **Flexibility**: Easier to modify and extend the data model From f3de5d1278ca24b9f9e69e7228b034b75c96c54e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:08:58 +0000 Subject: [PATCH 29/38] Update documentation/getting-started/helixdb.mdx --- documentation/getting-started/helixdb.mdx | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/getting-started/helixdb.mdx b/documentation/getting-started/helixdb.mdx index b4ffd63..8c06164 100644 --- a/documentation/getting-started/helixdb.mdx +++ b/documentation/getting-started/helixdb.mdx @@ -8,7 +8,9 @@ icon: 'database' Rust version 1.88.0 or higher is required. Make sure you have an updated version of Rust installed. Run `rustup update` to update your Rust version. -## Key Features +## What are HelixDB's key features? + +HelixDB provides: - **High Performance**: Purpose-built storage engine optimized for both graph and vector operations - **Type Safety**: Explicit type definitions to ensure data integrity From 4d172748e5f587924e98597a0ead6826ad55ad08 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:09:05 +0000 Subject: [PATCH 30/38] Update documentation/getting-started/helixdb.mdx --- documentation/getting-started/helixdb.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/getting-started/helixdb.mdx b/documentation/getting-started/helixdb.mdx index 8c06164..ba18a52 100644 --- a/documentation/getting-started/helixdb.mdx +++ b/documentation/getting-started/helixdb.mdx @@ -17,9 +17,9 @@ HelixDB provides: - **Developer-Friendly**: Simple setup and migration - **Secure**: Options for encryption at rest -## Data Model +## How does HelixDB store data? -HelixDB follows the property graph model, which consists of: +HelixDB uses a property graph model with three core components: - **Nodes**: Represent entities with unique identifiers and properties ```js From 879c31176ebefc75f60229fe6a45d19f9abc9b56 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:09:25 +0000 Subject: [PATCH 31/38] Update documentation/hql/schema/schema-definition.mdx --- documentation/hql/schema/schema-definition.mdx | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/documentation/hql/schema/schema-definition.mdx b/documentation/hql/schema/schema-definition.mdx index ebb5f3f..9227e30 100644 --- a/documentation/hql/schema/schema-definition.mdx +++ b/documentation/hql/schema/schema-definition.mdx @@ -1,12 +1,11 @@ --- -title: "Schema Definition" -description: "Text, title, and styling in standard markdown" +title: "Schema definition" +description: "How to define schemas for nodes, edges, and vectors in HelixDB with type-safe property definitions" --- -## Schema Definition +## How do I define schemas in HelixDB? -HelixQL uses a schema definition to define the structure of the graph. -Note that every node, edge and vector has an implicit `ID` field. that is not in the schema definition. +Define the structure of your graph using HelixQL schema definitions. Every node, edge, and vector automatically includes an implicit `ID` field. ### Node Schema From 4cc7e3051e59339c5f4809f390aac8baf6a3a1cf Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:09:30 +0000 Subject: [PATCH 32/38] Update documentation/hql/schema/schema-definition.mdx --- documentation/hql/schema/schema-definition.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/hql/schema/schema-definition.mdx b/documentation/hql/schema/schema-definition.mdx index 9227e30..c58fd5a 100644 --- a/documentation/hql/schema/schema-definition.mdx +++ b/documentation/hql/schema/schema-definition.mdx @@ -7,9 +7,9 @@ description: "How to define schemas for nodes, edges, and vectors in HelixDB wit Define the structure of your graph using HelixQL schema definitions. Every node, edge, and vector automatically includes an implicit `ID` field. -### Node Schema +### Node schemas -Defines node types and their properties in the graph. +Define node types and their properties: ```rust N::NodeType { From e1e8773e83fd35dfc5521f830cf935ecb3653a76 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:09:36 +0000 Subject: [PATCH 33/38] Update documentation/hql/schema/schema-definition.mdx --- documentation/hql/schema/schema-definition.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/hql/schema/schema-definition.mdx b/documentation/hql/schema/schema-definition.mdx index c58fd5a..4321477 100644 --- a/documentation/hql/schema/schema-definition.mdx +++ b/documentation/hql/schema/schema-definition.mdx @@ -20,9 +20,9 @@ N::NodeType { --- -### Edge Schema +### Edge schemas -Defines relationships between nodes and their properties. +Define relationships between nodes with properties: ```rust E::EdgeType { From 6733880e6471f9ed6bbfb482dab075d43d0ada4f Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:09:42 +0000 Subject: [PATCH 34/38] Update documentation/hql/schema/schema-definition.mdx --- documentation/hql/schema/schema-definition.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/hql/schema/schema-definition.mdx b/documentation/hql/schema/schema-definition.mdx index 4321477..81e485a 100644 --- a/documentation/hql/schema/schema-definition.mdx +++ b/documentation/hql/schema/schema-definition.mdx @@ -37,9 +37,9 @@ E::EdgeType { --- -### Vector Schema +### Vector schemas -Defines the vector type. +Define vector types with metadata properties: ```rust V::VectorType { From f91bcffba3236da04191d71729d99e4500c6593e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:10:02 +0000 Subject: [PATCH 35/38] Update documentation/getting-started/helixdb.mdx --- documentation/getting-started/helixdb.mdx | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/documentation/getting-started/helixdb.mdx b/documentation/getting-started/helixdb.mdx index ba18a52..d683f5e 100644 --- a/documentation/getting-started/helixdb.mdx +++ b/documentation/getting-started/helixdb.mdx @@ -48,3 +48,20 @@ HelixDB uses a property graph model with three core components: ``` This model allows for rich representation of complex domains while maintaining query performance. + +## Next steps + + + + Install and deploy your first HelixDB instance + + + Master the HelixQL query language + + + Define your graph structure + + + Use HelixDB with Python + + From 0242eb0b27743bb49279c4706be5f62c0b157b1b Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:10:13 +0000 Subject: [PATCH 36/38] Update documentation/getting-started/graph-database.mdx --- .../getting-started/graph-database.mdx | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/documentation/getting-started/graph-database.mdx b/documentation/getting-started/graph-database.mdx index 2477c4d..c25f017 100644 --- a/documentation/getting-started/graph-database.mdx +++ b/documentation/getting-started/graph-database.mdx @@ -76,3 +76,20 @@ Use a graph database when: 2. **Flexibility**: Easier to modify and extend the data model 3. **Intuitive**: More natural way to model connected data 4. **Scalability**: Better handling of complex relationship patterns + +## Next steps + + + + Learn about HelixDB's architecture and features + + + Install and deploy your first graph database + + + Build a social network with graph databases + + + Learn to query graph data + + From 537c40e2bbe691660cfafbe6259f39b479610acd Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:10:23 +0000 Subject: [PATCH 37/38] Update documentation/hql/create/addN.mdx --- documentation/hql/create/addN.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/documentation/hql/create/addN.mdx b/documentation/hql/create/addN.mdx index 4d6e5d5..8f5bf2b 100644 --- a/documentation/hql/create/addN.mdx +++ b/documentation/hql/create/addN.mdx @@ -312,3 +312,10 @@ curl -X POST \ -d '{}' ``` + +## Related operations + +- [Select nodes](/documentation/hql/select/selectN) - Query existing nodes +- [Create edges](/documentation/hql/create/addE) - Connect nodes with relationships +- [Update nodes](/documentation/hql/updating) - Modify node properties +- [Schema definitions](/documentation/hql/schema/schema-definition) - Define node types From 11f2198d70bd5b36924179d5a44acd27d43d7928 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 10:10:33 +0000 Subject: [PATCH 38/38] Update documentation/hql/select/selectN.mdx --- documentation/hql/select/selectN.mdx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/documentation/hql/select/selectN.mdx b/documentation/hql/select/selectN.mdx index 8c74931..9997b7e 100644 --- a/documentation/hql/select/selectN.mdx +++ b/documentation/hql/select/selectN.mdx @@ -245,3 +245,10 @@ curl -X POST \ You can also do specific property-based filtering, e.g., returning only ID, see the [Property Filtering](../properties/property-access). You can also do aggregation steps, e.g., returning the count of nodes, see the [Aggregations](../aggregation). + +## Related operations + +- [Create nodes](/documentation/hql/create/addN) - Add new nodes to your graph +- [Traversals](/documentation/hql/traversals/steps_nodes) - Navigate between connected nodes +- [Conditionals](/documentation/hql/conditionals/conditions) - Filter nodes by properties +- [Property access](/documentation/hql/properties/property-access) - Work with node properties