@qualithm/arrow-flight-client 0.1.0 → 0.1.2

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.
Files changed (36) hide show
  1. package/README.md +46 -14
  2. package/dist/client/flight-client.d.ts.map +1 -1
  3. package/dist/client/flight-client.js +5 -9
  4. package/dist/client/flight-client.js.map +1 -1
  5. package/dist/client/flight-sql-client.d.ts.map +1 -1
  6. package/dist/client/flight-sql-client.js +5 -8
  7. package/dist/client/flight-sql-client.js.map +1 -1
  8. package/dist/gen/arrow/flight/FlightSql_pb.d.ts +2382 -1962
  9. package/dist/gen/arrow/flight/FlightSql_pb.js +316 -1957
  10. package/dist/gen/arrow/flight/Flight_pb.d.ts +847 -720
  11. package/dist/gen/arrow/flight/Flight_pb.js +119 -230
  12. package/dist/testing/builders.d.ts +53 -0
  13. package/dist/testing/builders.d.ts.map +1 -0
  14. package/dist/testing/builders.js +95 -0
  15. package/dist/testing/builders.js.map +1 -0
  16. package/dist/testing/descriptors.d.ts +43 -0
  17. package/dist/testing/descriptors.d.ts.map +1 -0
  18. package/dist/testing/descriptors.js +47 -0
  19. package/dist/testing/descriptors.js.map +1 -0
  20. package/dist/testing/helpers.d.ts +70 -0
  21. package/dist/testing/helpers.d.ts.map +1 -0
  22. package/dist/testing/helpers.js +95 -0
  23. package/dist/testing/helpers.js.map +1 -0
  24. package/dist/testing/index.d.ts +44 -0
  25. package/dist/testing/index.d.ts.map +1 -0
  26. package/dist/testing/index.js +49 -0
  27. package/dist/testing/index.js.map +1 -0
  28. package/dist/testing/streams.d.ts +88 -0
  29. package/dist/testing/streams.d.ts.map +1 -0
  30. package/dist/testing/streams.js +112 -0
  31. package/dist/testing/streams.js.map +1 -0
  32. package/package.json +17 -7
  33. package/dist/gen/arrow/flight/FlightSql_pb.d.ts.map +0 -1
  34. package/dist/gen/arrow/flight/FlightSql_pb.js.map +0 -1
  35. package/dist/gen/arrow/flight/Flight_pb.d.ts.map +0 -1
  36. package/dist/gen/arrow/flight/Flight_pb.js.map +0 -1
@@ -1,91 +1,125 @@
1
- import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
2
- import type { Timestamp } from "@bufbuild/protobuf/wkt";
3
- import type { Message } from "@bufbuild/protobuf";
1
+ //
2
+ // Licensed to the Apache Software Foundation (ASF) under one
3
+ // or more contributor license agreements. See the NOTICE file
4
+ // distributed with this work for additional information
5
+ // regarding copyright ownership. The ASF licenses this file
6
+ // to you under the Apache License, Version 2.0 (the
7
+ // "License"); you may not use this file except in compliance
8
+ // with the License. You may obtain a copy of the License at
9
+ // <p>
10
+ // http://www.apache.org/licenses/LICENSE-2.0
11
+ // <p>
12
+ // Unless required by applicable law or agreed to in writing, software
13
+ // distributed under the License is distributed on an "AS IS" BASIS,
14
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ // See the License for the specific language governing permissions and
16
+ // limitations under the License.
17
+
18
+ // @generated by protoc-gen-es v2.11.0 with parameter "target=js+dts"
19
+ // @generated from file arrow/flight/Flight.proto (package arrow.flight.protocol, syntax proto3)
20
+ /* eslint-disable */
21
+
22
+ import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2"
23
+ import type { Message } from "@bufbuild/protobuf"
24
+ import type { Timestamp } from "@bufbuild/protobuf/wkt"
25
+
4
26
  /**
5
27
  * Describes the file arrow/flight/Flight.proto.
6
28
  */
7
- export declare const file_arrow_flight_Flight: GenFile;
29
+ export declare const file_arrow_flight_Flight: GenFile
30
+
8
31
  /**
9
32
  *
10
33
  * The request that a client provides to a server on handshake.
11
34
  *
12
35
  * @generated from message arrow.flight.protocol.HandshakeRequest
13
36
  */
14
- export type HandshakeRequest = Message<"arrow.flight.protocol.HandshakeRequest"> & {
15
- /**
16
- *
17
- * A defined protocol version
18
- *
19
- * @generated from field: uint64 protocol_version = 1;
20
- */
21
- protocolVersion: bigint;
22
- /**
23
- *
24
- * Arbitrary auth/handshake info.
25
- *
26
- * @generated from field: bytes payload = 2;
27
- */
28
- payload: Uint8Array;
29
- };
37
+ export declare type HandshakeRequest = Message<"arrow.flight.protocol.HandshakeRequest"> & {
38
+ /**
39
+ *
40
+ * A defined protocol version
41
+ *
42
+ * @generated from field: uint64 protocol_version = 1;
43
+ */
44
+ protocolVersion: bigint
45
+
46
+ /**
47
+ *
48
+ * Arbitrary auth/handshake info.
49
+ *
50
+ * @generated from field: bytes payload = 2;
51
+ */
52
+ payload: Uint8Array
53
+ }
54
+
30
55
  /**
31
56
  * Describes the message arrow.flight.protocol.HandshakeRequest.
32
57
  * Use `create(HandshakeRequestSchema)` to create a new message.
33
58
  */
34
- export declare const HandshakeRequestSchema: GenMessage<HandshakeRequest>;
59
+ export declare const HandshakeRequestSchema: GenMessage<HandshakeRequest>
60
+
35
61
  /**
36
62
  * @generated from message arrow.flight.protocol.HandshakeResponse
37
63
  */
38
- export type HandshakeResponse = Message<"arrow.flight.protocol.HandshakeResponse"> & {
39
- /**
40
- *
41
- * A defined protocol version
42
- *
43
- * @generated from field: uint64 protocol_version = 1;
44
- */
45
- protocolVersion: bigint;
46
- /**
47
- *
48
- * Arbitrary auth/handshake info.
49
- *
50
- * @generated from field: bytes payload = 2;
51
- */
52
- payload: Uint8Array;
53
- };
64
+ export declare type HandshakeResponse = Message<"arrow.flight.protocol.HandshakeResponse"> & {
65
+ /**
66
+ *
67
+ * A defined protocol version
68
+ *
69
+ * @generated from field: uint64 protocol_version = 1;
70
+ */
71
+ protocolVersion: bigint
72
+
73
+ /**
74
+ *
75
+ * Arbitrary auth/handshake info.
76
+ *
77
+ * @generated from field: bytes payload = 2;
78
+ */
79
+ payload: Uint8Array
80
+ }
81
+
54
82
  /**
55
83
  * Describes the message arrow.flight.protocol.HandshakeResponse.
56
84
  * Use `create(HandshakeResponseSchema)` to create a new message.
57
85
  */
58
- export declare const HandshakeResponseSchema: GenMessage<HandshakeResponse>;
86
+ export declare const HandshakeResponseSchema: GenMessage<HandshakeResponse>
87
+
59
88
  /**
60
89
  *
61
90
  * A message for doing simple auth.
62
91
  *
63
92
  * @generated from message arrow.flight.protocol.BasicAuth
64
93
  */
65
- export type BasicAuth = Message<"arrow.flight.protocol.BasicAuth"> & {
66
- /**
67
- * @generated from field: string username = 2;
68
- */
69
- username: string;
70
- /**
71
- * @generated from field: string password = 3;
72
- */
73
- password: string;
74
- };
94
+ export declare type BasicAuth = Message<"arrow.flight.protocol.BasicAuth"> & {
95
+ /**
96
+ * @generated from field: string username = 2;
97
+ */
98
+ username: string
99
+
100
+ /**
101
+ * @generated from field: string password = 3;
102
+ */
103
+ password: string
104
+ }
105
+
75
106
  /**
76
107
  * Describes the message arrow.flight.protocol.BasicAuth.
77
108
  * Use `create(BasicAuthSchema)` to create a new message.
78
109
  */
79
- export declare const BasicAuthSchema: GenMessage<BasicAuth>;
110
+ export declare const BasicAuthSchema: GenMessage<BasicAuth>
111
+
80
112
  /**
81
113
  * @generated from message arrow.flight.protocol.Empty
82
114
  */
83
- export type Empty = Message<"arrow.flight.protocol.Empty"> & {};
115
+ export declare type Empty = Message<"arrow.flight.protocol.Empty"> & {}
116
+
84
117
  /**
85
118
  * Describes the message arrow.flight.protocol.Empty.
86
119
  * Use `create(EmptySchema)` to create a new message.
87
120
  */
88
- export declare const EmptySchema: GenMessage<Empty>;
121
+ export declare const EmptySchema: GenMessage<Empty>
122
+
89
123
  /**
90
124
  *
91
125
  * Describes an available action, including both the name used for execution
@@ -93,21 +127,24 @@ export declare const EmptySchema: GenMessage<Empty>;
93
127
  *
94
128
  * @generated from message arrow.flight.protocol.ActionType
95
129
  */
96
- export type ActionType = Message<"arrow.flight.protocol.ActionType"> & {
97
- /**
98
- * @generated from field: string type = 1;
99
- */
100
- type: string;
101
- /**
102
- * @generated from field: string description = 2;
103
- */
104
- description: string;
105
- };
130
+ export declare type ActionType = Message<"arrow.flight.protocol.ActionType"> & {
131
+ /**
132
+ * @generated from field: string type = 1;
133
+ */
134
+ type: string
135
+
136
+ /**
137
+ * @generated from field: string description = 2;
138
+ */
139
+ description: string
140
+ }
141
+
106
142
  /**
107
143
  * Describes the message arrow.flight.protocol.ActionType.
108
144
  * Use `create(ActionTypeSchema)` to create a new message.
109
145
  */
