Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.helix-db.com/llms.txt

Use this file to discover all available pages before exploring further.

HelixQL is deprecated in HelixDB v2. Queries are now written with the Rust DSL and dispatched as JSON — see the Querying guide. This section is kept as a reference for legacy HelixQL projects.
For the complete documentation index optimized for AI agents, see llms.txt.

​
How do I create nodes in HelixDB?

Use AddN to create new nodes in your graph with optional properties. 
AddN<Type>
AddN<Type>({properties})
When using the SDKs or curling the endpoint, the query name must match what is defined in the queries.hx file exactly.

​
Example 1: Adding an empty user node

QUERY CreateUsers () =>
    empty_user <- AddN<User>
    RETURN empty_user
Here’s how to run the query using the SDKs or curl 
from helix.client import Client
client = Client(local=True, port=6969)
print(client.query("CreateUsers"))

​
Example 2: Adding a user with parameters

QUERY CreateUser (name: String, age: U8, email: String) =>
    user <- AddN<User>({
        name: name,
        age: age,
        email: email
    })

    RETURN user
Here’s how to run the query using the SDKs or curl 
from helix.client import Client
client = Client(local=True, port=6969)

params = {
    "name": "Alice",
    "age": 25,
    "email": "alice@example.com",
}

print(client.query("CreateUser", params))

​
Example 3: Adding a user with predefined properties

QUERY CreateUser () =>
    predefined_user <- AddN<User>({
        name: "Alice Johnson",
        age: 30,
        email: "alice@example.com"
    })

    RETURN predefined_user
Here’s how to run the query using the SDKs or curl 
from helix.client import Client
client = Client(local=True, port=6969)
print(client.query("CreateUser"))