@qualithm/arrow-flight-sql-js 1.1.0 → 1.3.0

package/LICENSE

@@ -1,18 +1,150 @@
-MIT License
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Copyright (c) 2026 Qualithm
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
-associated documentation files (the "Software"), to deal in the Software without restriction,
-including without limitation the rights to use, copy, modify, merge, publish, distribute,
-sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+1.  Definitions.
 
-The above copyright notice and this permission notice shall be included in all copies or substantial
-portions of the Software.
+    "License" shall mean the terms and conditions for use, reproduction, and distribution as defined
+    by Sections 1 through 9 of this document.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
-NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
-OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
-CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+    "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is
+    granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all other entities that control,
+    are controlled by, or are under common control with that entity. For the purposes of this
+    definition, "control" means (i) the power, direct or indirect, to cause the direction or
+    management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent
+    (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by
+    this License.
+
+    "Source" form shall mean the preferred form for making modifications, including but not limited
+    to software source code, documentation source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical transformation or translation of a
+    Source form, including but not limited to compiled object code, generated documentation, and
+    conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or Object form, made available under
+    the License, as indicated by a copyright notice that is included in or attached to the work (an
+    example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or
+    derived from) the Work and for which the editorial revisions, annotations, elaborations, or
+    other modifications represent, as a whole, an original work of authorship. For the purposes of
+    this License, Derivative Works shall not include works that remain separable from, or merely
+    link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including the original version of the Work and
+    any modifications or additions to that Work or Derivative Works thereof, that is intentionally
+    submitted to the Licensor for inclusion in the Work by the copyright owner or by an individual
+    or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this
+    definition, "submitted" means any form of electronic, verbal, or written communication sent to
+    the Licensor or its representatives, including but not limited to communication on electronic
+    mailing lists, source code control systems, and issue tracking systems that are managed by, or
+    on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding
+    communication that is conspicuously marked or otherwise designated in writing by the copyright
+    owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
+    Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of this License, each
+    Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+    irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display,
+    publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or
+    Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of this License, each Contributor
+    hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made, use, offer to sell, sell,
+    import, and otherwise transfer the Work, where such license applies only to those patent claims
+    licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or
+    by combination of their Contribution(s) with the Work to which such Contribution(s) was
+    submitted. If You institute patent litigation against any entity (including a cross-claim or
+    counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work
+    constitutes direct or contributory patent infringement, then any patent licenses granted to You
+    under this License for that Work shall terminate as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof
+    in any medium, with or without modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or Derivative Works a copy of this License;
+    and
+
+    (b) You must cause any modified files to carry prominent notices stating that You changed the
+    files; and
+
+    (c) You must retain, in the Source form of any Derivative Works that You distribute, all
+    copyright, patent, trademark, and attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
+    Works that You distribute must include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not pertain to any part of the
+    Derivative Works, in at least one of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or documentation, if provided along with
+    the Derivative Works; or, within a display generated by the Derivative Works, if and wherever
+    such third-party notices normally appear. The contents of the NOTICE file are for informational
+    purposes only and do not modify the License. You may add Your own attribution notices within
+    Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the
+    Work, provided that such additional attribution notices cannot be construed as modifying the
+    License.
+
+    You may add Your own copyright statement to Your modifications and may provide additional or
+    different license terms and conditions for use, reproduction, or distribution of Your
+    modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and
+    distribution of the Work otherwise complies with the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise, any Contribution
+    intentionally submitted for inclusion in the Work by You to the Licensor shall be under the
+    terms and conditions of this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate
+    license agreement you may have executed with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade names, trademarks, service
+    marks, or product names of the Licensor, except as required for reasonable and customary use in
+    describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor
+    provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT
+    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation,
+    any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or
+    redistributing the Work and assume any risks associated with Your exercise of permissions under
+    this License.
+
+8.  Limitation of Liability. In no event and under no legal theory, whether in tort (including
+    negligence), contract, or otherwise, unless required by applicable law (such as deliberate and
+    grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for
+    damages, including any direct, indirect, special, incidental, or consequential damages of any
+    character arising as a result of this License or out of the use or inability to use the Work
+    (including but not limited to damages for loss of goodwill, work stoppage, computer failure or
+    malfunction, or any and all other commercial damages or losses), even if such Contributor has
+    been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works
+    thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty,
+    indemnity, or other liability obligations and/or rights consistent with this License. However,
+    in accepting such obligations, You may act only on Your own behalf and on Your sole
+    responsibility, not on behalf of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability incurred by, or claims asserted
+    against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Qualithm
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
+compliance with the License. You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is
+distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied. See the License for the specific language governing permissions and limitations under the
+License.

package/dist/client.d.ts

@@ -0,0 +1,314 @@
+/**
+ * Flight SQL client implementation.
+ *
+ * @packageDocumentation
+ */
+import { type CallOptions, FlightClient, type FlightClientOptions, type FlightInfo } from "@qualithm/arrow-flight-js";
+/**
+ * Options for creating a FlightSqlClient.
+ */
+export type FlightSqlClientOptions = FlightClientOptions;
+/**
+ * Options for executing a query.
+ */
+export type QueryOptions = CallOptions & {
+    /**
+     * Transaction ID for executing the query as part of a transaction.
+     * If not provided, the query is auto-committed.
+     */
+    transactionId?: Buffer;
+};
+/**
+ * Result of a statement update operation.
+ */
+export type UpdateResult = {
+    /**
+     * The number of records affected by the update.
+     * A value of -1 indicates an unknown count.
+     */
+    recordCount: number;
+};
+/**
+ * Options for creating a prepared statement.
+ */
+export type PreparedStatementOptions = CallOptions & {
+    /**
+     * Transaction ID for creating the prepared statement as part of a transaction.
+     * If not provided, executions of the prepared statement will be auto-committed.
+     */
+    transactionId?: Buffer;
+};
+/**
+ * Result of creating a prepared statement.
+ */
+export type PreparedStatementResult = {
+    /**
+     * Opaque handle for the prepared statement on the server.
+     * Use this handle with executePreparedQuery or executePreparedUpdate.
+     */
+    handle: Buffer;
+    /**
+     * The schema of the result set, if the query returns results.
+     * This is an IPC-encapsulated Schema as described in Schema.fbs.
+     * May be empty if the query does not return results.
+     */
+    datasetSchema: Buffer;
+    /**
+     * The schema of the expected parameters, if the query has parameters.
+     * This is an IPC-encapsulated Schema as described in Schema.fbs.
+     * May be empty if the query has no parameters.
+     */
+    parameterSchema: Buffer;
+};
+/**
+ * Result of binding parameters to a prepared statement.
+ */
+export type BindParametersResult = {
+    /**
+     * Updated handle for the prepared statement.
+     * If provided, this handle should be used for subsequent operations
+     * instead of the original handle. If undefined, continue using the
+     * original handle.
+     */
+    handle?: Buffer;
+};
+/**
+ * Parameter data for binding to a prepared statement.
+ * Can be provided as raw Arrow IPC bytes or as separate schema/data components.
+ */
+export type ParameterData = {
+    /**
+     * Arrow IPC schema message bytes.
+     * Required when sending parameters.
+     */
+    schema: Uint8Array;
+    /**
+     * Arrow IPC record batch data bytes.
+     * Contains the actual parameter values.
+     */
+    data: Uint8Array;
+};
+/**
+ * Arrow Flight SQL client for executing SQL queries and commands.
+ *
+ * Extends the base FlightClient with SQL-specific functionality including
+ * query execution, updates, and metadata queries.
+ *
+ * @example
+ * ```ts
+ * const client = new FlightSqlClient({
+ *   host: "localhost",
+ *   port: 8815,
+ *   tls: false
+ * })
+ *
+ * await client.connect()
+ *
+ * // Execute a query
+ * const info = await client.query("SELECT * FROM users")
+ *
+ * // Execute an update
+ * const result = await client.executeUpdate("INSERT INTO users (name) VALUES ('Alice')")
+ * console.log("Rows affected:", result.recordCount)
+ *
+ * client.close()
+ * ```
+ */
+export declare class FlightSqlClient extends FlightClient {
+    /**
+     * Executes a SQL query and returns flight information for retrieving results.
+     *
+     * This method sends a CommandStatementQuery to the server and returns
+     * FlightInfo containing endpoints for data retrieval. Use the returned
+     * FlightInfo with `doGet()` to retrieve the actual data.
+     *
+     * @param query - The SQL query to execute
+     * @param options - Optional query options
+     * @returns Flight information for retrieving query results
+     * @throws {FlightError} If the query fails
+     *
+     * @example
+     * ```ts
+     * const info = await client.query("SELECT * FROM users WHERE active = true")
+     *
+     * // Retrieve data from each endpoint
+     * for (const endpoint of info.endpoint) {
+     *   for await (const data of client.doGet(endpoint.ticket!)) {
+     *     // Process data
+     *   }
+     * }
+     * ```
+     */
+    query(query: string, options?: QueryOptions): Promise<FlightInfo>;
+    /**
+     * Executes a prepared statement query and returns flight information for retrieving results.
+     *
+     * This method sends a CommandPreparedStatementQuery to the server and returns
+     * FlightInfo containing endpoints for data retrieval. Use the returned
+     * FlightInfo with `doGet()` to retrieve the actual data.
+     *
+     * @param handle - The prepared statement handle from createPreparedStatement
+     * @param options - Optional call options
+     * @returns Flight information for retrieving query results
+     * @throws {FlightError} If the query fails
+     *
+     * @example
+     * ```ts
+     * const prepared = await client.createPreparedStatement("SELECT * FROM users WHERE id = ?")
+     *
+     * // Execute the prepared statement
+     * const info = await client.executePreparedQuery(prepared.handle)
+     *
+     * // Retrieve data from each endpoint
+     * for (const endpoint of info.endpoint) {
+     *   for await (const data of client.doGet(endpoint.ticket!)) {
+     *     // Process data
+     *   }
+     * }
+     *
+     * // Clean up
+     * await client.closePreparedStatement(prepared.handle)
+     * ```
+     */
+    executePreparedQuery(handle: Buffer, options?: CallOptions): Promise<FlightInfo>;
+    /**
+     * Executes a prepared statement update (INSERT, UPDATE, DELETE).
+     *
+     * @param handle - The prepared statement handle from createPreparedStatement
+     * @param options - Optional call options
+     * @returns The update result containing the number of affected records
+     * @throws {FlightError} If the update fails
+     *
+     * @example
+     * ```ts
+     * const prepared = await client.createPreparedStatement(
+     *   "UPDATE users SET active = false WHERE id = ?"
+     * )
+     *
+     * // Execute the prepared statement
+     * const result = await client.executePreparedUpdate(prepared.handle)
+     * console.log("Rows updated:", result.recordCount)
+     *
+     * // Clean up
+     * await client.closePreparedStatement(prepared.handle)
+     * ```
+     */
+    executePreparedUpdate(handle: Buffer, options?: CallOptions): Promise<UpdateResult>;
+    /**
+     * Executes a SQL update statement (INSERT, UPDATE, DELETE).
+     *
+     * @param query - The SQL update statement to execute
+     * @param options - Optional query options
+     * @returns The update result containing the number of affected records
+     * @throws {FlightError} If the update fails
+     *
+     * @example
+     * ```ts
+     * const result = await client.executeUpdate(
+     *   "UPDATE users SET active = false WHERE last_login < '2024-01-01'"
+     * )
+     * console.log("Rows updated:", result.recordCount)
+     * ```
+     */
+    executeUpdate(query: string, options?: QueryOptions): Promise<UpdateResult>;
+    /**
+     * Creates a prepared statement for the given SQL query.
+     *
+     * The returned handle can be used to execute the query multiple times
+     * with different parameters. The prepared statement should be closed
+     * when no longer needed using `closePreparedStatement()`.
+     *
+     * @param query - The SQL query to prepare
+     * @param options - Optional options including transaction ID
+     * @returns The prepared statement result containing the handle and schemas
+     * @throws {FlightError} If the preparation fails
+     *
+     * @example
+     * ```ts
+     * const prepared = await client.createPreparedStatement(
+     *   "SELECT * FROM users WHERE id = ?"
+     * )
+     *
+     * // Use prepared.handle with executePreparedQuery
+     * // ...
+     *
+     * // Clean up when done
+     * await client.closePreparedStatement(prepared.handle)
+     * ```
+     */
+    createPreparedStatement(query: string, options?: PreparedStatementOptions): Promise<PreparedStatementResult>;
+    /**
+     * Closes a prepared statement and releases server resources.
+     *
+     * @param handle - The prepared statement handle to close
+     * @param options - Optional call options
+     * @throws {FlightError} If closing fails
+     *
+     * @example
+     * ```ts
+     * const prepared = await client.createPreparedStatement("SELECT * FROM users")
+     * // ... use the prepared statement ...
+     * await client.closePreparedStatement(prepared.handle)
+     * ```
+     */
+    closePreparedStatement(handle: Buffer, options?: CallOptions): Promise<void>;
+    /**
+     * Binds parameter values to a prepared statement.
+     *
+     * Parameter values are sent as Arrow IPC data matching the parameter schema
+     * from the prepared statement. After binding, call `executePreparedQuery()`
+     * or `executePreparedUpdate()` to execute with the bound parameters.
+     *
+     * @param handle - The prepared statement handle
+     * @param parameters - The parameter data as Arrow IPC bytes
+     * @param options - Optional call options
+     * @returns Result containing an optional updated handle
+     * @throws {FlightError} If binding fails
+     *
+     * @example
+     * ```ts
+     * import { tableToIPC, tableFromArrays } from "apache-arrow"
+     *
+     * const prepared = await client.createPreparedStatement(
+     *   "SELECT * FROM users WHERE id = ?"
+     * )
+     *
+     * // Create parameter data as Arrow IPC
+     * const params = tableFromArrays({ id: [42] })
+     * const ipcData = tableToIPC(params)
+     *
+     * // Bind the parameters
+     * const result = await client.bindParameters(prepared.handle, {
+     *   schema: ipcData.slice(0, schemaLength),  // Extract schema bytes
+     *   data: ipcData.slice(schemaLength)         // Extract data bytes
+     * })
+     *
+     * // Use updated handle if provided
+     * const handle = result.handle ?? prepared.handle
+     *
+     * // Execute and retrieve results
+     * const info = await client.executePreparedQuery(handle)
+     * ```
+     */
+    bindParameters(handle: Buffer, parameters: ParameterData, options?: CallOptions): Promise<BindParametersResult>;
+}
+/**
+ * Creates a new FlightSqlClient and connects to the server.
+ *
+ * This is a convenience function that combines creating a client
+ * and calling connect() in one step.
+ *
+ * @param options - Connection options
+ * @returns A connected FlightSqlClient
+ *
+ * @example
+ * ```ts
+ * const client = await createFlightSqlClient({
+ *   host: "localhost",
+ *   port: 8815,
+ *   tls: false
+ * })
+ * ```
+ */
+export declare function createFlightSqlClient(options: FlightSqlClientOptions): Promise<FlightSqlClient>;
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,EACL,KAAK,WAAW,EAGhB,YAAY,EACZ,KAAK,mBAAmB,EAExB,KAAK,UAAU,EAChB,MAAM,2BAA2B,CAAA;AAyBlC;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAA;AAExD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG;IACvC;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,WAAW,GAAG;IACnD;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;;OAGG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,eAAe,EAAE,MAAM,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;;OAGG;IACH,MAAM,EAAE,UAAU,CAAA;IAElB;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAA;CACjB,CAAA;AA4ID;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAgB,SAAQ,YAAY;IAC/C;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC;IAYvE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA6BG;IACG,oBAAoB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,UAAU,CAAC;IAWtF;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,YAAY,CAAC;IA6CzF;;;;;;;;;;;;;;;OAeG;IACG,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IA8CjF;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,uBAAuB,CAC3B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,wBAAwB,GACjC,OAAO,CAAC,uBAAuB,CAAC;IAsCnC;;;;;;;;;;;;;OAaG;IACG,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBlF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACG,cAAc,CAClB,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,aAAa,EACzB,OAAO,CAAC,EAAE,WAAW,GACpB,OAAO,CAAC,oBAAoB,CAAC;CA+CjC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,eAAe,CAAC,CAI1B"}