110
- export declare const ActionTypeSchema: GenMessage<ActionType>;
146
+ export declare const ActionTypeSchema: GenMessage<ActionType>
147
+
111
148
  /**
112
149
  *
113
150
  * A service specific expression that can be used to return a limited set
@@ -115,77 +152,86 @@ export declare const ActionTypeSchema: GenMessage<ActionType>;
115
152
  *
116
153
  * @generated from message arrow.flight.protocol.Criteria
117
154
  */
118
- export type Criteria = Message<"arrow.flight.protocol.Criteria"> & {
119
- /**
120
- * @generated from field: bytes expression = 1;
121
- */
122
- expression: Uint8Array;
123
- };
155
+ export declare type Criteria = Message<"arrow.flight.protocol.Criteria"> & {
156
+ /**
157
+ * @generated from field: bytes expression = 1;
158
+ */
159
+ expression: Uint8Array
160
+ }
161
+
124
162
  /**
125
163
  * Describes the message arrow.flight.protocol.Criteria.
126
164
  * Use `create(CriteriaSchema)` to create a new message.
127
165
  */
128
- export declare const CriteriaSchema: GenMessage<Criteria>;
166
+ export declare const CriteriaSchema: GenMessage<Criteria>
167
+
129
168
  /**
130
169
  *
131
170
  * An opaque action specific for the service.
132
171
  *
133
172
  * @generated from message arrow.flight.protocol.Action
134
173
  */
135
- export type Action = Message<"arrow.flight.protocol.Action"> & {
136
- /**
137
- * @generated from field: string type = 1;
138
- */
139
- type: string;
140
- /**
141
- * @generated from field: bytes body = 2;
142
- */
143
- body: Uint8Array;
144
- };
174
+ export declare type Action = Message<"arrow.flight.protocol.Action"> & {
175
+ /**
176
+ * @generated from field: string type = 1;
177
+ */
178
+ type: string
179
+
180
+ /**
181
+ * @generated from field: bytes body = 2;
182
+ */
183
+ body: Uint8Array
184
+ }
185
+
145
186
  /**
146
187
  * Describes the message arrow.flight.protocol.Action.
147
188
  * Use `create(ActionSchema)` to create a new message.
148
189
  */
149
- export declare const ActionSchema: GenMessage<Action>;
190
+ export declare const ActionSchema: GenMessage<Action>
191
+
150
192
  /**
151
193
  *
152
194
  * An opaque result returned after executing an action.
153
195
  *
154
196
  * @generated from message arrow.flight.protocol.Result
155
197
  */
156
- export type Result = Message<"arrow.flight.protocol.Result"> & {
157
- /**
158
- * @generated from field: bytes body = 1;
159
- */
160
- body: Uint8Array;
161
- };
198
+ export declare type Result = Message<"arrow.flight.protocol.Result"> & {
199
+ /**
200
+ * @generated from field: bytes body = 1;
201
+ */
202
+ body: Uint8Array
203
+ }
204
+
162
205
  /**
163
206
  * Describes the message arrow.flight.protocol.Result.
164
207
  * Use `create(ResultSchema)` to create a new message.
165
208
  */
166
- export declare const ResultSchema: GenMessage<Result>;
209
+ export declare const ResultSchema: GenMessage<Result>
210
+
167
211
  /**
168
212
  *
169
213
  * Wrap the result of a getSchema call
170
214
  *
171
215
  * @generated from message arrow.flight.protocol.SchemaResult
172
216
  */
173
- export type SchemaResult = Message<"arrow.flight.protocol.SchemaResult"> & {
174
- /**
175
- * The schema of the dataset in its IPC form:
176
- * 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix
177
- * 4 bytes - the byte length of the payload
178
- * a flatbuffer Message whose header is the Schema
179
- *
180
- * @generated from field: bytes schema = 1;
181
- */
182
- schema: Uint8Array;
183
- };
217
+ export declare type SchemaResult = Message<"arrow.flight.protocol.SchemaResult"> & {
218
+ /**
219
+ * The schema of the dataset in its IPC form:
220
+ * 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix
221
+ * 4 bytes - the byte length of the payload
222
+ * a flatbuffer Message whose header is the Schema
223
+ *
224
+ * @generated from field: bytes schema = 1;
225
+ */
226
+ schema: Uint8Array
227
+ }
228
+
184
229
  /**
185
230
  * Describes the message arrow.flight.protocol.SchemaResult.
186
231
  * Use `create(SchemaResultSchema)` to create a new message.
187
232
  */
188
- export declare const SchemaResultSchema: GenMessage<SchemaResult>;
233
+ export declare const SchemaResultSchema: GenMessage<SchemaResult>
234
+
189
235
  /**
190
236
  *
191
237
  * The name or tag for a Flight. May be used as a way to retrieve or generate
@@ -193,67 +239,75 @@ export declare const SchemaResultSchema: GenMessage<SchemaResult>;
193
239
  *
194
240
  * @generated from message arrow.flight.protocol.FlightDescriptor
195
241
  */
196
- export type FlightDescriptor = Message<"arrow.flight.protocol.FlightDescriptor"> & {
197
- /**
198
- * @generated from field: arrow.flight.protocol.FlightDescriptor.DescriptorType type = 1;
199
- */
200
- type: FlightDescriptor_DescriptorType;
201
- /**
202
- *
203
- * Opaque value used to express a command. Should only be defined when
204
- * type = CMD.
205
- *
206
- * @generated from field: bytes cmd = 2;
207
- */
208
- cmd: Uint8Array;
209
- /**
210
- *
211
- * List of strings identifying a particular dataset. Should only be defined
212
- * when type = PATH.
213
- *
214
- * @generated from field: repeated string path = 3;
215
- */
216
- path: string[];
217
- };
242
+ export declare type FlightDescriptor = Message<"arrow.flight.protocol.FlightDescriptor"> & {
243
+ /**
244
+ * @generated from field: arrow.flight.protocol.FlightDescriptor.DescriptorType type = 1;
245
+ */
246
+ type: FlightDescriptor_DescriptorType
247
+
248
+ /**
249
+ *
250
+ * Opaque value used to express a command. Should only be defined when
251
+ * type = CMD.
252
+ *
253
+ * @generated from field: bytes cmd = 2;
254
+ */
255
+ cmd: Uint8Array
256
+
257
+ /**
258
+ *
259
+ * List of strings identifying a particular dataset. Should only be defined
260
+ * when type = PATH.
261
+ *
262
+ * @generated from field: repeated string path = 3;
263
+ */
264
+ path: string[]
265
+ }
266
+
218
267
  /**
219
268
  * Describes the message arrow.flight.protocol.FlightDescriptor.
220
269
  * Use `create(FlightDescriptorSchema)` to create a new message.
221
270
  */
222
- export declare const FlightDescriptorSchema: GenMessage<FlightDescriptor>;
271
+ export declare const FlightDescriptorSchema: GenMessage<FlightDescriptor>
272
+
223
273
  /**
224
274
  *
225
275
  * Describes what type of descriptor is defined.
226
276
  *
227
277
  * @generated from enum arrow.flight.protocol.FlightDescriptor.DescriptorType
228
278
  */
