Rust SDK

Build typed HelixDB queries and execute them over HTTP or an embedded engine

Guide

The published helix-db 3.0.0 crate provides the query DSL, request types, async HTTP client, native graph helpers, and a feature-gated embedded client.

The package is published as helix-db and imported as helix_db.

Install

cargo add helix-db@3.0.0

Or add the dependency directly:

Cargo.toml

[dependencies]
helix-db = "3.0.0"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }

Define a query

use helix_db::dsl::prelude::*;

#[query]
fn find_users(tenant_id: String, limit: i64) -> ReadBatch {
    read_batch()
        .var_as(
            "users",
            g()
                .n_with_label("User")
                .where_(Predicate::eq("tenantId", tenant_id))
                .limit(limit)
                .value_map(Some(vec!["$id", "name", "tenantId"])),
        )
        .returning(["users"])
}

#[query] converts typed arguments into request parameters and sets query_name to the function name.

Execute

use helix_db::Client;

let client = Client::new(Some("http://localhost:6969"))?;
let request = find_users("acme".to_string(), 25);
let response: serde_json::Value = client.query(request).send().await?;

Use .with_api_key(Some("hx_...")) for Helix Cloud. Request-builder options can require the writer, require a warm read, or control durability waiting.

Build without the macro

let request = QueryRequest::read(
    read_batch()
        .var_as("count", g().n_with_label("User").count())
        .returning(["count"]),
)
.with_query_name("count_users");

Embedded runtime

Enable the embedded feature:

cargo add helix-db --features embedded

See Embedded database for storage, cache, and handle configuration.

Verify

Rust SDK documentation examples are doctests:

cargo test --manifest-path sdks/rust/Cargo.toml --doc

Next steps

Query tutorial

Learn the batch and traversal model.

Reading data

Select data by ID, label, or indexed property.