@qualithm/arrow-flight-client 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/LICENSE +190 -0
  2. package/README.md +258 -0
  3. package/dist/client/create-flight-client.d.ts +28 -0
  4. package/dist/client/create-flight-client.d.ts.map +1 -0
  5. package/dist/client/create-flight-client.js +29 -0
  6. package/dist/client/create-flight-client.js.map +1 -0
  7. package/dist/client/create-flight-sql-client.d.ts +28 -0
  8. package/dist/client/create-flight-sql-client.d.ts.map +1 -0
  9. package/dist/client/create-flight-sql-client.js +29 -0
  10. package/dist/client/create-flight-sql-client.js.map +1 -0
  11. package/dist/client/errors.d.ts +81 -0
  12. package/dist/client/errors.d.ts.map +1 -0
  13. package/dist/client/errors.js +106 -0
  14. package/dist/client/errors.js.map +1 -0
  15. package/dist/client/flight-client.d.ts +161 -0
  16. package/dist/client/flight-client.d.ts.map +1 -0
  17. package/dist/client/flight-client.js +403 -0
  18. package/dist/client/flight-client.js.map +1 -0
  19. package/dist/client/flight-sql-client.d.ts +348 -0
  20. package/dist/client/flight-sql-client.d.ts.map +1 -0
  21. package/dist/client/flight-sql-client.js +689 -0
  22. package/dist/client/flight-sql-client.js.map +1 -0
  23. package/dist/client/index.d.ts +11 -0
  24. package/dist/client/index.d.ts.map +1 -0
  25. package/dist/client/index.js +10 -0
  26. package/dist/client/index.js.map +1 -0
  27. package/dist/client/ipc.d.ts +131 -0
  28. package/dist/client/ipc.d.ts.map +1 -0
  29. package/dist/client/ipc.js +246 -0
  30. package/dist/client/ipc.js.map +1 -0
  31. package/dist/client/types.d.ts +153 -0
  32. package/dist/client/types.d.ts.map +1 -0
  33. package/dist/client/types.js +26 -0
  34. package/dist/client/types.js.map +1 -0
  35. package/dist/gen/arrow/flight/FlightSql_pb.d.ts +3173 -0
  36. package/dist/gen/arrow/flight/FlightSql_pb.d.ts.map +1 -0
  37. package/dist/gen/arrow/flight/FlightSql_pb.js +2258 -0
  38. package/dist/gen/arrow/flight/FlightSql_pb.js.map +1 -0
  39. package/dist/gen/arrow/flight/Flight_pb.d.ts +1159 -0
  40. package/dist/gen/arrow/flight/Flight_pb.d.ts.map +1 -0
  41. package/dist/gen/arrow/flight/Flight_pb.js +397 -0
  42. package/dist/gen/arrow/flight/Flight_pb.js.map +1 -0
  43. package/dist/index.d.ts +12 -0
  44. package/dist/index.d.ts.map +1 -0
  45. package/dist/index.js +14 -0
  46. package/dist/index.js.map +1 -0
  47. package/package.json +96 -0
