dirsql 0.4.119 → 0.4.120

package/docs/reference/cli.md

@@ -240,18 +240,46 @@ requests, closes open `/events` streams, and exits.
 Pass `--frontend` to serve the bundled dirsql SQL explorer shell at `/` on
 the same origin as the HTTP API. It works offline and prints `Frontend at
 http://<host>:<actual-port>/` without opening a browser. With `--port 0`, the
-printed URL uses the assigned port. The initial shell shows server status;
-query controls are coming in a subsequent update.
+printed URL uses the assigned port. The page offers an editable SQL box
+holding the starter query `SELECT * FROM './' LIMIT 100`. Nothing runs until
+you press **Run** (or Ctrl/Cmd+Enter); pressing it again refreshes the
+result. Queries go through `POST /query`, so the read-only rule applies, and
+run exactly as written. The page shows elapsed time, the number of rows
+returned, and errors. Values render as text (`NULL` is marked), and only the
+first 1000 rows are displayed. An empty result says so and shows no column
+names, since the response carries none.
 
 ```bash
 dirsql server --frontend
 dirsql server --frontend -c .dirsql.toml
 ```
 
-The shell reads `GET /frontend/state`: `{"error":null}` when the index is
-ready, or HTTP `503` with `{"error":"<diagnostic>"}` when config loading
-fails. Fix the config and restart the server. Without `--frontend`, the `/`
-and `/frontend/state` routes return `404`.
+The shell reads `GET /frontend/state`. When the index is ready it returns
+HTTP `200`:
+
+```json
+{
+  "error": null,
+  "root": "/abs/path/of/the/invocation/directory",
+  "tables": [
+    {"name": "posts", "columns": [{"name": "basename", "type": "TEXT"}]}
+  ]
+}
+```
+
+`root` is the query root, where [path-tables](./path-tables.md) resolve.
+`tables` lists the declared tables, ordered by name, each with its columns in
+declaration order and the declared SQLite type (`""` when untyped). Empty
+tables are listed. A configless server, or a config with only functions or
+extensions, returns `"tables": []`. dirsql's bookkeeping tables, SQLite's own
+tables, virtual tables with their shadow tables, and path-tables are never
+listed. The metadata is read from SQLite's catalog: no file is parsed, no
+directory walked, no table counted.
+
+When config loading fails the endpoint returns HTTP `503` with
+`{"error":"<diagnostic>"}` and no `root` or `tables`. Fix the config and
+restart the server. Without `--frontend`, the `/` and `/frontend/state`
+routes return `404`. `POST /query` is unchanged.
 
 ### Flags
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dirsql",
-  "version": "0.4.119",
+  "version": "0.4.120",
   "description": "Ephemeral SQL index over a local directory",
   "license": "MIT",
   "repository": "https://github.com/thekevinscott/dirsql",
@@ -221,10 +221,10 @@
     ]
   },
   "optionalDependencies": {
-    "@dirsql/lib-linux-x64-gnu": "0.4.119",
-    "@dirsql/lib-linux-arm64-gnu": "0.4.119",
-    "@dirsql/lib-darwin-x64": "0.4.119",
-    "@dirsql/lib-darwin-arm64": "0.4.119",
-    "@dirsql/lib-win32-x64-msvc": "0.4.119"
+    "@dirsql/lib-linux-x64-gnu": "0.4.120",
+    "@dirsql/lib-linux-arm64-gnu": "0.4.120",
+    "@dirsql/lib-darwin-x64": "0.4.120",
+    "@dirsql/lib-darwin-arm64": "0.4.120",
+    "@dirsql/lib-win32-x64-msvc": "0.4.120"
   }
 }