Skip to main content
Guide
The Python SDK is packaged as helix-db and imported as helixdb. Its builder methods use snake_case and produce the same operation-tree AST as the other v3 SDKs.
helix-db includes the synchronous and asynchronous server clients. Install helix-db-embedded as well only when the application runs HelixDB in process.

Install

Define a query

Execute

The server clients have no native runtime dependency.

Async execution

Reuse one async client to reuse its HTTP connection pool. HTTP requests have no timeout unless you explicitly configure one.
Cancellation propagates as asyncio.CancelledError, closes the response stream, and leaves the client reusable. The client owns and closes an injected HTTPX async transport. await client.close() is idempotent.

Embedded runtime

Install the SDK and embedded runtime with python -m pip install helix-db helix-db-embedded. See Embedded database for storage, cache, and handle configuration.
Async embedded queries await native UniFFI operations directly. Use asyncio.timeout(...) for cancellation boundaries. Async native graph loading is not part of this API; use the synchronous Client.graph(...) API.

Verify

Next steps

Query tutorial

Follow the shared batch and traversal model.

Embedded database

Open an in-process writer or reader.