@useairfoil/flight 0.4.6 → 0.4.8
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/README.md +22 -1
- package/dist/{index.d.ts → index.d.mts} +223 -88
- package/dist/{index.js → index.mjs} +288 -325
- package/dist/index.mjs.map +1 -0
- package/dist/{chunk-Bp6m_JJh.js → rolldown-runtime-D7D4PA-g.mjs} +4 -4
- package/package.json +12 -12
- package/src/index.ts +2 -0
- package/dist/index.js.map +0 -1
package/README.md
CHANGED
|
@@ -1 +1,22 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Flight
|
|
2
|
+
|
|
3
|
+
This package has Effect clients for Arrow Flight and Flight SQL.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @useairfoil/flight effect@^4
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```ts
|
|
14
|
+
import { ArrowFlightSqlClient } from "@useairfoil/flight";
|
|
15
|
+
import { Effect } from "effect";
|
|
16
|
+
|
|
17
|
+
const result = ArrowFlightSqlClient.executeQuery({ query: "SELECT 1" }).pipe(
|
|
18
|
+
Effect.flatMap(ArrowFlightSqlClient.executeFlightInfo),
|
|
19
|
+
Effect.provide(ArrowFlightSqlClient.layer({ host: "localhost:50051" })),
|
|
20
|
+
Effect.scoped,
|
|
21
|
+
);
|
|
22
|
+
```
|
|
@@ -1,40 +1,38 @@
|
|
|
1
1
|
import { Config, Context, Effect, Layer, Scope, Stream } from "effect";
|
|
2
2
|
import { CallOptions, CallOptions as CallOptions$1, Channel, ChannelCredentials, ChannelOptions, CompatServiceDefinition, DefaultCallOptions, NormalizedServiceDefinition } from "nice-grpc";
|
|
3
|
-
import { RecordBatch, RecordBatch as RecordBatch$1, Schema, TypeMap } from "apache-arrow";
|
|
3
|
+
import { RecordBatch, RecordBatch as RecordBatch$1, RecordBatch as RecordBatch$2, Schema, TypeMap } from "apache-arrow";
|
|
4
4
|
import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
|
|
5
|
-
import
|
|
6
|
-
import * as effect_Cause0 from "effect/Cause";
|
|
7
|
-
|
|
5
|
+
import "nice-grpc-common";
|
|
8
6
|
//#region src/record-batch-with-metadata.d.ts
|
|
9
7
|
type RecordBatchWithMetadata<T extends TypeMap = any> = {
|
|
10
|
-
readonly batch: RecordBatch<T>;
|
|
8
|
+
readonly batch: RecordBatch$1<T>;
|
|
11
9
|
readonly appMetadata: Uint8Array;
|
|
12
10
|
};
|
|
13
11
|
declare namespace flight_client_error_d_exports {
|
|
14
12
|
export { FlightClientError, FlightClientErrorLike, FlightDecodeError, FlightProtocolError, FlightTransportError };
|
|
15
13
|
}
|
|
16
|
-
declare const FlightClientError_base: new <A extends Record<string, any> = {}>(args:
|
|
14
|
+
declare const FlightClientError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
|
|
17
15
|
readonly _tag: "FlightClientError";
|
|
18
16
|
} & Readonly<A>;
|
|
19
17
|
declare class FlightClientError extends FlightClientError_base<{
|
|
20
18
|
readonly message: string;
|
|
21
19
|
readonly cause?: unknown;
|
|
22
20
|
}> {}
|
|
23
|
-
declare const FlightTransportError_base: new <A extends Record<string, any> = {}>(args:
|
|
21
|
+
declare const FlightTransportError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
|
|
24
22
|
readonly _tag: "FlightTransportError";
|
|
25
23
|
} & Readonly<A>;
|
|
26
24
|
declare class FlightTransportError extends FlightTransportError_base<{
|
|
27
25
|
readonly message: string;
|
|
28
26
|
readonly cause?: unknown;
|
|
29
27
|
}> {}
|
|
30
|
-
declare const FlightDecodeError_base: new <A extends Record<string, any> = {}>(args:
|
|
28
|
+
declare const FlightDecodeError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
|
|
31
29
|
readonly _tag: "FlightDecodeError";
|
|
32
30
|
} & Readonly<A>;
|
|
33
31
|
declare class FlightDecodeError extends FlightDecodeError_base<{
|
|
34
32
|
readonly message: string;
|
|
35
33
|
readonly cause?: unknown;
|
|
36
34
|
}> {}
|
|
37
|
-
declare const FlightProtocolError_base: new <A extends Record<string, any> = {}>(args:
|
|
35
|
+
declare const FlightProtocolError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
|
|
38
36
|
readonly _tag: "FlightProtocolError";
|
|
39
37
|
} & Readonly<A>;
|
|
40
38
|
declare class FlightProtocolError extends FlightProtocolError_base<{
|
|
@@ -57,7 +55,7 @@ type HostOrChannel = {
|
|
|
57
55
|
host?: never;
|
|
58
56
|
channel: Channel;
|
|
59
57
|
};
|
|
60
|
-
declare function createChannelFromConfig(config: HostOrChannel): Channel;
|
|
58
|
+
export declare function createChannelFromConfig(config: HostOrChannel): Channel;
|
|
61
59
|
//#endregion
|
|
62
60
|
//#region src/proto/Flight.d.ts
|
|
63
61
|
/** The request that a client provides to a server on handshake. */
|
|
@@ -121,7 +119,7 @@ interface SchemaResult {
|
|
|
121
119
|
* The name or tag for a Flight. May be used as a way to retrieve or generate
|
|
122
120
|
* a flight or be used to expose a set of previously defined flights.
|
|
123
121
|
*/
|
|
124
|
-
interface FlightDescriptor {
|
|
122
|
+
export interface FlightDescriptor {
|
|
125
123
|
$type: "arrow.flight.protocol.FlightDescriptor";
|
|
126
124
|
readonly type: FlightDescriptor_DescriptorType;
|
|
127
125
|
/**
|
|
@@ -136,7 +134,7 @@ interface FlightDescriptor {
|
|
|
136
134
|
readonly path: readonly string[];
|
|
137
135
|
}
|
|
138
136
|
/** Describes what type of descriptor is defined. */
|
|
139
|
-
declare enum FlightDescriptor_DescriptorType {
|
|
137
|
+
export declare enum FlightDescriptor_DescriptorType {
|
|
140
138
|
/** UNKNOWN - Protobuf pattern, not used. */
|
|
141
139
|
UNKNOWN = 0,
|
|
142
140
|
/**
|
|
@@ -147,13 +145,13 @@ declare enum FlightDescriptor_DescriptorType {
|
|
|
147
145
|
PATH = 1,
|
|
148
146
|
/** CMD - An opaque command to generate a dataset. */
|
|
149
147
|
CMD = 2,
|
|
150
|
-
UNRECOGNIZED = -1
|
|
148
|
+
UNRECOGNIZED = -1
|
|
151
149
|
}
|
|
152
150
|
/**
|
|
153
151
|
* The access coordinates for retrieval of a dataset. With a FlightInfo, a
|
|
154
152
|
* consumer is able to determine how to retrieve a dataset.
|
|
155
153
|
*/
|
|
156
|
-
interface FlightInfo {
|
|
154
|
+
export interface FlightInfo {
|
|
157
155
|
$type: "arrow.flight.protocol.FlightInfo";
|
|
158
156
|
/**
|
|
159
157
|
* The schema of the dataset in its IPC form:
|
|
@@ -298,12 +296,12 @@ interface Location {
|
|
|
298
296
|
* Tickets are meant to be single use. It is an error/application-defined
|
|
299
297
|
* behavior to reuse a ticket.
|
|
300
298
|
*/
|
|
301
|
-
interface Ticket {
|
|
299
|
+
export interface Ticket {
|
|
302
300
|
$type: "arrow.flight.protocol.Ticket";
|
|
303
301
|
readonly ticket: Uint8Array;
|
|
304
302
|
}
|
|
305
303
|
/** A batch of Arrow data as part of a stream of batches. */
|
|
306
|
-
interface FlightData {
|
|
304
|
+
export interface FlightData {
|
|
307
305
|
$type: "arrow.flight.protocol.FlightData";
|
|
308
306
|
/**
|
|
309
307
|
* The descriptor of the data. This is only relevant when a client is
|
|
@@ -323,26 +321,26 @@ interface FlightData {
|
|
|
323
321
|
readonly dataBody: Uint8Array;
|
|
324
322
|
}
|
|
325
323
|
/** The response message associated with the submission of a DoPut. */
|
|
326
|
-
interface PutResult {
|
|
324
|
+
export interface PutResult {
|
|
327
325
|
$type: "arrow.flight.protocol.PutResult";
|
|
328
326
|
readonly appMetadata: Uint8Array;
|
|
329
327
|
}
|
|
330
|
-
declare const HandshakeRequest: MessageFns$
|
|
331
|
-
declare const HandshakeResponse: MessageFns$
|
|
332
|
-
declare const Empty: MessageFns$
|
|
333
|
-
declare const ActionType: MessageFns$
|
|
334
|
-
declare const Criteria: MessageFns$
|
|
335
|
-
declare const Action: MessageFns$
|
|
336
|
-
declare const Result: MessageFns$
|
|
337
|
-
declare const SchemaResult: MessageFns$
|
|
338
|
-
declare const FlightDescriptor: MessageFns$
|
|
339
|
-
declare const FlightInfo: MessageFns$
|
|
340
|
-
declare const PollInfo: MessageFns$
|
|
341
|
-
declare const FlightEndpoint: MessageFns$
|
|
342
|
-
declare const Location: MessageFns$
|
|
343
|
-
declare const Ticket: MessageFns$
|
|
344
|
-
declare const FlightData: MessageFns$
|
|
345
|
-
declare const PutResult: MessageFns$
|
|
328
|
+
declare const HandshakeRequest: MessageFns$2<HandshakeRequest, "arrow.flight.protocol.HandshakeRequest">;
|
|
329
|
+
declare const HandshakeResponse: MessageFns$2<HandshakeResponse, "arrow.flight.protocol.HandshakeResponse">;
|
|
330
|
+
declare const Empty: MessageFns$2<Empty, "arrow.flight.protocol.Empty">;
|
|
331
|
+
declare const ActionType: MessageFns$2<ActionType, "arrow.flight.protocol.ActionType">;
|
|
332
|
+
declare const Criteria: MessageFns$2<Criteria, "arrow.flight.protocol.Criteria">;
|
|
333
|
+
declare const Action: MessageFns$2<Action, "arrow.flight.protocol.Action">;
|
|
334
|
+
declare const Result: MessageFns$2<Result, "arrow.flight.protocol.Result">;
|
|
335
|
+
declare const SchemaResult: MessageFns$2<SchemaResult, "arrow.flight.protocol.SchemaResult">;
|
|
336
|
+
export declare const FlightDescriptor: MessageFns$2<FlightDescriptor, "arrow.flight.protocol.FlightDescriptor">;
|
|
337
|
+
export declare const FlightInfo: MessageFns$2<FlightInfo, "arrow.flight.protocol.FlightInfo">;
|
|
338
|
+
declare const PollInfo: MessageFns$2<PollInfo, "arrow.flight.protocol.PollInfo">;
|
|
339
|
+
declare const FlightEndpoint: MessageFns$2<FlightEndpoint, "arrow.flight.protocol.FlightEndpoint">;
|
|
340
|
+
declare const Location: MessageFns$2<Location, "arrow.flight.protocol.Location">;
|
|
341
|
+
export declare const Ticket: MessageFns$2<Ticket, "arrow.flight.protocol.Ticket">;
|
|
342
|
+
export declare const FlightData: MessageFns$2<FlightData, "arrow.flight.protocol.FlightData">;
|
|
343
|
+
export declare const PutResult: MessageFns$2<PutResult, "arrow.flight.protocol.PutResult">;
|
|
346
344
|
/**
|
|
347
345
|
* A flight service is an endpoint for retrieving or storing Arrow data. A
|
|
348
346
|
* flight service can expose one or more predefined endpoints that can be
|
|
@@ -362,9 +360,9 @@ declare const FlightServiceDefinition: {
|
|
|
362
360
|
*/
|
|
363
361
|
readonly handshake: {
|
|
364
362
|
readonly name: "Handshake";
|
|
365
|
-
readonly requestType: MessageFns$
|
|
363
|
+
readonly requestType: MessageFns$2<HandshakeRequest, "arrow.flight.protocol.HandshakeRequest">;
|
|
366
364
|
readonly requestStream: true;
|
|
367
|
-
readonly responseType: MessageFns$
|
|
365
|
+
readonly responseType: MessageFns$2<HandshakeResponse, "arrow.flight.protocol.HandshakeResponse">;
|
|
368
366
|
readonly responseStream: true;
|
|
369
367
|
readonly options: {};
|
|
370
368
|
};
|
|
@@ -378,9 +376,9 @@ declare const FlightServiceDefinition: {
|
|
|
378
376
|
*/
|
|
379
377
|
readonly listFlights: {
|
|
380
378
|
readonly name: "ListFlights";
|
|
381
|
-
readonly requestType: MessageFns$
|
|
379
|
+
readonly requestType: MessageFns$2<Criteria, "arrow.flight.protocol.Criteria">;
|
|
382
380
|
readonly requestStream: false;
|
|
383
|
-
readonly responseType: MessageFns$
|
|
381
|
+
readonly responseType: MessageFns$2<FlightInfo, "arrow.flight.protocol.FlightInfo">;
|
|
384
382
|
readonly responseStream: true;
|
|
385
383
|
readonly options: {};
|
|
386
384
|
};
|
|
@@ -398,9 +396,9 @@ declare const FlightServiceDefinition: {
|
|
|
398
396
|
*/
|
|
399
397
|
readonly getFlightInfo: {
|
|
400
398
|
readonly name: "GetFlightInfo";
|
|
401
|
-
readonly requestType: MessageFns$
|
|
399
|
+
readonly requestType: MessageFns$2<FlightDescriptor, "arrow.flight.protocol.FlightDescriptor">;
|
|
402
400
|
readonly requestStream: false;
|
|
403
|
-
readonly responseType: MessageFns$
|
|
401
|
+
readonly responseType: MessageFns$2<FlightInfo, "arrow.flight.protocol.FlightInfo">;
|
|
404
402
|
readonly responseStream: false;
|
|
405
403
|
readonly options: {};
|
|
406
404
|
};
|
|
@@ -430,9 +428,9 @@ declare const FlightServiceDefinition: {
|
|
|
430
428
|
*/
|
|
431
429
|
readonly pollFlightInfo: {
|
|
432
430
|
readonly name: "PollFlightInfo";
|
|
433
|
-
readonly requestType: MessageFns$
|
|
431
|
+
readonly requestType: MessageFns$2<FlightDescriptor, "arrow.flight.protocol.FlightDescriptor">;
|
|
434
432
|
readonly requestStream: false;
|
|
435
|
-
readonly responseType: MessageFns$
|
|
433
|
+
readonly responseType: MessageFns$2<PollInfo, "arrow.flight.protocol.PollInfo">;
|
|
436
434
|
readonly responseStream: false;
|
|
437
435
|
readonly options: {};
|
|
438
436
|
};
|
|
@@ -444,9 +442,9 @@ declare const FlightServiceDefinition: {
|
|
|
444
442
|
*/
|
|
445
443
|
readonly getSchema: {
|
|
446
444
|
readonly name: "GetSchema";
|
|
447
|
-
readonly requestType: MessageFns$
|
|
445
|
+
readonly requestType: MessageFns$2<FlightDescriptor, "arrow.flight.protocol.FlightDescriptor">;
|
|
448
446
|
readonly requestStream: false;
|
|
449
|
-
readonly responseType: MessageFns$
|
|
447
|
+
readonly responseType: MessageFns$2<SchemaResult, "arrow.flight.protocol.SchemaResult">;
|
|
450
448
|
readonly responseStream: false;
|
|
451
449
|
readonly options: {};
|
|
452
450
|
};
|
|
@@ -458,9 +456,9 @@ declare const FlightServiceDefinition: {
|
|
|
458
456
|
*/
|
|
459
457
|
readonly doGet: {
|
|
460
458
|
readonly name: "DoGet";
|
|
461
|
-
readonly requestType: MessageFns$
|
|
459
|
+
readonly requestType: MessageFns$2<Ticket, "arrow.flight.protocol.Ticket">;
|
|
462
460
|
readonly requestStream: false;
|
|
463
|
-
readonly responseType: MessageFns$
|
|
461
|
+
readonly responseType: MessageFns$2<FlightData, "arrow.flight.protocol.FlightData">;
|
|
464
462
|
readonly responseStream: true;
|
|
465
463
|
readonly options: {};
|
|
466
464
|
};
|
|
@@ -474,9 +472,9 @@ declare const FlightServiceDefinition: {
|
|
|
474
472
|
*/
|
|
475
473
|
readonly doPut: {
|
|
476
474
|
readonly name: "DoPut";
|
|
477
|
-
readonly requestType: MessageFns$
|
|
475
|
+
readonly requestType: MessageFns$2<FlightData, "arrow.flight.protocol.FlightData">;
|
|
478
476
|
readonly requestStream: true;
|
|
479
|
-
readonly responseType: MessageFns$
|
|
477
|
+
readonly responseType: MessageFns$2<PutResult, "arrow.flight.protocol.PutResult">;
|
|
480
478
|
readonly responseStream: true;
|
|
481
479
|
readonly options: {};
|
|
482
480
|
};
|
|
@@ -489,9 +487,9 @@ declare const FlightServiceDefinition: {
|
|
|
489
487
|
*/
|
|
490
488
|
readonly doExchange: {
|
|
491
489
|
readonly name: "DoExchange";
|
|
492
|
-
readonly requestType: MessageFns$
|
|
490
|
+
readonly requestType: MessageFns$2<FlightData, "arrow.flight.protocol.FlightData">;
|
|
493
491
|
readonly requestStream: true;
|
|
494
|
-
readonly responseType: MessageFns$
|
|
492
|
+
readonly responseType: MessageFns$2<FlightData, "arrow.flight.protocol.FlightData">;
|
|
495
493
|
readonly responseStream: true;
|
|
496
494
|
readonly options: {};
|
|
497
495
|
};
|
|
@@ -505,9 +503,9 @@ declare const FlightServiceDefinition: {
|
|
|
505
503
|
*/
|
|
506
504
|
readonly doAction: {
|
|
507
505
|
readonly name: "DoAction";
|
|
508
|
-
readonly requestType: MessageFns$
|
|
506
|
+
readonly requestType: MessageFns$2<Action, "arrow.flight.protocol.Action">;
|
|
509
507
|
readonly requestStream: false;
|
|
510
|
-
readonly responseType: MessageFns$
|
|
508
|
+
readonly responseType: MessageFns$2<Result, "arrow.flight.protocol.Result">;
|
|
511
509
|
readonly responseStream: true;
|
|
512
510
|
readonly options: {};
|
|
513
511
|
};
|
|
@@ -518,33 +516,33 @@ declare const FlightServiceDefinition: {
|
|
|
518
516
|
*/
|
|
519
517
|
readonly listActions: {
|
|
520
518
|
readonly name: "ListActions";
|
|
521
|
-
readonly requestType: MessageFns$
|
|
519
|
+
readonly requestType: MessageFns$2<Empty, "arrow.flight.protocol.Empty">;
|
|
522
520
|
readonly requestStream: false;
|
|
523
|
-
readonly responseType: MessageFns$
|
|
521
|
+
readonly responseType: MessageFns$2<ActionType, "arrow.flight.protocol.ActionType">;
|
|
524
522
|
readonly responseStream: true;
|
|
525
523
|
readonly options: {};
|
|
526
524
|
};
|
|
527
525
|
};
|
|
528
526
|
};
|
|
529
|
-
type Builtin$
|
|
530
|
-
type DeepPartial$
|
|
527
|
+
type Builtin$2 = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
|
|
528
|
+
type DeepPartial$2<T> = T extends Builtin$2 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$2<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$2<U>> : T extends {
|
|
531
529
|
readonly $case: string;
|
|
532
|
-
} ? { [K in keyof Omit<T, "$case">]?: DeepPartial$
|
|
530
|
+
} ? { [K in keyof Omit<T, "$case">]?: DeepPartial$2<T[K]>; } & {
|
|
533
531
|
readonly $case: T["$case"];
|
|
534
|
-
} : T extends {} ? { [K in Exclude<keyof T, "$type">]?: DeepPartial$
|
|
535
|
-
type KeysOfUnion$
|
|
536
|
-
type Exact$
|
|
537
|
-
interface MessageFns$
|
|
532
|
+
} : T extends {} ? { [K in Exclude<keyof T, "$type">]?: DeepPartial$2<T[K]>; } : Partial<T>;
|
|
533
|
+
type KeysOfUnion$2<T> = T extends T ? keyof T : never;
|
|
534
|
+
type Exact$2<P, I extends P> = P extends Builtin$2 ? P : P & { [K in keyof P]: Exact$2<P[K], I[K]>; } & { [K in Exclude<keyof I, KeysOfUnion$2<P> | "$type">]: never; };
|
|
535
|
+
interface MessageFns$2<T, V extends string> {
|
|
538
536
|
readonly $type: V;
|
|
539
537
|
encode(message: T, writer?: BinaryWriter): BinaryWriter;
|
|
540
538
|
decode(input: BinaryReader | Uint8Array, length?: number): T;
|
|
541
539
|
fromJSON(object: any): T;
|
|
542
540
|
toJSON(message: T): unknown;
|
|
543
|
-
create<I extends Exact$
|
|
544
|
-
fromPartial<I extends Exact$
|
|
541
|
+
create<I extends Exact$2<DeepPartial$2<T>, I>>(base?: I): T;
|
|
542
|
+
fromPartial<I extends Exact$2<DeepPartial$2<T>, I>>(object: I): T;
|
|
545
543
|
}
|
|
546
544
|
declare namespace arrow_flight_client_d_exports {
|
|
547
|
-
export { ArrowFlightClient, ArrowFlightClientOptions, ArrowFlightClientService, CallOptions$1 as CallOptions, ClientOptions, HostOrChannel, RecordBatch$
|
|
545
|
+
export { ArrowFlightClient, ArrowFlightClientOptions, ArrowFlightClientService, CallOptions$1 as CallOptions, ClientOptions, HostOrChannel, RecordBatch$2 as RecordBatch, RecordBatchWithMetadata, layer$1 as layer, layerConfig$1 as layerConfig, make$1 as make };
|
|
548
546
|
}
|
|
549
547
|
type ArrowFlightClientOptions = HostOrChannel & {
|
|
550
548
|
readonly defaultCallOptions?: DefaultCallOptions<NormalizedServiceDefinition<FlightServiceDefinition>>;
|
|
@@ -565,7 +563,6 @@ declare const layer$1: (options: ArrowFlightClientOptions) => Layer.Layer<ArrowF
|
|
|
565
563
|
declare const layerConfig$1: (options: Config.Wrap<ArrowFlightClientOptions>) => Layer.Layer<ArrowFlightClient, Config.ConfigError, never>;
|
|
566
564
|
//#endregion
|
|
567
565
|
//#region src/proto/FlightSql.d.ts
|
|
568
|
-
|
|
569
566
|
/**
|
|
570
567
|
* Represents a request to retrieve the list of catalogs on a Flight SQL enabled backend.
|
|
571
568
|
* The definition of a catalog depends on vendor/implementation. It is usually the database itself
|
|
@@ -715,27 +712,27 @@ interface CommandStatementQuery {
|
|
|
715
712
|
/** Include the query as part of this transaction (if unset, the query is auto-committed). */
|
|
716
713
|
readonly transactionId?: Uint8Array | undefined;
|
|
717
714
|
}
|
|
718
|
-
declare const CommandGetCatalogs: MessageFns<CommandGetCatalogs, "arrow.flight.protocol.sql.CommandGetCatalogs">;
|
|
719
|
-
declare const CommandGetDbSchemas: MessageFns<CommandGetDbSchemas, "arrow.flight.protocol.sql.CommandGetDbSchemas">;
|
|
720
|
-
declare const CommandGetTables: MessageFns<CommandGetTables, "arrow.flight.protocol.sql.CommandGetTables">;
|
|
721
|
-
declare const CommandGetTableTypes: MessageFns<CommandGetTableTypes, "arrow.flight.protocol.sql.CommandGetTableTypes">;
|
|
722
|
-
declare const CommandStatementQuery: MessageFns<CommandStatementQuery, "arrow.flight.protocol.sql.CommandStatementQuery">;
|
|
723
|
-
type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
|
|
724
|
-
type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
|
|
715
|
+
declare const CommandGetCatalogs: MessageFns$1<CommandGetCatalogs, "arrow.flight.protocol.sql.CommandGetCatalogs">;
|
|
716
|
+
declare const CommandGetDbSchemas: MessageFns$1<CommandGetDbSchemas, "arrow.flight.protocol.sql.CommandGetDbSchemas">;
|
|
717
|
+
declare const CommandGetTables: MessageFns$1<CommandGetTables, "arrow.flight.protocol.sql.CommandGetTables">;
|
|
718
|
+
declare const CommandGetTableTypes: MessageFns$1<CommandGetTableTypes, "arrow.flight.protocol.sql.CommandGetTableTypes">;
|
|
719
|
+
declare const CommandStatementQuery: MessageFns$1<CommandStatementQuery, "arrow.flight.protocol.sql.CommandStatementQuery">;
|
|
720
|
+
type Builtin$1 = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
|
|
721
|
+
type DeepPartial$1<T> = T extends Builtin$1 ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial$1<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial$1<U>> : T extends {
|
|
725
722
|
readonly $case: string;
|
|
726
|
-
} ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]
|
|
723
|
+
} ? { [K in keyof Omit<T, "$case">]?: DeepPartial$1<T[K]>; } & {
|
|
727
724
|
readonly $case: T["$case"];
|
|
728
|
-
} : T extends {} ? { [K in Exclude<keyof T, "$type">]?: DeepPartial<T[K]
|
|
729
|
-
type KeysOfUnion<T> = T extends T ? keyof T : never;
|
|
730
|
-
type Exact<P
|
|
731
|
-
interface MessageFns<T, V extends string> {
|
|
725
|
+
} : T extends {} ? { [K in Exclude<keyof T, "$type">]?: DeepPartial$1<T[K]>; } : Partial<T>;
|
|
726
|
+
type KeysOfUnion$1<T> = T extends T ? keyof T : never;
|
|
727
|
+
type Exact$1<P, I extends P> = P extends Builtin$1 ? P : P & { [K in keyof P]: Exact$1<P[K], I[K]>; } & { [K in Exclude<keyof I, KeysOfUnion$1<P> | "$type">]: never; };
|
|
728
|
+
interface MessageFns$1<T, V extends string> {
|
|
732
729
|
readonly $type: V;
|
|
733
730
|
encode(message: T, writer?: BinaryWriter): BinaryWriter;
|
|
734
731
|
decode(input: BinaryReader | Uint8Array, length?: number): T;
|
|
735
732
|
fromJSON(object: any): T;
|
|
736
733
|
toJSON(message: T): unknown;
|
|
737
|
-
create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
|
|
738
|
-
fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
|
|
734
|
+
create<I extends Exact$1<DeepPartial$1<T>, I>>(base?: I): T;
|
|
735
|
+
fromPartial<I extends Exact$1<DeepPartial$1<T>, I>>(object: I): T;
|
|
739
736
|
}
|
|
740
737
|
declare namespace arrow_flight_sql_client_d_exports {
|
|
741
738
|
export { ArrowFlightSqlClient, ArrowFlightSqlClientOptions, ArrowFlightSqlClientService, CallOptions, FlightInfo, RecordBatchWithMetadata, layer, layerConfig, make };
|
|
@@ -756,17 +753,12 @@ declare const layer: (options: ArrowFlightSqlClientOptions) => Layer.Layer<Arrow
|
|
|
756
753
|
declare const layerConfig: (options: Config.Wrap<ArrowFlightSqlClientOptions>) => Layer.Layer<ArrowFlightSqlClient, Config.ConfigError, never>;
|
|
757
754
|
//#endregion
|
|
758
755
|
//#region src/flight-data-encoder.d.ts
|
|
759
|
-
declare const FlightDataEncoder: {
|
|
760
|
-
encodeSchema(schema: Schema, {
|
|
761
|
-
flightDescriptor,
|
|
762
|
-
appMetadata
|
|
763
|
-
}: {
|
|
756
|
+
export declare const FlightDataEncoder: {
|
|
757
|
+
encodeSchema(schema: Schema, { flightDescriptor, appMetadata }: {
|
|
764
758
|
flightDescriptor: FlightDescriptor;
|
|
765
759
|
appMetadata?: Uint8Array;
|
|
766
760
|
}): FlightData;
|
|
767
|
-
encodeBatch(batch: RecordBatch, {
|
|
768
|
-
appMetadata
|
|
769
|
-
}?: {
|
|
761
|
+
encodeBatch(batch: RecordBatch$1, { appMetadata }?: {
|
|
770
762
|
appMetadata?: (args: {
|
|
771
763
|
index: number;
|
|
772
764
|
length: number;
|
|
@@ -774,5 +766,148 @@ declare const FlightDataEncoder: {
|
|
|
774
766
|
}): ReadonlyArray<FlightData>;
|
|
775
767
|
};
|
|
776
768
|
//#endregion
|
|
777
|
-
|
|
778
|
-
|
|
769
|
+
//#region src/proto/any.d.ts
|
|
770
|
+
/**
|
|
771
|
+
* `Any` contains an arbitrary serialized protocol buffer message along with a
|
|
772
|
+
* URL that describes the type of the serialized message.
|
|
773
|
+
*
|
|
774
|
+
* Protobuf library provides support to pack/unpack Any values in the form
|
|
775
|
+
* of utility functions or additional generated methods of the Any type.
|
|
776
|
+
*
|
|
777
|
+
* Example 1: Pack and unpack a message in C++.
|
|
778
|
+
*
|
|
779
|
+
* Foo foo = ...;
|
|
780
|
+
* Any any;
|
|
781
|
+
* any.PackFrom(foo);
|
|
782
|
+
* ...
|
|
783
|
+
* if (any.UnpackTo(&foo)) {
|
|
784
|
+
* ...
|
|
785
|
+
* }
|
|
786
|
+
*
|
|
787
|
+
* Example 2: Pack and unpack a message in Java.
|
|
788
|
+
*
|
|
789
|
+
* Foo foo = ...;
|
|
790
|
+
* Any any = Any.pack(foo);
|
|
791
|
+
* ...
|
|
792
|
+
* if (any.is(Foo.class)) {
|
|
793
|
+
* foo = any.unpack(Foo.class);
|
|
794
|
+
* }
|
|
795
|
+
* // or ...
|
|
796
|
+
* if (any.isSameTypeAs(Foo.getDefaultInstance())) {
|
|
797
|
+
* foo = any.unpack(Foo.getDefaultInstance());
|
|
798
|
+
* }
|
|
799
|
+
*
|
|
800
|
+
* Example 3: Pack and unpack a message in Python.
|
|
801
|
+
*
|
|
802
|
+
* foo = Foo(...)
|
|
803
|
+
* any = Any()
|
|
804
|
+
* any.Pack(foo)
|
|
805
|
+
* ...
|
|
806
|
+
* if any.Is(Foo.DESCRIPTOR):
|
|
807
|
+
* any.Unpack(foo)
|
|
808
|
+
* ...
|
|
809
|
+
*
|
|
810
|
+
* Example 4: Pack and unpack a message in Go
|
|
811
|
+
*
|
|
812
|
+
* foo := &pb.Foo{...}
|
|
813
|
+
* any, err := anypb.New(foo)
|
|
814
|
+
* if err != nil {
|
|
815
|
+
* ...
|
|
816
|
+
* }
|
|
817
|
+
* ...
|
|
818
|
+
* foo := &pb.Foo{}
|
|
819
|
+
* if err := any.UnmarshalTo(foo); err != nil {
|
|
820
|
+
* ...
|
|
821
|
+
* }
|
|
822
|
+
*
|
|
823
|
+
* The pack methods provided by protobuf library will by default use
|
|
824
|
+
* 'type.googleapis.com/full.type.name' as the type URL and the unpack
|
|
825
|
+
* methods only use the fully qualified type name after the last '/'
|
|
826
|
+
* in the type URL, for example "foo.bar.com/x/y.z" will yield type
|
|
827
|
+
* name "y.z".
|
|
828
|
+
*
|
|
829
|
+
* JSON
|
|
830
|
+
* ====
|
|
831
|
+
* The JSON representation of an `Any` value uses the regular
|
|
832
|
+
* representation of the deserialized, embedded message, with an
|
|
833
|
+
* additional field `@type` which contains the type URL. Example:
|
|
834
|
+
*
|
|
835
|
+
* package google.profile;
|
|
836
|
+
* message Person {
|
|
837
|
+
* string first_name = 1;
|
|
838
|
+
* string last_name = 2;
|
|
839
|
+
* }
|
|
840
|
+
*
|
|
841
|
+
* {
|
|
842
|
+
* "@type": "type.googleapis.com/google.profile.Person",
|
|
843
|
+
* "firstName": <string>,
|
|
844
|
+
* "lastName": <string>
|
|
845
|
+
* }
|
|
846
|
+
*
|
|
847
|
+
* If the embedded message type is well-known and has a custom JSON
|
|
848
|
+
* representation, that representation will be embedded adding a field
|
|
849
|
+
* `value` which holds the custom JSON in addition to the `@type`
|
|
850
|
+
* field. Example (for message [google.protobuf.Duration][]):
|
|
851
|
+
*
|
|
852
|
+
* {
|
|
853
|
+
* "@type": "type.googleapis.com/google.protobuf.Duration",
|
|
854
|
+
* "value": "1.212s"
|
|
855
|
+
* }
|
|
856
|
+
*/
|
|
857
|
+
export interface Any {
|
|
858
|
+
$type: "google.protobuf.Any";
|
|
859
|
+
/**
|
|
860
|
+
* A URL/resource name that uniquely identifies the type of the serialized
|
|
861
|
+
* protocol buffer message. This string must contain at least
|
|
862
|
+
* one "/" character. The last segment of the URL's path must represent
|
|
863
|
+
* the fully qualified name of the type (as in
|
|
864
|
+
* `path/google.protobuf.Duration`). The name should be in a canonical form
|
|
865
|
+
* (e.g., leading "." is not accepted).
|
|
866
|
+
*
|
|
867
|
+
* In practice, teams usually precompile into the binary all types that they
|
|
868
|
+
* expect it to use in the context of Any. However, for URLs which use the
|
|
869
|
+
* scheme `http`, `https`, or no scheme, one can optionally set up a type
|
|
870
|
+
* server that maps type URLs to message definitions as follows:
|
|
871
|
+
*
|
|
872
|
+
* * If no scheme is provided, `https` is assumed.
|
|
873
|
+
* * An HTTP GET on the URL must yield a [google.protobuf.Type][]
|
|
874
|
+
* value in binary format, or produce an error.
|
|
875
|
+
* * Applications are allowed to cache lookup results based on the
|
|
876
|
+
* URL, or have them precompiled into a binary to avoid any
|
|
877
|
+
* lookup. Therefore, binary compatibility needs to be preserved
|
|
878
|
+
* on changes to types. (Use versioned type names to manage
|
|
879
|
+
* breaking changes.)
|
|
880
|
+
*
|
|
881
|
+
* Note: this functionality is not currently available in the official
|
|
882
|
+
* protobuf release, and it is not used for type URLs beginning with
|
|
883
|
+
* type.googleapis.com. As of May 2023, there are no widely used type server
|
|
884
|
+
* implementations and no plans to implement one.
|
|
885
|
+
*
|
|
886
|
+
* Schemes other than `http`, `https` (or the empty scheme) might be
|
|
887
|
+
* used with implementation specific semantics.
|
|
888
|
+
*/
|
|
889
|
+
readonly typeUrl: string;
|
|
890
|
+
/** Must be a valid serialized protocol buffer of the above specified type. */
|
|
891
|
+
readonly value: Uint8Array;
|
|
892
|
+
}
|
|
893
|
+
export declare const Any: MessageFns<Any, "google.protobuf.Any">;
|
|
894
|
+
type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
|
|
895
|
+
type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
|
|
896
|
+
readonly $case: string;
|
|
897
|
+
} ? { [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>; } & {
|
|
898
|
+
readonly $case: T["$case"];
|
|
899
|
+
} : T extends {} ? { [K in Exclude<keyof T, "$type">]?: DeepPartial<T[K]>; } : Partial<T>;
|
|
900
|
+
type KeysOfUnion<T> = T extends T ? keyof T : never;
|
|
901
|
+
type Exact<P, I extends P> = P extends Builtin ? P : P & { [K in keyof P]: Exact<P[K], I[K]>; } & { [K in Exclude<keyof I, KeysOfUnion<P> | "$type">]: never; };
|
|
902
|
+
interface MessageFns<T, V extends string> {
|
|
903
|
+
readonly $type: V;
|
|
904
|
+
encode(message: T, writer?: BinaryWriter): BinaryWriter;
|
|
905
|
+
decode(input: BinaryReader | Uint8Array, length?: number): T;
|
|
906
|
+
fromJSON(object: any): T;
|
|
907
|
+
toJSON(message: T): unknown;
|
|
908
|
+
create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
|
|
909
|
+
fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
|
|
910
|
+
}
|
|
911
|
+
//#endregion
|
|
912
|
+
export { arrow_flight_client_d_exports as ArrowFlightClient, type ArrowFlightClientOptions, type ArrowFlightClientService, arrow_flight_sql_client_d_exports as ArrowFlightSqlClient, type ArrowFlightSqlClientOptions, type ArrowFlightSqlClientService, type ClientOptions, flight_client_error_d_exports as FlightClientError, type FlightClientErrorLike, type HostOrChannel, type RecordBatch, type RecordBatchWithMetadata };
|
|
913
|
+
//# sourceMappingURL=index.d.mts.map
|