@gizmodata/gizmosql-client 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,25 @@
1
+ GizmoSQL Client for JavaScript/TypeScript
2
+ Copyright 2025 GizmoData LLC
3
+
4
+ This project is a fork of flight-sql-client-js, originally developed by Firetiger Inc.
5
+ Original repository: https://github.com/firetiger-oss/flight-sql-client-js
6
+
7
+ Licensed under the Apache License, Version 2.0 (the "License");
8
+ you may not use this file except in compliance with the License.
9
+ You may obtain a copy of the License at
10
+
11
+ http://www.apache.org/licenses/LICENSE-2.0
12
+
13
+ Unless required by applicable law or agreed to in writing, software
14
+ distributed under the License is distributed on an "AS IS" BASIS,
15
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16
+ See the License for the specific language governing permissions and
17
+ limitations under the License.
18
+
19
+ ================================================================================
20
+
21
+ This product includes software developed by:
22
+
23
+ - Firetiger Inc (https://github.com/firetiger-oss) - Original flight-sql-client-js
24
+ - Apache Arrow (https://arrow.apache.org/) - Arrow data format and Flight protocol
25
+ - gRPC (https://grpc.io/) - RPC framework
package/README.md ADDED
@@ -0,0 +1,204 @@
1
+ # GizmoSQL Client for JavaScript/TypeScript
2
+
3
+ A TypeScript/JavaScript client for [GizmoSQL](https://github.com/gizmodata/gizmosql) and Apache Arrow Flight SQL servers.
4
+
5
+ ## Features
6
+
7
+ - Full support for Apache Arrow Flight SQL protocol
8
+ - TLS with certificate verification skip option for self-signed certificates
9
+ - Basic authentication (username/password)
10
+ - Bearer token authentication
11
+ - Query execution with Apache Arrow table results
12
+ - Database metadata operations (catalogs, schemas, tables)
13
+ - Prepared statements support
14
+
15
+ ## Installation
16
+
17
+ ```bash
18
+ npm install @gizmodata/gizmosql-client
19
+ ```
20
+
21
+ ## Quick Start
22
+
23
+ ### Connecting to GizmoSQL with TLS
24
+
25
+ ```typescript
26
+ import { FlightSQLClient } from "@gizmodata/gizmosql-client";
27
+
28
+ const client = new FlightSQLClient({
29
+ host: "localhost",
30
+ port: 31337,
31
+ tlsSkipVerify: true, // Skip certificate verification for self-signed certs
32
+ username: "gizmosql",
33
+ password: "your-password",
34
+ });
35
+
36
+ // Execute a query - returns an Apache Arrow Table
37
+ const table = await client.execute("SELECT * FROM my_table LIMIT 10");
38
+
39
+ // Convert to array of row objects
40
+ console.log(table.toArray());
41
+ // Output: [ { id: 1, name: "Alice" }, { id: 2, name: "Bob" }, ... ]
42
+
43
+ await client.close();
44
+ ```
45
+
46
+ ### Connection Options
47
+
48
+ ```typescript
49
+ interface FlightClientConfig {
50
+ host: string; // Server hostname
51
+ port: number; // Server port (default: 31337 for GizmoSQL)
52
+ plaintext?: boolean; // Use unencrypted connection (default: false)
53
+ tlsSkipVerify?: boolean; // Skip TLS certificate verification (default: false)
54
+ username?: string; // Username for basic auth
55
+ password?: string; // Password for basic auth
56
+ token?: string; // Bearer token for token auth
57
+ }
58
+ ```
59
+
60
+ ### Using Bearer Token Authentication
61
+
62
+ ```typescript
63
+ const client = new FlightSQLClient({
64
+ host: "localhost",
65
+ port: 31337,
66
+ tlsSkipVerify: true,
67
+ token: "your-bearer-token",
68
+ });
69
+ ```
70
+
71
+ ### Plaintext Connection (Development Only)
72
+
73
+ ```typescript
74
+ const client = new FlightSQLClient({
75
+ host: "localhost",
76
+ port: 31337,
77
+ plaintext: true, // No TLS encryption
78
+ username: "gizmosql",
79
+ password: "your-password",
80
+ });
81
+ ```
82
+
83
+ ## Starting a GizmoSQL Server
84
+
85
+ To use this client, you need a running GizmoSQL server. The easiest way is via Docker:
86
+
87
+ ```bash
88
+ docker run --name gizmosql \
89
+ --detach --tty --init \
90
+ --publish 31337:31337 \
91
+ --env TLS_ENABLED="1" \
92
+ --env GIZMOSQL_USERNAME="gizmosql" \
93
+ --env GIZMOSQL_PASSWORD="your-password" \
94
+ gizmodata/gizmosql:latest
95
+ ```
96
+
97
+ For more options and configuration, see the [GizmoSQL repository](https://github.com/gizmodata/gizmosql).
98
+
99
+ ### Mounting Your Own Database
100
+
101
+ ```bash
102
+ docker run --name gizmosql \
103
+ --detach --tty --init \
104
+ --publish 31337:31337 \
105
+ --mount type=bind,source=$(pwd)/data,target=/opt/gizmosql/data \
106
+ --env TLS_ENABLED="1" \
107
+ --env GIZMOSQL_USERNAME="gizmosql" \
108
+ --env GIZMOSQL_PASSWORD="your-password" \
109
+ --env DATABASE_FILENAME="data/mydb.duckdb" \
110
+ gizmodata/gizmosql:latest
111
+ ```
112
+
113
+ ## API Reference
114
+
115
+ ### Query Execution
116
+
117
+ ```typescript
118
+ // Execute a SQL query
119
+ const table = await client.execute("SELECT * FROM users WHERE active = true");
120
+
121
+ // Get results as array
122
+ const rows = table.toArray();
123
+ ```
124
+
125
+ ### Database Metadata
126
+
127
+ ```typescript
128
+ // Get all catalogs
129
+ const catalogs = await client.getCatalogs();
130
+
131
+ // Get schemas (optionally filtered by catalog)
132
+ const schemas = await client.getSchemas("my_catalog");
133
+
134
+ // Get tables (with optional filters)
135
+ const tables = await client.getTables(
136
+ "my_catalog", // catalog (optional)
137
+ "my_schema", // schema pattern (optional)
138
+ "my_table%", // table name pattern (optional)
139
+ ["TABLE", "VIEW"] // table types (optional)
140
+ );
141
+
142
+ // Get table types
143
+ const tableTypes = await client.getTableTypes();
144
+ ```
145
+
146
+ ### Prepared Statements
147
+
148
+ ```typescript
149
+ // Prepare a statement
150
+ const prepared = await client.prepare("SELECT * FROM users WHERE id = ?");
151
+
152
+ // Execute the prepared statement
153
+ const results = await client.executePrepared(prepared);
154
+
155
+ // Close the prepared statement
156
+ await client.closePrepared(prepared);
157
+ ```
158
+
159
+ ## Working with Arrow Tables
160
+
161
+ The `execute()` method returns an Apache Arrow `Table` object. See the [Apache Arrow JS documentation](https://arrow.apache.org/docs/js/) for full details.
162
+
163
+ ```typescript
164
+ const table = await client.execute("SELECT id, name, score FROM players");
165
+
166
+ // Get column by name
167
+ const names = table.getChild("name");
168
+
169
+ // Iterate over rows
170
+ for (const row of table) {
171
+ console.log(row.id, row.name, row.score);
172
+ }
173
+
174
+ // Convert to array of objects
175
+ const rows = table.toArray();
176
+
177
+ // Get schema information
178
+ console.log(table.schema.fields);
179
+ ```
180
+
181
+ ## Dependencies
182
+
183
+ - `@grpc/grpc-js` - gRPC implementation for Node.js
184
+ - `apache-arrow` - Apache Arrow data format support
185
+ - `google-protobuf` - Protocol Buffers runtime
186
+
187
+ ## Requirements
188
+
189
+ - Node.js >= 20.0.0
190
+
191
+ ## License
192
+
193
+ Apache License 2.0
194
+
195
+ ## Acknowledgements
196
+
197
+ This project is a fork of [flight-sql-client-js](https://github.com/firetiger-oss/flight-sql-client-js) originally developed by [Firetiger Inc](https://github.com/firetiger-oss). We thank them for their foundational work on this client.
198
+
199
+ ## Links
200
+
201
+ - [GizmoSQL](https://github.com/gizmodata/gizmosql) - High-performance SQL server with Arrow Flight SQL
202
+ - [GizmoData](https://gizmodata.com) - Company behind GizmoSQL
203
+ - [Apache Arrow](https://arrow.apache.org/) - In-memory columnar data format
204
+ - [Arrow Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html) - SQL protocol specification
@@ -0,0 +1,19 @@
1
+ export declare class FlightError extends Error {
2
+ code?: string | undefined;
3
+ constructor(message: string, code?: string | undefined);
4
+ }
5
+ export declare class FlightSQLError extends FlightError {
6
+ sqlState?: string | undefined;
7
+ constructor(message: string, sqlState?: string | undefined, code?: string);
8
+ }
9
+ export declare class ConnectionError extends FlightError {
10
+ originalError?: Error | undefined;
11
+ constructor(message: string, originalError?: Error | undefined);
12
+ }
13
+ export declare class AuthenticationError extends FlightError {
14
+ constructor(message?: string);
15
+ }
16
+ export declare class SchemaError extends FlightError {
17
+ constructor(message: string);
18
+ }
19
+ //# sourceMappingURL=errors.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,qBAAa,WAAY,SAAQ,KAAK;IACA,IAAI,CAAC,EAAE,MAAM;gBAArC,OAAO,EAAE,MAAM,EAAS,IAAI,CAAC,EAAE,MAAM,YAAA;CAIlD;AAED,qBAAa,cAAe,SAAQ,WAAW;IACT,QAAQ,CAAC,EAAE,MAAM;gBAAzC,OAAO,EAAE,MAAM,EAAS,QAAQ,CAAC,EAAE,MAAM,YAAA,EAAE,IAAI,CAAC,EAAE,MAAM;CAIrE;AAED,qBAAa,eAAgB,SAAQ,WAAW;IACV,aAAa,CAAC,EAAE,KAAK;gBAA7C,OAAO,EAAE,MAAM,EAAS,aAAa,CAAC,EAAE,KAAK,YAAA;CAI1D;AAED,qBAAa,mBAAoB,SAAQ,WAAW;gBACtC,OAAO,GAAE,MAAgC;CAItD;AAED,qBAAa,WAAY,SAAQ,WAAW;gBAC9B,OAAO,EAAE,MAAM;CAI5B"}
package/dist/errors.js ADDED
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SchemaError = exports.AuthenticationError = exports.ConnectionError = exports.FlightSQLError = exports.FlightError = void 0;
4
+ class FlightError extends Error {
5
+ constructor(message, code) {
6
+ super(message);
7
+ this.code = code;
8
+ this.name = 'FlightError';
9
+ }
10
+ }
11
+ exports.FlightError = FlightError;
12
+ class FlightSQLError extends FlightError {
13
+ constructor(message, sqlState, code) {
14
+ super(message, code);
15
+ this.sqlState = sqlState;
16
+ this.name = 'FlightSQLError';
17
+ }
18
+ }
19
+ exports.FlightSQLError = FlightSQLError;
20
+ class ConnectionError extends FlightError {
21
+ constructor(message, originalError) {
22
+ super(message);
23
+ this.originalError = originalError;
24
+ this.name = 'ConnectionError';
25
+ }
26
+ }
27
+ exports.ConnectionError = ConnectionError;
28
+ class AuthenticationError extends FlightError {
29
+ constructor(message = 'Authentication failed') {
30
+ super(message);
31
+ this.name = 'AuthenticationError';
32
+ }
33
+ }
34
+ exports.AuthenticationError = AuthenticationError;
35
+ class SchemaError extends FlightError {
36
+ constructor(message) {
37
+ super(message);
38
+ this.name = 'SchemaError';
39
+ }
40
+ }
41
+ exports.SchemaError = SchemaError;
42
+ //# sourceMappingURL=errors.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA,MAAa,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe,EAAS,IAAa;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;QADmB,SAAI,GAAJ,IAAI,CAAS;QAE/C,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AALD,kCAKC;AAED,MAAa,cAAe,SAAQ,WAAW;IAC7C,YAAY,OAAe,EAAS,QAAiB,EAAE,IAAa;QAClE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QADa,aAAQ,GAAR,QAAQ,CAAS;QAEnD,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;IAC/B,CAAC;CACF;AALD,wCAKC;AAED,MAAa,eAAgB,SAAQ,WAAW;IAC9C,YAAY,OAAe,EAAS,aAAqB;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;QADmB,kBAAa,GAAb,aAAa,CAAQ;QAEvD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;IAChC,CAAC;CACF;AALD,0CAKC;AAED,MAAa,mBAAoB,SAAQ,WAAW;IAClD,YAAY,UAAkB,uBAAuB;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,qBAAqB,CAAC;IACpC,CAAC;CACF;AALD,kDAKC;AAED,MAAa,WAAY,SAAQ,WAAW;IAC1C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AALD,kCAKC"}
@@ -0,0 +1,47 @@
1
+ import { Schema, Table } from 'apache-arrow';
2
+ import { FlightDescriptor, FlightInfo, Ticket, FlightData, Action, ActionType, Result, Criteria } from './generated/proto/Flight_pb';
3
+ import { FlightClientConfig } from './types';
4
+ export declare class FlightClient {
5
+ private client;
6
+ private config;
7
+ private readonly credentials;
8
+ private readonly metadata;
9
+ constructor(config: FlightClientConfig);
10
+ private createCredentials;
11
+ private createMetadata;
12
+ connect(): Promise<void>;
13
+ private authenticate;
14
+ getFlightInfo(descriptor: FlightDescriptor): Promise<FlightInfo>;
15
+ doGet(ticket: Ticket): Promise<Table>;
16
+ /**
17
+ * Processes FlightData messages and reconstructs them into Arrow IPC format.
18
+ * According to Apache Arrow Flight spec, FlightData contains FlatBuffer messages
19
+ * that need to be converted to proper Arrow IPC format for parsing.
20
+ */
21
+ private processFlightDataMessages;
22
+ /**
23
+ * Converts FlightData messages to Arrow IPC format.
24
+ * Each FlightData message contains a header (FlatBuffer) and optional body data.
25
+ */
26
+ private convertFlightDataToIPC;
27
+ /**
28
+ * Creates a single Arrow IPC message from FlightData header and body.
29
+ * Format: [4 bytes continuation] [4 bytes message length] [message] [padding] [body]
30
+ */
31
+ private createIPCMessage;
32
+ /**
33
+ * Calculates padding needed to align to 8-byte boundary.
34
+ */
35
+ private calculatePadding;
36
+ /**
37
+ * Writes a 32-bit unsigned integer in little-endian format.
38
+ */
39
+ private writeUint32;
40
+ doPut(stream: AsyncIterable<FlightData>): Promise<void>;
41
+ doAction(action: Action): Promise<Result[]>;
42
+ listFlights(criteria?: Criteria): Promise<FlightInfo[]>;
43
+ getSchema(descriptor: FlightDescriptor): Promise<Schema>;
44
+ listActions(): Promise<ActionType[]>;
45
+ close(): Promise<void>;
46
+ }
47
+ //# sourceMappingURL=flight-client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"flight-client.d.ts","sourceRoot":"","sources":["../src/flight-client.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,MAAM,EAAE,KAAK,EAAe,MAAM,cAAc,CAAC;AAEzD,OAAO,EACL,gBAAgB,EAChB,UAAU,EACV,MAAM,EACN,UAAU,EAEV,MAAM,EACN,UAAU,EACV,MAAM,EACN,QAAQ,EAET,MAAM,6BAA6B,CAAC;AACrC,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAI7C,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAoC;IAClD,OAAO,CAAC,MAAM,CAAqB;IACnC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA0B;IACtD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAgB;gBAE7B,MAAM,EAAE,kBAAkB;IAOtC,OAAO,CAAC,iBAAiB;IAczB,OAAO,CAAC,cAAc;IAYhB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;YAyBhB,YAAY;IAkCpB,aAAa,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAAC,UAAU,CAAC;IAgBhE,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IA8C3C;;;;OAIG;IACH,OAAO,CAAC,yBAAyB;IAUjC;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAiB9B;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IA8BxB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAIxB;;OAEG;IACH,OAAO,CAAC,WAAW;IAMb,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA6BvD,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAuB3C,WAAW,CAAC,QAAQ,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAyBvD,SAAS,CAAC,UAAU,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC;IAsBxD,WAAW,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAyBpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAM7B"}