LoraDb.Client.Native 0.1.2

LoraDb.Client

A modern .NET client for LoraDB — a graph database with a Cypher-like query language — supporting both HTTP and embedded (Rust FFI via P/Invoke) modes.

✨ Features

📦 Installation

dotnet add package LoraDb.Client

⚡ Quick start

using LoraDb.Client;

await using var client = LoraDbClient.CreateHttp(new Uri("http://127.0.0.1:4747/"));

UserNameRow? first = null;
await foreach (var row in client.ExecuteRowsAsync<UserNameRow>(
                   "MATCH (u:User) WHERE u.name = $name RETURN u.name AS name",
                   new Dictionary<string, object?> { ["name"] = "Alice" }))
{
    first = row;
    break;
}

var name = first?.Name;

public sealed class UserNameRow
{
    public string Name { get; init; } = string.Empty;
}

Need low-level JSON access? ExecuteAsync returns LoraDbQueryResult with Root.

🔌 Runtime modes

HTTP mode

await using var client = LoraDbClient.CreateHttp(new Uri("http://127.0.0.1:4747/"));

Embedded mode

// In-memory (ephemeral)
await using var client = LoraDbClient.CreateEmbedded();

// Persistent on-disk
await using var client = LoraDbClient.CreateEmbedded(new LoraDbEmbeddedOpenOptions
{
    DatabaseName = "app",
    DatabaseDirectory = "/var/lib/loradb",
});

Embedded mode uses lora_ffi and expects these exported symbols:

• lora_db_new, lora_db_new_named, lora_db_new_with_wal
• lora_db_free
• lora_db_execute_json, lora_db_explain_json, lora_db_profile_json
• lora_db_save_snapshot, lora_db_load_snapshot
• lora_string_free

📖 Usage documentation

For a full guide covering HTTP mode, embedded mode, DI setup, result handling, and troubleshooting, see docs/USAGE.md.

🛠️ Development

dotnet restore LoraDb.Client.slnx
dotnet build LoraDb.Client.slnx
dotnet test LoraDb.Client.Tests/LoraDb.Client.Tests.csproj

Integration tests

Integration tests exercise real HTTP and embedded modes and require:

dotnet test LoraDb.Client.IntegrationTests/LoraDb.Client.IntegrationTests.csproj

Build/pin native lora_ffi

The pinned upstream version is tracked in LoraDb.Client.Native/lora-ffi.version.

# Build using the currently pinned upstream ref
./scripts/build-lora-ffi.sh

# Update to a new upstream ref and persist the pin
./scripts/build-lora-ffi.sh --ref <tag-or-commit> --update-pin

🤝 Contributing

See CONTRIBUTING.md for commit conventions, branch workflow, and PR guidelines.

🔒 Security

Please do not open a public issue for vulnerabilities. See SECURITY.md for the responsible disclosure process.

📄 License

This project is licensed under the MIT License. Copyright © 2026 Harry Cordewener.