@@ -0,0 +1,3173 @@
1
+ import type { GenEnum, GenExtension, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
2
+ import type { MessageOptions } from "@bufbuild/protobuf/wkt";
3
+ import type { Message } from "@bufbuild/protobuf";
4
+ /**
5
+ * Describes the file arrow/flight/FlightSql.proto.
6
+ */
7
+ export declare const file_arrow_flight_FlightSql: GenFile;
8
+ /**
9
+ *
10
+ * Represents a metadata request. Used in the command member of FlightDescriptor
11
+ * for the following RPC calls:
12
+ * - GetSchema: return the Arrow schema of the query.
13
+ * - GetFlightInfo: execute the metadata request.
14
+ *
15
+ * The returned Arrow schema will be:
16
+ * <
17
+ * info_name: uint32 not null,
18
+ * value: dense_union<
19
+ * string_value: utf8,
20
+ * bool_value: bool,
21
+ * bigint_value: int64,
22
+ * int32_bitmask: int32,
23
+ * string_list: list<string_data: utf8>
24
+ * int32_to_int32_list_map: map<key: int32, value: list<$data$: int32>>
25
+ * >
26
+ * where there is one row per requested piece of metadata information.
27
+ *
28
+ * @generated from message arrow.flight.protocol.sql.CommandGetSqlInfo
29
+ */
30
+ export type CommandGetSqlInfo = Message<"arrow.flight.protocol.sql.CommandGetSqlInfo"> & {
31
+ /**
32
+ *
33
+ * Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
34
+ * Flight SQL clients with basic, SQL syntax and SQL functions related information.
35
+ * More information types can be added in future releases.
36
+ * E.g. more SQL syntax support types, scalar functions support, type conversion support etc.
37
+ *
38
+ * Note that the set of metadata may expand.
39
+ *
40
+ * Initially, Flight SQL will support the following information types:
41
+ * - Server Information - Range [0-500)
42
+ * - Syntax Information - Range [500-1000)
43
+ * Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
44
+ * Custom options should start at 10,000.
45
+ *
46
+ * If omitted, then all metadata will be retrieved.
47
+ * Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
48
+ * at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
49
+ * If additional metadata is included, the metadata IDs should start from 10,000.
50
+ *
51
+ * @generated from field: repeated uint32 info = 1;
52
+ */
53
+ info: number[];
54
+ };
55
+ /**
56
+ * Describes the message arrow.flight.protocol.sql.CommandGetSqlInfo.
57
+ * Use `create(CommandGetSqlInfoSchema)` to create a new message.
58
+ */
59
+ export declare const CommandGetSqlInfoSchema: GenMessage<CommandGetSqlInfo>;
60
+ /**
61
+ *
62
+ * Represents a request to retrieve information about data type supported on a Flight SQL enabled backend.
63
+ * Used in the command member of FlightDescriptor for the following RPC calls:
64
+ * - GetSchema: return the schema of the query.
65
+ * - GetFlightInfo: execute the catalog metadata request.
66
+ *
67
+ * The returned schema will be:
68
+ * <
69
+ * type_name: utf8 not null (The name of the data type, for example: VARCHAR, INTEGER, etc),
70
+ * data_type: int32 not null (The SQL data type),
71
+ * column_size: int32 (The maximum size supported by that column.
72
+ * In case of exact numeric types, this represents the maximum precision.
73
+ * In case of string types, this represents the character length.
74
+ * In case of datetime data types, this represents the length in characters of the string representation.
75
+ * NULL is returned for data types where column size is not applicable.),
76
+ * literal_prefix: utf8 (Character or characters used to prefix a literal, NULL is returned for
77
+ * data types where a literal prefix is not applicable.),
78
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
79
+ * NULL is returned for data types where a literal suffix is not applicable.),
80
+ * create_params: list<utf8 not null>
81
+ * (A list of keywords corresponding to which parameters can be used when creating
82
+ * a column for that specific type.
83
+ * NULL is returned if there are no parameters for the data type definition.),
84
+ * nullable: int32 not null (Shows if the data type accepts a NULL value. The possible values can be seen in the
85
+ * Nullable enum.),
86
+ * case_sensitive: bool not null (Shows if a character data type is case-sensitive in collations and comparisons),
87
+ * searchable: int32 not null (Shows how the data type is used in a WHERE clause. The possible values can be seen in the
88
+ * Searchable enum.),
89
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is returned if the attribute is
90
+ * not applicable to the data type or the data type is not numeric.),
91
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined fixed precision and scale.),
92
+ * auto_increment: bool (Shows if the data type is auto incremental. NULL is returned if the attribute
93
+ * is not applicable to the data type or the data type is not numeric.),
94
+ * local_type_name: utf8 (Localized version of the data source-dependent name of the data type. NULL
95
+ * is returned if a localized name is not supported by the data source),
96
+ * minimum_scale: int32 (The minimum scale of the data type on the data source.
97
+ * If a data type has a fixed scale, the MINIMUM_SCALE and MAXIMUM_SCALE
98
+ * columns both contain this value. NULL is returned if scale is not applicable.),
99
+ * maximum_scale: int32 (The maximum scale of the data type on the data source.
100
+ * NULL is returned if scale is not applicable.),
101
+ * sql_data_type: int32 not null (The value of the SQL DATA TYPE which has the same values
102
+ * as data_type value. Except for interval and datetime, which
103
+ * uses generic values. More info about those types can be
104
+ * obtained through datetime_subcode. The possible values can be seen
105
+ * in the XdbcDataType enum.),
106
+ * datetime_subcode: int32 (Only used when the SQL DATA TYPE is interval or datetime. It contains
107
+ * its sub types. For type different from interval and datetime, this value
108
+ * is NULL. The possible values can be seen in the XdbcDatetimeSubcode enum.),
109
+ * num_prec_radix: int32 (If the data type is an approximate numeric type, this column contains
110
+ * the value 2 to indicate that COLUMN_SIZE specifies a number of bits. For
111
+ * exact numeric types, this column contains the value 10 to indicate that
112
+ * column size specifies a number of decimal digits. Otherwise, this column is NULL.),
113
+ * interval_precision: int32 (If the data type is an interval data type, then this column contains the value
114
+ * of the interval leading precision. Otherwise, this column is NULL. This fields
115
+ * is only relevant to be used by ODBC).
116
+ * >
117
+ * The returned data should be ordered by data_type and then by type_name.
118
+ *
119
+ * @generated from message arrow.flight.protocol.sql.CommandGetXdbcTypeInfo
120
+ */
121
+ export type CommandGetXdbcTypeInfo = Message<"arrow.flight.protocol.sql.CommandGetXdbcTypeInfo"> & {
122
+ /**
123
+ *
124
+ * Specifies the data type to search for the info.
125
+ *
126
+ * @generated from field: optional int32 data_type = 1;
127
+ */
128
+ dataType?: number;
129
+ };
130
+ /**
131
+ * Describes the message arrow.flight.protocol.sql.CommandGetXdbcTypeInfo.
132
+ * Use `create(CommandGetXdbcTypeInfoSchema)` to create a new message.
133
+ */
134
+ export declare const CommandGetXdbcTypeInfoSchema: GenMessage<CommandGetXdbcTypeInfo>;
135
+ /**
136
+ *
137
+ * Represents a request to retrieve the list of catalogs on a Flight SQL enabled backend.
138
+ * The definition of a catalog depends on vendor/implementation. It is usually the database itself
139
+ * Used in the command member of FlightDescriptor for the following RPC calls:
140
+ * - GetSchema: return the Arrow schema of the query.
141
+ * - GetFlightInfo: execute the catalog metadata request.
142
+ *
143
+ * The returned Arrow schema will be:
144
+ * <
145
+ * catalog_name: utf8 not null
146
+ * >
147
+ * The returned data should be ordered by catalog_name.
148
+ *
149
+ * @generated from message arrow.flight.protocol.sql.CommandGetCatalogs
150
+ */
151
+ export type CommandGetCatalogs = Message<"arrow.flight.protocol.sql.CommandGetCatalogs"> & {};
152
+ /**
153
+ * Describes the message arrow.flight.protocol.sql.CommandGetCatalogs.
154
+ * Use `create(CommandGetCatalogsSchema)` to create a new message.
155
+ */
156
+ export declare const CommandGetCatalogsSchema: GenMessage<CommandGetCatalogs>;
157
+ /**
158
+ *
159
+ * Represents a request to retrieve the list of database schemas on a Flight SQL enabled backend.
160
+ * The definition of a database schema depends on vendor/implementation. It is usually a collection of tables.
161
+ * Used in the command member of FlightDescriptor for the following RPC calls:
162
+ * - GetSchema: return the Arrow schema of the query.
163
+ * - GetFlightInfo: execute the catalog metadata request.
164
+ *
165
+ * The returned Arrow schema will be:
166
+ * <
167
+ * catalog_name: utf8,
168
+ * db_schema_name: utf8 not null
169
+ * >
170
+ * The returned data should be ordered by catalog_name, then db_schema_name.
171
+ *
172
+ * @generated from message arrow.flight.protocol.sql.CommandGetDbSchemas
173
+ */
174
+ export type CommandGetDbSchemas = Message<"arrow.flight.protocol.sql.CommandGetDbSchemas"> & {
175
+ /**
176
+ *
177
+ * Specifies the Catalog to search for the tables.
178
+ * An empty string retrieves those without a catalog.
179
+ * If omitted the catalog name should not be used to narrow the search.
180
+ *
181
+ * @generated from field: optional string catalog = 1;
182
+ */
183
+ catalog?: string;
184
+ /**
185
+ *
186
+ * Specifies a filter pattern for schemas to search for.
187
+ * When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search.
188
+ * In the pattern string, two special characters can be used to denote matching rules:
189
+ * - "%" means to match any substring with 0 or more characters.
190
+ * - "_" means to match any one character.
191
+ *
192
+ * @generated from field: optional string db_schema_filter_pattern = 2;
193
+ */
194
+ dbSchemaFilterPattern?: string;
195
+ };
196
+ /**
197
+ * Describes the message arrow.flight.protocol.sql.CommandGetDbSchemas.
198
+ * Use `create(CommandGetDbSchemasSchema)` to create a new message.
199
+ */
200
+ export declare const CommandGetDbSchemasSchema: GenMessage<CommandGetDbSchemas>;
201
+ /**
202
+ *
203
+ * Represents a request to retrieve the list of tables, and optionally their schemas, on a Flight SQL enabled backend.
204
+ * Used in the command member of FlightDescriptor for the following RPC calls:
205
+ * - GetSchema: return the Arrow schema of the query.
206
+ * - GetFlightInfo: execute the catalog metadata request.
207
+ *
208
+ * The returned Arrow schema will be:
209
+ * <
210
+ * catalog_name: utf8,
211
+ * db_schema_name: utf8,
212
+ * table_name: utf8 not null,
213
+ * table_type: utf8 not null,
214
+ * [optional] table_schema: bytes not null (schema of the table as described in Schema.fbs::Schema,
215
+ * it is serialized as an IPC message.)
216
+ * >
217
+ * Fields on table_schema may contain the following metadata:
218
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
219
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
220
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
221
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
222
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
223
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
224
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
225
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
226
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
227
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
228
+ * - ARROW:FLIGHT:SQL:REMARKS - A comment describing the column. This field has been added after all others, clients should be prepared to find it missing.
229
+ * The returned data should be ordered by catalog_name, db_schema_name, table_name, then table_type, followed by table_schema if requested.
230
+ *
231
+ * @generated from message arrow.flight.protocol.sql.CommandGetTables
232
+ */
233
+ export type CommandGetTables = Message<"arrow.flight.protocol.sql.CommandGetTables"> & {
234
+ /**
235
+ *
236
+ * Specifies the Catalog to search for the tables.
237
+ * An empty string retrieves those without a catalog.
238
+ * If omitted the catalog name should not be used to narrow the search.
239
+ *
240
+ * @generated from field: optional string catalog = 1;
241
+ */
242
+ catalog?: string;
243
+ /**
244
+ *
245
+ * Specifies a filter pattern for schemas to search for.
246
+ * When no db_schema_filter_pattern is provided, all schemas matching other filters are searched.
247
+ * In the pattern string, two special characters can be used to denote matching rules:
248
+ * - "%" means to match any substring with 0 or more characters.
249
+ * - "_" means to match any one character.
250
+ *
251
+ * @generated from field: optional string db_schema_filter_pattern = 2;
252
+ */
253
+ dbSchemaFilterPattern?: string;
254
+ /**
255
+ *
256
+ * Specifies a filter pattern for tables to search for.
257
+ * When no table_name_filter_pattern is provided, all tables matching other filters are searched.
258
+ * In the pattern string, two special characters can be used to denote matching rules:
259
+ * - "%" means to match any substring with 0 or more characters.
260
+ * - "_" means to match any one character.
261
+ *
262
+ * @generated from field: optional string table_name_filter_pattern = 3;
263
+ */
264
+ tableNameFilterPattern?: string;
265
+ /**
266
+ *
267
+ * Specifies a filter of table types which must match.
268
+ * The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
269
+ * TABLE, VIEW, and SYSTEM TABLE are commonly supported.
270
+ *
271
+ * @generated from field: repeated string table_types = 4;
272
+ */
273
+ tableTypes: string[];
274
+ /**
275
+ * Specifies if the Arrow schema should be returned for found tables.
276
+ *
277
+ * @generated from field: bool include_schema = 5;
278
+ */
279
+ includeSchema: boolean;
280
+ };
281
+ /**
282
+ * Describes the message arrow.flight.protocol.sql.CommandGetTables.
283
+ * Use `create(CommandGetTablesSchema)` to create a new message.
284
+ */
285
+ export declare const CommandGetTablesSchema: GenMessage<CommandGetTables>;
286
+ /**
287
+ *
288
+ * Represents a request to retrieve the list of table types on a Flight SQL enabled backend.
289
+ * The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
290
+ * TABLE, VIEW, and SYSTEM TABLE are commonly supported.
291
+ * Used in the command member of FlightDescriptor for the following RPC calls:
292
+ * - GetSchema: return the Arrow schema of the query.
293
+ * - GetFlightInfo: execute the catalog metadata request.
294
+ *
295
+ * The returned Arrow schema will be:
296
+ * <
297
+ * table_type: utf8 not null
298
+ * >
299
+ * The returned data should be ordered by table_type.
300
+ *
301
+ * @generated from message arrow.flight.protocol.sql.CommandGetTableTypes
302
+ */
303
+ export type CommandGetTableTypes = Message<"arrow.flight.protocol.sql.CommandGetTableTypes"> & {};
304
+ /**
305
+ * Describes the message arrow.flight.protocol.sql.CommandGetTableTypes.
306
+ * Use `create(CommandGetTableTypesSchema)` to create a new message.
307
+ */
308
+ export declare const CommandGetTableTypesSchema: GenMessage<CommandGetTableTypes>;
309
+ /**
310
+ *
311
+ * Represents a request to retrieve the primary keys of a table on a Flight SQL enabled backend.
312
+ * Used in the command member of FlightDescriptor for the following RPC calls:
313
+ * - GetSchema: return the Arrow schema of the query.
314
+ * - GetFlightInfo: execute the catalog metadata request.
315
+ *
316
+ * The returned Arrow schema will be:
317
+ * <
318
+ * catalog_name: utf8,
319
+ * db_schema_name: utf8,
320
+ * table_name: utf8 not null,
321
+ * column_name: utf8 not null,
322
+ * key_name: utf8,
323
+ * key_sequence: int32 not null
324
+ * >
325
+ * The returned data should be ordered by catalog_name, db_schema_name, table_name, key_name, then key_sequence.
326
+ *
327
+ * @generated from message arrow.flight.protocol.sql.CommandGetPrimaryKeys
328
+ */
329
+ export type CommandGetPrimaryKeys = Message<"arrow.flight.protocol.sql.CommandGetPrimaryKeys"> & {
330
+ /**
331
+ *
332
+ * Specifies the catalog to search for the table.
333
+ * An empty string retrieves those without a catalog.
334
+ * If omitted the catalog name should not be used to narrow the search.
335
+ *
336
+ * @generated from field: optional string catalog = 1;
337
+ */
338
+ catalog?: string;
339
+ /**
340
+ *
341
+ * Specifies the schema to search for the table.
342
+ * An empty string retrieves those without a schema.
343
+ * If omitted the schema name should not be used to narrow the search.
344
+ *
345
+ * @generated from field: optional string db_schema = 2;
346
+ */
347
+ dbSchema?: string;
348
+ /**
349
+ * Specifies the table to get the primary keys for.
350
+ *
351
+ * @generated from field: string table = 3;
352
+ */
353
+ table: string;
354
+ };
355
+ /**
356
+ * Describes the message arrow.flight.protocol.sql.CommandGetPrimaryKeys.
357
+ * Use `create(CommandGetPrimaryKeysSchema)` to create a new message.
358
+ */
359
+ export declare const CommandGetPrimaryKeysSchema: GenMessage<CommandGetPrimaryKeys>;
360
+ /**
361
+ *
362
+ * Represents a request to retrieve a description of the foreign key columns that reference the given table's
363
+ * primary key columns (the foreign keys exported by a table) of a table on a Flight SQL enabled backend.
364
+ * Used in the command member of FlightDescriptor for the following RPC calls:
365
+ * - GetSchema: return the Arrow schema of the query.
366
+ * - GetFlightInfo: execute the catalog metadata request.
367
+ *
368
+ * The returned Arrow schema will be:
369
+ * <
370
+ * pk_catalog_name: utf8,
371
+ * pk_db_schema_name: utf8,
372
+ * pk_table_name: utf8 not null,
373
+ * pk_column_name: utf8 not null,
374
+ * fk_catalog_name: utf8,
375
+ * fk_db_schema_name: utf8,
376
+ * fk_table_name: utf8 not null,
377
+ * fk_column_name: utf8 not null,
378
+ * key_sequence: int32 not null,
379
+ * fk_key_name: utf8,
380
+ * pk_key_name: utf8,
381
+ * update_rule: uint8 not null,
382
+ * delete_rule: uint8 not null
383
+ * >
384
+ * The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence.
385
+ * update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.
386
+ *
387
+ * @generated from message arrow.flight.protocol.sql.CommandGetExportedKeys
388
+ */
389
+ export type CommandGetExportedKeys = Message<"arrow.flight.protocol.sql.CommandGetExportedKeys"> & {
390
+ /**
391
+ *
392
+ * Specifies the catalog to search for the foreign key table.
393
+ * An empty string retrieves those without a catalog.
394
+ * If omitted the catalog name should not be used to narrow the search.
395
+ *
396
+ * @generated from field: optional string catalog = 1;
397
+ */
398
+ catalog?: string;
399
+ /**
400
+ *
401
+ * Specifies the schema to search for the foreign key table.
402
+ * An empty string retrieves those without a schema.
403
+ * If omitted the schema name should not be used to narrow the search.
404
+ *
405
+ * @generated from field: optional string db_schema = 2;
406
+ */
407
+ dbSchema?: string;
408
+ /**
409
+ * Specifies the foreign key table to get the foreign keys for.
410
+ *
411
+ * @generated from field: string table = 3;
412
+ */
413
+ table: string;
414
+ };
415
+ /**
416
+ * Describes the message arrow.flight.protocol.sql.CommandGetExportedKeys.
417
+ * Use `create(CommandGetExportedKeysSchema)` to create a new message.
418
+ */
419
+ export declare const CommandGetExportedKeysSchema: GenMessage<CommandGetExportedKeys>;
420
+ /**
421
+ *
422
+ * Represents a request to retrieve the foreign keys of a table on a Flight SQL enabled backend.
423
+ * Used in the command member of FlightDescriptor for the following RPC calls:
424
+ * - GetSchema: return the Arrow schema of the query.
425
+ * - GetFlightInfo: execute the catalog metadata request.
426
+ *
427
+ * The returned Arrow schema will be:
428
+ * <
429
+ * pk_catalog_name: utf8,
430
+ * pk_db_schema_name: utf8,
431
+ * pk_table_name: utf8 not null,
432
+ * pk_column_name: utf8 not null,
433
+ * fk_catalog_name: utf8,
434
+ * fk_db_schema_name: utf8,
435
+ * fk_table_name: utf8 not null,
436
+ * fk_column_name: utf8 not null,
437
+ * key_sequence: int32 not null,
438
+ * fk_key_name: utf8,
439
+ * pk_key_name: utf8,
440
+ * update_rule: uint8 not null,
441
+ * delete_rule: uint8 not null
442
+ * >
443
+ * The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
444
+ * update_rule and delete_rule returns a byte that is equivalent to actions:
445
+ * - 0 = CASCADE
446
+ * - 1 = RESTRICT
447
+ * - 2 = SET NULL
448
+ * - 3 = NO ACTION
449
+ * - 4 = SET DEFAULT
450
+ *
451
+ * @generated from message arrow.flight.protocol.sql.CommandGetImportedKeys
452
+ */
453
+ export type CommandGetImportedKeys = Message<"arrow.flight.protocol.sql.CommandGetImportedKeys"> & {
454
+ /**
455
+ *
456
+ * Specifies the catalog to search for the primary key table.
457
+ * An empty string retrieves those without a catalog.
458
+ * If omitted the catalog name should not be used to narrow the search.
459
+ *
460
+ * @generated from field: optional string catalog = 1;
461
+ */
462
+ catalog?: string;
463
+ /**
464
+ *
465
+ * Specifies the schema to search for the primary key table.
466
+ * An empty string retrieves those without a schema.
467
+ * If omitted the schema name should not be used to narrow the search.
468
+ *
469
+ * @generated from field: optional string db_schema = 2;
470
+ */
471
+ dbSchema?: string;
472
+ /**
473
+ * Specifies the primary key table to get the foreign keys for.
474
+ *
475
+ * @generated from field: string table = 3;
476
+ */
477
+ table: string;
478
+ };
479
+ /**
480
+ * Describes the message arrow.flight.protocol.sql.CommandGetImportedKeys.
481
+ * Use `create(CommandGetImportedKeysSchema)` to create a new message.
482
+ */
483
+ export declare const CommandGetImportedKeysSchema: GenMessage<CommandGetImportedKeys>;
484
+ /**
485
+ *
486
+ * Represents a request to retrieve a description of the foreign key columns in the given foreign key table that
487
+ * reference the primary key or the columns representing a unique constraint of the parent table (could be the same
488
+ * or a different table) on a Flight SQL enabled backend.
489
+ * Used in the command member of FlightDescriptor for the following RPC calls:
490
+ * - GetSchema: return the Arrow schema of the query.
491
+ * - GetFlightInfo: execute the catalog metadata request.
492
+ *
493
+ * The returned Arrow schema will be:
494
+ * <
495
+ * pk_catalog_name: utf8,
496
+ * pk_db_schema_name: utf8,
497
+ * pk_table_name: utf8 not null,
498
+ * pk_column_name: utf8 not null,
499
+ * fk_catalog_name: utf8,
500
+ * fk_db_schema_name: utf8,
501
+ * fk_table_name: utf8 not null,
502
+ * fk_column_name: utf8 not null,
503
+ * key_sequence: int32 not null,
504
+ * fk_key_name: utf8,
505
+ * pk_key_name: utf8,
506
+ * update_rule: uint8 not null,
507
+ * delete_rule: uint8 not null
508
+ * >
509
+ * The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
510
+ * update_rule and delete_rule returns a byte that is equivalent to actions:
511
+ * - 0 = CASCADE
512
+ * - 1 = RESTRICT
513
+ * - 2 = SET NULL
514
+ * - 3 = NO ACTION
515
+ * - 4 = SET DEFAULT
516
+ *
517
+ * @generated from message arrow.flight.protocol.sql.CommandGetCrossReference
518
+ */
519
+ export type CommandGetCrossReference = Message<"arrow.flight.protocol.sql.CommandGetCrossReference"> & {
520
+ /**
521
+ * *
522
+ * The catalog name where the parent table is.
523
+ * An empty string retrieves those without a catalog.
524
+ * If omitted the catalog name should not be used to narrow the search.
525
+ *
526
+ * @generated from field: optional string pk_catalog = 1;
527
+ */
528
+ pkCatalog?: string;
529
+ /**
530
+ * *
531
+ * The Schema name where the parent table is.
532
+ * An empty string retrieves those without a schema.
533
+ * If omitted the schema name should not be used to narrow the search.
534
+ *
535
+ * @generated from field: optional string pk_db_schema = 2;
536
+ */
537
+ pkDbSchema?: string;
538
+ /**
539
+ * *
540
+ * The parent table name. It cannot be null.
541
+ *
542
+ * @generated from field: string pk_table = 3;
543
+ */
544
+ pkTable: string;
545
+ /**
546
+ * *
547
+ * The catalog name where the foreign table is.
548
+ * An empty string retrieves those without a catalog.
549
+ * If omitted the catalog name should not be used to narrow the search.
550
+ *
551
+ * @generated from field: optional string fk_catalog = 4;
552
+ */
553
+ fkCatalog?: string;
554
+ /**
555
+ * *
556
+ * The schema name where the foreign table is.
557
+ * An empty string retrieves those without a schema.
558
+ * If omitted the schema name should not be used to narrow the search.
559
+ *
560
+ * @generated from field: optional string fk_db_schema = 5;
561
+ */
562
+ fkDbSchema?: string;
563
+ /**
564
+ * *
565
+ * The foreign table name. It cannot be null.
566
+ *
567
+ * @generated from field: string fk_table = 6;
568
+ */
569
+ fkTable: string;
570
+ };
571
+ /**
572
+ * Describes the message arrow.flight.protocol.sql.CommandGetCrossReference.
573
+ * Use `create(CommandGetCrossReferenceSchema)` to create a new message.
574
+ */
575
+ export declare const CommandGetCrossReferenceSchema: GenMessage<CommandGetCrossReference>;
576
+ /**
577
+ *
578
+ * Request message for the "CreatePreparedStatement" action on a Flight SQL enabled backend.
579
+ *
580
+ * @generated from message arrow.flight.protocol.sql.ActionCreatePreparedStatementRequest
581
+ */
582
+ export type ActionCreatePreparedStatementRequest = Message<"arrow.flight.protocol.sql.ActionCreatePreparedStatementRequest"> & {
583
+ /**
584
+ * The valid SQL string to create a prepared statement for.
585
+ *
586
+ * @generated from field: string query = 1;
587
+ */
588
+ query: string;
589
+ /**
590
+ * Create/execute the prepared statement as part of this transaction (if
591
+ * unset, executions of the prepared statement will be auto-committed).
592
+ *
593
+ * @generated from field: optional bytes transaction_id = 2;
594
+ */
595
+ transactionId?: Uint8Array;
596
+ };
597
+ /**
598
+ * Describes the message arrow.flight.protocol.sql.ActionCreatePreparedStatementRequest.
599
+ * Use `create(ActionCreatePreparedStatementRequestSchema)` to create a new message.
600
+ */
601
+ export declare const ActionCreatePreparedStatementRequestSchema: GenMessage<ActionCreatePreparedStatementRequest>;
602
+ /**
603
+ *
604
+ * An embedded message describing a Substrait plan to execute.
605
+ *
606
+ * @generated from message arrow.flight.protocol.sql.SubstraitPlan
607
+ */
608
+ export type SubstraitPlan = Message<"arrow.flight.protocol.sql.SubstraitPlan"> & {
609
+ /**
610
+ * The serialized substrait.Plan to create a prepared statement for.
611
+ * XXX(ARROW-16902): this is bytes instead of an embedded message
612
+ * because Protobuf does not really support one DLL using Protobuf
613
+ * definitions from another DLL.
614
+ *
615
+ * @generated from field: bytes plan = 1;
616
+ */
617
+ plan: Uint8Array;
618
+ /**
619
+ * The Substrait release, e.g. "0.12.0". This information is not
620
+ * tracked in the plan itself, so this is the only way for consumers
621
+ * to potentially know if they can handle the plan.
622
+ *
623
+ * @generated from field: string version = 2;
624
+ */
625
+ version: string;
626
+ };
627
+ /**
628
+ * Describes the message arrow.flight.protocol.sql.SubstraitPlan.
629
+ * Use `create(SubstraitPlanSchema)` to create a new message.
630
+ */
631
+ export declare const SubstraitPlanSchema: GenMessage<SubstraitPlan>;
632
+ /**
633
+ *
634
+ * Request message for the "CreatePreparedSubstraitPlan" action on a Flight SQL enabled backend.
635
+ *
636
+ * @generated from message arrow.flight.protocol.sql.ActionCreatePreparedSubstraitPlanRequest
637
+ */
638
+ export type ActionCreatePreparedSubstraitPlanRequest = Message<"arrow.flight.protocol.sql.ActionCreatePreparedSubstraitPlanRequest"> & {
639
+ /**
640
+ * The serialized substrait.Plan to create a prepared statement for.
641
+ *
642
+ * @generated from field: arrow.flight.protocol.sql.SubstraitPlan plan = 1;
643
+ */
644
+ plan?: SubstraitPlan;
645
+ /**
646
+ * Create/execute the prepared statement as part of this transaction (if
647
+ * unset, executions of the prepared statement will be auto-committed).
648
+ *
649
+ * @generated from field: optional bytes transaction_id = 2;
650
+ */
651
+ transactionId?: Uint8Array;
652
+ };
653
+ /**
654
+ * Describes the message arrow.flight.protocol.sql.ActionCreatePreparedSubstraitPlanRequest.
655
+ * Use `create(ActionCreatePreparedSubstraitPlanRequestSchema)` to create a new message.
656
+ */
657
+ export declare const ActionCreatePreparedSubstraitPlanRequestSchema: GenMessage<ActionCreatePreparedSubstraitPlanRequest>;
658
+ /**
659
+ *
660
+ * Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.
661
+ *
662
+ * The resultant PreparedStatement can be closed either:
663
+ * - Manually, through the "ClosePreparedStatement" action;
664
+ * - Automatically, by a server timeout.
665
+ *
666
+ * The result should be wrapped in a google.protobuf.Any message.
667
+ *
668
+ * @generated from message arrow.flight.protocol.sql.ActionCreatePreparedStatementResult
669
+ */
670
+ export type ActionCreatePreparedStatementResult = Message<"arrow.flight.protocol.sql.ActionCreatePreparedStatementResult"> & {
671
+ /**
672
+ * Opaque handle for the prepared statement on the server.
673
+ *
674
+ * @generated from field: bytes prepared_statement_handle = 1;
675
+ */
676
+ preparedStatementHandle: Uint8Array;
677
+ /**
678
+ * If a result set generating query was provided, dataset_schema contains the
679
+ * schema of the result set. It should be an IPC-encapsulated Schema, as described in Schema.fbs.
680
+ * For some queries, the schema of the results may depend on the schema of the parameters. The server
681
+ * should provide its best guess as to the schema at this point. Clients must not assume that this
682
+ * schema, if provided, will be accurate.
683
+ *
684
+ * @generated from field: bytes dataset_schema = 2;
685
+ */
686
+ datasetSchema: Uint8Array;
687
+ /**
688
+ * If the query provided contained parameters, parameter_schema contains the
689
+ * schema of the expected parameters. It should be an IPC-encapsulated Schema, as described in Schema.fbs.
690
+ *
691
+ * @generated from field: bytes parameter_schema = 3;
692
+ */
693
+ parameterSchema: Uint8Array;
694
+ };
695
+ /**
696
+ * Describes the message arrow.flight.protocol.sql.ActionCreatePreparedStatementResult.
697
+ * Use `create(ActionCreatePreparedStatementResultSchema)` to create a new message.
698
+ */
699
+ export declare const ActionCreatePreparedStatementResultSchema: GenMessage<ActionCreatePreparedStatementResult>;
700
+ /**
701
+ *
702
+ * Request message for the "ClosePreparedStatement" action on a Flight SQL enabled backend.
703
+ * Closes server resources associated with the prepared statement handle.
704
+ *
705
+ * @generated from message arrow.flight.protocol.sql.ActionClosePreparedStatementRequest
706
+ */
707
+ export type ActionClosePreparedStatementRequest = Message<"arrow.flight.protocol.sql.ActionClosePreparedStatementRequest"> & {
708
+ /**
709
+ * Opaque handle for the prepared statement on the server.
710
+ *
711
+ * @generated from field: bytes prepared_statement_handle = 1;
712
+ */
713
+ preparedStatementHandle: Uint8Array;
714
+ };
715
+ /**
716
+ * Describes the message arrow.flight.protocol.sql.ActionClosePreparedStatementRequest.
717
+ * Use `create(ActionClosePreparedStatementRequestSchema)` to create a new message.
718
+ */
719
+ export declare const ActionClosePreparedStatementRequestSchema: GenMessage<ActionClosePreparedStatementRequest>;
720
+ /**
721
+ *
722
+ * Request message for the "BeginTransaction" action.
723
+ * Begins a transaction.
724
+ *
725
+ * @generated from message arrow.flight.protocol.sql.ActionBeginTransactionRequest
726
+ */
727
+ export type ActionBeginTransactionRequest = Message<"arrow.flight.protocol.sql.ActionBeginTransactionRequest"> & {};
728
+ /**
729
+ * Describes the message arrow.flight.protocol.sql.ActionBeginTransactionRequest.
730
+ * Use `create(ActionBeginTransactionRequestSchema)` to create a new message.
731
+ */
732
+ export declare const ActionBeginTransactionRequestSchema: GenMessage<ActionBeginTransactionRequest>;
733
+ /**
734
+ *
735
+ * Request message for the "BeginSavepoint" action.
736
+ * Creates a savepoint within a transaction.
737
+ *
738
+ * Only supported if FLIGHT_SQL_SERVER_TRANSACTION returns
739
+ * SQL_SUPPORTED_TRANSACTION_SAVEPOINT.
740
+ *
741
+ * @generated from message arrow.flight.protocol.sql.ActionBeginSavepointRequest
742
+ */
743
+ export type ActionBeginSavepointRequest = Message<"arrow.flight.protocol.sql.ActionBeginSavepointRequest"> & {
744
+ /**
745
+ * The transaction to which a savepoint belongs.
746
+ *
747
+ * @generated from field: bytes transaction_id = 1;
748
+ */
749
+ transactionId: Uint8Array;
750
+ /**
751
+ * Name for the savepoint.
752
+ *
753
+ * @generated from field: string name = 2;
754
+ */
755
+ name: string;
756
+ };
757
+ /**
758
+ * Describes the message arrow.flight.protocol.sql.ActionBeginSavepointRequest.
759
+ * Use `create(ActionBeginSavepointRequestSchema)` to create a new message.
760
+ */
761
+ export declare const ActionBeginSavepointRequestSchema: GenMessage<ActionBeginSavepointRequest>;
762
+ /**
763
+ *
764
+ * The result of a "BeginTransaction" action.
765
+ *
766
+ * The transaction can be manipulated with the "EndTransaction" action, or
767
+ * automatically via server timeout. If the transaction times out, then it is
768
+ * automatically rolled back.
769
+ *
770
+ * The result should be wrapped in a google.protobuf.Any message.
771
+ *
772
+ * @generated from message arrow.flight.protocol.sql.ActionBeginTransactionResult
773
+ */
774
+ export type ActionBeginTransactionResult = Message<"arrow.flight.protocol.sql.ActionBeginTransactionResult"> & {
775
+ /**
776
+ * Opaque handle for the transaction on the server.
777
+ *
778
+ * @generated from field: bytes transaction_id = 1;
779
+ */
780
+ transactionId: Uint8Array;
781
+ };
782
+ /**
783
+ * Describes the message arrow.flight.protocol.sql.ActionBeginTransactionResult.
784
+ * Use `create(ActionBeginTransactionResultSchema)` to create a new message.
785
+ */
786
+ export declare const ActionBeginTransactionResultSchema: GenMessage<ActionBeginTransactionResult>;
787
+ /**
788
+ *
789
+ * The result of a "BeginSavepoint" action.
790
+ *
791
+ * The transaction can be manipulated with the "EndSavepoint" action.
792
+ * If the associated transaction is committed, rolled back, or times
793
+ * out, then the savepoint is also invalidated.
794
+ *
795
+ * The result should be wrapped in a google.protobuf.Any message.
796
+ *
797
+ * @generated from message arrow.flight.protocol.sql.ActionBeginSavepointResult
798
+ */
799
+ export type ActionBeginSavepointResult = Message<"arrow.flight.protocol.sql.ActionBeginSavepointResult"> & {
800
+ /**
801
+ * Opaque handle for the savepoint on the server.
802
+ *
803
+ * @generated from field: bytes savepoint_id = 1;
804
+ */
805
+ savepointId: Uint8Array;
806
+ };
807
+ /**
808
+ * Describes the message arrow.flight.protocol.sql.ActionBeginSavepointResult.
809
+ * Use `create(ActionBeginSavepointResultSchema)` to create a new message.
810
+ */
811
+ export declare const ActionBeginSavepointResultSchema: GenMessage<ActionBeginSavepointResult>;
812
+ /**
813
+ *
814
+ * Request message for the "EndTransaction" action.
815
+ *
816
+ * Commit (COMMIT) or rollback (ROLLBACK) the transaction.
817
+ *
818
+ * If the action completes successfully, the transaction handle is
819
+ * invalidated, as are all associated savepoints.
820
+ *
821
+ * @generated from message arrow.flight.protocol.sql.ActionEndTransactionRequest
822
+ */
823
+ export type ActionEndTransactionRequest = Message<"arrow.flight.protocol.sql.ActionEndTransactionRequest"> & {
824
+ /**
825
+ * Opaque handle for the transaction on the server.
826
+ *
827
+ * @generated from field: bytes transaction_id = 1;
828
+ */
829
+ transactionId: Uint8Array;
830
+ /**
831
+ * Whether to commit/rollback the given transaction.
832
+ *
833
+ * @generated from field: arrow.flight.protocol.sql.ActionEndTransactionRequest.EndTransaction action = 2;
834
+ */
835
+ action: ActionEndTransactionRequest_EndTransaction;
836
+ };
837
+ /**
838
+ * Describes the message arrow.flight.protocol.sql.ActionEndTransactionRequest.
839
+ * Use `create(ActionEndTransactionRequestSchema)` to create a new message.
840
+ */
841
+ export declare const ActionEndTransactionRequestSchema: GenMessage<ActionEndTransactionRequest>;
842
+ /**
843
+ * @generated from enum arrow.flight.protocol.sql.ActionEndTransactionRequest.EndTransaction
844
+ */
845
+ export declare enum ActionEndTransactionRequest_EndTransaction {
846
+ /**
847
+ * @generated from enum value: END_TRANSACTION_UNSPECIFIED = 0;
848
+ */
849
+ UNSPECIFIED = 0,
850
+ /**
851
+ * Commit the transaction.
852
+ *
853
+ * @generated from enum value: END_TRANSACTION_COMMIT = 1;
854
+ */
855
+ COMMIT = 1,
856
+ /**
857
+ * Roll back the transaction.
858
+ *
859
+ * @generated from enum value: END_TRANSACTION_ROLLBACK = 2;
860
+ */
861
+ ROLLBACK = 2
862
+ }
863
+ /**
864
+ * Describes the enum arrow.flight.protocol.sql.ActionEndTransactionRequest.EndTransaction.
865
+ */
866
+ export declare const ActionEndTransactionRequest_EndTransactionSchema: GenEnum<ActionEndTransactionRequest_EndTransaction>;
867
+ /**
868
+ *
869
+ * Request message for the "EndSavepoint" action.
870
+ *
871
+ * Release (RELEASE) the savepoint or rollback (ROLLBACK) to the
872
+ * savepoint.
873
+ *
874
+ * Releasing a savepoint invalidates that savepoint. Rolling back to
875
+ * a savepoint does not invalidate the savepoint, but invalidates all
876
+ * savepoints created after the current savepoint.
877
+ *
878
+ * @generated from message arrow.flight.protocol.sql.ActionEndSavepointRequest
879
+ */
880
+ export type ActionEndSavepointRequest = Message<"arrow.flight.protocol.sql.ActionEndSavepointRequest"> & {
881
+ /**
882
+ * Opaque handle for the savepoint on the server.
883
+ *
884
+ * @generated from field: bytes savepoint_id = 1;
885
+ */
886
+ savepointId: Uint8Array;
887
+ /**
888
+ * Whether to rollback/release the given savepoint.
889
+ *
890
+ * @generated from field: arrow.flight.protocol.sql.ActionEndSavepointRequest.EndSavepoint action = 2;
891
+ */
892
+ action: ActionEndSavepointRequest_EndSavepoint;
893
+ };
894
+ /**
895
+ * Describes the message arrow.flight.protocol.sql.ActionEndSavepointRequest.
896
+ * Use `create(ActionEndSavepointRequestSchema)` to create a new message.
897
+ */
898
+ export declare const ActionEndSavepointRequestSchema: GenMessage<ActionEndSavepointRequest>;
899
+ /**
900
+ * @generated from enum arrow.flight.protocol.sql.ActionEndSavepointRequest.EndSavepoint
901
+ */
902
+ export declare enum ActionEndSavepointRequest_EndSavepoint {
903
+ /**
904
+ * @generated from enum value: END_SAVEPOINT_UNSPECIFIED = 0;
905
+ */
906
+ UNSPECIFIED = 0,
907
+ /**
908
+ * Release the savepoint.
909
+ *
910
+ * @generated from enum value: END_SAVEPOINT_RELEASE = 1;
911
+ */
912
+ RELEASE = 1,
913
+ /**
914
+ * Roll back to a savepoint.
915
+ *
916
+ * @generated from enum value: END_SAVEPOINT_ROLLBACK = 2;
917
+ */
918
+ ROLLBACK = 2
919
+ }
920
+ /**
921
+ * Describes the enum arrow.flight.protocol.sql.ActionEndSavepointRequest.EndSavepoint.
922
+ */
923
+ export declare const ActionEndSavepointRequest_EndSavepointSchema: GenEnum<ActionEndSavepointRequest_EndSavepoint>;
924
+ /**
925
+ *
926
+ * Represents a SQL query. Used in the command member of FlightDescriptor
927
+ * for the following RPC calls:
928
+ * - GetSchema: return the Arrow schema of the query.
929
+ * Fields on this schema may contain the following metadata:
930
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
931
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
932
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
933
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
934
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
935
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
936
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
937
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
938
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
939
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
940
+ * - ARROW:FLIGHT:SQL:REMARKS - A comment describing the column. This field has been added after all others, clients should be prepared to find it missing.
941
+ * - GetFlightInfo: execute the query.
942
+ *
943
+ * @generated from message arrow.flight.protocol.sql.CommandStatementQuery
944
+ */
945
+ export type CommandStatementQuery = Message<"arrow.flight.protocol.sql.CommandStatementQuery"> & {
946
+ /**
947
+ * The SQL syntax.
948
+ *
949
+ * @generated from field: string query = 1;
950
+ */
951
+ query: string;
952
+ /**
953
+ * Include the query as part of this transaction (if unset, the query is auto-committed).
954
+ *
955
+ * @generated from field: optional bytes transaction_id = 2;
956
+ */
957
+ transactionId?: Uint8Array;
958
+ };
959
+ /**
960
+ * Describes the message arrow.flight.protocol.sql.CommandStatementQuery.
961
+ * Use `create(CommandStatementQuerySchema)` to create a new message.
962
+ */
963
+ export declare const CommandStatementQuerySchema: GenMessage<CommandStatementQuery>;
964
+ /**
965
+ *
966
+ * Represents a Substrait plan. Used in the command member of FlightDescriptor
967
+ * for the following RPC calls:
968
+ * - GetSchema: return the Arrow schema of the query.
969
+ * Fields on this schema may contain the following metadata:
970
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
971
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
972
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
973
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
974
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
975
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
976
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
977
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
978
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
979
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
980
+ * - ARROW:FLIGHT:SQL:REMARKS - A comment describing the column. This field has been added after all others, clients should be prepared to find it missing.
981
+ * - GetFlightInfo: execute the query.
982
+ * - DoPut: execute the query.
983
+ *
984
+ * @generated from message arrow.flight.protocol.sql.CommandStatementSubstraitPlan
985
+ */
986
+ export type CommandStatementSubstraitPlan = Message<"arrow.flight.protocol.sql.CommandStatementSubstraitPlan"> & {
987
+ /**
988
+ * A serialized substrait.Plan
989
+ *
990
+ * @generated from field: arrow.flight.protocol.sql.SubstraitPlan plan = 1;
991
+ */
992
+ plan?: SubstraitPlan;
993
+ /**
994
+ * Include the query as part of this transaction (if unset, the query is auto-committed).
995
+ *
996
+ * @generated from field: optional bytes transaction_id = 2;
997
+ */
998
+ transactionId?: Uint8Array;
999
+ };
1000
+ /**
1001
+ * Describes the message arrow.flight.protocol.sql.CommandStatementSubstraitPlan.
1002
+ * Use `create(CommandStatementSubstraitPlanSchema)` to create a new message.
1003
+ */
1004
+ export declare const CommandStatementSubstraitPlanSchema: GenMessage<CommandStatementSubstraitPlan>;
1005
+ /**
1006
+ * *
1007
+ * Represents a ticket resulting from GetFlightInfo with a CommandStatementQuery.
1008
+ * This should be used only once and treated as an opaque value, that is, clients should not attempt to parse this.
1009
+ *
1010
+ * @generated from message arrow.flight.protocol.sql.TicketStatementQuery
1011
+ */
1012
+ export type TicketStatementQuery = Message<"arrow.flight.protocol.sql.TicketStatementQuery"> & {
1013
+ /**
1014
+ * Unique identifier for the instance of the statement to execute.
1015
+ *
1016
+ * @generated from field: bytes statement_handle = 1;
1017
+ */
1018
+ statementHandle: Uint8Array;
1019
+ };
1020
+ /**
1021
+ * Describes the message arrow.flight.protocol.sql.TicketStatementQuery.
1022
+ * Use `create(TicketStatementQuerySchema)` to create a new message.
1023
+ */
1024
+ export declare const TicketStatementQuerySchema: GenMessage<TicketStatementQuery>;
1025
+ /**
1026
+ *
1027
+ * Represents an instance of executing a prepared statement. Used in the command member of FlightDescriptor for
1028
+ * the following RPC calls:
1029
+ * - GetSchema: return the Arrow schema of the query.
1030
+ * Fields on this schema may contain the following metadata:
1031
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
1032
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
1033
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
1034
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
1035
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
1036
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
1037
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
1038
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
1039
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
1040
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
1041
+ * - ARROW:FLIGHT:SQL:REMARKS - A comment describing the column. This field has been added after all others, clients should be prepared to find it missing.
1042
+ *
1043
+ * If the schema is retrieved after parameter values have been bound with DoPut, then the server should account
1044
+ * for the parameters when determining the schema.
1045
+ * - DoPut: bind parameter values. All of the bound parameter sets will be executed as a single atomic execution.
1046
+ * - GetFlightInfo: execute the prepared statement instance.
1047
+ *
1048
+ * @generated from message arrow.flight.protocol.sql.CommandPreparedStatementQuery
1049
+ */
1050
+ export type CommandPreparedStatementQuery = Message<"arrow.flight.protocol.sql.CommandPreparedStatementQuery"> & {
1051
+ /**
1052
+ * Opaque handle for the prepared statement on the server.
1053
+ *
1054
+ * @generated from field: bytes prepared_statement_handle = 1;
1055
+ */
1056
+ preparedStatementHandle: Uint8Array;
1057
+ };
1058
+ /**
1059
+ * Describes the message arrow.flight.protocol.sql.CommandPreparedStatementQuery.
1060
+ * Use `create(CommandPreparedStatementQuerySchema)` to create a new message.
1061
+ */
1062
+ export declare const CommandPreparedStatementQuerySchema: GenMessage<CommandPreparedStatementQuery>;
1063
+ /**
1064
+ *
1065
+ * Represents a SQL update query. Used in the command member of FlightDescriptor
1066
+ * for the RPC call DoPut to cause the server to execute the included SQL update.
1067
+ *
1068
+ * @generated from message arrow.flight.protocol.sql.CommandStatementUpdate
1069
+ */
1070
+ export type CommandStatementUpdate = Message<"arrow.flight.protocol.sql.CommandStatementUpdate"> & {
1071
+ /**
1072
+ * The SQL syntax.
1073
+ *
1074
+ * @generated from field: string query = 1;
1075
+ */
1076
+ query: string;
1077
+ /**
1078
+ * Include the query as part of this transaction (if unset, the query is auto-committed).
1079
+ *
1080
+ * @generated from field: optional bytes transaction_id = 2;
1081
+ */
1082
+ transactionId?: Uint8Array;
1083
+ };
1084
+ /**
1085
+ * Describes the message arrow.flight.protocol.sql.CommandStatementUpdate.
1086
+ * Use `create(CommandStatementUpdateSchema)` to create a new message.
1087
+ */
1088
+ export declare const CommandStatementUpdateSchema: GenMessage<CommandStatementUpdate>;
1089
+ /**
1090
+ *
1091
+ * Represents a SQL update query. Used in the command member of FlightDescriptor
1092
+ * for the RPC call DoPut to cause the server to execute the included
1093
+ * prepared statement handle as an update.
1094
+ *
1095
+ * @generated from message arrow.flight.protocol.sql.CommandPreparedStatementUpdate
1096
+ */
1097
+ export type CommandPreparedStatementUpdate = Message<"arrow.flight.protocol.sql.CommandPreparedStatementUpdate"> & {
1098
+ /**
1099
+ * Opaque handle for the prepared statement on the server.
1100
+ *
1101
+ * @generated from field: bytes prepared_statement_handle = 1;
1102
+ */
1103
+ preparedStatementHandle: Uint8Array;
1104
+ };
1105
+ /**
1106
+ * Describes the message arrow.flight.protocol.sql.CommandPreparedStatementUpdate.
1107
+ * Use `create(CommandPreparedStatementUpdateSchema)` to create a new message.
1108
+ */
1109
+ export declare const CommandPreparedStatementUpdateSchema: GenMessage<CommandPreparedStatementUpdate>;
1110
+ /**
1111
+ *
1112
+ * Represents a bulk ingestion request. Used in the command member of FlightDescriptor
1113
+ * for the RPC call DoPut to cause the server load the contents of the stream's
1114
+ * FlightData into the target destination.
1115
+ *
1116
+ * @generated from message arrow.flight.protocol.sql.CommandStatementIngest
1117
+ */
1118
+ export type CommandStatementIngest = Message<"arrow.flight.protocol.sql.CommandStatementIngest"> & {
1119
+ /**
1120
+ * The behavior for handling the table definition.
1121
+ *
1122
+ * @generated from field: arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions table_definition_options = 1;
1123
+ */
1124
+ tableDefinitionOptions?: CommandStatementIngest_TableDefinitionOptions;
1125
+ /**
1126
+ * The table to load data into.
1127
+ *
1128
+ * @generated from field: string table = 2;
1129
+ */
1130
+ table: string;
1131
+ /**
1132
+ * The db_schema of the destination table to load data into. If unset, a backend-specific default may be used.
1133
+ *
1134
+ * @generated from field: optional string schema = 3;
1135
+ */
1136
+ schema?: string;
1137
+ /**
1138
+ * The catalog of the destination table to load data into. If unset, a backend-specific default may be used.
1139
+ *
1140
+ * @generated from field: optional string catalog = 4;
1141
+ */
1142
+ catalog?: string;
1143
+ /**
1144
+ *
1145
+ * Store ingested data in a temporary table.
1146
+ * The effect of setting temporary is to place the table in a backend-defined namespace, and to drop the table at the end of the session.
1147
+ * The namespacing may make use of a backend-specific schema and/or catalog.
1148
+ * The server should return an error if an explicit choice of schema or catalog is incompatible with the server's namespacing decision.
1149
+ *
1150
+ * @generated from field: bool temporary = 5;
1151
+ */
1152
+ temporary: boolean;
1153
+ /**
1154
+ * Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation.
1155
+ *
1156
+ * @generated from field: optional bytes transaction_id = 6;
1157
+ */
1158
+ transactionId?: Uint8Array;
1159
+ /**
1160
+ * Backend-specific options.
1161
+ *
1162
+ * @generated from field: map<string, string> options = 1000;
1163
+ */
1164
+ options: {
1165
+ [key: string]: string;
1166
+ };
1167
+ };
1168
+ /**
1169
+ * Describes the message arrow.flight.protocol.sql.CommandStatementIngest.
1170
+ * Use `create(CommandStatementIngestSchema)` to create a new message.
1171
+ */
1172
+ export declare const CommandStatementIngestSchema: GenMessage<CommandStatementIngest>;
1173
+ /**
1174
+ * Options for table definition behavior
1175
+ *
1176
+ * @generated from message arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions
1177
+ */
1178
+ export type CommandStatementIngest_TableDefinitionOptions = Message<"arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions"> & {
1179
+ /**
1180
+ * @generated from field: arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions.TableNotExistOption if_not_exist = 1;
1181
+ */
1182
+ ifNotExist: CommandStatementIngest_TableDefinitionOptions_TableNotExistOption;
1183
+ /**
1184
+ * @generated from field: arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions.TableExistsOption if_exists = 2;
1185
+ */
1186
+ ifExists: CommandStatementIngest_TableDefinitionOptions_TableExistsOption;
1187
+ };
1188
+ /**
1189
+ * Describes the message arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions.
1190
+ * Use `create(CommandStatementIngest_TableDefinitionOptionsSchema)` to create a new message.
1191
+ */
1192
+ export declare const CommandStatementIngest_TableDefinitionOptionsSchema: GenMessage<CommandStatementIngest_TableDefinitionOptions>;
1193
+ /**
1194
+ * The action to take if the target table does not exist
1195
+ *
1196
+ * @generated from enum arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions.TableNotExistOption
1197
+ */
1198
+ export declare enum CommandStatementIngest_TableDefinitionOptions_TableNotExistOption {
1199
+ /**
1200
+ * Do not use. Servers should error if this is specified by a client.
1201
+ *
1202
+ * @generated from enum value: TABLE_NOT_EXIST_OPTION_UNSPECIFIED = 0;
1203
+ */
1204
+ UNSPECIFIED = 0,
1205
+ /**
1206
+ * Create the table if it does not exist
1207
+ *
1208
+ * @generated from enum value: TABLE_NOT_EXIST_OPTION_CREATE = 1;
1209
+ */
1210
+ CREATE = 1,
1211
+ /**
1212
+ * Fail if the table does not exist
1213
+ *
1214
+ * @generated from enum value: TABLE_NOT_EXIST_OPTION_FAIL = 2;
1215
+ */
1216
+ FAIL = 2
1217
+ }
1218
+ /**
1219
+ * Describes the enum arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions.TableNotExistOption.
1220
+ */
1221
+ export declare const CommandStatementIngest_TableDefinitionOptions_TableNotExistOptionSchema: GenEnum<CommandStatementIngest_TableDefinitionOptions_TableNotExistOption>;
1222
+ /**
1223
+ * The action to take if the target table already exists
1224
+ *
1225
+ * @generated from enum arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions.TableExistsOption
1226
+ */
1227
+ export declare enum CommandStatementIngest_TableDefinitionOptions_TableExistsOption {
1228
+ /**
1229
+ * Do not use. Servers should error if this is specified by a client.
1230
+ *
1231
+ * @generated from enum value: TABLE_EXISTS_OPTION_UNSPECIFIED = 0;
1232
+ */
1233
+ UNSPECIFIED = 0,
1234
+ /**
1235
+ * Fail if the table already exists
1236
+ *
1237
+ * @generated from enum value: TABLE_EXISTS_OPTION_FAIL = 1;
1238
+ */
1239
+ FAIL = 1,
1240
+ /**
1241
+ * Append to the table if it already exists
1242
+ *
1243
+ * @generated from enum value: TABLE_EXISTS_OPTION_APPEND = 2;
1244
+ */
1245
+ APPEND = 2,
1246
+ /**
1247
+ * Drop and recreate the table if it already exists
1248
+ *
1249
+ * @generated from enum value: TABLE_EXISTS_OPTION_REPLACE = 3;
1250
+ */
1251
+ REPLACE = 3
1252
+ }
1253
+ /**
1254
+ * Describes the enum arrow.flight.protocol.sql.CommandStatementIngest.TableDefinitionOptions.TableExistsOption.
1255
+ */
1256
+ export declare const CommandStatementIngest_TableDefinitionOptions_TableExistsOptionSchema: GenEnum<CommandStatementIngest_TableDefinitionOptions_TableExistsOption>;
1257
+ /**
1258
+ *
1259
+ * Returned from the RPC call DoPut when a CommandStatementUpdate,
1260
+ * CommandPreparedStatementUpdate, or CommandStatementIngest was
1261
+ * in the request, containing results from the update.
1262
+ *
1263
+ * @generated from message arrow.flight.protocol.sql.DoPutUpdateResult
1264
+ */
1265
+ export type DoPutUpdateResult = Message<"arrow.flight.protocol.sql.DoPutUpdateResult"> & {
1266
+ /**
1267
+ * The number of records updated. A return value of -1 represents
1268
+ * an unknown updated record count.
1269
+ *
1270
+ * @generated from field: int64 record_count = 1;
1271
+ */
1272
+ recordCount: bigint;
1273
+ };
1274
+ /**
1275
+ * Describes the message arrow.flight.protocol.sql.DoPutUpdateResult.
1276
+ * Use `create(DoPutUpdateResultSchema)` to create a new message.
1277
+ */
1278
+ export declare const DoPutUpdateResultSchema: GenMessage<DoPutUpdateResult>;
1279
+ /**
1280
+ * An *optional* response returned when `DoPut` is called with `CommandPreparedStatementQuery`.
1281
+ *
1282
+ * *Note on legacy behavior*: previous versions of the protocol did not return any result for
1283
+ * this command, and that behavior should still be supported by clients. In that case, the client
1284
+ * can continue as though the fields in this message were not provided or set to sensible default values.
1285
+ *
1286
+ * @generated from message arrow.flight.protocol.sql.DoPutPreparedStatementResult
1287
+ */
1288
+ export type DoPutPreparedStatementResult = Message<"arrow.flight.protocol.sql.DoPutPreparedStatementResult"> & {
1289
+ /**
1290
+ * Represents a (potentially updated) opaque handle for the prepared statement on the server.
1291
+ * Because the handle could potentially be updated, any previous handles for this prepared
1292
+ * statement should be considered invalid, and all subsequent requests for this prepared
1293
+ * statement must use this new handle.
1294
+ * The updated handle allows implementing query parameters with stateless services.
1295
+ *
1296
+ * When an updated handle is not provided by the server, clients should continue
1297
+ * using the previous handle provided by `ActionCreatePreparedStatementResult`.
1298
+ *
1299
+ * @generated from field: optional bytes prepared_statement_handle = 1;
1300
+ */
1301
+ preparedStatementHandle?: Uint8Array;
1302
+ };
1303
+ /**
1304
+ * Describes the message arrow.flight.protocol.sql.DoPutPreparedStatementResult.
1305
+ * Use `create(DoPutPreparedStatementResultSchema)` to create a new message.
1306
+ */
1307
+ export declare const DoPutPreparedStatementResultSchema: GenMessage<DoPutPreparedStatementResult>;
1308
+ /**
1309
+ *
1310
+ * Request message for the "CancelQuery" action.
1311
+ *
1312
+ * Explicitly cancel a running query.
1313
+ *
1314
+ * This lets a single client explicitly cancel work, no matter how many clients
1315
+ * are involved/whether the query is distributed or not, given server support.
1316
+ * The transaction/statement is not rolled back; it is the application's job to
1317
+ * commit or rollback as appropriate. This only indicates the client no longer
1318
+ * wishes to read the remainder of the query results or continue submitting
1319
+ * data.
1320
+ *
1321
+ * This command is idempotent.
1322
+ *
1323
+ * This command is deprecated since 13.0.0. Use the "CancelFlightInfo"
1324
+ * action with DoAction instead.
1325
+ *
1326
+ * @generated from message arrow.flight.protocol.sql.ActionCancelQueryRequest
1327
+ * @deprecated
1328
+ */
1329
+ export type ActionCancelQueryRequest = Message<"arrow.flight.protocol.sql.ActionCancelQueryRequest"> & {
1330
+ /**
1331
+ * The result of the GetFlightInfo RPC that initiated the query.
1332
+ * XXX(ARROW-16902): this must be a serialized FlightInfo, but is
1333
+ * rendered as bytes because Protobuf does not really support one
1334
+ * DLL using Protobuf definitions from another DLL.
1335
+ *
1336
+ * @generated from field: bytes info = 1;
1337
+ */
1338
+ info: Uint8Array;
1339
+ };
1340
+ /**
1341
+ * Describes the message arrow.flight.protocol.sql.ActionCancelQueryRequest.
1342
+ * Use `create(ActionCancelQueryRequestSchema)` to create a new message.
1343
+ * @deprecated
1344
+ */
1345
+ export declare const ActionCancelQueryRequestSchema: GenMessage<ActionCancelQueryRequest>;
1346
+ /**
1347
+ *
1348
+ * The result of cancelling a query.
1349
+ *
1350
+ * The result should be wrapped in a google.protobuf.Any message.
1351
+ *
1352
+ * This command is deprecated since 13.0.0. Use the "CancelFlightInfo"
1353
+ * action with DoAction instead.
1354
+ *
1355
+ * @generated from message arrow.flight.protocol.sql.ActionCancelQueryResult
1356
+ * @deprecated
1357
+ */
1358
+ export type ActionCancelQueryResult = Message<"arrow.flight.protocol.sql.ActionCancelQueryResult"> & {
1359
+ /**
1360
+ * @generated from field: arrow.flight.protocol.sql.ActionCancelQueryResult.CancelResult result = 1;
1361
+ */
1362
+ result: ActionCancelQueryResult_CancelResult;
1363
+ };
1364
+ /**
1365
+ * Describes the message arrow.flight.protocol.sql.ActionCancelQueryResult.
1366
+ * Use `create(ActionCancelQueryResultSchema)` to create a new message.
1367
+ * @deprecated
1368
+ */
1369
+ export declare const ActionCancelQueryResultSchema: GenMessage<ActionCancelQueryResult>;
1370
+ /**
1371
+ * @generated from enum arrow.flight.protocol.sql.ActionCancelQueryResult.CancelResult
1372
+ * @deprecated
1373
+ */
1374
+ export declare enum ActionCancelQueryResult_CancelResult {
1375
+ /**
1376
+ * The cancellation status is unknown. Servers should avoid using
1377
+ * this value (send a NOT_FOUND error if the requested query is
1378
+ * not known). Clients can retry the request.
1379
+ *
1380
+ * @generated from enum value: CANCEL_RESULT_UNSPECIFIED = 0;
1381
+ */
1382
+ UNSPECIFIED = 0,
1383
+ /**
1384
+ * The cancellation request is complete. Subsequent requests with
1385
+ * the same payload may return CANCELLED or a NOT_FOUND error.
1386
+ *
1387
+ * @generated from enum value: CANCEL_RESULT_CANCELLED = 1;
1388
+ */
1389
+ CANCELLED = 1,
1390
+ /**
1391
+ * The cancellation request is in progress. The client may retry
1392
+ * the cancellation request.
1393
+ *
1394
+ * @generated from enum value: CANCEL_RESULT_CANCELLING = 2;
1395
+ */
1396
+ CANCELLING = 2,
1397
+ /**
1398
+ * The query is not cancellable. The client should not retry the
1399
+ * cancellation request.
1400
+ *
1401
+ * @generated from enum value: CANCEL_RESULT_NOT_CANCELLABLE = 3;
1402
+ */
1403
+ NOT_CANCELLABLE = 3
1404
+ }
1405
+ /**
1406
+ * Describes the enum arrow.flight.protocol.sql.ActionCancelQueryResult.CancelResult.
1407
+ * @deprecated
1408
+ */
1409
+ export declare const ActionCancelQueryResult_CancelResultSchema: GenEnum<ActionCancelQueryResult_CancelResult>;
1410
+ /**
1411
+ * Options for CommandGetSqlInfo.
1412
+ *
1413
+ * @generated from enum arrow.flight.protocol.sql.SqlInfo
1414
+ */
1415
+ export declare enum SqlInfo {
1416
+ /**
1417
+ * Retrieves a UTF-8 string with the name of the Flight SQL Server.
1418
+ *
1419
+ * @generated from enum value: FLIGHT_SQL_SERVER_NAME = 0;
1420
+ */
1421
+ FLIGHT_SQL_SERVER_NAME = 0,
1422
+ /**
1423
+ * Retrieves a UTF-8 string with the native version of the Flight SQL Server.
1424
+ *
1425
+ * @generated from enum value: FLIGHT_SQL_SERVER_VERSION = 1;
1426
+ */
1427
+ FLIGHT_SQL_SERVER_VERSION = 1,
1428
+ /**
1429
+ * Retrieves a UTF-8 string with the Arrow format version of the Flight SQL Server.
1430
+ *
1431
+ * @generated from enum value: FLIGHT_SQL_SERVER_ARROW_VERSION = 2;
1432
+ */
1433
+ FLIGHT_SQL_SERVER_ARROW_VERSION = 2,
1434
+ /**
1435
+ *
1436
+ * Retrieves a boolean value indicating whether the Flight SQL Server is read only.
1437
+ *
1438
+ * Returns:
1439
+ * - false: if read-write
1440
+ * - true: if read only
1441
+ *
1442
+ * @generated from enum value: FLIGHT_SQL_SERVER_READ_ONLY = 3;
1443
+ */
1444
+ FLIGHT_SQL_SERVER_READ_ONLY = 3,
1445
+ /**
1446
+ *
1447
+ * Retrieves a boolean value indicating whether the Flight SQL Server supports executing
1448
+ * SQL queries.
1449
+ *
1450
+ * Note that the absence of this info (as opposed to a false value) does not necessarily
1451
+ * mean that SQL is not supported, as this property was not originally defined.
1452
+ *
1453
+ * @generated from enum value: FLIGHT_SQL_SERVER_SQL = 4;
1454
+ */
1455
+ FLIGHT_SQL_SERVER_SQL = 4,
1456
+ /**
1457
+ *
1458
+ * Retrieves a boolean value indicating whether the Flight SQL Server supports executing
1459
+ * Substrait plans.
1460
+ *
1461
+ * @generated from enum value: FLIGHT_SQL_SERVER_SUBSTRAIT = 5;
1462
+ */
1463
+ FLIGHT_SQL_SERVER_SUBSTRAIT = 5,
1464
+ /**
1465
+ *
1466
+ * Retrieves a string value indicating the minimum supported Substrait version, or null
1467
+ * if Substrait is not supported.
1468
+ *
1469
+ * @generated from enum value: FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION = 6;
1470
+ */
1471
+ FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION = 6,
1472
+ /**
1473
+ *
1474
+ * Retrieves a string value indicating the maximum supported Substrait version, or null
1475
+ * if Substrait is not supported.
1476
+ *
1477
+ * @generated from enum value: FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION = 7;
1478
+ */
1479
+ FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION = 7,
1480
+ /**
1481
+ *
1482
+ * Retrieves an int32 indicating whether the Flight SQL Server supports the
1483
+ * BeginTransaction/EndTransaction/BeginSavepoint/EndSavepoint actions.
1484
+ *
1485
+ * Even if this is not supported, the database may still support explicit "BEGIN
1486
+ * TRANSACTION"/"COMMIT" SQL statements (see SQL_TRANSACTIONS_SUPPORTED); this property
1487
+ * is only about whether the server implements the Flight SQL API endpoints.
1488
+ *
1489
+ * The possible values are listed in `SqlSupportedTransaction`.
1490
+ *
1491
+ * @generated from enum value: FLIGHT_SQL_SERVER_TRANSACTION = 8;
1492
+ */
1493
+ FLIGHT_SQL_SERVER_TRANSACTION = 8,
1494
+ /**
1495
+ *
1496
+ * Retrieves a boolean value indicating whether the Flight SQL Server supports explicit
1497
+ * query cancellation (the CancelQuery action).
1498
+ *
1499
+ * @generated from enum value: FLIGHT_SQL_SERVER_CANCEL = 9;
1500
+ */
1501
+ FLIGHT_SQL_SERVER_CANCEL = 9,
1502
+ /**
1503
+ *
1504
+ * Retrieves a boolean value indicating whether the Flight SQL Server supports executing
1505
+ * bulk ingestion.
1506
+ *
1507
+ * @generated from enum value: FLIGHT_SQL_SERVER_BULK_INGESTION = 10;
1508
+ */
1509
+ FLIGHT_SQL_SERVER_BULK_INGESTION = 10,
1510
+ /**
1511
+ *
1512
+ * Retrieves a boolean value indicating whether transactions are supported for bulk ingestion. If not, invoking
1513
+ * the method commit in the context of a bulk ingestion is a noop, and the isolation level is
1514
+ * `arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE`.
1515
+ *
1516
+ * Returns:
1517
+ * - false: if bulk ingestion transactions are unsupported;
1518
+ * - true: if bulk ingestion transactions are supported.
1519
+ *
1520
+ * @generated from enum value: FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED = 11;
1521
+ */
1522
+ FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED = 11,
1523
+ /**
1524
+ *
1525
+ * Retrieves an int32 indicating the timeout (in milliseconds) for prepared statement handles.
1526
+ *
1527
+ * If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.
1528
+ *
1529
+ * @generated from enum value: FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT = 100;
1530
+ */
1531
+ FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT = 100,
1532
+ /**
1533
+ *
1534
+ * Retrieves an int32 indicating the timeout (in milliseconds) for transactions, since transactions are not tied to a connection.
1535
+ *
1536
+ * If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.
1537
+ *
1538
+ * @generated from enum value: FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT = 101;
1539
+ */
1540
+ FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT = 101,
1541
+ /**
1542
+ *
1543
+ * Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of catalogs.
1544
+ *
1545
+ * Returns:
1546
+ * - false: if it doesn't support CREATE and DROP of catalogs.
1547
+ * - true: if it supports CREATE and DROP of catalogs.
1548
+ *
1549
+ * @generated from enum value: SQL_DDL_CATALOG = 500;
1550
+ */
1551
+ SQL_DDL_CATALOG = 500,
1552
+ /**
1553
+ *
1554
+ * Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of schemas.
1555
+ *
1556
+ * Returns:
1557
+ * - false: if it doesn't support CREATE and DROP of schemas.
1558
+ * - true: if it supports CREATE and DROP of schemas.
1559
+ *
1560
+ * @generated from enum value: SQL_DDL_SCHEMA = 501;
1561
+ */
1562
+ SQL_DDL_SCHEMA = 501,
1563
+ /**
1564
+ *
1565
+ * Indicates whether the Flight SQL Server supports CREATE and DROP of tables.
1566
+ *
1567
+ * Returns:
1568
+ * - false: if it doesn't support CREATE and DROP of tables.
1569
+ * - true: if it supports CREATE and DROP of tables.
1570
+ *
1571
+ * @generated from enum value: SQL_DDL_TABLE = 502;
1572
+ */
1573
+ SQL_DDL_TABLE = 502,
1574
+ /**
1575
+ *
1576
+ * Retrieves an int32 ordinal representing the case sensitivity of catalog, table, schema and table names.
1577
+ *
1578
+ * The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.
1579
+ *
1580
+ * @generated from enum value: SQL_IDENTIFIER_CASE = 503;
1581
+ */
1582
+ SQL_IDENTIFIER_CASE = 503,
1583
+ /**
1584
+ * Retrieves a UTF-8 string with the supported character(s) used to surround a delimited identifier.
1585
+ *
1586
+ * @generated from enum value: SQL_IDENTIFIER_QUOTE_CHAR = 504;
1587
+ */
1588
+ SQL_IDENTIFIER_QUOTE_CHAR = 504,
1589
+ /**
1590
+ *
1591
+ * Retrieves an int32 describing the case sensitivity of quoted identifiers.
1592
+ *
1593
+ * The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.
1594
+ *
1595
+ * @generated from enum value: SQL_QUOTED_IDENTIFIER_CASE = 505;
1596
+ */
1597
+ SQL_QUOTED_IDENTIFIER_CASE = 505,
1598
+ /**
1599
+ *
1600
+ * Retrieves a boolean value indicating whether all tables are selectable.
1601
+ *
1602
+ * Returns:
1603
+ * - false: if not all tables are selectable or if none are;
1604
+ * - true: if all tables are selectable.
1605
+ *
1606
+ * @generated from enum value: SQL_ALL_TABLES_ARE_SELECTABLE = 506;
1607
+ */
1608
+ SQL_ALL_TABLES_ARE_SELECTABLE = 506,
1609
+ /**
1610
+ *
1611
+ * Retrieves the null ordering.
1612
+ *
1613
+ * Returns an int32 ordinal for the null ordering being used, as described in
1614
+ * `arrow.flight.protocol.sql.SqlNullOrdering`.
1615
+ *
1616
+ * @generated from enum value: SQL_NULL_ORDERING = 507;
1617
+ */
1618
+ SQL_NULL_ORDERING = 507,
1619
+ /**
1620
+ * Retrieves a UTF-8 string list with values of the supported keywords.
1621
+ *
1622
+ * @generated from enum value: SQL_KEYWORDS = 508;
1623
+ */
1624
+ SQL_KEYWORDS = 508,
1625
+ /**
1626
+ * Retrieves a UTF-8 string list with values of the supported numeric functions.
1627
+ *
1628
+ * @generated from enum value: SQL_NUMERIC_FUNCTIONS = 509;
1629
+ */
1630
+ SQL_NUMERIC_FUNCTIONS = 509,
1631
+ /**
1632
+ * Retrieves a UTF-8 string list with values of the supported string functions.
1633
+ *
1634
+ * @generated from enum value: SQL_STRING_FUNCTIONS = 510;
1635
+ */
1636
+ SQL_STRING_FUNCTIONS = 510,
1637
+ /**
1638
+ * Retrieves a UTF-8 string list with values of the supported system functions.
1639
+ *
1640
+ * @generated from enum value: SQL_SYSTEM_FUNCTIONS = 511;
1641
+ */
1642
+ SQL_SYSTEM_FUNCTIONS = 511,
1643
+ /**
1644
+ * Retrieves a UTF-8 string list with values of the supported datetime functions.
1645
+ *
1646
+ * @generated from enum value: SQL_DATETIME_FUNCTIONS = 512;
1647
+ */
1648
+ SQL_DATETIME_FUNCTIONS = 512,
1649
+ /**
1650
+ *
1651
+ * Retrieves the UTF-8 string that can be used to escape wildcard characters.
1652
+ * This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern
1653
+ * (and therefore use one of the wildcard characters).
1654
+ * The '_' character represents any single character; the '%' character represents any sequence of zero or more
1655
+ * characters.
1656
+ *
1657
+ * @generated from enum value: SQL_SEARCH_STRING_ESCAPE = 513;
1658
+ */
1659
+ SQL_SEARCH_STRING_ESCAPE = 513,
1660
+ /**
1661
+ *
1662
+ * Retrieves a UTF-8 string with all the "extra" characters that can be used in unquoted identifier names
1663
+ * (those beyond a-z, A-Z, 0-9 and _).
1664
+ *
1665
+ * @generated from enum value: SQL_EXTRA_NAME_CHARACTERS = 514;
1666
+ */
1667
+ SQL_EXTRA_NAME_CHARACTERS = 514,
1668
+ /**
1669
+ *
1670
+ * Retrieves a boolean value indicating whether column aliasing is supported.
1671
+ * If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns
1672
+ * as required.
1673
+ *
1674
+ * Returns:
1675
+ * - false: if column aliasing is unsupported;
1676
+ * - true: if column aliasing is supported.
1677
+ *
1678
+ * @generated from enum value: SQL_SUPPORTS_COLUMN_ALIASING = 515;
1679
+ */
1680
+ SQL_SUPPORTS_COLUMN_ALIASING = 515,
1681
+ /**
1682
+ *
1683
+ * Retrieves a boolean value indicating whether concatenations between null and non-null values being
1684
+ * null are supported.
1685
+ *
1686
+ * Returns:
1687
+ * - false: if concatenations between null and non-null values being null are unsupported;
1688
+ * - true: if concatenations between null and non-null values being null are supported.
1689
+ *
1690
+ * @generated from enum value: SQL_NULL_PLUS_NULL_IS_NULL = 516;
1691
+ */
1692
+ SQL_NULL_PLUS_NULL_IS_NULL = 516,
1693
+ /**
1694
+ *
1695
+ * Retrieves a map where the key is the type to convert from and the value is a list with the types to convert to,
1696
+ * indicating the supported conversions. Each key and each item on the list value is a value to a predefined type on
1697
+ * SqlSupportsConvert enum.
1698
+ * The returned map will be: map<int32, list<int32>>
1699
+ *
1700
+ * @generated from enum value: SQL_SUPPORTS_CONVERT = 517;
1701
+ */
1702
+ SQL_SUPPORTS_CONVERT = 517,
1703
+ /**
1704
+ *
1705
+ * Retrieves a boolean value indicating whether, when table correlation names are supported,
1706
+ * they are restricted to being different from the names of the tables.
1707
+ *
1708
+ * Returns:
1709
+ * - false: if table correlation names are unsupported;
1710
+ * - true: if table correlation names are supported.
1711
+ *
1712
+ * @generated from enum value: SQL_SUPPORTS_TABLE_CORRELATION_NAMES = 518;
1713
+ */
1714
+ SQL_SUPPORTS_TABLE_CORRELATION_NAMES = 518,
1715
+ /**
1716
+ *
1717
+ * Retrieves a boolean value indicating whether, when table correlation names are supported,
1718
+ * they are restricted to being different from the names of the tables.
1719
+ *
1720
+ * Returns:
1721
+ * - false: if different table correlation names are unsupported;
1722
+ * - true: if different table correlation names are supported
1723
+ *
1724
+ * @generated from enum value: SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES = 519;
1725
+ */
1726
+ SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES = 519,
1727
+ /**
1728
+ *
1729
+ * Retrieves a boolean value indicating whether expressions in ORDER BY lists are supported.
1730
+ *
1731
+ * Returns:
1732
+ * - false: if expressions in ORDER BY are unsupported;
1733
+ * - true: if expressions in ORDER BY are supported;
1734
+ *
1735
+ * @generated from enum value: SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY = 520;
1736
+ */
1737
+ SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY = 520,
1738
+ /**
1739
+ *
1740
+ * Retrieves a boolean value indicating whether using a column that is not in the SELECT statement in a GROUP BY
1741
+ * clause is supported.
1742
+ *
1743
+ * Returns:
1744
+ * - false: if using a column that is not in the SELECT statement in a GROUP BY clause is unsupported;
1745
+ * - true: if using a column that is not in the SELECT statement in a GROUP BY clause is supported.
1746
+ *
1747
+ * @generated from enum value: SQL_SUPPORTS_ORDER_BY_UNRELATED = 521;
1748
+ */
1749
+ SQL_SUPPORTS_ORDER_BY_UNRELATED = 521,
1750
+ /**
1751
+ *
1752
+ * Retrieves the supported GROUP BY commands;
1753
+ *
1754
+ * Returns an int32 bitmask value representing the supported commands.
1755
+ * The returned bitmask should be parsed in order to retrieve the supported commands.
1756
+ *
1757
+ * For instance:
1758
+ * - return 0 (\b0) => [] (GROUP BY is unsupported);
1759
+ * - return 1 (\b1) => [SQL_GROUP_BY_UNRELATED];
1760
+ * - return 2 (\b10) => [SQL_GROUP_BY_BEYOND_SELECT];
1761
+ * - return 3 (\b11) => [SQL_GROUP_BY_UNRELATED, SQL_GROUP_BY_BEYOND_SELECT].
1762
+ * Valid GROUP BY types are described under `arrow.flight.protocol.sql.SqlSupportedGroupBy`.
1763
+ *
1764
+ * @generated from enum value: SQL_SUPPORTED_GROUP_BY = 522;
1765
+ */
1766
+ SQL_SUPPORTED_GROUP_BY = 522,
1767
+ /**
1768
+ *
1769
+ * Retrieves a boolean value indicating whether specifying a LIKE escape clause is supported.
1770
+ *
1771
+ * Returns:
1772
+ * - false: if specifying a LIKE escape clause is unsupported;
1773
+ * - true: if specifying a LIKE escape clause is supported.
1774
+ *
1775
+ * @generated from enum value: SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE = 523;
1776
+ */
1777
+ SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE = 523,
1778
+ /**
1779
+ *
1780
+ * Retrieves a boolean value indicating whether columns may be defined as non-nullable.
1781
+ *
1782
+ * Returns:
1783
+ * - false: if columns cannot be defined as non-nullable;
1784
+ * - true: if columns may be defined as non-nullable.
1785
+ *
1786
+ * @generated from enum value: SQL_SUPPORTS_NON_NULLABLE_COLUMNS = 524;
1787
+ */
1788
+ SQL_SUPPORTS_NON_NULLABLE_COLUMNS = 524,
1789
+ /**
1790
+ *
1791
+ * Retrieves the supported SQL grammar level as per the ODBC specification.
1792
+ *
1793
+ * Returns an int32 bitmask value representing the supported SQL grammar level.
1794
+ * The returned bitmask should be parsed in order to retrieve the supported grammar levels.
1795
+ *
1796
+ * For instance:
1797
+ * - return 0 (\b0) => [] (SQL grammar is unsupported);
1798
+ * - return 1 (\b1) => [SQL_MINIMUM_GRAMMAR];
1799
+ * - return 2 (\b10) => [SQL_CORE_GRAMMAR];
1800
+ * - return 3 (\b11) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR];
1801
+ * - return 4 (\b100) => [SQL_EXTENDED_GRAMMAR];
1802
+ * - return 5 (\b101) => [SQL_MINIMUM_GRAMMAR, SQL_EXTENDED_GRAMMAR];
1803
+ * - return 6 (\b110) => [SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR];
1804
+ * - return 7 (\b111) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR].
1805
+ * Valid SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedSqlGrammar`.
1806
+ *
1807
+ * @generated from enum value: SQL_SUPPORTED_GRAMMAR = 525;
1808
+ */
1809
+ SQL_SUPPORTED_GRAMMAR = 525,
1810
+ /**
1811
+ *
1812
+ * Retrieves the supported ANSI92 SQL grammar level.
1813
+ *
1814
+ * Returns an int32 bitmask value representing the supported ANSI92 SQL grammar level.
1815
+ * The returned bitmask should be parsed in order to retrieve the supported commands.
1816
+ *
1817
+ * For instance:
1818
+ * - return 0 (\b0) => [] (ANSI92 SQL grammar is unsupported);
1819
+ * - return 1 (\b1) => [ANSI92_ENTRY_SQL];
1820
+ * - return 2 (\b10) => [ANSI92_INTERMEDIATE_SQL];
1821
+ * - return 3 (\b11) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL];
1822
+ * - return 4 (\b100) => [ANSI92_FULL_SQL];
1823
+ * - return 5 (\b101) => [ANSI92_ENTRY_SQL, ANSI92_FULL_SQL];
1824
+ * - return 6 (\b110) => [ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL];
1825
+ * - return 7 (\b111) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL].
1826
+ * Valid ANSI92 SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel`.
1827
+ *
1828
+ * @generated from enum value: SQL_ANSI92_SUPPORTED_LEVEL = 526;
1829
+ */
1830
+ SQL_ANSI92_SUPPORTED_LEVEL = 526,
1831
+ /**
1832
+ *
1833
+ * Retrieves a boolean value indicating whether the SQL Integrity Enhancement Facility is supported.
1834
+ *
1835
+ * Returns:
1836
+ * - false: if the SQL Integrity Enhancement Facility is unsupported;
1837
+ * - true: if the SQL Integrity Enhancement Facility is supported.
1838
+ *
1839
+ * @generated from enum value: SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY = 527;
1840
+ */
1841
+ SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY = 527,
1842
+ /**
1843
+ *
1844
+ * Retrieves the support level for SQL OUTER JOINs.
1845
+ *
1846
+ * Returns an int32 ordinal for the SQL ordering being used, as described in
1847
+ * `arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel`.
1848
+ *
1849
+ * @generated from enum value: SQL_OUTER_JOINS_SUPPORT_LEVEL = 528;
1850
+ */
1851
+ SQL_OUTER_JOINS_SUPPORT_LEVEL = 528,
1852
+ /**
1853
+ * Retrieves a UTF-8 string with the preferred term for "schema".
1854
+ *
1855
+ * @generated from enum value: SQL_SCHEMA_TERM = 529;
1856
+ */
1857
+ SQL_SCHEMA_TERM = 529,
1858
+ /**
1859
+ * Retrieves a UTF-8 string with the preferred term for "procedure".
1860
+ *
1861
+ * @generated from enum value: SQL_PROCEDURE_TERM = 530;
1862
+ */
1863
+ SQL_PROCEDURE_TERM = 530,
1864
+ /**
1865
+ *
1866
+ * Retrieves a UTF-8 string with the preferred term for "catalog".
1867
+ * If an empty string is returned it is assumed that the server does NOT support catalogs.
1868
+ *
1869
+ * @generated from enum value: SQL_CATALOG_TERM = 531;
1870
+ */
1871
+ SQL_CATALOG_TERM = 531,
1872
+ /**
1873
+ *
1874
+ * Retrieves a boolean value indicating whether a catalog appears at the start of a fully qualified table name.
1875
+ *
1876
+ * - false: if a catalog does not appear at the start of a fully qualified table name;
1877
+ * - true: if a catalog appears at the start of a fully qualified table name.
1878
+ *
1879
+ * @generated from enum value: SQL_CATALOG_AT_START = 532;
1880
+ */
1881
+ SQL_CATALOG_AT_START = 532,
1882
+ /**
1883
+ *
1884
+ * Retrieves the supported actions for a SQL schema.
1885
+ *
1886
+ * Returns an int32 bitmask value representing the supported actions for a SQL schema.
1887
+ * The returned bitmask should be parsed in order to retrieve the supported actions for a SQL schema.
1888
+ *
1889
+ * For instance:
1890
+ * - return 0 (\b0) => [] (no supported actions for SQL schema);
1891
+ * - return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];
1892
+ * - return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];
1893
+ * - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
1894
+ * - return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
1895
+ * - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
1896
+ * - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
1897
+ * - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].
1898
+ * Valid actions for a SQL schema are described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.
1899
+ *
1900
+ * @generated from enum value: SQL_SCHEMAS_SUPPORTED_ACTIONS = 533;
1901
+ */
1902
+ SQL_SCHEMAS_SUPPORTED_ACTIONS = 533,
1903
+ /**
1904
+ *
1905
+ * Retrieves the supported actions for a SQL catalog.
1906
+ *
1907
+ * Returns an int32 bitmask value representing the supported actions for a SQL catalog.
1908
+ * The returned bitmask should be parsed in order to retrieve the supported actions for a SQL catalog.
1909
+ *
1910
+ * For instance:
1911
+ * - return 0 (\b0) => [] (no supported actions for SQL catalog);
1912
+ * - return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];
1913
+ * - return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];
1914
+ * - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
1915
+ * - return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
1916
+ * - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
1917
+ * - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
1918
+ * - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].
1919
+ * Valid actions for a SQL catalog are described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.
1920
+ *
1921
+ * @generated from enum value: SQL_CATALOGS_SUPPORTED_ACTIONS = 534;
1922
+ */
1923
+ SQL_CATALOGS_SUPPORTED_ACTIONS = 534,
1924
+ /**
1925
+ *
1926
+ * Retrieves the supported SQL positioned commands.
1927
+ *
1928
+ * Returns an int32 bitmask value representing the supported SQL positioned commands.
1929
+ * The returned bitmask should be parsed in order to retrieve the supported SQL positioned commands.
1930
+ *
1931
+ * For instance:
1932
+ * - return 0 (\b0) => [] (no supported SQL positioned commands);
1933
+ * - return 1 (\b1) => [SQL_POSITIONED_DELETE];
1934
+ * - return 2 (\b10) => [SQL_POSITIONED_UPDATE];
1935
+ * - return 3 (\b11) => [SQL_POSITIONED_DELETE, SQL_POSITIONED_UPDATE].
1936
+ * Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlSupportedPositionedCommands`.
1937
+ *
1938
+ * @generated from enum value: SQL_SUPPORTED_POSITIONED_COMMANDS = 535;
1939
+ */
1940
+ SQL_SUPPORTED_POSITIONED_COMMANDS = 535,
1941
+ /**
1942
+ *
1943
+ * Retrieves a boolean value indicating whether SELECT FOR UPDATE statements are supported.
1944
+ *
1945
+ * Returns:
1946
+ * - false: if SELECT FOR UPDATE statements are unsupported;
1947
+ * - true: if SELECT FOR UPDATE statements are supported.
1948
+ *
1949
+ * @generated from enum value: SQL_SELECT_FOR_UPDATE_SUPPORTED = 536;
1950
+ */
1951
+ SQL_SELECT_FOR_UPDATE_SUPPORTED = 536,
1952
+ /**
1953
+ *
1954
+ * Retrieves a boolean value indicating whether stored procedure calls that use the stored procedure escape syntax
1955
+ * are supported.
1956
+ *
1957
+ * Returns:
1958
+ * - false: if stored procedure calls that use the stored procedure escape syntax are unsupported;
1959
+ * - true: if stored procedure calls that use the stored procedure escape syntax are supported.
1960
+ *
1961
+ * @generated from enum value: SQL_STORED_PROCEDURES_SUPPORTED = 537;
1962
+ */
1963
+ SQL_STORED_PROCEDURES_SUPPORTED = 537,
1964
+ /**
1965
+ *
1966
+ * Retrieves the supported SQL subqueries.
1967
+ *
1968
+ * Returns an int32 bitmask value representing the supported SQL subqueries.
1969
+ * The returned bitmask should be parsed in order to retrieve the supported SQL subqueries.
1970
+ *
1971
+ * For instance:
1972
+ * - return 0 (\b0) => [] (no supported SQL subqueries);
1973
+ * - return 1 (\b1) => [SQL_SUBQUERIES_IN_COMPARISONS];
1974
+ * - return 2 (\b10) => [SQL_SUBQUERIES_IN_EXISTS];
1975
+ * - return 3 (\b11) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS];
1976
+ * - return 4 (\b100) => [SQL_SUBQUERIES_IN_INS];
1977
+ * - return 5 (\b101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS];
1978
+ * - return 6 (\b110) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_EXISTS];
1979
+ * - return 7 (\b111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS];
1980
+ * - return 8 (\b1000) => [SQL_SUBQUERIES_IN_QUANTIFIEDS];
1981
+ * - return 9 (\b1001) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
1982
+ * - return 10 (\b1010) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
1983
+ * - return 11 (\b1011) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
1984
+ * - return 12 (\b1100) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
1985
+ * - return 13 (\b1101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
1986
+ * - return 14 (\b1110) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
1987
+ * - return 15 (\b1111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
1988
+ * - ...
1989
+ * Valid SQL subqueries are described under `arrow.flight.protocol.sql.SqlSupportedSubqueries`.
1990
+ *
1991
+ * @generated from enum value: SQL_SUPPORTED_SUBQUERIES = 538;
1992
+ */
1993
+ SQL_SUPPORTED_SUBQUERIES = 538,
1994
+ /**
1995
+ *
1996
+ * Retrieves a boolean value indicating whether correlated subqueries are supported.
1997
+ *
1998
+ * Returns:
1999
+ * - false: if correlated subqueries are unsupported;
2000
+ * - true: if correlated subqueries are supported.
2001
+ *
2002
+ * @generated from enum value: SQL_CORRELATED_SUBQUERIES_SUPPORTED = 539;
2003
+ */
2004
+ SQL_CORRELATED_SUBQUERIES_SUPPORTED = 539,
2005
+ /**
2006
+ *
2007
+ * Retrieves the supported SQL UNIONs.
2008
+ *
2009
+ * Returns an int32 bitmask value representing the supported SQL UNIONs.
2010
+ * The returned bitmask should be parsed in order to retrieve the supported SQL UNIONs.
2011
+ *
2012
+ * For instance:
2013
+ * - return 0 (\b0) => [] (no supported SQL UNIONs);
2014
+ * - return 1 (\b1) => [SQL_UNION];
2015
+ * - return 2 (\b10) => [SQL_UNION_ALL];
2016
+ * - return 3 (\b11) => [SQL_UNION, SQL_UNION_ALL].
2017
+ * Valid SQL UNIONs are described under `arrow.flight.protocol.sql.SqlSupportedUnions`.
2018
+ *
2019
+ * @generated from enum value: SQL_SUPPORTED_UNIONS = 540;
2020
+ */
2021
+ SQL_SUPPORTED_UNIONS = 540,
2022
+ /**
2023
+ * Retrieves an int64 value representing the maximum number of hex characters allowed in an inline binary literal.
2024
+ *
2025
+ * @generated from enum value: SQL_MAX_BINARY_LITERAL_LENGTH = 541;
2026
+ */
2027
+ SQL_MAX_BINARY_LITERAL_LENGTH = 541,
2028
+ /**
2029
+ * Retrieves an int64 value representing the maximum number of characters allowed for a character literal.
2030
+ *
2031
+ * @generated from enum value: SQL_MAX_CHAR_LITERAL_LENGTH = 542;
2032
+ */
2033
+ SQL_MAX_CHAR_LITERAL_LENGTH = 542,
2034
+ /**
2035
+ * Retrieves an int64 value representing the maximum number of characters allowed for a column name.
2036
+ *
2037
+ * @generated from enum value: SQL_MAX_COLUMN_NAME_LENGTH = 543;
2038
+ */
2039
+ SQL_MAX_COLUMN_NAME_LENGTH = 543,
2040
+ /**
2041
+ * Retrieves an int64 value representing the maximum number of columns allowed in a GROUP BY clause.
2042
+ *
2043
+ * @generated from enum value: SQL_MAX_COLUMNS_IN_GROUP_BY = 544;
2044
+ */
2045
+ SQL_MAX_COLUMNS_IN_GROUP_BY = 544,
2046
+ /**
2047
+ * Retrieves an int64 value representing the maximum number of columns allowed in an index.
2048
+ *
2049
+ * @generated from enum value: SQL_MAX_COLUMNS_IN_INDEX = 545;
2050
+ */
2051
+ SQL_MAX_COLUMNS_IN_INDEX = 545,
2052
+ /**
2053
+ * Retrieves an int64 value representing the maximum number of columns allowed in an ORDER BY clause.
2054
+ *
2055
+ * @generated from enum value: SQL_MAX_COLUMNS_IN_ORDER_BY = 546;
2056
+ */
2057
+ SQL_MAX_COLUMNS_IN_ORDER_BY = 546,
2058
+ /**
2059
+ * Retrieves an int64 value representing the maximum number of columns allowed in a SELECT list.
2060
+ *
2061
+ * @generated from enum value: SQL_MAX_COLUMNS_IN_SELECT = 547;
2062
+ */
2063
+ SQL_MAX_COLUMNS_IN_SELECT = 547,
2064
+ /**
2065
+ * Retrieves an int64 value representing the maximum number of columns allowed in a table.
2066
+ *
2067
+ * @generated from enum value: SQL_MAX_COLUMNS_IN_TABLE = 548;
2068
+ */
2069
+ SQL_MAX_COLUMNS_IN_TABLE = 548,
2070
+ /**
2071
+ * Retrieves an int64 value representing the maximum number of concurrent connections possible.
2072
+ *
2073
+ * @generated from enum value: SQL_MAX_CONNECTIONS = 549;
2074
+ */
2075
+ SQL_MAX_CONNECTIONS = 549,
2076
+ /**
2077
+ * Retrieves an int64 value representing the maximum number of characters allowed in a cursor name.
2078
+ *
2079
+ * @generated from enum value: SQL_MAX_CURSOR_NAME_LENGTH = 550;
2080
+ */
2081
+ SQL_MAX_CURSOR_NAME_LENGTH = 550,
2082
+ /**
2083
+ *
2084
+ * Retrieves an int64 value representing the maximum number of bytes allowed for an index,
2085
+ * including all of the parts of the index.
2086
+ *
2087
+ * @generated from enum value: SQL_MAX_INDEX_LENGTH = 551;
2088
+ */
2089
+ SQL_MAX_INDEX_LENGTH = 551,
2090
+ /**
2091
+ * Retrieves an int64 value representing the maximum number of characters allowed in a schema name.
2092
+ *
2093
+ * @generated from enum value: SQL_DB_SCHEMA_NAME_LENGTH = 552;
2094
+ */
2095
+ SQL_DB_SCHEMA_NAME_LENGTH = 552,
2096
+ /**
2097
+ * Retrieves an int64 value representing the maximum number of characters allowed in a procedure name.
2098
+ *
2099
+ * @generated from enum value: SQL_MAX_PROCEDURE_NAME_LENGTH = 553;
2100
+ */
2101
+ SQL_MAX_PROCEDURE_NAME_LENGTH = 553,
2102
+ /**
2103
+ * Retrieves an int64 value representing the maximum number of characters allowed in a catalog name.
2104
+ *
2105
+ * @generated from enum value: SQL_MAX_CATALOG_NAME_LENGTH = 554;
2106
+ */
2107
+ SQL_MAX_CATALOG_NAME_LENGTH = 554,
2108
+ /**
2109
+ * Retrieves an int64 value representing the maximum number of bytes allowed in a single row.
2110
+ *
2111
+ * @generated from enum value: SQL_MAX_ROW_SIZE = 555;
2112
+ */
2113
+ SQL_MAX_ROW_SIZE = 555,
2114
+ /**
2115
+ *
2116
+ * Retrieves a boolean indicating whether the return value for the JDBC method getMaxRowSize includes the SQL
2117
+ * data types LONGVARCHAR and LONGVARBINARY.
2118
+ *
2119
+ * Returns:
2120
+ * - false: if return value for the JDBC method getMaxRowSize does
2121
+ * not include the SQL data types LONGVARCHAR and LONGVARBINARY;
2122
+ * - true: if return value for the JDBC method getMaxRowSize includes
2123
+ * the SQL data types LONGVARCHAR and LONGVARBINARY.
2124
+ *
2125
+ * @generated from enum value: SQL_MAX_ROW_SIZE_INCLUDES_BLOBS = 556;
2126
+ */
2127
+ SQL_MAX_ROW_SIZE_INCLUDES_BLOBS = 556,
2128
+ /**
2129
+ *
2130
+ * Retrieves an int64 value representing the maximum number of characters allowed for an SQL statement;
2131
+ * a result of 0 (zero) means that there is no limit or the limit is not known.
2132
+ *
2133
+ * @generated from enum value: SQL_MAX_STATEMENT_LENGTH = 557;
2134
+ */
2135
+ SQL_MAX_STATEMENT_LENGTH = 557,
2136
+ /**
2137
+ * Retrieves an int64 value representing the maximum number of active statements that can be open at the same time.
2138
+ *
2139
+ * @generated from enum value: SQL_MAX_STATEMENTS = 558;
2140
+ */
2141
+ SQL_MAX_STATEMENTS = 558,
2142
+ /**
2143
+ * Retrieves an int64 value representing the maximum number of characters allowed in a table name.
2144
+ *
2145
+ * @generated from enum value: SQL_MAX_TABLE_NAME_LENGTH = 559;
2146
+ */
2147
+ SQL_MAX_TABLE_NAME_LENGTH = 559,
2148
+ /**
2149
+ * Retrieves an int64 value representing the maximum number of tables allowed in a SELECT statement.
2150
+ *
2151
+ * @generated from enum value: SQL_MAX_TABLES_IN_SELECT = 560;
2152
+ */
2153
+ SQL_MAX_TABLES_IN_SELECT = 560,
2154
+ /**
2155
+ * Retrieves an int64 value representing the maximum number of characters allowed in a user name.
2156
+ *
2157
+ * @generated from enum value: SQL_MAX_USERNAME_LENGTH = 561;
2158
+ */
2159
+ SQL_MAX_USERNAME_LENGTH = 561,
2160
+ /**
2161
+ *
2162
+ * Retrieves this database's default transaction isolation level as described in
2163
+ * `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.
2164
+ *
2165
+ * Returns an int32 ordinal for the SQL transaction isolation level.
2166
+ *
2167
+ * @generated from enum value: SQL_DEFAULT_TRANSACTION_ISOLATION = 562;
2168
+ */
2169
+ SQL_DEFAULT_TRANSACTION_ISOLATION = 562,
2170
+ /**
2171
+ *
2172
+ * Retrieves a boolean value indicating whether transactions are supported. If not, invoking the method commit is a
2173
+ * noop, and the isolation level is `arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE`.
2174
+ *
2175
+ * Returns:
2176
+ * - false: if transactions are unsupported;
2177
+ * - true: if transactions are supported.
2178
+ *
2179
+ * @generated from enum value: SQL_TRANSACTIONS_SUPPORTED = 563;
2180
+ */
2181
+ SQL_TRANSACTIONS_SUPPORTED = 563,
2182
+ /**
2183
+ *
2184
+ * Retrieves the supported transactions isolation levels.
2185
+ *
2186
+ * Returns an int32 bitmask value representing the supported transactions isolation levels.
2187
+ * The returned bitmask should be parsed in order to retrieve the supported transactions isolation levels.
2188
+ *
2189
+ * For instance:
2190
+ * - return 0 (\b0) => [] (no supported SQL transactions isolation levels);
2191
+ * - return 1 (\b1) => [SQL_TRANSACTION_NONE];
2192
+ * - return 2 (\b10) => [SQL_TRANSACTION_READ_UNCOMMITTED];
2193
+ * - return 3 (\b11) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED];
2194
+ * - return 4 (\b100) => [SQL_TRANSACTION_READ_COMMITTED];
2195
+ * - return 5 (\b101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_COMMITTED];
2196
+ * - return 6 (\b110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED];
2197
+ * - return 7 (\b111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED];
2198
+ * - return 8 (\b1000) => [SQL_TRANSACTION_REPEATABLE_READ];
2199
+ * - return 9 (\b1001) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];
2200
+ * - return 10 (\b1010) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
2201
+ * - return 11 (\b1011) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
2202
+ * - return 12 (\b1100) => [SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
2203
+ * - return 13 (\b1101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
2204
+ * - return 14 (\b1110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
2205
+ * - return 15 (\b1111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
2206
+ * - return 16 (\b10000) => [SQL_TRANSACTION_SERIALIZABLE];
2207
+ * - ...
2208
+ * Valid SQL transaction isolation levels are described under `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.
2209
+ *
2210
+ * @generated from enum value: SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS = 564;
2211
+ */
2212
+ SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS = 564,
2213
+ /**
2214
+ *
2215
+ * Retrieves a boolean value indicating whether a data definition statement within a transaction forces
2216
+ * the transaction to commit.
2217
+ *
2218
+ * Returns:
2219
+ * - false: if a data definition statement within a transaction does not force the transaction to commit;
2220
+ * - true: if a data definition statement within a transaction forces the transaction to commit.
2221
+ *
2222
+ * @generated from enum value: SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT = 565;
2223
+ */
2224
+ SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT = 565,
2225
+ /**
2226
+ *
2227
+ * Retrieves a boolean value indicating whether a data definition statement within a transaction is ignored.
2228
+ *
2229
+ * Returns:
2230
+ * - false: if a data definition statement within a transaction is taken into account;
2231
+ * - true: a data definition statement within a transaction is ignored.
2232
+ *
2233
+ * @generated from enum value: SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED = 566;
2234
+ */
2235
+ SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED = 566,
2236
+ /**
2237
+ *
2238
+ * Retrieves an int32 bitmask value representing the supported result set types.
2239
+ * The returned bitmask should be parsed in order to retrieve the supported result set types.
2240
+ *
2241
+ * For instance:
2242
+ * - return 0 (\b0) => [] (no supported result set types);
2243
+ * - return 1 (\b1) => [SQL_RESULT_SET_TYPE_UNSPECIFIED];
2244
+ * - return 2 (\b10) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY];
2245
+ * - return 3 (\b11) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY];
2246
+ * - return 4 (\b100) => [SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
2247
+ * - return 5 (\b101) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
2248
+ * - return 6 (\b110) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
2249
+ * - return 7 (\b111) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
2250
+ * - return 8 (\b1000) => [SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE];
2251
+ * - ...
2252
+ * Valid result set types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetType`.
2253
+ *
2254
+ * @generated from enum value: SQL_SUPPORTED_RESULT_SET_TYPES = 567;
2255
+ */
2256
+ SQL_SUPPORTED_RESULT_SET_TYPES = 567,
2257
+ /**
2258
+ *
2259
+ * Returns an int32 bitmask value representing the concurrency types supported for
2260
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_UNSPECIFIED`.
2261
+ *
2262
+ * For instance:
2263
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
2264
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
2265
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2266
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2267
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2268
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2269
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2270
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2271
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
2272
+ *
2273
+ * @generated from enum value: SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED = 568;
2274
+ */
2275
+ SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED = 568,
2276
+ /**
2277
+ *
2278
+ * Returns an int32 bitmask value representing the concurrency types supported for
2279
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_FORWARD_ONLY`.
2280
+ *
2281
+ * For instance:
2282
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
2283
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
2284
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2285
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2286
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2287
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2288
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2289
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2290
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
2291
+ *
2292
+ * @generated from enum value: SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY = 569;
2293
+ */
2294
+ SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY = 569,
2295
+ /**
2296
+ *
2297
+ * Returns an int32 bitmask value representing the concurrency types supported for
2298
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE`.
2299
+ *
2300
+ * For instance:
2301
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
2302
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
2303
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2304
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2305
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2306
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2307
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2308
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2309
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
2310
+ *
2311
+ * @generated from enum value: SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE = 570;
2312
+ */
2313
+ SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE = 570,
2314
+ /**
2315
+ *
2316
+ * Returns an int32 bitmask value representing the concurrency types supported for
2317
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE`.
2318
+ *
2319
+ * For instance:
2320
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
2321
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
2322
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2323
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
2324
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2325
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2326
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2327
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
2328
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
2329
+ *
2330
+ * @generated from enum value: SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE = 571;
2331
+ */
2332
+ SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE = 571,
2333
+ /**
2334
+ *
2335
+ * Retrieves a boolean value indicating whether this database supports batch updates.
2336
+ *
2337
+ * - false: if this database does not support batch updates;
2338
+ * - true: if this database supports batch updates.
2339
+ *
2340
+ * @generated from enum value: SQL_BATCH_UPDATES_SUPPORTED = 572;
2341
+ */
2342
+ SQL_BATCH_UPDATES_SUPPORTED = 572,
2343
+ /**
2344
+ *
2345
+ * Retrieves a boolean value indicating whether this database supports savepoints.
2346
+ *
2347
+ * Returns:
2348
+ * - false: if this database does not support savepoints;
2349
+ * - true: if this database supports savepoints.
2350
+ *
2351
+ * @generated from enum value: SQL_SAVEPOINTS_SUPPORTED = 573;
2352
+ */
2353
+ SQL_SAVEPOINTS_SUPPORTED = 573,
2354
+ /**
2355
+ *
2356
+ * Retrieves a boolean value indicating whether named parameters are supported in callable statements.
2357
+ *
2358
+ * Returns:
2359
+ * - false: if named parameters in callable statements are unsupported;
2360
+ * - true: if named parameters in callable statements are supported.
2361
+ *
2362
+ * @generated from enum value: SQL_NAMED_PARAMETERS_SUPPORTED = 574;
2363
+ */
2364
+ SQL_NAMED_PARAMETERS_SUPPORTED = 574,
2365
+ /**
2366
+ *
2367
+ * Retrieves a boolean value indicating whether updates made to a LOB are made on a copy or directly to the LOB.
2368
+ *
2369
+ * Returns:
2370
+ * - false: if updates made to a LOB are made directly to the LOB;
2371
+ * - true: if updates made to a LOB are made on a copy.
2372
+ *
2373
+ * @generated from enum value: SQL_LOCATORS_UPDATE_COPY = 575;
2374
+ */
2375
+ SQL_LOCATORS_UPDATE_COPY = 575,
2376
+ /**
2377
+ *
2378
+ * Retrieves a boolean value indicating whether invoking user-defined or vendor functions
2379
+ * using the stored procedure escape syntax is supported.
2380
+ *
2381
+ * Returns:
2382
+ * - false: if invoking user-defined or vendor functions using the stored procedure escape syntax is unsupported;
2383
+ * - true: if invoking user-defined or vendor functions using the stored procedure escape syntax is supported.
2384
+ *
2385
+ * @generated from enum value: SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED = 576;
2386
+ */
2387
+ SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED = 576
2388
+ }
2389
+ /**
2390
+ * Describes the enum arrow.flight.protocol.sql.SqlInfo.
2391
+ */
2392
+ export declare const SqlInfoSchema: GenEnum<SqlInfo>;
2393
+ /**
2394
+ * The level of support for Flight SQL transaction RPCs.
2395
+ *
2396
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedTransaction
2397
+ */
2398
+ export declare enum SqlSupportedTransaction {
2399
+ /**
2400
+ * Unknown/not indicated/no support
2401
+ *
2402
+ * @generated from enum value: SQL_SUPPORTED_TRANSACTION_NONE = 0;
2403
+ */
2404
+ NONE = 0,
2405
+ /**
2406
+ * Transactions, but not savepoints.
2407
+ * A savepoint is a mark within a transaction that can be individually
2408
+ * rolled back to. Not all databases support savepoints.
2409
+ *
2410
+ * @generated from enum value: SQL_SUPPORTED_TRANSACTION_TRANSACTION = 1;
2411
+ */
2412
+ TRANSACTION = 1,
2413
+ /**
2414
+ * Transactions and savepoints
2415
+ *
2416
+ * @generated from enum value: SQL_SUPPORTED_TRANSACTION_SAVEPOINT = 2;
2417
+ */
2418
+ SAVEPOINT = 2
2419
+ }
2420
+ /**
2421
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedTransaction.
2422
+ */
2423
+ export declare const SqlSupportedTransactionSchema: GenEnum<SqlSupportedTransaction>;
2424
+ /**
2425
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedCaseSensitivity
2426
+ */
2427
+ export declare enum SqlSupportedCaseSensitivity {
2428
+ /**
2429
+ * @generated from enum value: SQL_CASE_SENSITIVITY_UNKNOWN = 0;
2430
+ */
2431
+ SQL_CASE_SENSITIVITY_UNKNOWN = 0,
2432
+ /**
2433
+ * @generated from enum value: SQL_CASE_SENSITIVITY_CASE_INSENSITIVE = 1;
2434
+ */
2435
+ SQL_CASE_SENSITIVITY_CASE_INSENSITIVE = 1,
2436
+ /**
2437
+ * @generated from enum value: SQL_CASE_SENSITIVITY_UPPERCASE = 2;
2438
+ */
2439
+ SQL_CASE_SENSITIVITY_UPPERCASE = 2,
2440
+ /**
2441
+ * @generated from enum value: SQL_CASE_SENSITIVITY_LOWERCASE = 3;
2442
+ */
2443
+ SQL_CASE_SENSITIVITY_LOWERCASE = 3
2444
+ }
2445
+ /**
2446
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedCaseSensitivity.
2447
+ */
2448
+ export declare const SqlSupportedCaseSensitivitySchema: GenEnum<SqlSupportedCaseSensitivity>;
2449
+ /**
2450
+ * @generated from enum arrow.flight.protocol.sql.SqlNullOrdering
2451
+ */
2452
+ export declare enum SqlNullOrdering {
2453
+ /**
2454
+ * @generated from enum value: SQL_NULLS_SORTED_HIGH = 0;
2455
+ */
2456
+ SQL_NULLS_SORTED_HIGH = 0,
2457
+ /**
2458
+ * @generated from enum value: SQL_NULLS_SORTED_LOW = 1;
2459
+ */
2460
+ SQL_NULLS_SORTED_LOW = 1,
2461
+ /**
2462
+ * @generated from enum value: SQL_NULLS_SORTED_AT_START = 2;
2463
+ */
2464
+ SQL_NULLS_SORTED_AT_START = 2,
2465
+ /**
2466
+ * @generated from enum value: SQL_NULLS_SORTED_AT_END = 3;
2467
+ */
2468
+ SQL_NULLS_SORTED_AT_END = 3
2469
+ }
2470
+ /**
2471
+ * Describes the enum arrow.flight.protocol.sql.SqlNullOrdering.
2472
+ */
2473
+ export declare const SqlNullOrderingSchema: GenEnum<SqlNullOrdering>;
2474
+ /**
2475
+ * @generated from enum arrow.flight.protocol.sql.SupportedSqlGrammar
2476
+ */
2477
+ export declare enum SupportedSqlGrammar {
2478
+ /**
2479
+ * @generated from enum value: SQL_MINIMUM_GRAMMAR = 0;
2480
+ */
2481
+ SQL_MINIMUM_GRAMMAR = 0,
2482
+ /**
2483
+ * @generated from enum value: SQL_CORE_GRAMMAR = 1;
2484
+ */
2485
+ SQL_CORE_GRAMMAR = 1,
2486
+ /**
2487
+ * @generated from enum value: SQL_EXTENDED_GRAMMAR = 2;
2488
+ */
2489
+ SQL_EXTENDED_GRAMMAR = 2
2490
+ }
2491
+ /**
2492
+ * Describes the enum arrow.flight.protocol.sql.SupportedSqlGrammar.
2493
+ */
2494
+ export declare const SupportedSqlGrammarSchema: GenEnum<SupportedSqlGrammar>;
2495
+ /**
2496
+ * @generated from enum arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel
2497
+ */
2498
+ export declare enum SupportedAnsi92SqlGrammarLevel {
2499
+ /**
2500
+ * @generated from enum value: ANSI92_ENTRY_SQL = 0;
2501
+ */
2502
+ ANSI92_ENTRY_SQL = 0,
2503
+ /**
2504
+ * @generated from enum value: ANSI92_INTERMEDIATE_SQL = 1;
2505
+ */
2506
+ ANSI92_INTERMEDIATE_SQL = 1,
2507
+ /**
2508
+ * @generated from enum value: ANSI92_FULL_SQL = 2;
2509
+ */
2510
+ ANSI92_FULL_SQL = 2
2511
+ }
2512
+ /**
2513
+ * Describes the enum arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel.
2514
+ */
2515
+ export declare const SupportedAnsi92SqlGrammarLevelSchema: GenEnum<SupportedAnsi92SqlGrammarLevel>;
2516
+ /**
2517
+ * @generated from enum arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel
2518
+ */
2519
+ export declare enum SqlOuterJoinsSupportLevel {
2520
+ /**
2521
+ * @generated from enum value: SQL_JOINS_UNSUPPORTED = 0;
2522
+ */
2523
+ SQL_JOINS_UNSUPPORTED = 0,
2524
+ /**
2525
+ * @generated from enum value: SQL_LIMITED_OUTER_JOINS = 1;
2526
+ */
2527
+ SQL_LIMITED_OUTER_JOINS = 1,
2528
+ /**
2529
+ * @generated from enum value: SQL_FULL_OUTER_JOINS = 2;
2530
+ */
2531
+ SQL_FULL_OUTER_JOINS = 2
2532
+ }
2533
+ /**
2534
+ * Describes the enum arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel.
2535
+ */
2536
+ export declare const SqlOuterJoinsSupportLevelSchema: GenEnum<SqlOuterJoinsSupportLevel>;
2537
+ /**
2538
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedGroupBy
2539
+ */
2540
+ export declare enum SqlSupportedGroupBy {
2541
+ /**
2542
+ * @generated from enum value: SQL_GROUP_BY_UNRELATED = 0;
2543
+ */
2544
+ SQL_GROUP_BY_UNRELATED = 0,
2545
+ /**
2546
+ * @generated from enum value: SQL_GROUP_BY_BEYOND_SELECT = 1;
2547
+ */
2548
+ SQL_GROUP_BY_BEYOND_SELECT = 1
2549
+ }
2550
+ /**
2551
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedGroupBy.
2552
+ */
2553
+ export declare const SqlSupportedGroupBySchema: GenEnum<SqlSupportedGroupBy>;
2554
+ /**
2555
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedElementActions
2556
+ */
2557
+ export declare enum SqlSupportedElementActions {
2558
+ /**
2559
+ * @generated from enum value: SQL_ELEMENT_IN_PROCEDURE_CALLS = 0;
2560
+ */
2561
+ SQL_ELEMENT_IN_PROCEDURE_CALLS = 0,
2562
+ /**
2563
+ * @generated from enum value: SQL_ELEMENT_IN_INDEX_DEFINITIONS = 1;
2564
+ */
2565
+ SQL_ELEMENT_IN_INDEX_DEFINITIONS = 1,
2566
+ /**
2567
+ * @generated from enum value: SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS = 2;
2568
+ */
2569
+ SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS = 2
2570
+ }
2571
+ /**
2572
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedElementActions.
2573
+ */
2574
+ export declare const SqlSupportedElementActionsSchema: GenEnum<SqlSupportedElementActions>;
2575
+ /**
2576
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedPositionedCommands
2577
+ */
2578
+ export declare enum SqlSupportedPositionedCommands {
2579
+ /**
2580
+ * @generated from enum value: SQL_POSITIONED_DELETE = 0;
2581
+ */
2582
+ SQL_POSITIONED_DELETE = 0,
2583
+ /**
2584
+ * @generated from enum value: SQL_POSITIONED_UPDATE = 1;
2585
+ */
2586
+ SQL_POSITIONED_UPDATE = 1
2587
+ }
2588
+ /**
2589
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedPositionedCommands.
2590
+ */
2591
+ export declare const SqlSupportedPositionedCommandsSchema: GenEnum<SqlSupportedPositionedCommands>;
2592
+ /**
2593
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedSubqueries
2594
+ */
2595
+ export declare enum SqlSupportedSubqueries {
2596
+ /**
2597
+ * @generated from enum value: SQL_SUBQUERIES_IN_COMPARISONS = 0;
2598
+ */
2599
+ SQL_SUBQUERIES_IN_COMPARISONS = 0,
2600
+ /**
2601
+ * @generated from enum value: SQL_SUBQUERIES_IN_EXISTS = 1;
2602
+ */
2603
+ SQL_SUBQUERIES_IN_EXISTS = 1,
2604
+ /**
2605
+ * @generated from enum value: SQL_SUBQUERIES_IN_INS = 2;
2606
+ */
2607
+ SQL_SUBQUERIES_IN_INS = 2,
2608
+ /**
2609
+ * @generated from enum value: SQL_SUBQUERIES_IN_QUANTIFIEDS = 3;
2610
+ */
2611
+ SQL_SUBQUERIES_IN_QUANTIFIEDS = 3
2612
+ }
2613
+ /**
2614
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedSubqueries.
2615
+ */
2616
+ export declare const SqlSupportedSubqueriesSchema: GenEnum<SqlSupportedSubqueries>;
2617
+ /**
2618
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedUnions
2619
+ */
2620
+ export declare enum SqlSupportedUnions {
2621
+ /**
2622
+ * @generated from enum value: SQL_UNION = 0;
2623
+ */
2624
+ SQL_UNION = 0,
2625
+ /**
2626
+ * @generated from enum value: SQL_UNION_ALL = 1;
2627
+ */
2628
+ SQL_UNION_ALL = 1
2629
+ }
2630
+ /**
2631
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedUnions.
2632
+ */
2633
+ export declare const SqlSupportedUnionsSchema: GenEnum<SqlSupportedUnions>;
2634
+ /**
2635
+ * @generated from enum arrow.flight.protocol.sql.SqlTransactionIsolationLevel
2636
+ */
2637
+ export declare enum SqlTransactionIsolationLevel {
2638
+ /**
2639
+ * @generated from enum value: SQL_TRANSACTION_NONE = 0;
2640
+ */
2641
+ SQL_TRANSACTION_NONE = 0,
2642
+ /**
2643
+ * @generated from enum value: SQL_TRANSACTION_READ_UNCOMMITTED = 1;
2644
+ */
2645
+ SQL_TRANSACTION_READ_UNCOMMITTED = 1,
2646
+ /**
2647
+ * @generated from enum value: SQL_TRANSACTION_READ_COMMITTED = 2;
2648
+ */
2649
+ SQL_TRANSACTION_READ_COMMITTED = 2,
2650
+ /**
2651
+ * @generated from enum value: SQL_TRANSACTION_REPEATABLE_READ = 3;
2652
+ */
2653
+ SQL_TRANSACTION_REPEATABLE_READ = 3,
2654
+ /**
2655
+ * @generated from enum value: SQL_TRANSACTION_SERIALIZABLE = 4;
2656
+ */
2657
+ SQL_TRANSACTION_SERIALIZABLE = 4
2658
+ }
2659
+ /**
2660
+ * Describes the enum arrow.flight.protocol.sql.SqlTransactionIsolationLevel.
2661
+ */
2662
+ export declare const SqlTransactionIsolationLevelSchema: GenEnum<SqlTransactionIsolationLevel>;
2663
+ /**
2664
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedTransactions
2665
+ */
2666
+ export declare enum SqlSupportedTransactions {
2667
+ /**
2668
+ * @generated from enum value: SQL_TRANSACTION_UNSPECIFIED = 0;
2669
+ */
2670
+ SQL_TRANSACTION_UNSPECIFIED = 0,
2671
+ /**
2672
+ * @generated from enum value: SQL_DATA_DEFINITION_TRANSACTIONS = 1;
2673
+ */
2674
+ SQL_DATA_DEFINITION_TRANSACTIONS = 1,
2675
+ /**
2676
+ * @generated from enum value: SQL_DATA_MANIPULATION_TRANSACTIONS = 2;
2677
+ */
2678
+ SQL_DATA_MANIPULATION_TRANSACTIONS = 2
2679
+ }
2680
+ /**
2681
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedTransactions.
2682
+ */
2683
+ export declare const SqlSupportedTransactionsSchema: GenEnum<SqlSupportedTransactions>;
2684
+ /**
2685
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedResultSetType
2686
+ */
2687
+ export declare enum SqlSupportedResultSetType {
2688
+ /**
2689
+ * @generated from enum value: SQL_RESULT_SET_TYPE_UNSPECIFIED = 0;
2690
+ */
2691
+ SQL_RESULT_SET_TYPE_UNSPECIFIED = 0,
2692
+ /**
2693
+ * @generated from enum value: SQL_RESULT_SET_TYPE_FORWARD_ONLY = 1;
2694
+ */
2695
+ SQL_RESULT_SET_TYPE_FORWARD_ONLY = 1,
2696
+ /**
2697
+ * @generated from enum value: SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE = 2;
2698
+ */
2699
+ SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE = 2,
2700
+ /**
2701
+ * @generated from enum value: SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE = 3;
2702
+ */
2703
+ SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE = 3
2704
+ }
2705
+ /**
2706
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedResultSetType.
2707
+ */
2708
+ export declare const SqlSupportedResultSetTypeSchema: GenEnum<SqlSupportedResultSetType>;
2709
+ /**
2710
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency
2711
+ */
2712
+ export declare enum SqlSupportedResultSetConcurrency {
2713
+ /**
2714
+ * @generated from enum value: SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED = 0;
2715
+ */
2716
+ SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED = 0,
2717
+ /**
2718
+ * @generated from enum value: SQL_RESULT_SET_CONCURRENCY_READ_ONLY = 1;
2719
+ */
2720
+ SQL_RESULT_SET_CONCURRENCY_READ_ONLY = 1,
2721
+ /**
2722
+ * @generated from enum value: SQL_RESULT_SET_CONCURRENCY_UPDATABLE = 2;
2723
+ */
2724
+ SQL_RESULT_SET_CONCURRENCY_UPDATABLE = 2
2725
+ }
2726
+ /**
2727
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency.
2728
+ */
2729
+ export declare const SqlSupportedResultSetConcurrencySchema: GenEnum<SqlSupportedResultSetConcurrency>;
2730
+ /**
2731
+ * @generated from enum arrow.flight.protocol.sql.SqlSupportsConvert
2732
+ */
2733
+ export declare enum SqlSupportsConvert {
2734
+ /**
2735
+ * @generated from enum value: SQL_CONVERT_BIGINT = 0;
2736
+ */
2737
+ SQL_CONVERT_BIGINT = 0,
2738
+ /**
2739
+ * @generated from enum value: SQL_CONVERT_BINARY = 1;
2740
+ */
2741
+ SQL_CONVERT_BINARY = 1,
2742
+ /**
2743
+ * @generated from enum value: SQL_CONVERT_BIT = 2;
2744
+ */
2745
+ SQL_CONVERT_BIT = 2,
2746
+ /**
2747
+ * @generated from enum value: SQL_CONVERT_CHAR = 3;
2748
+ */
2749
+ SQL_CONVERT_CHAR = 3,
2750
+ /**
2751
+ * @generated from enum value: SQL_CONVERT_DATE = 4;
2752
+ */
2753
+ SQL_CONVERT_DATE = 4,
2754
+ /**
2755
+ * @generated from enum value: SQL_CONVERT_DECIMAL = 5;
2756
+ */
2757
+ SQL_CONVERT_DECIMAL = 5,
2758
+ /**
2759
+ * @generated from enum value: SQL_CONVERT_FLOAT = 6;
2760
+ */
2761
+ SQL_CONVERT_FLOAT = 6,
2762
+ /**
2763
+ * @generated from enum value: SQL_CONVERT_INTEGER = 7;
2764
+ */
2765
+ SQL_CONVERT_INTEGER = 7,
2766
+ /**
2767
+ * @generated from enum value: SQL_CONVERT_INTERVAL_DAY_TIME = 8;
2768
+ */
2769
+ SQL_CONVERT_INTERVAL_DAY_TIME = 8,
2770
+ /**
2771
+ * @generated from enum value: SQL_CONVERT_INTERVAL_YEAR_MONTH = 9;
2772
+ */
2773
+ SQL_CONVERT_INTERVAL_YEAR_MONTH = 9,
2774
+ /**
2775
+ * @generated from enum value: SQL_CONVERT_LONGVARBINARY = 10;
2776
+ */
2777
+ SQL_CONVERT_LONGVARBINARY = 10,
2778
+ /**
2779
+ * @generated from enum value: SQL_CONVERT_LONGVARCHAR = 11;
2780
+ */
2781
+ SQL_CONVERT_LONGVARCHAR = 11,
2782
+ /**
2783
+ * @generated from enum value: SQL_CONVERT_NUMERIC = 12;
2784
+ */
2785
+ SQL_CONVERT_NUMERIC = 12,
2786
+ /**
2787
+ * @generated from enum value: SQL_CONVERT_REAL = 13;
2788
+ */
2789
+ SQL_CONVERT_REAL = 13,
2790
+ /**
2791
+ * @generated from enum value: SQL_CONVERT_SMALLINT = 14;
2792
+ */
2793
+ SQL_CONVERT_SMALLINT = 14,
2794
+ /**
2795
+ * @generated from enum value: SQL_CONVERT_TIME = 15;
2796
+ */
2797
+ SQL_CONVERT_TIME = 15,
2798
+ /**
2799
+ * @generated from enum value: SQL_CONVERT_TIMESTAMP = 16;
2800
+ */
2801
+ SQL_CONVERT_TIMESTAMP = 16,
2802
+ /**
2803
+ * @generated from enum value: SQL_CONVERT_TINYINT = 17;
2804
+ */
2805
+ SQL_CONVERT_TINYINT = 17,
2806
+ /**
2807
+ * @generated from enum value: SQL_CONVERT_VARBINARY = 18;
2808
+ */
2809
+ SQL_CONVERT_VARBINARY = 18,
2810
+ /**
2811
+ * @generated from enum value: SQL_CONVERT_VARCHAR = 19;
2812
+ */
2813
+ SQL_CONVERT_VARCHAR = 19
2814
+ }
2815
+ /**
2816
+ * Describes the enum arrow.flight.protocol.sql.SqlSupportsConvert.
2817
+ */
2818
+ export declare const SqlSupportsConvertSchema: GenEnum<SqlSupportsConvert>;
2819
+ /**
2820
+ * *
2821
+ * The JDBC/ODBC-defined type of any object.
2822
+ * All the values here are the same as in the JDBC and ODBC specs.
2823
+ *
2824
+ * @generated from enum arrow.flight.protocol.sql.XdbcDataType
2825
+ */
2826
+ export declare enum XdbcDataType {
2827
+ /**
2828
+ * @generated from enum value: XDBC_UNKNOWN_TYPE = 0;
2829
+ */
2830
+ XDBC_UNKNOWN_TYPE = 0,
2831
+ /**
2832
+ * @generated from enum value: XDBC_CHAR = 1;
2833
+ */
2834
+ XDBC_CHAR = 1,
2835
+ /**
2836
+ * @generated from enum value: XDBC_NUMERIC = 2;
2837
+ */
2838
+ XDBC_NUMERIC = 2,
2839
+ /**
2840
+ * @generated from enum value: XDBC_DECIMAL = 3;
2841
+ */
2842
+ XDBC_DECIMAL = 3,
2843
+ /**
2844
+ * @generated from enum value: XDBC_INTEGER = 4;
2845
+ */
2846
+ XDBC_INTEGER = 4,
2847
+ /**
2848
+ * @generated from enum value: XDBC_SMALLINT = 5;
2849
+ */
2850
+ XDBC_SMALLINT = 5,
2851
+ /**
2852
+ * @generated from enum value: XDBC_FLOAT = 6;
2853
+ */
2854
+ XDBC_FLOAT = 6,
2855
+ /**
2856
+ * @generated from enum value: XDBC_REAL = 7;
2857
+ */
2858
+ XDBC_REAL = 7,
2859
+ /**
2860
+ * @generated from enum value: XDBC_DOUBLE = 8;
2861
+ */
2862
+ XDBC_DOUBLE = 8,
2863
+ /**
2864
+ * @generated from enum value: XDBC_DATETIME = 9;
2865
+ */
2866
+ XDBC_DATETIME = 9,
2867
+ /**
2868
+ * @generated from enum value: XDBC_INTERVAL = 10;
2869
+ */
2870
+ XDBC_INTERVAL = 10,
2871
+ /**
2872
+ * @generated from enum value: XDBC_VARCHAR = 12;
2873
+ */
2874
+ XDBC_VARCHAR = 12,
2875
+ /**
2876
+ * @generated from enum value: XDBC_DATE = 91;
2877
+ */
2878
+ XDBC_DATE = 91,
2879
+ /**
2880
+ * @generated from enum value: XDBC_TIME = 92;
2881
+ */
2882
+ XDBC_TIME = 92,
2883
+ /**
2884
+ * @generated from enum value: XDBC_TIMESTAMP = 93;
2885
+ */
2886
+ XDBC_TIMESTAMP = 93,
2887
+ /**
2888
+ * @generated from enum value: XDBC_LONGVARCHAR = -1;
2889
+ */
2890
+ XDBC_LONGVARCHAR = -1,
2891
+ /**
2892
+ * @generated from enum value: XDBC_BINARY = -2;
2893
+ */
2894
+ XDBC_BINARY = -2,
2895
+ /**
2896
+ * @generated from enum value: XDBC_VARBINARY = -3;
2897
+ */
2898
+ XDBC_VARBINARY = -3,
2899
+ /**
2900
+ * @generated from enum value: XDBC_LONGVARBINARY = -4;
2901
+ */
2902
+ XDBC_LONGVARBINARY = -4,
2903
+ /**
2904
+ * @generated from enum value: XDBC_BIGINT = -5;
2905
+ */
2906
+ XDBC_BIGINT = -5,
2907
+ /**
2908
+ * @generated from enum value: XDBC_TINYINT = -6;
2909
+ */
2910
+ XDBC_TINYINT = -6,
2911
+ /**
2912
+ * @generated from enum value: XDBC_BIT = -7;
2913
+ */
2914
+ XDBC_BIT = -7,
2915
+ /**
2916
+ * @generated from enum value: XDBC_WCHAR = -8;
2917
+ */
2918
+ XDBC_WCHAR = -8,
2919
+ /**
2920
+ * @generated from enum value: XDBC_WVARCHAR = -9;
2921
+ */
2922
+ XDBC_WVARCHAR = -9
2923
+ }
2924
+ /**
2925
+ * Describes the enum arrow.flight.protocol.sql.XdbcDataType.
2926
+ */
2927
+ export declare const XdbcDataTypeSchema: GenEnum<XdbcDataType>;
2928
+ /**
2929
+ * *
2930
+ * Detailed subtype information for XDBC_TYPE_DATETIME and XDBC_TYPE_INTERVAL.
2931
+ *
2932
+ * @generated from enum arrow.flight.protocol.sql.XdbcDatetimeSubcode
2933
+ */
2934
+ export declare enum XdbcDatetimeSubcode {
2935
+ /**
2936
+ * @generated from enum value: XDBC_SUBCODE_UNKNOWN = 0;
2937
+ */
2938
+ XDBC_SUBCODE_UNKNOWN = 0,
2939
+ /**
2940
+ * @generated from enum value: XDBC_SUBCODE_YEAR = 1;
2941
+ */
2942
+ XDBC_SUBCODE_YEAR = 1,
2943
+ /**
2944
+ * @generated from enum value: XDBC_SUBCODE_DATE = 1;
2945
+ */
2946
+ XDBC_SUBCODE_DATE = 1,
2947
+ /**
2948
+ * @generated from enum value: XDBC_SUBCODE_TIME = 2;
2949
+ */
2950
+ XDBC_SUBCODE_TIME = 2,
2951
+ /**
2952
+ * @generated from enum value: XDBC_SUBCODE_MONTH = 2;
2953
+ */
2954
+ XDBC_SUBCODE_MONTH = 2,
2955
+ /**
2956
+ * @generated from enum value: XDBC_SUBCODE_TIMESTAMP = 3;
2957
+ */
2958
+ XDBC_SUBCODE_TIMESTAMP = 3,
2959
+ /**
2960
+ * @generated from enum value: XDBC_SUBCODE_DAY = 3;
2961
+ */
2962
+ XDBC_SUBCODE_DAY = 3,
2963
+ /**
2964
+ * @generated from enum value: XDBC_SUBCODE_TIME_WITH_TIMEZONE = 4;
2965
+ */
2966
+ XDBC_SUBCODE_TIME_WITH_TIMEZONE = 4,
2967
+ /**
2968
+ * @generated from enum value: XDBC_SUBCODE_HOUR = 4;
2969
+ */
2970
+ XDBC_SUBCODE_HOUR = 4,
2971
+ /**
2972
+ * @generated from enum value: XDBC_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5;
2973
+ */
2974
+ XDBC_SUBCODE_TIMESTAMP_WITH_TIMEZONE = 5,
2975
+ /**
2976
+ * @generated from enum value: XDBC_SUBCODE_MINUTE = 5;
2977
+ */
2978
+ XDBC_SUBCODE_MINUTE = 5,
2979
+ /**
2980
+ * @generated from enum value: XDBC_SUBCODE_SECOND = 6;
2981
+ */
2982
+ XDBC_SUBCODE_SECOND = 6,
2983
+ /**
2984
+ * @generated from enum value: XDBC_SUBCODE_YEAR_TO_MONTH = 7;
2985
+ */
2986
+ XDBC_SUBCODE_YEAR_TO_MONTH = 7,
2987
+ /**
2988
+ * @generated from enum value: XDBC_SUBCODE_DAY_TO_HOUR = 8;
2989
+ */
2990
+ XDBC_SUBCODE_DAY_TO_HOUR = 8,
2991
+ /**
2992
+ * @generated from enum value: XDBC_SUBCODE_DAY_TO_MINUTE = 9;
2993
+ */
2994
+ XDBC_SUBCODE_DAY_TO_MINUTE = 9,
2995
+ /**
2996
+ * @generated from enum value: XDBC_SUBCODE_DAY_TO_SECOND = 10;
2997
+ */
2998
+ XDBC_SUBCODE_DAY_TO_SECOND = 10,
2999
+ /**
3000
+ * @generated from enum value: XDBC_SUBCODE_HOUR_TO_MINUTE = 11;
3001
+ */
3002
+ XDBC_SUBCODE_HOUR_TO_MINUTE = 11,
3003
+ /**
3004
+ * @generated from enum value: XDBC_SUBCODE_HOUR_TO_SECOND = 12;
3005
+ */
3006
+ XDBC_SUBCODE_HOUR_TO_SECOND = 12,
3007
+ /**
3008
+ * @generated from enum value: XDBC_SUBCODE_MINUTE_TO_SECOND = 13;
3009
+ */
3010
+ XDBC_SUBCODE_MINUTE_TO_SECOND = 13,
3011
+ /**
3012
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_YEAR = 101;
3013
+ */
3014
+ XDBC_SUBCODE_INTERVAL_YEAR = 101,
3015
+ /**
3016
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_MONTH = 102;
3017
+ */
3018
+ XDBC_SUBCODE_INTERVAL_MONTH = 102,
3019
+ /**
3020
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_DAY = 103;
3021
+ */
3022
+ XDBC_SUBCODE_INTERVAL_DAY = 103,
3023
+ /**
3024
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_HOUR = 104;
3025
+ */
3026
+ XDBC_SUBCODE_INTERVAL_HOUR = 104,
3027
+ /**
3028
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_MINUTE = 105;
3029
+ */
3030
+ XDBC_SUBCODE_INTERVAL_MINUTE = 105,
3031
+ /**
3032
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_SECOND = 106;
3033
+ */
3034
+ XDBC_SUBCODE_INTERVAL_SECOND = 106,
3035
+ /**
3036
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107;
3037
+ */
3038
+ XDBC_SUBCODE_INTERVAL_YEAR_TO_MONTH = 107,
3039
+ /**
3040
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_DAY_TO_HOUR = 108;
3041
+ */
3042
+ XDBC_SUBCODE_INTERVAL_DAY_TO_HOUR = 108,
3043
+ /**
3044
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109;
3045
+ */
3046
+ XDBC_SUBCODE_INTERVAL_DAY_TO_MINUTE = 109,
3047
+ /**
3048
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_DAY_TO_SECOND = 110;
3049
+ */
3050
+ XDBC_SUBCODE_INTERVAL_DAY_TO_SECOND = 110,
3051
+ /**
3052
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111;
3053
+ */
3054
+ XDBC_SUBCODE_INTERVAL_HOUR_TO_MINUTE = 111,
3055
+ /**
3056
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112;
3057
+ */
3058
+ XDBC_SUBCODE_INTERVAL_HOUR_TO_SECOND = 112,
3059
+ /**
3060
+ * @generated from enum value: XDBC_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113;
3061
+ */
3062
+ XDBC_SUBCODE_INTERVAL_MINUTE_TO_SECOND = 113
3063
+ }
3064
+ /**
3065
+ * Describes the enum arrow.flight.protocol.sql.XdbcDatetimeSubcode.
3066
+ */
3067
+ export declare const XdbcDatetimeSubcodeSchema: GenEnum<XdbcDatetimeSubcode>;
3068
+ /**
3069
+ * @generated from enum arrow.flight.protocol.sql.Nullable
3070
+ */
3071
+ export declare enum Nullable {
3072
+ /**
3073
+ * *
3074
+ * Indicates that the field does not allow the use of null values.
3075
+ *
3076
+ * @generated from enum value: NULLABILITY_NO_NULLS = 0;
3077
+ */
3078
+ NULLABILITY_NO_NULLS = 0,
3079
+ /**
3080
+ * *
3081
+ * Indicates that the fields allow the use of null values.
3082
+ *
3083
+ * @generated from enum value: NULLABILITY_NULLABLE = 1;
3084
+ */
3085
+ NULLABILITY_NULLABLE = 1,
3086
+ /**
3087
+ * *
3088
+ * Indicates that nullability of the fields cannot be determined.
3089
+ *
3090
+ * @generated from enum value: NULLABILITY_UNKNOWN = 2;
3091
+ */
3092
+ NULLABILITY_UNKNOWN = 2
3093
+ }
3094
+ /**
3095
+ * Describes the enum arrow.flight.protocol.sql.Nullable.
3096
+ */
3097
+ export declare const NullableSchema: GenEnum<Nullable>;
3098
+ /**
3099
+ * @generated from enum arrow.flight.protocol.sql.Searchable
3100
+ */
3101
+ export declare enum Searchable {
3102
+ /**
3103
+ * *
3104
+ * Indicates that column cannot be used in a WHERE clause.
3105
+ *
3106
+ * @generated from enum value: SEARCHABLE_NONE = 0;
3107
+ */
3108
+ NONE = 0,
3109
+ /**
3110
+ * *
3111
+ * Indicates that the column can be used in a WHERE clause if it is using a
3112
+ * LIKE operator.
3113
+ *
3114
+ * @generated from enum value: SEARCHABLE_CHAR = 1;
3115
+ */
3116
+ CHAR = 1,
3117
+ /**
3118
+ * *
3119
+ * Indicates that the column can be used In a WHERE clause with any
3120
+ * operator other than LIKE.
3121
+ *
3122
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
3123
+ * DISTINCT, IN, MATCH, and UNIQUE.
3124
+ *
3125
+ * @generated from enum value: SEARCHABLE_BASIC = 2;
3126
+ */
3127
+ BASIC = 2,
3128
+ /**
3129
+ * *
3130
+ * Indicates that the column can be used in a WHERE clause using any operator.
3131
+ *
3132
+ * @generated from enum value: SEARCHABLE_FULL = 3;
3133
+ */
3134
+ FULL = 3
3135
+ }
3136
+ /**
3137
+ * Describes the enum arrow.flight.protocol.sql.Searchable.
3138
+ */
3139
+ export declare const SearchableSchema: GenEnum<Searchable>;
3140
+ /**
3141
+ * @generated from enum arrow.flight.protocol.sql.UpdateDeleteRules
3142
+ */
3143
+ export declare enum UpdateDeleteRules {
3144
+ /**
3145
+ * @generated from enum value: CASCADE = 0;
3146
+ */
3147
+ CASCADE = 0,
3148
+ /**
3149
+ * @generated from enum value: RESTRICT = 1;
3150
+ */
3151
+ RESTRICT = 1,
3152
+ /**
3153
+ * @generated from enum value: SET_NULL = 2;
3154
+ */
3155
+ SET_NULL = 2,
3156
+ /**
3157
+ * @generated from enum value: NO_ACTION = 3;
3158
+ */
3159
+ NO_ACTION = 3,
3160
+ /**
3161
+ * @generated from enum value: SET_DEFAULT = 4;
3162
+ */
3163
+ SET_DEFAULT = 4
3164
+ }
3165
+ /**
3166
+ * Describes the enum arrow.flight.protocol.sql.UpdateDeleteRules.
3167
+ */
3168
+ export declare const UpdateDeleteRulesSchema: GenEnum<UpdateDeleteRules>;
3169
+ /**
3170
+ * @generated from extension: bool experimental = 1000;
3171
+ */
3172
+ export declare const experimental: GenExtension<MessageOptions, boolean>;
3173
+ //# sourceMappingURL=FlightSql_pb.d.ts.map