Skip to main content

Client API Details

SDK MethodAPI Request Description
submit(statement) → SubmitResponsePOST /v1/resource/, return the requestId.
get_status(request_id) → StatusResponseGET /v1/status/{id}, return the parsed status.
execute(statement, timeout=, poll_interval=) → StatusResponseSubmit + poll until terminal. Blocks thread until API returns.
Typed helper: <verb>_<resource>(...) (52 methods)Typed wrappers around execute() that build SQL for you. See Typed helpers.

Notes

  • Lazy import. from onehouse_python_sdk import OnehouseResources works even when the [resources] extra isn't installed; the first network call raises a clear "install [resources] extra" error.
  • Rate limit. Project APIs are capped at 10 QPS. The transport retries 429 responses with bounded exponential backoff.
  • Not a SqlClient. OnehouseResources is a control-plane HTTP client and intentionally does not implement the SqlClient interface (no cursor, fetchall, etc.). For SQL against your lakehouse data, use the LakeBase client.