Skip to content

Commit 466d697

Browse files
committed
docs: add runtime feature overview
Summarize the runtime client, workspace, retry, result, and health helpers so downstream adapters can quickly understand the package surface.
1 parent 78f8541 commit 466d697

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@ Shared runtime primitives for Hotdata integrations: workspace/session semantics,
44

55
Runtime boundary and guarantees are defined in `CONTRACT.md`.
66

7+
## Features
8+
9+
- **Environment-driven client setup** — create clients from `HOTDATA_API_KEY`, optional `HOTDATA_API_URL`, `HOTDATA_WORKSPACE`, and `HOTDATA_SANDBOX`.
10+
- **Workspace resolution** — choose an explicit workspace from env, otherwise discover workspaces and select the active workspace or first available workspace.
11+
- **Sandbox/session propagation** — pass sandbox session context through the SDK via `X-Session-Id`.
12+
- **HTTP resilience** — configure SDK retries for transient connection failures and retry SQL execution on stale pooled sockets.
13+
- **SQL execution helper** — run SQL through `POST /v1/query`, poll async query runs when needed, and return a `QueryResult`.
14+
- **Result utilities** — convert query results to records, pandas DataFrames, or metadata dictionaries for adapter display layers.
15+
- **History helpers** — list recent results and query run history with normalized dataclasses.
16+
- **Health helpers** — build compact API/workspace health summaries for UI integrations.
17+
718
Install:
819

920
```bash

0 commit comments

Comments
 (0)