@qualithm/arrow-flight-client 0.1.0

package/dist/client/flight-client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flight-client.js","sourceRoot":"","sources":["../../src/client/flight-client.ts"],"names":[],"mappings":"AAAA,gLAAgL;AAChL,0DAA0D;AAE1D,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAA;AACrD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,OAAO,EAEL,eAAe,EAIf,aAAa,EAMd,MAAM,kCAAkC,CAAA;AACzC,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AACpG,OAAO,EAOL,cAAc,EACf,MAAM,YAAY,CAAA;AAEnB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,YAAY;IACd,QAAQ,CAA6B;IAC9C,uGAAuG;IAC9F,OAAO,CAAK;IACrB,OAAO,GAAG,KAAK,CAAA;IACf,cAAc,GAAG,KAAK,CAAA;IACtB,UAAU,CAAoB;IAE9B,YAAY,OAA4B;QACtC,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC,OAAO,CAAC,CAAA;QAEvC,wDAAwD;QACxD,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAA;QAE5C,MAAM,SAAS,GAAG,mBAAmB,CAAC;YACpC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG;YAC1B,WAAW;SACZ,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,GAAG,YAAY,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;IACvD,CAAC;IAED;;OAEG;IACH,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAA;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAA;IAC5B,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,SAAS,CAAC,OAAoB;QAClC,IAAI,CAAC,WAAW,EAAE,CAAA;QAElB,4DAA4D;QAC5D,IAAI,gBAAgB,GAAG,OAAO,CAAA;QAC9B,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;YAC9D,MAAM,SAAS,GAAG,MAAM,CAAC,eAAe,EAAE;gBACxC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ;gBACjD,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ;aAClD,CAAC,CAAA;YACF,gBAAgB,GAAG,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,CAAA;QACzD,CAAC;QAED,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACtB,MAAM,IAAI,WAAW,CACnB,wEAAwE,CACzE,CAAA;QACH,CAAC;QAED,IAAI,CAAC;YACH,sDAAsD;YACtD,4DAA4D;YAC5D,MAAM,QAAQ,GAAG,KAAK,SAAS,CAAC;gBAK9B,MAAM;oBACJ,eAAe,EAAE,EAAE;oBACnB,OAAO,EAAE,gBAAgB;iBAC1B,CAAA;YACH,CAAC,CAAA;YAED,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE;gBAChD,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE;aACnC,CAAC,CAAA;YAEF,IAAI,QAAuC,CAAA;YAC3C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBAC/B,QAAQ,GAAG,GAAG,CAAA;gBACd,MAAK,CAAC,2BAA2B;YACnC,CAAC;YAED,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,eAAe,CAAC,2CAA2C,CAAC,CAAA;YACxE,CAAC;YAED,+DAA+D;YAC/D,MAAM,KAAK,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAA;YACxD,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;YAE1B,OAAO,KAAK,CAAA;QACd,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,KAAK,CAAA;YACb,CAAC;YACD,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,WAAW,EAAE,CAAA;QAElB,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;YACzC,OAAO,IAAI,CAAC,SAAS,EAAE,CAAA;QACzB,CAAC;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC1C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;YAC1B,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAA;QACjC,CAAC;QAED,qBAAqB;QACrB,OAAO,SAAS,CAAA;IAClB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CAAC,UAAiC;QACnD,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE;gBAC5E,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE;aACnC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,eAAe,CAAC,CAAA;QAC/C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,cAAc,CAAC,UAAiC;QACpD,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE;gBAC7E,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE;aACnC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,UAAiC;QAC/C,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,EAAE;gBACxE,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE;aACnC,CAAC,CAAA;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,CAAC,WAAW,CAAC,QAAyB;QAC1C,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CACrC,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,IAAI,IAAI,UAAU,EAAE,EAAE,EACxD,EAAE,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,CACvC,CAAA;YACD,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,aAAa,CAAC,CAAA;QAC7C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,CAAC,WAAW;QAChB,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAA;YACnF,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;gBAClC,MAAM,MAAM,CAAA;YACd,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,aAAa,CAAC,CAAA;QAC7C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAoB;QAClC,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAClC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,UAAU,EAAE,EAAE,EAC5D,EAAE,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,EAAE,CACvC,CAAA;YACD,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;gBAClC,MAAM,MAAM,CAAA;YACd,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,CAAA;QAC1C,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,KAAK,CAAC,CAAC,KAAK,CAAC,MAAoB;QAC/B,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;gBACxC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE;aACnC,CAAC,CAAA;YACF,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAA;YACZ,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,CAAC,KAAK,CAAC,IAA+B;QAC1C,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE;gBACtC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE;aACnC,CAAC,CAAA;YACF,IAAI,KAAK,EAAE,MAAM,MAAM,IAAI,MAAM,EAAE,CAAC;gBAClC,MAAM,MAAM,CAAA;YACd,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAA;QACvC,CAAC;IACH,CAAC;IAED,wEAAwE;IAExE,4CAA4C;IAC5C,WAAW;QACT,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,WAAW,CAAC,kBAAkB,CAAC,CAAA;QAC3C,CAAC;IACH,CAAC;IAED,6EAA6E;IAC7E,mBAAmB,CAAC,KAA4B;QAC9C,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC1B,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAA,CAAC,WAAW;QAClD,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAA,CAAC,UAAU;IAC/C,CAAC;IAED,iEAAiE;IACjE,iBAAiB;QACf,MAAM,WAAW,GAA4B,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAA;QAE7E,kCAAkC;QAClC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACtB,MAAM,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAA;YAC7B,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC3B,WAAW,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAA;YAC7B,CAAC;YACD,IAAI,GAAG,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;gBAC1B,WAAW,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,CAAA;YAC3B,CAAC;YACD,IAAI,GAAG,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;gBACzB,WAAW,CAAC,EAAE,GAAG,GAAG,CAAC,EAAE,CAAA;YACzB,CAAC;YACD,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,IAAI,GAAG,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;gBAC1D,WAAW,CAAC,UAAU,GAAG,GAAG,CAAC,UAAU,CAAA;YACzC,CAAC;YACD,IAAI,GAAG,CAAC,kBAAkB,KAAK,SAAS,EAAE,CAAC;gBACzC,WAAW,CAAC,kBAAkB,GAAG,GAAG,CAAC,kBAAkB,CAAA;YACzD,CAAC;QACH,CAAC;QAED,OAAO,WAAW,CAAA;IACpB,CAAC;IAED,2EAA2E;IAC3E,kBAAkB;QAChB,MAAM,OAAO,GAA2B,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAA;QAEpE,gDAAgD;QAChD,IAAI,IAAI,CAAC,UAAU,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,EAAE,EAAE,CAAC;YAC5D,OAAO,CAAC,aAAa,GAAG,UAAU,IAAI,CAAC,UAAU,EAAE,CAAA;QACrD,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,8EAA8E;IAC9E,UAAU,CAAC,KAAc,EAAE,SAAiB;QAC1C,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAA;QACd,CAAC;QAED,2BAA2B;QAC3B,IAAI,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,EAAE,CAAC;YAC9C,MAAM,YAAY,GAAG,KAAsD,CAAA;YAE3E,0CAA0C;YAC1C,IAAI,YAAY,CAAC,IAAI,KAAK,iBAAiB,IAAI,YAAY,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;gBACzF,OAAO,IAAI,eAAe,CAAC,GAAG,SAAS,YAAY,YAAY,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAA;YACnF,CAAC;YAED,OAAO,IAAI,iBAAiB,CAC1B,GAAG,SAAS,YAAY,YAAY,CAAC,OAAO,EAAE,EAC9C,YAAY,CAAC,IAAI,EACjB,YAAY,CAAC,UAAU,EACvB,KAAK,CACN,CAAA;QACH,CAAC;QAED,2BAA2B;QAC3B,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YACrE,OAAO,IAAI,qBAAqB,CAC9B,wBAAwB,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,EAC3C,IAAI,CAAC,QAAQ,CAAC,GAAG,EACjB,KAAK,CACN,CAAA;QACH,CAAC;QAED,yBAAyB;QACzB,OAAO,IAAI,WAAW,CACpB,GAAG,SAAS,YAAY,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAChF,KAAK,CACN,CAAA;IACH,CAAC;CACF"}

