@qualithm/arrow-flight-sql-js 1.0.0 → 1.2.0

package/dist/results.js

@@ -0,0 +1,138 @@
+import { tableFromIPC } from "apache-arrow";
+/**
+ * Collects all FlightData from a doGet stream into Arrow IPC bytes.
+ *
+ * @param dataStream - The async iterable of FlightData messages
+ * @returns Combined IPC bytes for all batches
+ */
+async function collectFlightData(dataStream) {
+    const chunks = [];
+    for await (const data of dataStream) {
+        // The first message contains the schema in dataHeader
+        if (data.dataHeader.length > 0) {
+            chunks.push(data.dataHeader);
+        }
+        // Data body contains the actual record batch
+        if (data.dataBody.length > 0) {
+            chunks.push(data.dataBody);
+        }
+    }
+    return chunks;
+}
+/**
+ * Executes a query and returns results as an Arrow Table.
+ *
+ * This is a convenience function that handles the entire query workflow:
+ * 1. Executes the query to get FlightInfo
+ * 2. Retrieves data from all endpoints
+ * 3. Combines the data into an Arrow Table
+ *
+ * @param client - The FlightSqlClient to use
+ * @param query - The SQL query to execute
+ * @returns An Arrow Table containing all query results
+ *
+ * @example
+ * ```ts
+ * import { queryToTable } from "@qualithm/arrow-flight-sql-js"
+ *
+ * const table = await queryToTable(client, "SELECT * FROM users LIMIT 100")
+ * console.log("Rows:", table.numRows)
+ * console.log("Columns:", table.schema.fields.map(f => f.name))
+ *
+ * // Iterate over rows
+ * for (const row of table) {
+ *   console.log(row.toJSON())
+ * }
+ * ```
+ */
+export async function queryToTable(client, query) {
+    const info = await client.query(query);
+    return flightInfoToTable(client, info);
+}
+/**
+ * Retrieves data from FlightInfo and returns it as an Arrow Table.
+ *
+ * @param client - The FlightSqlClient to use
+ * @param info - The FlightInfo from a query
+ * @returns An Arrow Table containing all data from the endpoints
+ *
+ * @example
+ * ```ts
+ * const info = await client.query("SELECT * FROM users")
+ * const table = await flightInfoToTable(client, info)
+ * ```
+ */
+export async function flightInfoToTable(client, info) {
+    const allChunks = [];
+    for (const endpoint of info.endpoint) {
+        if (!endpoint.ticket) {
+            continue;
+        }
+        const dataStream = client.doGet(endpoint.ticket);
+        const chunks = await collectFlightData(dataStream);
+        allChunks.push(...chunks);
+    }
+    if (allChunks.length === 0) {
+        throw new Error("no data returned from query");
+    }
+    // Combine all chunks and parse as IPC
+    const totalLength = allChunks.reduce((sum, chunk) => sum + chunk.length, 0);
+    const combined = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const chunk of allChunks) {
+        combined.set(chunk, offset);
+        offset += chunk.length;
+    }
+    return tableFromIPC(combined);
+}
+/**
+ * Iterates over query results as Arrow record batches.
+ *
+ * This is useful for processing large result sets without loading
+ * everything into memory at once.
+ *
+ * @param client - The FlightSqlClient to use
+ * @param info - The FlightInfo from a query
+ * @yields FlightData messages containing Arrow IPC data
+ *
+ * @example
+ * ```ts
+ * const info = await client.query("SELECT * FROM large_table")
+ *
+ * for await (const data of iterateResults(client, info)) {
+ *   // Process each batch of data
+ *   console.log("Received batch:", data.dataBody.length, "bytes")
+ * }
+ * ```
+ */
+export async function* iterateResults(client, info) {
+    for (const endpoint of info.endpoint) {
+        if (!endpoint.ticket) {
+            continue;
+        }
+        yield* client.doGet(endpoint.ticket);
+    }
+}
+/**
+ * Gets a single ticket's data as an Arrow Table.
+ *
+ * @param client - The FlightSqlClient to use
+ * @param ticket - The ticket to retrieve
+ * @returns An Arrow Table containing the ticket's data
+ */
+export async function ticketToTable(client, ticket) {
+    const dataStream = client.doGet(ticket);
+    const chunks = await collectFlightData(dataStream);
+    if (chunks.length === 0) {
+        throw new Error("no data returned from ticket");
+    }
+    const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
+    const combined = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const chunk of chunks) {
+        combined.set(chunk, offset);
+        offset += chunk.length;
+    }
+    return tableFromIPC(combined);
+}
+//# sourceMappingURL=results.js.map

