Getting Started
Console tour
A quick tour of the NYXDB web console — catalog, SQL shell, storage, queries, transforms, and lineage.
The NYXDB console is a web UI over the same engine. It groups the operational surface into focused areas.
TODO-verify: console bundling and the exact URL/port it is served on for your deployment. The areas below reflect the console's feature modules.
Areas
| Area | What it does |
|---|---|
| Overview | Node status and a summary of the workload. |
| SQL shell | Run queries and follow streaming results in the browser. |
| Catalog | Browse tables, attributes, and schemas. |
| Storage | Storage policies, disks/pools, and part accounting. |
| Queries | Live and historical queries (system.queries, system.query_log). |
| Transformations | Continuous transforms — state, lag, and controls. |
| Subscribers | Live streaming subscribers and PSI delivery health. |
| Endpoints | Registered query endpoints and their governance counters. |
| Lineage | How data flows across streams, transforms, and tables. |
| Governance | Grants, roles, users, operator grants, and rate limits. |
| Settings | Node and session settings, including the theme. |
Same engine, two front doors
The console and the nyxsql CLI both speak the engine's wire protocol. Anything
you can express in SQL — DDL, DML, streaming reads, transforms — works from
either. The console adds visual surfaces for storage, lineage, and governance
that are awkward to read as tabular output.