package/dist/client/flight-sql-client.d.ts

@@ -0,0 +1,348 @@
+import type { RecordBatch, Table, TypeMap } from "apache-arrow";
+import type { FlightData, FlightInfo } from "../gen/arrow/flight/Flight_pb.js";
+import { FlightClient } from "./flight-client.js";
+import type { FlightClientOptions } from "./types.js";
+/**
+ * Options for executing a SQL query.
+ */
+export type ExecuteQueryOptions = {
+    /**
+     * Execute the query within this transaction.
+     * If not provided, the query is auto-committed.
+     */
+    transactionId?: Uint8Array;
+};
+/**
+ * Options for executing a SQL update (INSERT, UPDATE, DELETE).
+ */
+export type ExecuteUpdateOptions = {
+    /**
+     * Execute the update within this transaction.
+     * If not provided, the update is auto-committed.
+     */
+    transactionId?: Uint8Array;
+};
+/**
+ * Result of executing a SQL update.
+ */
+export type UpdateResult = {
+    /**
+     * Number of records affected by the update.
+     * -1 indicates an unknown count.
+     */
+    recordCount: bigint;
+};
+/**
+ * Prepared statement handle returned from preparing a SQL statement.
+ */
+export type PreparedStatement = {
+    /**
+     * Opaque handle for the prepared statement on the server.
+     */
+    handle: Uint8Array;
+    /**
+     * Schema of the result set (IPC-encoded).
+     * Empty if the statement doesn't return results.
+     */
+    datasetSchema: Uint8Array;
+    /**
+     * Schema of the parameters (IPC-encoded).
+     * Empty if the statement has no parameters.
+     */
+    parameterSchema: Uint8Array;
+};
+/**
+ * Transaction handle returned from beginning a transaction.
+ */
+export type Transaction = {
+    /**
+     * Opaque handle for the transaction on the server.
+     */
+    id: Uint8Array;
+};
+/**
+ * Arrow Flight SQL client for executing SQL queries and managing transactions.
+ *
+ * FlightSqlClient wraps FlightClient using composition, providing Flight SQL
+ * specific operations while delegating core Flight RPC to the underlying client.
+ *
+ * @example
+ * ```ts
+ * const client = new FlightSqlClient({ url: "https://flight.example.com:8815" })
+ *
+ * // Execute a query and get results as a Table
+ * const table = await client.query("SELECT * FROM users")
+ * console.log(`Got ${table.numRows} rows`)
+ *
+ * // Execute an update
+ * const result = await client.executeUpdate("INSERT INTO users (name) VALUES ('Alice')")
+ * console.log(`Inserted ${result.recordCount} rows`)
+ *
+ * // Use prepared statements
+ * const stmt = await client.prepare("SELECT * FROM users WHERE id = ?")
+ * // ... bind parameters and execute ...
+ * await client.closePreparedStatement(stmt)
+ *
+ * client.close()
+ * ```
+ */
+export declare class FlightSqlClient {
+    #private;
+    /**
+     * Creates a new FlightSqlClient.
+     *
+     * @param optionsOrClient - Either FlightClientOptions to create a new FlightClient,
+     *                          or an existing FlightClient instance to wrap.
+     */
+    constructor(optionsOrClient: FlightClientOptions | FlightClient);
+    /**
+     * The underlying Flight client.
+     * Use this for advanced Flight operations not covered by Flight SQL.
+     */
+    get flight(): FlightClient;
+    /**
+     * The base URL of the Flight server.
+     */
+    get url(): string;
+    /**
+     * Whether the client has been closed.
+     */
+    get closed(): boolean;
+    /**
+     * Close the client and release resources.
+     */
+    close(): void;
+    /**
+     * Authenticate with the server using configured credentials.
+     */
+    authenticate(): Promise<string | undefined>;
+    /**
+     * Execute a SQL query and return results as an Arrow Table.
+     *
+     * This is a convenience method that combines getFlightInfo and doGet
+     * to fetch all query results into memory.
+     *
+     * @param query - SQL query string
+     * @param options - Query execution options
+     * @returns Arrow Table containing query results
+     *
+     * @example
+     * ```ts
+     * const table = await client.query("SELECT * FROM users WHERE active = true")
+     * console.log(`Found ${table.numRows} active users`)
+     * ```
+     */
+    query<T extends TypeMap = TypeMap>(query: string, options?: ExecuteQueryOptions): Promise<Table<T>>;
+    /**
+     * Execute a SQL query and return results as a stream of RecordBatches.
+     *
+     * Use this for large result sets to avoid loading all data into memory.
+     *
+     * @param query - SQL query string
+     * @param options - Query execution options
+     * @yields RecordBatch objects
+     *
+     * @example
+     * ```ts
+     * for await (const batch of client.queryBatches("SELECT * FROM large_table")) {
+     *   processBatch(batch)
+     * }
+     * ```
+     */
+    queryBatches<T extends TypeMap = TypeMap>(query: string, options?: ExecuteQueryOptions): AsyncGenerator<RecordBatch<T>>;
+    /**
+     * Execute a SQL query and return the raw FlightData stream.
+     *
+     * This is the lowest-level query method, useful when you need
+     * access to raw Flight data or custom decoding.
+     *
+     * @param query - SQL query string
+     * @param options - Query execution options
+     * @yields FlightData messages
+     */
+    queryStream(query: string, options?: ExecuteQueryOptions): AsyncGenerator<FlightData>;
+    /**
+     * Get FlightInfo for a SQL query without executing it.
+     *
+     * Use this to inspect the query plan, schema, or endpoints
+     * before fetching data.
+     *
+     * @param query - SQL query string
+     * @param options - Query execution options
+     * @returns FlightInfo describing the query results
+     */
+    getQueryInfo(query: string, options?: ExecuteQueryOptions): Promise<FlightInfo>;
+    /**
+     * Execute a SQL update statement (INSERT, UPDATE, DELETE, DDL).
+     *
+     * @param query - SQL update statement
+     * @param options - Update execution options
+     * @returns Update result with affected row count
+     *
+     * @example
+     * ```ts
+     * const result = await client.executeUpdate("DELETE FROM users WHERE inactive = true")
+     * console.log(`Deleted ${result.recordCount} inactive users`)
+     * ```
+     */
+    executeUpdate(query: string, options?: ExecuteUpdateOptions): Promise<UpdateResult>;
+    /**
+     * Prepare a SQL statement for repeated execution.
+     *
+     * @param query - SQL query with optional parameter placeholders
+     * @param transactionId - Optional transaction to associate with the statement
+     * @returns Prepared statement handle
+     *
+     * @example
+     * ```ts
+     * const stmt = await client.prepare("SELECT * FROM users WHERE id = ?")
+     * // Use executePrepared() to execute with parameters
+     * await client.closePreparedStatement(stmt)
+     * ```
+     */
+    prepare(query: string, transactionId?: Uint8Array): Promise<PreparedStatement>;
+    /**
+     * Execute a prepared query statement and return results as a Table.
+     *
+     * @param statement - Prepared statement from prepare()
+     * @returns Arrow Table containing query results
+     */
+    executePrepared<T extends TypeMap = TypeMap>(statement: PreparedStatement): Promise<Table<T>>;
+    /**
+     * Execute a prepared query statement and return results as a stream.
+     *
+     * @param statement - Prepared statement from prepare()
+     * @yields FlightData messages
+     */
+    executePreparedStream(statement: PreparedStatement): AsyncGenerator<FlightData>;
+    /**
+     * Execute a prepared update statement and return affected row count.
+     *
+     * @param statement - Prepared statement from prepare()
+     * @param parameters - Optional parameter values as RecordBatches
+     * @returns Update result with affected row count
+     */
+    executePreparedUpdate(statement: PreparedStatement, parameters?: AsyncIterable<RecordBatch> | Iterable<RecordBatch>): Promise<UpdateResult>;
+    /**
+     * Close a prepared statement and release server resources.
+     *
+     * @param statement - Prepared statement to close
+     */
+    closePreparedStatement(statement: PreparedStatement): Promise<void>;
+    /**
+     * Begin a new transaction.
+     *
+     * @returns Transaction handle
+     *
+     * @example
+     * ```ts
+     * const txn = await client.beginTransaction()
+     * try {
+     *   await client.executeUpdate("INSERT INTO users ...", { transactionId: txn.id })
+     *   await client.executeUpdate("INSERT INTO logs ...", { transactionId: txn.id })
+     *   await client.commit(txn)
+     * } catch (e) {
+     *   await client.rollback(txn)
+     *   throw e
+     * }
+     * ```
+     */
+    beginTransaction(): Promise<Transaction>;
+    /**
+     * Commit a transaction.
+     *
+     * @param transaction - Transaction to commit
+     */
+    commit(transaction: Transaction): Promise<void>;
+    /**
+     * Roll back a transaction.
+     *
+     * @param transaction - Transaction to roll back
+     */
+    rollback(transaction: Transaction): Promise<void>;
+    /**
+     * Get the list of catalogs in the database.
+     *
+     * @returns Arrow Table with catalog_name column
+     *
+     * @example
+     * ```ts
+     * const catalogs = await client.getCatalogs()
+     * for (const row of catalogs) {
+     *   console.log(row.catalog_name)
+     * }
+     * ```
+     */
+    getCatalogs<T extends TypeMap = TypeMap>(): Promise<Table<T>>;
+    /**
+     * Get the list of database schemas.
+     *
+     * @param options - Filter options
+     * @returns Arrow Table with catalog_name and db_schema_name columns
+     *
+     * @example
+     * ```ts
+     * const schemas = await client.getDbSchemas({ catalog: "my_catalog" })
+     * ```
+     */
+    getDbSchemas<T extends TypeMap = TypeMap>(options?: {
+        /** Filter by catalog name */
+        catalog?: string;
+        /** Filter pattern for schema names (supports % and _ wildcards) */
+        dbSchemaFilterPattern?: string;
+    }): Promise<Table<T>>;
+    /**
+     * Get the list of tables.
+     *
+     * @param options - Filter options
+     * @returns Arrow Table with catalog_name, db_schema_name, table_name, table_type columns
+     *
+     * @example
+     * ```ts
+     * const tables = await client.getTables({ tableTypes: ["TABLE", "VIEW"] })
+     * ```
+     */
+    getTables<T extends TypeMap = TypeMap>(options?: {
+        /** Filter by catalog name */
+        catalog?: string;
+        /** Filter pattern for schema names (supports % and _ wildcards) */
+        dbSchemaFilterPattern?: string;
+        /** Filter pattern for table names (supports % and _ wildcards) */
+        tableNameFilterPattern?: string;
+        /** Filter by table types (e.g., "TABLE", "VIEW") */
+        tableTypes?: string[];
+        /** Include table schema in results */
+        includeSchema?: boolean;
+    }): Promise<Table<T>>;
+    /**
+     * Get the list of table types supported by the server.
+     *
+     * @returns Arrow Table with table_type column
+     *
+     * @example
+     * ```ts
+     * const tableTypes = await client.getTableTypes()
+     * // Common types: TABLE, VIEW, SYSTEM TABLE
+     * ```
+     */
+    getTableTypes<T extends TypeMap = TypeMap>(): Promise<Table<T>>;
+    /**
+     * Get the primary keys for a table.
+     *
+     * @param table - Table name (required)
+     * @param options - Additional filter options
+     * @returns Arrow Table with catalog_name, db_schema_name, table_name, column_name, key_name, key_sequence columns
+     *
+     * @example
+     * ```ts
+     * const keys = await client.getPrimaryKeys("users", { catalog: "my_db" })
+     * ```
+     */
+    getPrimaryKeys<T extends TypeMap = TypeMap>(table: string, options?: {
+        /** Catalog containing the table */
+        catalog?: string;
+        /** Schema containing the table */
+        dbSchema?: string;
+    }): Promise<Table<T>>;
+}
+//# sourceMappingURL=flight-sql-client.d.ts.map

