Get Started
From a Clean Machine to a Running Lattice in Minutes.
Use the Windows or macOS installer, a package manager, Docker, or build it yourself. Every way gives you the server, the hexdb command, the admin UI and the ODBC driver.
HexDB for Windows
Run the installer, or use a package manager. Either way you get the server, the hexdb command, the admin UI and the ODBC driver.
64-bit installer (.msi)
- Installs into C:\Program Files\HexDB and adds it to the PATH. Windows 10 or later, 64-bit; nothing else is needed.
- The first start creates your configuration and encryption key in %LOCALAPPDATA%\HexDB and tells you where the generated admin password is.
- The ODBC driver is registered as "HexDB", ready for Excel, Power BI and anything else that speaks ODBC.
choco install hexdb
# Then, in a new terminal
hexdb starthttp://127.0.0.1:7700/ui/ and sign in as hexdbadmin with the generated password. Create an API key on the Account page, export it as HEXDB_TOKEN, and run the two curl commands at the top of this page. From a clone of the repository, node scripts/seed.mjs loads sample data.Implement
Get It Wherever You Already Get Software.
Every release is published to the package managers below on the same day, with SHA-256 checksums on GitHub. The ODBC driver comes with HexDB itself, on every platform, and the JDBC driver is one jar on every release.
HexDB
The server, the hexdb command, the admin UI and the ODBC driver.
Windows installer, macOS installer, archives for every platform, .deb packages and checksums
github.com/dreaminhex/hexdb/releasesmacOS and Linux, with a background service
brew install dreaminhex/hexdb/hexdbDebian and Ubuntu, amd64 and arm64, with a systemd service
sudo apt install hexdbThe same image, mirrored from each release
docker pull ghcr.io/dreaminhex/hexdbThe Helm chart, for Kubernetes, one hex or a replicated cluster
helm install hexdb oci://ghcr.io/dreaminhex/charts/hexdbLinux and macOS, without root: checks the download's SHA-256 and installs to ~/.local
curl -fsSL https://raw.githubusercontent.com/dreaminhex/hexdb/main/packaging/install.sh | shBrowse a lattice, run SQL and GraphQL, edit documents and functions, review quarantined files. Also on Open VSX for VSCodium and Cursor
code --install-extension DreamInHex.hexdb
Client Libraries
For applications that talk to HexDB. The libraries cover documents, queries, aggregations, transactions, streams, functions and files; the JDBC driver speaks HexDB's read-only SQL.
JavaScript and TypeScript, for Node.js, Deno, Bun and browsers
npm install @dreaminhex/hexdbHexDB.EntityFrameworkCore, an EF Core 9 provider
dotnet add package HexDB.EntityFrameworkCoreThe ODBC driver, installed with the server on every platform for BI tools, spreadsheets, pyodbc and R
registered as "HexDB"hexdb-jdbc, the JDBC driver for Java 11 and later: one jar, no dependencies
hexdb-jdbc-<version>.jar
Your First Request
Once it's running, every feature is an HTTP call away. Insert a document and query it back; the answer says which index it used.
# Insert a document
curl -X POST http://localhost:7700/orders \
-H "Authorization: Bearer $HEXDB_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "customer": "ada", "total": 42, "status": "paid" }'
# Query it back, largest first
curl -G http://localhost:7700/orders \
-H "Authorization: Bearer $HEXDB_TOKEN" \
--data-urlencode 'filter={"status":"paid","total":{"$gte":10}}' \
--data-urlencode 'sort=-total'{
"documents": [
{ "id": "01JTY87RVJ9B5863KMB2YD896B",
"customer": "ada", "total": 42, "status": "paid" }
],
"total": 1,
"plan": { "indexes": ["status"], "scanned": 1 }
}