229
- export declare enum FlightDescriptor_DescriptorType {
230
- /**
231
- * Protobuf pattern, not used.
232
- *
233
- * @generated from enum value: UNKNOWN = 0;
234
- */
235
- UNKNOWN = 0,
236
- /**
237
- *
238
- * A named path that identifies a dataset. A path is composed of a string
239
- * or list of strings describing a particular dataset. This is conceptually
240
- * similar to a path inside a filesystem.
241
- *
242
- * @generated from enum value: PATH = 1;
243
- */
244
- PATH = 1,
245
- /**
246
- *
247
- * An opaque command to generate a dataset.
248
- *
249
- * @generated from enum value: CMD = 2;
250
- */
251
- CMD = 2
279
+ export enum FlightDescriptor_DescriptorType {
280
+ /**
281
+ * Protobuf pattern, not used.
282
+ *
283
+ * @generated from enum value: UNKNOWN = 0;
284
+ */
285
+ UNKNOWN = 0,
286
+
287
+ /**
288
+ *
289
+ * A named path that identifies a dataset. A path is composed of a string
290
+ * or list of strings describing a particular dataset. This is conceptually
291
+ * similar to a path inside a filesystem.
292
+ *
293
+ * @generated from enum value: PATH = 1;
294
+ */
295
+ PATH = 1,
296
+
297
+ /**
298
+ *
299
+ * An opaque command to generate a dataset.
300
+ *
301
+ * @generated from enum value: CMD = 2;
302
+ */
303
+ CMD = 2
252
304
  }
305
+
253
306
  /**
254
307
  * Describes the enum arrow.flight.protocol.FlightDescriptor.DescriptorType.
255
308
  */
256
- export declare const FlightDescriptor_DescriptorTypeSchema: GenEnum<FlightDescriptor_DescriptorType>;
309
+ export declare const FlightDescriptor_DescriptorTypeSchema: GenEnum<FlightDescriptor_DescriptorType>
310
+
257
311
  /**
258
312
  *
259
313
  * The access coordinates for retrieval of a dataset. With a FlightInfo, a
@@ -261,147 +315,160 @@ export declare const FlightDescriptor_DescriptorTypeSchema: GenEnum<FlightDescri
261
315
  *
262
316
  * @generated from message arrow.flight.protocol.FlightInfo
263
317
  */
264
- export type FlightInfo = Message<"arrow.flight.protocol.FlightInfo"> & {
265
- /**
266
- * The schema of the dataset in its IPC form:
267
- * 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix
268
- * 4 bytes - the byte length of the payload
269
- * a flatbuffer Message whose header is the Schema
270
- *
271
- * @generated from field: bytes schema = 1;
272
- */
273
- schema: Uint8Array;
274
- /**
275
- *
276
- * The descriptor associated with this info.
277
- *
278
- * @generated from field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;
279
- */
280
- flightDescriptor?: FlightDescriptor;
281
- /**
282
- *
283
- * A list of endpoints associated with the flight. To consume the
284
- * whole flight, all endpoints (and hence all Tickets) must be
285
- * consumed. Endpoints can be consumed in any order.
286
- *
287
- * In other words, an application can use multiple endpoints to
288
- * represent partitioned data.
289
- *
290
- * If the returned data has an ordering, an application can use
291
- * "FlightInfo.ordered = true" or should return all data in a
292
- * single endpoint. Otherwise, there is no ordering defined on
293
- * endpoints or the data within.
294
- *
295
- * A client can read ordered data by reading data from returned
296
- * endpoints, in order, from front to back.
297
- *
298
- * Note that a client may ignore "FlightInfo.ordered = true". If an
299
- * ordering is important for an application, an application must
300
- * choose one of them:
301
- *
302
- * * An application requires that all clients must read data in
303
- * returned endpoints order.
304
- * * An application must return all data in a single endpoint.
305
- *
306
- * @generated from field: repeated arrow.flight.protocol.FlightEndpoint endpoint = 3;
307
- */
308
- endpoint: FlightEndpoint[];
309
- /**
310
- * Set these to -1 if unknown.
311
- *
312
- * @generated from field: int64 total_records = 4;
313
- */
314
- totalRecords: bigint;
315
- /**
316
- * @generated from field: int64 total_bytes = 5;
317
- */
318
- totalBytes: bigint;
319
- /**
320
- *
321
- * FlightEndpoints are in the same order as the data.
322
- *
323
- * @generated from field: bool ordered = 6;
324
- */
325
- ordered: boolean;
326
- /**
327
- *
328
- * Application-defined metadata.
329
- *
330
- * There is no inherent or required relationship between this
331
- * and the app_metadata fields in the FlightEndpoints or resulting
332
- * FlightData messages. Since this metadata is application-defined,
333
- * a given application could define there to be a relationship,
334
- * but there is none required by the spec.
335
- *
336
- * @generated from field: bytes app_metadata = 7;
337
- */
338
- appMetadata: Uint8Array;
339
- };
318
+ export declare type FlightInfo = Message<"arrow.flight.protocol.FlightInfo"> & {
319
+ /**
320
+ * The schema of the dataset in its IPC form:
321
+ * 4 bytes - an optional IPC_CONTINUATION_TOKEN prefix
322
+ * 4 bytes - the byte length of the payload
323
+ * a flatbuffer Message whose header is the Schema
324
+ *
325
+ * @generated from field: bytes schema = 1;
326
+ */
327
+ schema: Uint8Array
328
+
329
+ /**
330
+ *
331
+ * The descriptor associated with this info.
332
+ *
333
+ * @generated from field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;
334
+ */
335
+ flightDescriptor?: FlightDescriptor
336
+
337
+ /**
338
+ *
339
+ * A list of endpoints associated with the flight. To consume the
340
+ * whole flight, all endpoints (and hence all Tickets) must be
341
+ * consumed. Endpoints can be consumed in any order.
342
+ *
343
+ * In other words, an application can use multiple endpoints to
344
+ * represent partitioned data.
345
+ *
346
+ * If the returned data has an ordering, an application can use
347
+ * "FlightInfo.ordered = true" or should return all data in a
348
+ * single endpoint. Otherwise, there is no ordering defined on
349
+ * endpoints or the data within.
350
+ *
351
+ * A client can read ordered data by reading data from returned
352
+ * endpoints, in order, from front to back.
353
+ *
354
+ * Note that a client may ignore "FlightInfo.ordered = true". If an
355
+ * ordering is important for an application, an application must
356
+ * choose one of them:
357
+ *
358
+ * * An application requires that all clients must read data in
359
+ * returned endpoints order.
360
+ * * An application must return all data in a single endpoint.
361
+ *
362
+ * @generated from field: repeated arrow.flight.protocol.FlightEndpoint endpoint = 3;
363
+ */
364
+ endpoint: FlightEndpoint[]
365
+
366
+ /**
367
+ * Set these to -1 if unknown.
368
+ *
369
+ * @generated from field: int64 total_records = 4;
370
+ */
371
+ totalRecords: bigint
372
+
373
+ /**
374
+ * @generated from field: int64 total_bytes = 5;
375
+ */
376
+ totalBytes: bigint
377
+
378
+ /**
379
+ *
380
+ * FlightEndpoints are in the same order as the data.
381
+ *
382
+ * @generated from field: bool ordered = 6;
383
+ */
384
+ ordered: boolean
385
+
386
+ /**
387
+ *
388
+ * Application-defined metadata.
389
+ *
390
+ * There is no inherent or required relationship between this
391
+ * and the app_metadata fields in the FlightEndpoints or resulting
392
+ * FlightData messages. Since this metadata is application-defined,
393
+ * a given application could define there to be a relationship,
394
+ * but there is none required by the spec.
395
+ *
396
+ * @generated from field: bytes app_metadata = 7;
397
+ */
398
+ appMetadata: Uint8Array
399
+ }
400
+
340
401
  /**
341
402
  * Describes the message arrow.flight.protocol.FlightInfo.
342
403
  * Use `create(FlightInfoSchema)` to create a new message.
343
404
  */
344
- export declare const FlightInfoSchema: GenMessage<FlightInfo>;
405
+ export declare const FlightInfoSchema: GenMessage<FlightInfo>
406
+
345
407
  /**
346
408
  *
347
409
  * The information to process a long-running query.
348
410
  *
349
411
  * @generated from message arrow.flight.protocol.PollInfo
350
412
  */
351
- export type PollInfo = Message<"arrow.flight.protocol.PollInfo"> & {
352
- /**
353
- *
354
- * The currently available results.
355
- *
356
- * If "flight_descriptor" is not specified, the query is complete
357
- * and "info" specifies all results. Otherwise, "info" contains
358
- * partial query results.
359
- *
360
- * Note that each PollInfo response contains a complete
361
- * FlightInfo (not just the delta between the previous and current
362
- * FlightInfo).
363
- *
364
- * Subsequent PollInfo responses may only append new endpoints to
365
- * info.
366
- *
367
- * Clients can begin fetching results via DoGet(Ticket) with the
368
- * ticket in the info before the query is
369
- * completed. FlightInfo.ordered is also valid.
370
- *
371
- * @generated from field: arrow.flight.protocol.FlightInfo info = 1;
372
- */
373
- info?: FlightInfo;
374
- /**
375
- *
376
- * The descriptor the client should use on the next try.
377
- * If unset, the query is complete.
378
- *
379
- * @generated from field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;
380
- */
381
- flightDescriptor?: FlightDescriptor;
382
- /**
383
- *
384
- * Query progress. If known, must be in [0.0, 1.0] but need not be
385
- * monotonic or nondecreasing. If unknown, do not set.
386
- *
387
- * @generated from field: optional double progress = 3;
388
- */
389
- progress?: number;
390
- /**
391
- *
392
- * Expiration time for this request. After this passes, the server
393
- * might not accept the retry descriptor anymore (and the query may
394
- * be cancelled). This may be updated on a call to PollFlightInfo.
395
- *
396
- * @generated from field: google.protobuf.Timestamp expiration_time = 4;
397
- */
398
- expirationTime?: Timestamp;
399
- };
413
+ export declare type PollInfo = Message<"arrow.flight.protocol.PollInfo"> & {
414
+ /**
415
+ *
416
+ * The currently available results.
417
+ *
418
+ * If "flight_descriptor" is not specified, the query is complete
419
+ * and "info" specifies all results. Otherwise, "info" contains
420
+ * partial query results.
421
+ *
422
+ * Note that each PollInfo response contains a complete
423
+ * FlightInfo (not just the delta between the previous and current
424
+ * FlightInfo).
425
+ *
426
+ * Subsequent PollInfo responses may only append new endpoints to
427
+ * info.
428
+ *
429
+ * Clients can begin fetching results via DoGet(Ticket) with the
430
+ * ticket in the info before the query is
431
+ * completed. FlightInfo.ordered is also valid.
432
+ *
433
+ * @generated from field: arrow.flight.protocol.FlightInfo info = 1;
434
+ */
435
+ info?: FlightInfo
436
+
437
+ /**
438
+ *
439
+ * The descriptor the client should use on the next try.
440
+ * If unset, the query is complete.
441
+ *
442
+ * @generated from field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 2;
443
+ */
444
+ flightDescriptor?: FlightDescriptor
445
+
446
+ /**
447
+ *
448
+ * Query progress. If known, must be in [0.0, 1.0] but need not be
449
+ * monotonic or nondecreasing. If unknown, do not set.
450
+ *
451
+ * @generated from field: optional double progress = 3;
452
+ */
453
+ progress?: number
454
+
455
+ /**
456
+ *
457
+ * Expiration time for this request. After this passes, the server
458
+ * might not accept the retry descriptor anymore (and the query may
459
+ * be cancelled). This may be updated on a call to PollFlightInfo.
460
+ *
461
+ * @generated from field: google.protobuf.Timestamp expiration_time = 4;
462
+ */
463
+ expirationTime?: Timestamp
464
+ }
465
+
400
466
  /**
401
467
  * Describes the message arrow.flight.protocol.PollInfo.
402
468
  * Use `create(PollInfoSchema)` to create a new message.
403
469
  */
404
- export declare const PollInfoSchema: GenMessage<PollInfo>;
470
+ export declare const PollInfoSchema: GenMessage<PollInfo>
471
+
405
472
  /**
406
473
  *
407
474
  * The request of the CancelFlightInfo action.
@@ -410,17 +477,20 @@ export declare const PollInfoSchema: GenMessage<PollInfo>;
410
477
  *
411
478
  * @generated from message arrow.flight.protocol.CancelFlightInfoRequest
412
479
  */
413
- export type CancelFlightInfoRequest = Message<"arrow.flight.protocol.CancelFlightInfoRequest"> & {
480
+ export declare type CancelFlightInfoRequest =
481
+ Message<"arrow.flight.protocol.CancelFlightInfoRequest"> & {
414
482
  /**
415
483
  * @generated from field: arrow.flight.protocol.FlightInfo info = 1;
416
484
  */
417
- info?: FlightInfo;
418
- };
485
+ info?: FlightInfo
486
+ }
487
+
419
488
  /**
420
489
  * Describes the message arrow.flight.protocol.CancelFlightInfoRequest.
421
490
  * Use `create(CancelFlightInfoRequestSchema)` to create a new message.
422
491
  */
423
- export declare const CancelFlightInfoRequestSchema: GenMessage<CancelFlightInfoRequest>;
492
+ export declare const CancelFlightInfoRequestSchema: GenMessage<CancelFlightInfoRequest>
493
+
424
494
  /**
425
495
  *
426
496
  * The result of the CancelFlightInfo action.
@@ -429,17 +499,20 @@ export declare const CancelFlightInfoRequestSchema: GenMessage<CancelFlightInfoR
429
499
  *
430
500
  * @generated from message arrow.flight.protocol.CancelFlightInfoResult
431
501
  */
432
- export type CancelFlightInfoResult = Message<"arrow.flight.protocol.CancelFlightInfoResult"> & {
502
+ export declare type CancelFlightInfoResult =
503
+ Message<"arrow.flight.protocol.CancelFlightInfoResult"> & {
433
504
  /**
434
505
  * @generated from field: arrow.flight.protocol.CancelStatus status = 1;
435
506
  */
436
- status: CancelStatus;
437
- };
507
+ status: CancelStatus
508
+ }
509
+
438
510
  /**
439
511
  * Describes the message arrow.flight.protocol.CancelFlightInfoResult.
440
512
  * Use `create(CancelFlightInfoResultSchema)` to create a new message.
441
513
  */
442
- export declare const CancelFlightInfoResultSchema: GenMessage<CancelFlightInfoResult>;
514
+ export declare const CancelFlightInfoResultSchema: GenMessage<CancelFlightInfoResult>
515
+
443
516
  /**
444
517
  *
445
518
  * An opaque identifier that the service can use to retrieve a particular
@@ -450,17 +523,19 @@ export declare const CancelFlightInfoResultSchema: GenMessage<CancelFlightInfoRe
450
523
  *
451
524
  * @generated from message arrow.flight.protocol.Ticket
452
525
  */
453
- export type Ticket = Message<"arrow.flight.protocol.Ticket"> & {
454
- /**
455
- * @generated from field: bytes ticket = 1;
456
- */
457
- ticket: Uint8Array;
458
- };
526
+ export declare type Ticket = Message<"arrow.flight.protocol.Ticket"> & {
527
+ /**
528
+ * @generated from field: bytes ticket = 1;
529
+ */
530
+ ticket: Uint8Array
531
+ }
532
+
459
533
  /**
460
534
  * Describes the message arrow.flight.protocol.Ticket.
461
535
  * Use `create(TicketSchema)` to create a new message.
462
536
  */
463
- export declare const TicketSchema: GenMessage<Ticket>;
537
+ export declare const TicketSchema: GenMessage<Ticket>
538
+
464
539
  /**
465
540
  *
466
541
  * A location to retrieve a particular stream from. This URI should be one of
@@ -501,83 +576,90 @@ export declare const TicketSchema: GenMessage<Ticket>;
501
576
  *
502
577
  * @generated from message arrow.flight.protocol.Location
503
578
  */
504
- export type Location = Message<"arrow.flight.protocol.Location"> & {
505
- /**
506
- * @generated from field: string uri = 1;
507
- */
508
- uri: string;
509
- };
579
+ export declare type Location = Message<"arrow.flight.protocol.Location"> & {
580
+ /**
581
+ * @generated from field: string uri = 1;
582
+ */
583
+ uri: string
584
+ }
585
+
510
586
  /**
511
587
  * Describes the message arrow.flight.protocol.Location.
512
588
  * Use `create(LocationSchema)` to create a new message.
513
589
  */
514
- export declare const LocationSchema: GenMessage<Location>;
590
+ export declare const LocationSchema: GenMessage<Location>
591
+
515
592
  /**
516
593
  *
517
594
  * A particular stream or split associated with a flight.
518
595
  *
519
596
  * @generated from message arrow.flight.protocol.FlightEndpoint
520
597
  */
521
- export type FlightEndpoint = Message<"arrow.flight.protocol.FlightEndpoint"> & {
522
- /**
523
- *
524
- * Token used to retrieve this stream.
525
- *
526
- * @generated from field: arrow.flight.protocol.Ticket ticket = 1;
527
- */
528
- ticket?: Ticket;
529
- /**
530
- *
531
- * A list of URIs where this ticket can be redeemed via DoGet().
532
- *
533
- * If the list is empty, the expectation is that the ticket can only
534
- * be redeemed on the current service where the ticket was
535
- * generated.
536
- *
537
- * If the list is not empty, the expectation is that the ticket can be
538
- * redeemed at any of the locations, and that the data returned will be
539
- * equivalent. In this case, the ticket may only be redeemed at one of the
540
- * given locations, and not (necessarily) on the current service. If one
541
- * of the given locations is "arrow-flight-reuse-connection://?", the
542
- * client may redeem the ticket on the service where the ticket was
543
- * generated (i.e., the same as above), in addition to the other
544
- * locations. (This URI was chosen to maximize compatibility, as 'scheme:'
545
- * or 'scheme://' are not accepted by Java's java.net.URI.)
546
- *
547
- * In other words, an application can use multiple locations to
548
- * represent redundant and/or load balanced services.
549
- *
550
- * @generated from field: repeated arrow.flight.protocol.Location location = 2;
551
- */
552
- location: Location[];
553
- /**
554
- *
555
- * Expiration time of this stream. If present, clients may assume
556
- * they can retry DoGet requests. Otherwise, it is
557
- * application-defined whether DoGet requests may be retried.
558
- *
559
- * @generated from field: google.protobuf.Timestamp expiration_time = 3;
560
- */
561
- expirationTime?: Timestamp;
562
- /**
563
- *
564
- * Application-defined metadata.
565
- *
566
- * There is no inherent or required relationship between this
567
- * and the app_metadata fields in the FlightInfo or resulting
568
- * FlightData messages. Since this metadata is application-defined,
569
- * a given application could define there to be a relationship,
570
- * but there is none required by the spec.
571
- *
572
- * @generated from field: bytes app_metadata = 4;
573
- */
574
- appMetadata: Uint8Array;
575
- };
598
+ export declare type FlightEndpoint = Message<"arrow.flight.protocol.FlightEndpoint"> & {
599
+ /**
600
+ *
601
+ * Token used to retrieve this stream.
602
+ *
603
+ * @generated from field: arrow.flight.protocol.Ticket ticket = 1;
604
+ */
605
+ ticket?: Ticket
606
+
607
+ /**
608
+ *
609
+ * A list of URIs where this ticket can be redeemed via DoGet().
610
+ *
611
+ * If the list is empty, the expectation is that the ticket can only
612
+ * be redeemed on the current service where the ticket was
613
+ * generated.
614
+ *
615
+ * If the list is not empty, the expectation is that the ticket can be
616
+ * redeemed at any of the locations, and that the data returned will be
617
+ * equivalent. In this case, the ticket may only be redeemed at one of the
618
+ * given locations, and not (necessarily) on the current service. If one
619
+ * of the given locations is "arrow-flight-reuse-connection://?", the
620
+ * client may redeem the ticket on the service where the ticket was
621
+ * generated (i.e., the same as above), in addition to the other
622
+ * locations. (This URI was chosen to maximize compatibility, as 'scheme:'
623
+ * or 'scheme://' are not accepted by Java's java.net.URI.)
624
+ *
625
+ * In other words, an application can use multiple locations to
626
+ * represent redundant and/or load balanced services.
627
+ *
628
+ * @generated from field: repeated arrow.flight.protocol.Location location = 2;
629
+ */
630
+ location: Location[]
631
+
632
+ /**
633
+ *
634
+ * Expiration time of this stream. If present, clients may assume
635
+ * they can retry DoGet requests. Otherwise, it is
636
+ * application-defined whether DoGet requests may be retried.
637
+ *
638
+ * @generated from field: google.protobuf.Timestamp expiration_time = 3;
639
+ */
640
+ expirationTime?: Timestamp
641
+
642
+ /**
643
+ *
644
+ * Application-defined metadata.
645
+ *
646
+ * There is no inherent or required relationship between this
647
+ * and the app_metadata fields in the FlightInfo or resulting
648
+ * FlightData messages. Since this metadata is application-defined,
649
+ * a given application could define there to be a relationship,
650
+ * but there is none required by the spec.
651
+ *
652
+ * @generated from field: bytes app_metadata = 4;
653
+ */
654
+ appMetadata: Uint8Array
655
+ }
656
+
576
657
  /**
577
658
  * Describes the message arrow.flight.protocol.FlightEndpoint.
578
659
  * Use `create(FlightEndpointSchema)` to create a new message.
579
660
  */
580
- export declare const FlightEndpointSchema: GenMessage<FlightEndpoint>;
661
+ export declare const FlightEndpointSchema: GenMessage<FlightEndpoint>
662
+
581
663
  /**
582
664
  *
583
665
  * The request of the RenewFlightEndpoint action.
@@ -586,79 +668,89 @@ export declare const FlightEndpointSchema: GenMessage<FlightEndpoint>;
586
668
  *
587
669
  * @generated from message arrow.flight.protocol.RenewFlightEndpointRequest
588
670
  */
589
- export type RenewFlightEndpointRequest = Message<"arrow.flight.protocol.RenewFlightEndpointRequest"> & {
671
+ export declare type RenewFlightEndpointRequest =
672
+ Message<"arrow.flight.protocol.RenewFlightEndpointRequest"> & {
590
673
  /**
591
674
  * @generated from field: arrow.flight.protocol.FlightEndpoint endpoint = 1;
592
675
  */
593
- endpoint?: FlightEndpoint;
594
- };
676
+ endpoint?: FlightEndpoint
677
+ }
678
+
595
679
  /**
596
680
  * Describes the message arrow.flight.protocol.RenewFlightEndpointRequest.
597
681
  * Use `create(RenewFlightEndpointRequestSchema)` to create a new message.
598
682
  */
599
- export declare const RenewFlightEndpointRequestSchema: GenMessage<RenewFlightEndpointRequest>;
683
+ export declare const RenewFlightEndpointRequestSchema: GenMessage<RenewFlightEndpointRequest>
684
+
600
685
  /**
601
686
  *
602
687
  * A batch of Arrow data as part of a stream of batches.
603
688
  *
604
689
  * @generated from message arrow.flight.protocol.FlightData
605
690
  */
606
- export type FlightData = Message<"arrow.flight.protocol.FlightData"> & {
607
- /**
608
- *
609
- * The descriptor of the data. This is only relevant when a client is
610
- * starting a new DoPut stream.
611
- *
612
- * @generated from field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 1;
613
- */
614
- flightDescriptor?: FlightDescriptor;
615
- /**
616
- *
617
- * Header for message data as described in Message.fbs::Message.
618
- *
619
- * @generated from field: bytes data_header = 2;
620
- */
621
- dataHeader: Uint8Array;
622
- /**
623
- *
624
- * Application-defined metadata.
625
- *
626
- * @generated from field: bytes app_metadata = 3;
627
- */
628
- appMetadata: Uint8Array;
629
- /**
630
- *
631
- * The actual batch of Arrow data. Preferably handled with minimal-copies
632
- * coming last in the definition to help with sidecar patterns (it is
633
- * expected that some implementations will fetch this field off the wire
634
- * with specialized code to avoid extra memory copies).
635
- *
636
- * @generated from field: bytes data_body = 1000;
637
- */
638
- dataBody: Uint8Array;
639
- };
691
+ export declare type FlightData = Message<"arrow.flight.protocol.FlightData"> & {
692
+ /**
693
+ *
694
+ * The descriptor of the data. This is only relevant when a client is
695
+ * starting a new DoPut stream.
696
+ *
697
+ * @generated from field: arrow.flight.protocol.FlightDescriptor flight_descriptor = 1;
698
+ */
699
+ flightDescriptor?: FlightDescriptor
700
+
701
+ /**
702
+ *
703
+ * Header for message data as described in Message.fbs::Message.
704
+ *
705
+ * @generated from field: bytes data_header = 2;
706
+ */
707
+ dataHeader: Uint8Array
708
+
709
+ /**
710
+ *
711
+ * Application-defined metadata.
712
+ *
713
+ * @generated from field: bytes app_metadata = 3;
714
+ */
715
+ appMetadata: Uint8Array
716
+
717
+ /**
718
+ *
719
+ * The actual batch of Arrow data. Preferably handled with minimal-copies
720
+ * coming last in the definition to help with sidecar patterns (it is
721
+ * expected that some implementations will fetch this field off the wire
722
+ * with specialized code to avoid extra memory copies).
723
+ *
724
+ * @generated from field: bytes data_body = 1000;
725
+ */
726
+ dataBody: Uint8Array
727
+ }
728
+
640
729
  /**
641
730
  * Describes the message arrow.flight.protocol.FlightData.
642
731
  * Use `create(FlightDataSchema)` to create a new message.
643
732
  */
644
- export declare const FlightDataSchema: GenMessage<FlightData>;
733
+ export declare const FlightDataSchema: GenMessage<FlightData>
734
+
645
735
  /**
646
736
  * *
647
737
  * The response message associated with the submission of a DoPut.
648
738
  *
649
739
  * @generated from message arrow.flight.protocol.PutResult
650
740
  */
651
- export type PutResult = Message<"arrow.flight.protocol.PutResult"> & {
652
- /**
653
- * @generated from field: bytes app_metadata = 1;
654
- */
655
- appMetadata: Uint8Array;
656
- };
741
+ export declare type PutResult = Message<"arrow.flight.protocol.PutResult"> & {
742
+ /**
743
+ * @generated from field: bytes app_metadata = 1;
744
+ */
745
+ appMetadata: Uint8Array
746
+ }
747
+
657
748
  /**
658
749
  * Describes the message arrow.flight.protocol.PutResult.
659
750
  * Use `create(PutResultSchema)` to create a new message.
660
751
  */
661
- export declare const PutResultSchema: GenMessage<PutResult>;
752
+ export declare const PutResultSchema: GenMessage<PutResult>
753
+
662
754
  /**
663
755
  *
664
756
  * EXPERIMENTAL: Union of possible value types for a Session Option to be set to.
@@ -668,64 +760,72 @@ export declare const PutResultSchema: GenMessage<PutResult>;
668
760
  *
669
761
  * @generated from message arrow.flight.protocol.SessionOptionValue
670
762
  */
671
- export type SessionOptionValue = Message<"arrow.flight.protocol.SessionOptionValue"> & {
672
- /**
673
- * @generated from oneof arrow.flight.protocol.SessionOptionValue.option_value
674
- */
675
- optionValue: {
763
+ export declare type SessionOptionValue = Message<"arrow.flight.protocol.SessionOptionValue"> & {
764
+ /**
765
+ * @generated from oneof arrow.flight.protocol.SessionOptionValue.option_value
766
+ */
767
+ optionValue:
768
+ | {
676
769
  /**
677
770
  * @generated from field: string string_value = 1;
678
771
  */
679
- value: string;
680
- case: "stringValue";
681
- } | {
772
+ value: string
773
+ case: "stringValue"
774
+ }
775
+ | {
682
776
  /**
683
777
  * @generated from field: bool bool_value = 2;
684
778
  */
685
- value: boolean;
686
- case: "boolValue";
687
- } | {
779
+ value: boolean
780
+ case: "boolValue"
781
+ }
782
+ | {
688
783
  /**
689
784
  * @generated from field: sfixed64 int64_value = 3;
690
785
  */
691
- value: bigint;
692
- case: "int64Value";
693
- } | {
786
+ value: bigint
787
+ case: "int64Value"
788
+ }
789
+ | {
694
790
  /**
695
791
  * @generated from field: double double_value = 4;
696
792
  */
697
- value: number;
698
- case: "doubleValue";
699
- } | {
793
+ value: number
794
+ case: "doubleValue"
795
+ }
796
+ | {
700
797
  /**
701
798
  * @generated from field: arrow.flight.protocol.SessionOptionValue.StringListValue string_list_value = 5;
702
799
  */
703
- value: SessionOptionValue_StringListValue;
704
- case: "stringListValue";
705
- } | {
706
- case: undefined;
707
- value?: undefined;
708
- };
709
- };
800
+ value: SessionOptionValue_StringListValue
801
+ case: "stringListValue"
802
+ }
803
+ | { case: undefined; value?: undefined }
804
+ }
805
+
710
806
  /**
711
807
  * Describes the message arrow.flight.protocol.SessionOptionValue.
712
808
  * Use `create(SessionOptionValueSchema)` to create a new message.
713
809
  */
714
- export declare const SessionOptionValueSchema: GenMessage<SessionOptionValue>;
810
+ export declare const SessionOptionValueSchema: GenMessage<SessionOptionValue>
811
+
715
812
  /**
716
813
  * @generated from message arrow.flight.protocol.SessionOptionValue.StringListValue
717
814
  */
718
- export type SessionOptionValue_StringListValue = Message<"arrow.flight.protocol.SessionOptionValue.StringListValue"> & {
815
+ export declare type SessionOptionValue_StringListValue =
816
+ Message<"arrow.flight.protocol.SessionOptionValue.StringListValue"> & {
719
817
  /**
720
818
  * @generated from field: repeated string values = 1;
721
819
  */
722
- values: string[];
723
- };
820
+ values: string[]
821
+ }
822
+
724
823
  /**
725
824
  * Describes the message arrow.flight.protocol.SessionOptionValue.StringListValue.
726
825
  * Use `create(SessionOptionValue_StringListValueSchema)` to create a new message.
727
826
  */
728
- export declare const SessionOptionValue_StringListValueSchema: GenMessage<SessionOptionValue_StringListValue>;
827
+ export declare const SessionOptionValue_StringListValueSchema: GenMessage<SessionOptionValue_StringListValue>
828
+
729
829
  /**
730
830
  *
731
831
  * EXPERIMENTAL: A request to set session options for an existing or new (implicit)
@@ -743,19 +843,20 @@ export declare const SessionOptionValue_StringListValueSchema: GenMessage<Sessio
743
843
  *
744
844
  * @generated from message arrow.flight.protocol.SetSessionOptionsRequest
745
845
  */
746
- export type SetSessionOptionsRequest = Message<"arrow.flight.protocol.SetSessionOptionsRequest"> & {
846
+ export declare type SetSessionOptionsRequest =
847
+ Message<"arrow.flight.protocol.SetSessionOptionsRequest"> & {
747
848
  /**
748
849
  * @generated from field: map<string, arrow.flight.protocol.SessionOptionValue> session_options = 1;
749
850
  */
750
- sessionOptions: {
751
- [key: string]: SessionOptionValue;
752
- };
753
- };
851
+ sessionOptions: { [key: string]: SessionOptionValue }
852
+ }
853
+
754
854
  /**
755
855
  * Describes the message arrow.flight.protocol.SetSessionOptionsRequest.
756
856
  * Use `create(SetSessionOptionsRequestSchema)` to create a new message.
757
857
  */
758
- export declare const SetSessionOptionsRequestSchema: GenMessage<SetSessionOptionsRequest>;
858
+ export declare const SetSessionOptionsRequestSchema: GenMessage<SetSessionOptionsRequest>
859
+
759
860
  /**
760
861
  *
761
862
  * EXPERIMENTAL: The results (individually) of setting a set of session options.
@@ -766,67 +867,76 @@ export declare const SetSessionOptionsRequestSchema: GenMessage<SetSessionOption
766
867
  *
767
868
  * @generated from message arrow.flight.protocol.SetSessionOptionsResult
768
869
  */
769
- export type SetSessionOptionsResult = Message<"arrow.flight.protocol.SetSessionOptionsResult"> & {
870
+ export declare type SetSessionOptionsResult =
871
+ Message<"arrow.flight.protocol.SetSessionOptionsResult"> & {
770
872
  /**
771
873
  * @generated from field: map<string, arrow.flight.protocol.SetSessionOptionsResult.Error> errors = 1;
772
874
  */
773
- errors: {
774
- [key: string]: SetSessionOptionsResult_Error;
775
- };
776
- };
875
+ errors: { [key: string]: SetSessionOptionsResult_Error }
876
+ }
877
+
777
878
  /**
778
879
  * Describes the message arrow.flight.protocol.SetSessionOptionsResult.
779
880
  * Use `create(SetSessionOptionsResultSchema)` to create a new message.
780
881
  */
781
- export declare const SetSessionOptionsResultSchema: GenMessage<SetSessionOptionsResult>;
882
+ export declare const SetSessionOptionsResultSchema: GenMessage<SetSessionOptionsResult>
883
+
782
884
  /**
783
885
  * @generated from message arrow.flight.protocol.SetSessionOptionsResult.Error
784
886
  */
785
- export type SetSessionOptionsResult_Error = Message<"arrow.flight.protocol.SetSessionOptionsResult.Error"> & {
887
+ export declare type SetSessionOptionsResult_Error =
888
+ Message<"arrow.flight.protocol.SetSessionOptionsResult.Error"> & {
786
889
  /**
787
890
  * @generated from field: arrow.flight.protocol.SetSessionOptionsResult.ErrorValue value = 1;
788
891
  */
789
- value: SetSessionOptionsResult_ErrorValue;
790
- };
892
+ value: SetSessionOptionsResult_ErrorValue
893
+ }
894
+
791
895
  /**
792
896
  * Describes the message arrow.flight.protocol.SetSessionOptionsResult.Error.
793
897
  * Use `create(SetSessionOptionsResult_ErrorSchema)` to create a new message.
794
898
  */
795
- export declare const SetSessionOptionsResult_ErrorSchema: GenMessage<SetSessionOptionsResult_Error>;
899
+ export declare const SetSessionOptionsResult_ErrorSchema: GenMessage<SetSessionOptionsResult_Error>
900
+
796
901
  /**
797
902
  * @generated from enum arrow.flight.protocol.SetSessionOptionsResult.ErrorValue
798
903
  */
799
- export declare enum SetSessionOptionsResult_ErrorValue {
800
- /**
801
- * Protobuf deserialization fallback value: The status is unknown or unrecognized.
802
- * Servers should avoid using this value. The request may be retried by the client.
803
- *
804
- * @generated from enum value: UNSPECIFIED = 0;
805
- */
806
- UNSPECIFIED = 0,
807
- /**
808
- * The given session option name is invalid.
809
- *
810
- * @generated from enum value: INVALID_NAME = 1;
811
- */
812
- INVALID_NAME = 1,
813
- /**
814
- * The session option value or type is invalid.
815
- *
816
- * @generated from enum value: INVALID_VALUE = 2;
817
- */
818
- INVALID_VALUE = 2,
819
- /**
820
- * The session option cannot be set.
821
- *
822
- * @generated from enum value: ERROR = 3;
823
- */
824
- ERROR = 3
904
+ export enum SetSessionOptionsResult_ErrorValue {
905
+ /**
906
+ * Protobuf deserialization fallback value: The status is unknown or unrecognized.
907
+ * Servers should avoid using this value. The request may be retried by the client.
908
+ *
909
+ * @generated from enum value: UNSPECIFIED = 0;
910
+ */
911
+ UNSPECIFIED = 0,
912
+
913
+ /**
914
+ * The given session option name is invalid.
915
+ *
916
+ * @generated from enum value: INVALID_NAME = 1;
917
+ */
918
+ INVALID_NAME = 1,
919
+
920
+ /**
921
+ * The session option value or type is invalid.
922
+ *
923
+ * @generated from enum value: INVALID_VALUE = 2;
924
+ */
925
+ INVALID_VALUE = 2,
926
+
927
+ /**
928
+ * The session option cannot be set.
929
+ *
930
+ * @generated from enum value: ERROR = 3;
931
+ */
932
+ ERROR = 3
825
933
  }
934
+
826
935
  /**
827
936
  * Describes the enum arrow.flight.protocol.SetSessionOptionsResult.ErrorValue.
828
937
  */
829
- export declare const SetSessionOptionsResult_ErrorValueSchema: GenEnum<SetSessionOptionsResult_ErrorValue>;
938
+ export declare const SetSessionOptionsResult_ErrorValueSchema: GenEnum<SetSessionOptionsResult_ErrorValue>
939
+
830
940
  /**
831
941
  *
832
942
  * EXPERIMENTAL: A request to access the session options for the current server session.
@@ -838,31 +948,35 @@ export declare const SetSessionOptionsResult_ErrorValueSchema: GenEnum<SetSessio
838
948
  *
839
949
  * @generated from message arrow.flight.protocol.GetSessionOptionsRequest
840
950
  */
841
- export type GetSessionOptionsRequest = Message<"arrow.flight.protocol.GetSessionOptionsRequest"> & {};
951
+ export declare type GetSessionOptionsRequest =
952
+ Message<"arrow.flight.protocol.GetSessionOptionsRequest"> & {}
953
+
842
954
  /**
843
955
  * Describes the message arrow.flight.protocol.GetSessionOptionsRequest.
844
956
  * Use `create(GetSessionOptionsRequestSchema)` to create a new message.
845
957
  */
846
- export declare const GetSessionOptionsRequestSchema: GenMessage<GetSessionOptionsRequest>;
958
+ export declare const GetSessionOptionsRequestSchema: GenMessage<GetSessionOptionsRequest>
959
+
847
960
  /**
848
961
  *
849
962
  * EXPERIMENTAL: The result containing the current server session options.
850
963
  *
851
964
  * @generated from message arrow.flight.protocol.GetSessionOptionsResult
852
965
  */
853
- export type GetSessionOptionsResult = Message<"arrow.flight.protocol.GetSessionOptionsResult"> & {
966
+ export declare type GetSessionOptionsResult =
967
+ Message<"arrow.flight.protocol.GetSessionOptionsResult"> & {
854
968
  /**
855
969
  * @generated from field: map<string, arrow.flight.protocol.SessionOptionValue> session_options = 1;
856
970
  */
857
- sessionOptions: {
858
- [key: string]: SessionOptionValue;
859
- };
860
- };
971
+ sessionOptions: { [key: string]: SessionOptionValue }
972
+ }
973
+
861
974
  /**
862
975
  * Describes the message arrow.flight.protocol.GetSessionOptionsResult.
863
976
  * Use `create(GetSessionOptionsResultSchema)` to create a new message.
864
977
  */
865
- export declare const GetSessionOptionsResultSchema: GenMessage<GetSessionOptionsResult>;
978
+ export declare const GetSessionOptionsResultSchema: GenMessage<GetSessionOptionsResult>
979
+
866
980
  /**
867
981
  *
868
982
  * Request message for the "Close Session" action.
@@ -871,67 +985,76 @@ export declare const GetSessionOptionsResultSchema: GenMessage<GetSessionOptions
871
985
  *
872
986
  * @generated from message arrow.flight.protocol.CloseSessionRequest
873
987
  */
874
- export type CloseSessionRequest = Message<"arrow.flight.protocol.CloseSessionRequest"> & {};
988
+ export declare type CloseSessionRequest = Message<"arrow.flight.protocol.CloseSessionRequest"> & {}
989
+
875
990
  /**
876
991
  * Describes the message arrow.flight.protocol.CloseSessionRequest.
877
992
  * Use `create(CloseSessionRequestSchema)` to create a new message.
878
993
  */
879
- export declare const CloseSessionRequestSchema: GenMessage<CloseSessionRequest>;
994
+ export declare const CloseSessionRequestSchema: GenMessage<CloseSessionRequest>
995
+
880
996
  /**
881
997
  *
882
998
  * The result of closing a session.
883
999
  *
884
1000
  * @generated from message arrow.flight.protocol.CloseSessionResult
885
1001
  */
886
- export type CloseSessionResult = Message<"arrow.flight.protocol.CloseSessionResult"> & {
887
- /**
888
- * @generated from field: arrow.flight.protocol.CloseSessionResult.Status status = 1;
889
- */
890
- status: CloseSessionResult_Status;
891
- };
1002
+ export declare type CloseSessionResult = Message<"arrow.flight.protocol.CloseSessionResult"> & {
1003
+ /**
1004
+ * @generated from field: arrow.flight.protocol.CloseSessionResult.Status status = 1;
1005
+ */
1006
+ status: CloseSessionResult_Status
1007
+ }
1008
+
892
1009
  /**
893
1010
  * Describes the message arrow.flight.protocol.CloseSessionResult.
894
1011
  * Use `create(CloseSessionResultSchema)` to create a new message.
895
1012
  */
896
- export declare const CloseSessionResultSchema: GenMessage<CloseSessionResult>;
1013
+ export declare const CloseSessionResultSchema: GenMessage<CloseSessionResult>
1014
+
897
1015
  /**
898
1016
  * @generated from enum arrow.flight.protocol.CloseSessionResult.Status
899
1017
  */
900
- export declare enum CloseSessionResult_Status {
901
- /**
902
- * Protobuf deserialization fallback value: The session close status is unknown or
903
- * not recognized. Servers should avoid using this value (send a NOT_FOUND error if
904
- * the requested session is not known or expired). Clients can retry the request.
905
- *
906
- * @generated from enum value: UNSPECIFIED = 0;
907
- */
908
- UNSPECIFIED = 0,
909
- /**
910
- * The session close request is complete. Subsequent requests with
911
- * the same session produce a NOT_FOUND error.
912
- *
913
- * @generated from enum value: CLOSED = 1;
914
- */
915
- CLOSED = 1,
916
- /**
917
- * The session close request is in progress. The client may retry
918
- * the close request.
919
- *
920
- * @generated from enum value: CLOSING = 2;
921
- */
922
- CLOSING = 2,
923
- /**
924
- * The session is not closeable. The client should not retry the
925
- * close request.
926
- *
927
- * @generated from enum value: NOT_CLOSEABLE = 3;
928
- */
929
- NOT_CLOSEABLE = 3
1018
+ export enum CloseSessionResult_Status {
1019
+ /**
1020
+ * Protobuf deserialization fallback value: The session close status is unknown or
1021
+ * not recognized. Servers should avoid using this value (send a NOT_FOUND error if
1022
+ * the requested session is not known or expired). Clients can retry the request.
1023
+ *
1024
+ * @generated from enum value: UNSPECIFIED = 0;
1025
+ */
1026
+ UNSPECIFIED = 0,
1027
+
1028
+ /**
1029
+ * The session close request is complete. Subsequent requests with
1030
+ * the same session produce a NOT_FOUND error.
1031
+ *
1032
+ * @generated from enum value: CLOSED = 1;
1033
+ */
1034
+ CLOSED = 1,
1035
+
1036
+ /**
1037
+ * The session close request is in progress. The client may retry
1038
+ * the close request.
1039
+ *
1040
+ * @generated from enum value: CLOSING = 2;
1041
+ */
1042
+ CLOSING = 2,
1043
+
1044
+ /**
1045
+ * The session is not closeable. The client should not retry the
1046
+ * close request.
1047
+ *
1048
+ * @generated from enum value: NOT_CLOSEABLE = 3;
1049
+ */
1050
+ NOT_CLOSEABLE = 3
930
1051
  }
1052
+
931
1053
  /**
932
1054
  * Describes the enum arrow.flight.protocol.CloseSessionResult.Status.
933
1055
  */
934
- export declare const CloseSessionResult_StatusSchema: GenEnum<CloseSessionResult_Status>;
1056
+ export declare const CloseSessionResult_StatusSchema: GenEnum<CloseSessionResult_Status>
1057
+
935
1058
  /**
936
1059
  *
937
1060
  * The result of a cancel operation.
@@ -940,41 +1063,46 @@ export declare const CloseSessionResult_StatusSchema: GenEnum<CloseSessionResult
940
1063
  *
941
1064
  * @generated from enum arrow.flight.protocol.CancelStatus
942
1065
  */
943
- export declare enum CancelStatus {
944
- /**
945
- * The cancellation status is unknown. Servers should avoid using
946
- * this value (send a NOT_FOUND error if the requested query is
947
- * not known). Clients can retry the request.
948
- *
949
- * @generated from enum value: CANCEL_STATUS_UNSPECIFIED = 0;
950
- */
951
- UNSPECIFIED = 0,
952
- /**
953
- * The cancellation request is complete. Subsequent requests with
954
- * the same payload may return CANCELLED or a NOT_FOUND error.
955
- *
956
- * @generated from enum value: CANCEL_STATUS_CANCELLED = 1;
957
- */
958
- CANCELLED = 1,
959
- /**
960
- * The cancellation request is in progress. The client may retry
961
- * the cancellation request.
962
- *
963
- * @generated from enum value: CANCEL_STATUS_CANCELLING = 2;
964
- */
965
- CANCELLING = 2,
966
- /**
967
- * The query is not cancellable. The client should not retry the
968
- * cancellation request.
969
- *
970
- * @generated from enum value: CANCEL_STATUS_NOT_CANCELLABLE = 3;
971
- */
972
- NOT_CANCELLABLE = 3
1066
+ export enum CancelStatus {
1067
+ /**
1068
+ * The cancellation status is unknown. Servers should avoid using
1069
+ * this value (send a NOT_FOUND error if the requested query is
1070
+ * not known). Clients can retry the request.
1071
+ *
1072
+ * @generated from enum value: CANCEL_STATUS_UNSPECIFIED = 0;
1073
+ */
1074
+ UNSPECIFIED = 0,
1075
+
1076
+ /**
1077
+ * The cancellation request is complete. Subsequent requests with
1078
+ * the same payload may return CANCELLED or a NOT_FOUND error.
1079
+ *
1080
+ * @generated from enum value: CANCEL_STATUS_CANCELLED = 1;
1081
+ */
1082
+ CANCELLED = 1,
1083
+
1084
+ /**
1085
+ * The cancellation request is in progress. The client may retry
1086
+ * the cancellation request.
1087
+ *
1088
+ * @generated from enum value: CANCEL_STATUS_CANCELLING = 2;
1089
+ */
1090
+ CANCELLING = 2,
1091
+
1092
+ /**
1093
+ * The query is not cancellable. The client should not retry the
1094
+ * cancellation request.
1095
+ *
1096
+ * @generated from enum value: CANCEL_STATUS_NOT_CANCELLABLE = 3;
1097
+ */
1098
+ NOT_CANCELLABLE = 3
973
1099
  }
1100
+
974
1101
  /**
975
1102
  * Describes the enum arrow.flight.protocol.CancelStatus.
976
1103
  */
977
- export declare const CancelStatusSchema: GenEnum<CancelStatus>;
1104
+ export declare const CancelStatusSchema: GenEnum<CancelStatus>
1105
+
978
1106
  /**
979
1107
  *
980
1108
  * A flight service is an endpoint for retrieving or storing Arrow data. A
@@ -985,175 +1113,174 @@ export declare const CancelStatusSchema: GenEnum<CancelStatus>;
985
1113
  * @generated from service arrow.flight.protocol.FlightService
986
1114
  */
987
1115
  export declare const FlightService: GenService<{
988
- /**
989
- *
990
- * Handshake between client and server. Depending on the server, the
991
- * handshake may be required to determine the token that should be used for
992
- * future operations. Both request and response are streams to allow multiple
993
- * round-trips depending on auth mechanism.
994
- *
995
- * @generated from rpc arrow.flight.protocol.FlightService.Handshake
996
- */
997
- handshake: {
998
- methodKind: "bidi_streaming";
999
- input: typeof HandshakeRequestSchema;
1000
- output: typeof HandshakeResponseSchema;
1001
- };
1002
- /**
1003
- *
1004
- * Get a list of available streams given a particular criteria. Most flight
1005
- * services will expose one or more streams that are readily available for
1006
- * retrieval. This api allows listing the streams available for
1007
- * consumption. A user can also provide a criteria. The criteria can limit
1008
- * the subset of streams that can be listed via this interface. Each flight
1009
- * service allows its own definition of how to consume criteria.
1010
- *
1011
- * @generated from rpc arrow.flight.protocol.FlightService.ListFlights
1012
- */
1013
- listFlights: {
1014
- methodKind: "server_streaming";
1015
- input: typeof CriteriaSchema;
1016
- output: typeof FlightInfoSchema;
1017
- };
1018
- /**
1019
- *
1020
- * For a given FlightDescriptor, get information about how the flight can be
1021
- * consumed. This is a useful interface if the consumer of the interface
1022
- * already can identify the specific flight to consume. This interface can
1023
- * also allow a consumer to generate a flight stream through a specified
1024
- * descriptor. For example, a flight descriptor might be something that
1025
- * includes a SQL statement or a Pickled Python operation that will be
1026
- * executed. In those cases, the descriptor will not be previously available
1027
- * within the list of available streams provided by ListFlights but will be
1028
- * available for consumption for the duration defined by the specific flight
1029
- * service.
1030
- *
1031
- * @generated from rpc arrow.flight.protocol.FlightService.GetFlightInfo
1032
- */
1033
- getFlightInfo: {
1034
- methodKind: "unary";
1035
- input: typeof FlightDescriptorSchema;
1036
- output: typeof FlightInfoSchema;
1037
- };
1038
- /**
1039
- *
1040
- * For a given FlightDescriptor, start a query and get information
1041
- * to poll its execution status. This is a useful interface if the
1042
- * query may be a long-running query. The first PollFlightInfo call
1043
- * should return as quickly as possible. (GetFlightInfo doesn't
1044
- * return until the query is complete.)
1045
- *
1046
- * A client can consume any available results before
1047
- * the query is completed. See PollInfo.info for details.
1048
- *
1049
- * A client can poll the updated query status by calling
1050
- * PollFlightInfo() with PollInfo.flight_descriptor. A server
1051
- * should not respond until the result would be different from last
1052
- * time. That way, the client can "long poll" for updates
1053
- * without constantly making requests. Clients can set a short timeout
1054
- * to avoid blocking calls if desired.
1055
- *
1056
- * A client can't use PollInfo.flight_descriptor after
1057
- * PollInfo.expiration_time passes. A server might not accept the
1058
- * retry descriptor anymore and the query may be cancelled.
1059
- *
1060
- * A client may use the CancelFlightInfo action with
1061
- * PollInfo.info to cancel the running query.
1062
- *
1063
- * @generated from rpc arrow.flight.protocol.FlightService.PollFlightInfo
1064
- */
1065
- pollFlightInfo: {
1066
- methodKind: "unary";
1067
- input: typeof FlightDescriptorSchema;
1068
- output: typeof PollInfoSchema;
1069
- };
1070
- /**
1071
- *
1072
- * For a given FlightDescriptor, get the Schema as described in Schema.fbs::Schema
1073
- * This is used when a consumer needs the Schema of flight stream. Similar to
1074
- * GetFlightInfo this interface may generate a new flight that was not previously
1075
- * available in ListFlights.
1076
- *
1077
- * @generated from rpc arrow.flight.protocol.FlightService.GetSchema
1078
- */
1079
- getSchema: {
1080
- methodKind: "unary";
1081
- input: typeof FlightDescriptorSchema;
1082
- output: typeof SchemaResultSchema;
1083
- };
1084
- /**
1085
- *
1086
- * Retrieve a single stream associated with a particular descriptor
1087
- * associated with the referenced ticket. A Flight can be composed of one or
1088
- * more streams where each stream can be retrieved using a separate opaque
1089
- * ticket that the flight service uses for managing a collection of streams.
1090
- *
1091
- * @generated from rpc arrow.flight.protocol.FlightService.DoGet
1092
- */
1093
- doGet: {
1094
- methodKind: "server_streaming";
1095
- input: typeof TicketSchema;
1096
- output: typeof FlightDataSchema;
1097
- };
1098
- /**
1099
- *
1100
- * Push a stream to the flight service associated with a particular
1101
- * flight stream. This allows a client of a flight service to upload a stream
1102
- * of data. Depending on the particular flight service, a client consumer
1103
- * could be allowed to upload a single stream per descriptor or an unlimited
1104
- * number. In the latter, the service might implement a 'seal' action that
1105
- * can be applied to a descriptor once all streams are uploaded.
1106
- *
1107
- * @generated from rpc arrow.flight.protocol.FlightService.DoPut
1108
- */
1109
- doPut: {
1110
- methodKind: "bidi_streaming";
1111
- input: typeof FlightDataSchema;
1112
- output: typeof PutResultSchema;
1113
- };
1114
- /**
1115
- *
1116
- * Open a bidirectional data channel for a given descriptor. This
1117
- * allows clients to send and receive arbitrary Arrow data and
1118
- * application-specific metadata in a single logical stream. In
1119
- * contrast to DoGet/DoPut, this is more suited for clients
1120
- * offloading computation (rather than storage) to a Flight service.
1121
- *
1122
- * @generated from rpc arrow.flight.protocol.FlightService.DoExchange
1123
- */
1124
- doExchange: {
1125
- methodKind: "bidi_streaming";
1126
- input: typeof FlightDataSchema;
1127
- output: typeof FlightDataSchema;
1128
- };
1129
- /**
1130
- *
1131
- * Flight services can support an arbitrary number of simple actions in
1132
- * addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut
1133
- * operations that are potentially available. DoAction allows a flight client
1134
- * to do a specific action against a flight service. An action includes
1135
- * opaque request and response objects that are specific to the type action
1136
- * being undertaken.
1137
- *
1138
- * @generated from rpc arrow.flight.protocol.FlightService.DoAction
1139
- */
1140
- doAction: {
1141
- methodKind: "server_streaming";
1142
- input: typeof ActionSchema;
1143
- output: typeof ResultSchema;
1144
- };
1145
- /**
1146
- *
1147
- * A flight service exposes all of the available action types that it has
1148
- * along with descriptions. This allows different flight consumers to
1149
- * understand the capabilities of the flight service.
1150
- *
1151
- * @generated from rpc arrow.flight.protocol.FlightService.ListActions
1152
- */
1153
- listActions: {
1154
- methodKind: "server_streaming";
1155
- input: typeof EmptySchema;
1156
- output: typeof ActionTypeSchema;
1157
- };
1158
- }>;
1159
- //# sourceMappingURL=Flight_pb.d.ts.map
1116
+ /**
1117
+ *
1118
+ * Handshake between client and server. Depending on the server, the
1119
+ * handshake may be required to determine the token that should be used for
1120
+ * future operations. Both request and response are streams to allow multiple
1121
+ * round-trips depending on auth mechanism.
1122
+ *
1123
+ * @generated from rpc arrow.flight.protocol.FlightService.Handshake
1124
+ */
1125
+ handshake: {
1126
+ methodKind: "bidi_streaming"
1127
+ input: typeof HandshakeRequestSchema
1128
+ output: typeof HandshakeResponseSchema
1129
+ }
1130
+ /**
1131
+ *
1132
+ * Get a list of available streams given a particular criteria. Most flight
1133
+ * services will expose one or more streams that are readily available for
1134
+ * retrieval. This api allows listing the streams available for
1135
+ * consumption. A user can also provide a criteria. The criteria can limit
1136
+ * the subset of streams that can be listed via this interface. Each flight
1137
+ * service allows its own definition of how to consume criteria.
1138
+ *
1139
+ * @generated from rpc arrow.flight.protocol.FlightService.ListFlights
1140
+ */
1141
+ listFlights: {
1142
+ methodKind: "server_streaming"
1143
+ input: typeof CriteriaSchema
1144
+ output: typeof FlightInfoSchema
1145
+ }
1146
+ /**
1147
+ *
1148
+ * For a given FlightDescriptor, get information about how the flight can be
1149
+ * consumed. This is a useful interface if the consumer of the interface
1150
+ * already can identify the specific flight to consume. This interface can
1151
+ * also allow a consumer to generate a flight stream through a specified
1152
+ * descriptor. For example, a flight descriptor might be something that
1153
+ * includes a SQL statement or a Pickled Python operation that will be
1154
+ * executed. In those cases, the descriptor will not be previously available
1155
+ * within the list of available streams provided by ListFlights but will be
1156
+ * available for consumption for the duration defined by the specific flight
1157
+ * service.
1158
+ *
1159
+ * @generated from rpc arrow.flight.protocol.FlightService.GetFlightInfo
1160
+ */
1161
+ getFlightInfo: {
1162
+ methodKind: "unary"
1163
+ input: typeof FlightDescriptorSchema
1164
+ output: typeof FlightInfoSchema
1165
+ }
1166
+ /**
1167
+ *
1168
+ * For a given FlightDescriptor, start a query and get information
1169
+ * to poll its execution status. This is a useful interface if the
1170
+ * query may be a long-running query. The first PollFlightInfo call
1171
+ * should return as quickly as possible. (GetFlightInfo doesn't
1172
+ * return until the query is complete.)
1173
+ *
1174
+ * A client can consume any available results before
1175
+ * the query is completed. See PollInfo.info for details.
1176
+ *
1177
+ * A client can poll the updated query status by calling
1178
+ * PollFlightInfo() with PollInfo.flight_descriptor. A server
1179
+ * should not respond until the result would be different from last
1180
+ * time. That way, the client can "long poll" for updates
1181
+ * without constantly making requests. Clients can set a short timeout
1182
+ * to avoid blocking calls if desired.
1183
+ *
1184
+ * A client can't use PollInfo.flight_descriptor after
1185
+ * PollInfo.expiration_time passes. A server might not accept the
1186
+ * retry descriptor anymore and the query may be cancelled.
1187
+ *
1188
+ * A client may use the CancelFlightInfo action with
1189
+ * PollInfo.info to cancel the running query.
1190
+ *
1191
+ * @generated from rpc arrow.flight.protocol.FlightService.PollFlightInfo
1192
+ */
1193
+ pollFlightInfo: {
1194
+ methodKind: "unary"
1195
+ input: typeof FlightDescriptorSchema
1196
+ output: typeof PollInfoSchema
1197
+ }
1198
+ /**
1199
+ *
1200
+ * For a given FlightDescriptor, get the Schema as described in Schema.fbs::Schema
1201
+ * This is used when a consumer needs the Schema of flight stream. Similar to
1202
+ * GetFlightInfo this interface may generate a new flight that was not previously
1203
+ * available in ListFlights.
1204
+ *
1205
+ * @generated from rpc arrow.flight.protocol.FlightService.GetSchema
1206
+ */
1207
+ getSchema: {
1208
+ methodKind: "unary"
1209
+ input: typeof FlightDescriptorSchema
1210
+ output: typeof SchemaResultSchema
1211
+ }
1212
+ /**
1213
+ *
1214
+ * Retrieve a single stream associated with a particular descriptor
1215
+ * associated with the referenced ticket. A Flight can be composed of one or
1216
+ * more streams where each stream can be retrieved using a separate opaque
1217
+ * ticket that the flight service uses for managing a collection of streams.
1218
+ *
1219
+ * @generated from rpc arrow.flight.protocol.FlightService.DoGet
1220
+ */
1221
+ doGet: {
1222
+ methodKind: "server_streaming"
1223
+ input: typeof TicketSchema
1224
+ output: typeof FlightDataSchema
1225
+ }
1226
+ /**
1227
+ *
1228
+ * Push a stream to the flight service associated with a particular
1229
+ * flight stream. This allows a client of a flight service to upload a stream
1230
+ * of data. Depending on the particular flight service, a client consumer
1231
+ * could be allowed to upload a single stream per descriptor or an unlimited
1232
+ * number. In the latter, the service might implement a 'seal' action that
1233
+ * can be applied to a descriptor once all streams are uploaded.
1234
+ *
1235
+ * @generated from rpc arrow.flight.protocol.FlightService.DoPut
1236
+ */
1237
+ doPut: {
1238
+ methodKind: "bidi_streaming"
1239
+ input: typeof FlightDataSchema
1240
+ output: typeof PutResultSchema
1241
+ }
1242
+ /**
1243
+ *
1244
+ * Open a bidirectional data channel for a given descriptor. This
1245
+ * allows clients to send and receive arbitrary Arrow data and
1246
+ * application-specific metadata in a single logical stream. In
1247
+ * contrast to DoGet/DoPut, this is more suited for clients
1248
+ * offloading computation (rather than storage) to a Flight service.
1249
+ *
1250
+ * @generated from rpc arrow.flight.protocol.FlightService.DoExchange
1251
+ */
1252
+ doExchange: {
1253
+ methodKind: "bidi_streaming"
1254
+ input: typeof FlightDataSchema
1255
+ output: typeof FlightDataSchema
1256
+ }
1257
+ /**
1258
+ *
1259
+ * Flight services can support an arbitrary number of simple actions in
1260
+ * addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut
1261
+ * operations that are potentially available. DoAction allows a flight client
1262
+ * to do a specific action against a flight service. An action includes
1263
+ * opaque request and response objects that are specific to the type action
1264
+ * being undertaken.
1265
+ *
1266
+ * @generated from rpc arrow.flight.protocol.FlightService.DoAction
1267
+ */
1268
+ doAction: {
1269
+ methodKind: "server_streaming"
1270
+ input: typeof ActionSchema
1271
+ output: typeof ResultSchema
1272
+ }
1273
+ /**
1274
+ *
1275
+ * A flight service exposes all of the available action types that it has
1276
+ * along with descriptions. This allows different flight consumers to
1277
+ * understand the capabilities of the flight service.
1278
+ *
1279
+ * @generated from rpc arrow.flight.protocol.FlightService.ListActions
1280
+ */
1281
+ listActions: {
1282
+ methodKind: "server_streaming"
1283
+ input: typeof EmptySchema
1284
+ output: typeof ActionTypeSchema
1285
+ }
1286
+ }>