HexDB

Search HexDB

Find a feature, an API example, a step, a FAQ answer or a term, then jump to it.

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 start
Then sign in and make your first request. Open http://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.

Listen to the podcast - 5:55 min

Installation: Packages, Containers and Kubernetes

Every way to install HexDB, from release archives, installers, APT, Chocolatey and Homebrew to Docker images and the Helm chart, and how that differs from installing a client driver.

0:00--:--

HexDB

The server, the hexdb command, the admin UI and the ODBC driver.

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.

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.

terminal
# 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'
200 OK · application/json
{
  "documents": [
    { "id": "01JTY87RVJ9B5863KMB2YD896B",
      "customer": "ada", "total": 42, "status": "paid" }
  ],
  "total": 1,
  "plan": { "indexes": ["status"], "scanned": 1 }
}