package/dist/results.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"results.js","sourceRoot":"","sources":["../src/results.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAe3C;;;;;GAKG;AACH,KAAK,UAAU,iBAAiB,CAC9B,UAAuD;IAEvD,MAAM,MAAM,GAAiB,EAAE,CAAA;IAE/B,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;QACpC,sDAAsD;QACtD,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC9B,CAAC;QACD,6CAA6C;QAC7C,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC5B,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAAuB,EACvB,KAAa;IAEb,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACtC,OAAO,iBAAiB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;AACxC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAuB,EACvB,IAAgB;IAEhB,MAAM,SAAS,GAAiB,EAAE,CAAA;IAElC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACrB,SAAQ;QACV,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;QAChD,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,UAAU,CAAC,CAAA;QAClD,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAA;IAC3B,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAA;IAChD,CAAC;IAED,sCAAsC;IACtC,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IAC3E,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAA;IAC5C,IAAI,MAAM,GAAG,CAAC,CAAA;IACd,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE,CAAC;QAC9B,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC3B,MAAM,IAAI,KAAK,CAAC,MAAM,CAAA;IACxB,CAAC;IAED,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAA;AAC/B,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,cAAc,CACnC,MAAuB,EACvB,IAAgB;IAEhB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACrB,SAAQ;QACV,CAAC;QACD,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IACtC,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAuB,EACvB,MAAc;IAEd,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;IACvC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,UAAU,CAAC,CAAA;IAElD,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;IACjD,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;IACxE,MAAM,QAAQ,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAA;IAC5C,IAAI,MAAM,GAAG,CAAC,CAAA;IACd,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC3B,MAAM,IAAI,KAAK,CAAC,MAAM,CAAA;IACxB,CAAC;IAED,OAAO,YAAY,CAAC,QAAQ,CAAC,CAAA;AAC/B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qualithm/arrow-flight-sql-js",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Arrow Flight SQL client for JavaScript and TypeScript runtimes.",
   "private": false,
   "type": "module",
@@ -12,7 +12,7 @@
     "typescript",
     "apache-arrow"
   ],
-  "license": "MIT",
+  "license": "Apache-2.0",
   "author": "Qualithm",
   "repository": {
     "type": "git",
@@ -54,6 +54,7 @@
     "lint:fix": "eslint --fix .",
     "lint": "eslint .",
     "prepublishOnly": "bun run clean && bun run build",
+    "proto:generate": "grpc_tools_node_protoc --plugin=protoc-gen-ts_proto=./node_modules/.bin/protoc-gen-ts_proto --proto_path=./proto --ts_proto_out=./src/generated --ts_proto_opt=outputServices=grpc-js,esModuleInterop=true,importSuffix=.js,env=node,useExactTypes=false,snakeToCamel=true,outputPartialMethods=true,enumsAsLiterals=true proto/arrow/flight/protocol/sql/FlightSql.proto",
     "start": "bun run src/index.ts",
     "test:coverage": "bun test --coverage",
     "test:unit": "bun test src/__tests__/unit",
@@ -62,8 +63,16 @@
     "typecheck": "tsc -p tsconfig.node.json --noEmit"
   },
   "dependencies": {},
+  "peerDependencies": {
+    "@qualithm/arrow-flight-js": ">=1.0.0",
+    "apache-arrow": ">=17.0.0"
+  },
   "devDependencies": {
+    "@qualithm/arrow-flight-js": "1.5.0",
+    "apache-arrow": "19.0.1",
     "@eslint/js": "10.0.1",
+    "grpc-tools": "1.13.1",
+    "ts-proto": "2.11.2",
     "@types/bun": "1.3.9",
     "eslint": "10.0.0",
     "eslint-plugin-simple-import-sort": "12.1.1",

package/dist/greet.d.ts

@@ -1,26 +0,0 @@
-/**
- * Options for the greet function.
- */
-export type GreetOptions = {
-    /** Name to greet. */
-    name: string;
-    /** Whether to use formal greeting. */
-    formal?: boolean;
-};
-/**
- * Generate a greeting message.
- *
- * @param options - The greeting options.
- * @returns A greeting string.
- *
- * @example
- * ```ts
- * const message = greet({ name: "World" })
- * // => "Hello, World!"
- *
- * const formal = greet({ name: "World", formal: true })
- * // => "Good day, World."
- * ```
- */
-export declare function greet(options: GreetOptions): string;
-//# sourceMappingURL=greet.d.ts.map

package/dist/greet.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"greet.d.ts","sourceRoot":"","sources":["../src/greet.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,qBAAqB;IACrB,IAAI,EAAE,MAAM,CAAA;IACZ,sCAAsC;IACtC,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAQnD"}

package/dist/greet.js

@@ -1,23 +0,0 @@
-/**
- * Generate a greeting message.
- *
- * @param options - The greeting options.
- * @returns A greeting string.
- *
- * @example
- * ```ts
- * const message = greet({ name: "World" })
- * // => "Hello, World!"
- *
- * const formal = greet({ name: "World", formal: true })
- * // => "Good day, World."
- * ```
- */
-export function greet(options) {
-    const { name, formal = false } = options;
-    if (formal) {
-        return `Good day, ${name}.`;
-    }
-    return `Hello, ${name}!`;
-}
-//# sourceMappingURL=greet.js.map

package/dist/greet.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"greet.js","sourceRoot":"","sources":["../src/greet.ts"],"names":[],"mappings":"AAUA;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,KAAK,CAAC,OAAqB;IACzC,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,KAAK,EAAE,GAAG,OAAO,CAAA;IAExC,IAAI,MAAM,EAAE,CAAC;QACX,OAAO,aAAa,IAAI,GAAG,CAAA;IAC7B,CAAC;IAED,OAAO,UAAU,IAAI,GAAG,CAAA;AAC1B,CAAC"}