package/dist/client/flight-sql-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"flight-sql-client.d.ts","sourceRoot":"","sources":["../../src/client/flight-sql-client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA;AAE/D,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAA;AAwB9E,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAMjD,OAAO,KAAK,EAAE,mBAAmB,EAAyB,MAAM,YAAY,CAAA;AA4I5E;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;;OAGG;IACH,aAAa,CAAC,EAAE,UAAU,CAAA;CAC3B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;OAGG;IACH,aAAa,CAAC,EAAE,UAAU,CAAA;CAC3B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAElB;;;OAGG;IACH,aAAa,EAAE,UAAU,CAAA;IAEzB;;;OAGG;IACH,eAAe,EAAE,UAAU,CAAA;CAC5B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,EAAE,EAAE,UAAU,CAAA;CACf,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAe;;IAG1B;;;;;OAKG;gBACS,eAAe,EAAE,mBAAmB,GAAG,YAAY;IAY/D;;;OAGG;IACH,IAAI,MAAM,IAAI,YAAY,CAEzB;IAED;;OAEG;IACH,IAAI,GAAG,IAAI,MAAM,CAEhB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACH,KAAK,IAAI,IAAI;IAIb;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAMjD;;;;;;;;;;;;;;;OAeG;IACG,KAAK,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EACrC,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAKpB;;;;;;;;;;;;;;;OAeG;IACI,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC7C,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,mBAAmB,GAC5B,cAAc,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;IAOjC;;;;;;;;;OASG;IACI,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,cAAc,CAAC,UAAU,CAAC;IA8B5F;;;;;;;;;OASG;IACG,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,UAAU,CAAC;IAcrF;;;;;;;;;;;;OAYG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,YAAY,CAAC;IA6CzF;;;;;;;;;;;;;OAaG;IACG,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,iBAAiB,CAAC;IA+BpF;;;;;OAKG;IACG,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC/C,SAAS,EAAE,iBAAiB,GAC3B,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAKpB;;;;;OAKG;IACI,qBAAqB,CAAC,SAAS,EAAE,iBAAiB,GAAG,cAAc,CAAC,UAAU,CAAC;IAqBtF;;;;;;OAMG;IACG,qBAAqB,CACzB,SAAS,EAAE,iBAAiB,EAC5B,UAAU,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,GAC9D,OAAO,CAAC,YAAY,CAAC;IA8DxB;;;;OAIG;IACG,sBAAsB,CAAC,SAAS,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqBzE;;;;;;;;;;;;;;;;;OAiBG;IACG,gBAAgB,IAAI,OAAO,CAAC,WAAW,CAAC;IAyB9C;;;;OAIG;IACG,MAAM,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;;;OAIG;IACG,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAMvD;;;;;;;;;;;;OAYG;IACG,WAAW,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAMnE;;;;;;;;;;OAUG;IACG,YAAY,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE;QACxD,6BAA6B;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,mEAAmE;QACnE,qBAAqB,CAAC,EAAE,MAAM,CAAA;KAC/B,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IASrB;;;;;;;;;;OAUG;IACG,SAAS,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAAE,OAAO,CAAC,EAAE;QACrD,6BAA6B;QAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,mEAAmE;QACnE,qBAAqB,CAAC,EAAE,MAAM,CAAA;QAC9B,kEAAkE;QAClE,sBAAsB,CAAC,EAAE,MAAM,CAAA;QAC/B,oDAAoD;QACpD,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;QACrB,sCAAsC;QACtC,aAAa,CAAC,EAAE,OAAO,CAAA;KACxB,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAYrB;;;;;;;;;;OAUG;IACG,aAAa,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,KAAK,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAMrE;;;;;;;;;;;OAWG;IACG,cAAc,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC9C,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QACR,mCAAmC;QACnC,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,kCAAkC;QAClC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAClB,GACA,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;CA+ErB"}