dirsql 0.4.55 → 0.4.56

package/dist/core.d.ts

@@ -1,7 +1,8 @@
-import type { ExtensionSpec, RowEvent, ScanFailure } from "./dirsql.js";
+import type { ExtensionSpec, QueryResult, RowEvent, ScanFailure } from "./dirsql.js";
 import type { TableDef } from "./table.js";
 export interface NativeDirSQL {
     query(sql: string): Promise<Record<string, unknown>[]>;
+    queryOrdered(sql: string): Promise<QueryResult>;
     startWatcher(): Promise<void>;
     pollEvents(timeoutMs: number): Promise<RowEvent[]>;
     scanFailures(): ScanFailure[];

package/dist/dirsql.d.ts

@@ -81,6 +81,16 @@ export interface RowEvent {
     error?: string | null;
     filePath?: string | null;
 }
+/** The result of {@link DirSQL.queryOrdered}. */
+export interface QueryResult {
+    /**
+     * Column names in the order the SELECT list names them. Iterate this, not
+     * a row's keys: object keys that look like integers enumerate first.
+     */
+    columns: string[];
+    /** The rows, exactly as {@link DirSQL.query} returns them. */
+    rows: Record<string, unknown>[];
+}
 /**
  * One file the initial scan could not index.
  *
@@ -147,6 +157,16 @@ export declare class DirSQL {
      * even for large result sets or long-running queries.
      */
     query(sql: string): Promise<Record<string, unknown>[]>;
+    /**
+     * {@link query}, plus the column order the SELECT list names. Use it to
+     * render columns in the order the caller asked for.
+     *
+     * ```ts
+     * const { columns, rows } = await db.queryOrdered("SELECT path, size FROM './'");
+     * // columns: ["path", "size"]
+     * ```
+     */
+    queryOrdered(sql: string): Promise<QueryResult>;
     /**
      * The files the initial scan could not index, each with its root-relative
      * `path` and the hook's own `message`.

package/dist/dirsql.js

@@ -97,6 +97,19 @@ export class DirSQL {
         await this.ready;
         return this._inner.query(sql);
     }
+    /**
+     * {@link query}, plus the column order the SELECT list names. Use it to
+     * render columns in the order the caller asked for.
+     *
+     * ```ts
+     * const { columns, rows } = await db.queryOrdered("SELECT path, size FROM './'");
+     * // columns: ["path", "size"]
+     * ```
+     */
+    async queryOrdered(sql) {
+        await this.ready;
+        return this._inner.queryOrdered(sql);
+    }
     /**
      * The files the initial scan could not index, each with its root-relative
      * `path` and the hook's own `message`.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { DirSQL } from "./dirsql.js";
-export type { DirSQLOptions, ExtensionSpec, RowEvent, ScanFailure, } from "./dirsql.js";
+export type { DirSQLOptions, ExtensionSpec, QueryResult, RowEvent, ScanFailure, } from "./dirsql.js";
 export { Table } from "./table.js";
 export type { TableDef } from "./table.js";

package/docs/reference/sdk.md

@@ -239,6 +239,25 @@ than `Number.MAX_SAFE_INTEGER`, 2^53 − 1) cannot be represented as a JS
 than return a rounded value. Python's `int` is unbounded, so it always
 round-trips.
 
+### `queryOrdered`
+
+::: code-group
+
+```typescript [TypeScript]
+await db.queryOrdered(sql: string) -> { columns: string[]; rows: Record<string, unknown>[] }
+```
+
+```rust [Rust]
+db.query_ordered(sql: &str) -> Result<QueryResult>   // QueryResult { columns, rows }
+```
+
+:::
+
+Runs `query` and also returns the column names in the order the SELECT list
+names them. Use it to render columns in the order the caller asked for: a
+row's keys do not carry that order. In TypeScript, object keys that look like
+integers always enumerate first.
+
 ### `watch`
 
 ::: code-group

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dirsql",
-  "version": "0.4.55",
+  "version": "0.4.56",
   "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.55",
-    "@dirsql/lib-linux-arm64-gnu": "0.4.55",
-    "@dirsql/lib-darwin-x64": "0.4.55",
-    "@dirsql/lib-darwin-arm64": "0.4.55",
-    "@dirsql/lib-win32-x64-msvc": "0.4.55"
+    "@dirsql/lib-linux-x64-gnu": "0.4.56",
+    "@dirsql/lib-linux-arm64-gnu": "0.4.56",
+    "@dirsql/lib-darwin-x64": "0.4.56",
+    "@dirsql/lib-darwin-arm64": "0.4.56",
+    "@dirsql/lib-win32-x64-msvc": "0.4.56"
   }
 }