@qualithm/arrow-flight-sql-js 1.0.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,2183 @@
1
+ import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
2
+ export declare const protobufPackage = "arrow.flight.protocol.sql";
3
+ /** Options for CommandGetSqlInfo. */
4
+ export declare const SqlInfo: {
5
+ /** FLIGHT_SQL_SERVER_NAME - Retrieves a UTF-8 string with the name of the Flight SQL Server. */
6
+ readonly FLIGHT_SQL_SERVER_NAME: 0;
7
+ /** FLIGHT_SQL_SERVER_VERSION - Retrieves a UTF-8 string with the native version of the Flight SQL Server. */
8
+ readonly FLIGHT_SQL_SERVER_VERSION: 1;
9
+ /** FLIGHT_SQL_SERVER_ARROW_VERSION - Retrieves a UTF-8 string with the Arrow format version of the Flight SQL Server. */
10
+ readonly FLIGHT_SQL_SERVER_ARROW_VERSION: 2;
11
+ /**
12
+ * FLIGHT_SQL_SERVER_READ_ONLY - Retrieves a boolean value indicating whether the Flight SQL Server is read only.
13
+ *
14
+ * Returns:
15
+ * - false: if read-write
16
+ * - true: if read only
17
+ */
18
+ readonly FLIGHT_SQL_SERVER_READ_ONLY: 3;
19
+ /**
20
+ * FLIGHT_SQL_SERVER_SQL - Retrieves a boolean value indicating whether the Flight SQL Server supports executing
21
+ * SQL queries.
22
+ *
23
+ * Note that the absence of this info (as opposed to a false value) does not necessarily
24
+ * mean that SQL is not supported, as this property was not originally defined.
25
+ */
26
+ readonly FLIGHT_SQL_SERVER_SQL: 4;
27
+ /**
28
+ * FLIGHT_SQL_SERVER_SUBSTRAIT - Retrieves a boolean value indicating whether the Flight SQL Server supports executing
29
+ * Substrait plans.
30
+ */
31
+ readonly FLIGHT_SQL_SERVER_SUBSTRAIT: 5;
32
+ /**
33
+ * FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION - Retrieves a string value indicating the minimum supported Substrait version, or null
34
+ * if Substrait is not supported.
35
+ */
36
+ readonly FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION: 6;
37
+ /**
38
+ * FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION - Retrieves a string value indicating the maximum supported Substrait version, or null
39
+ * if Substrait is not supported.
40
+ */
41
+ readonly FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION: 7;
42
+ /**
43
+ * FLIGHT_SQL_SERVER_TRANSACTION - Retrieves an int32 indicating whether the Flight SQL Server supports the
44
+ * BeginTransaction/EndTransaction/BeginSavepoint/EndSavepoint actions.
45
+ *
46
+ * Even if this is not supported, the database may still support explicit "BEGIN
47
+ * TRANSACTION"/"COMMIT" SQL statements (see SQL_TRANSACTIONS_SUPPORTED); this property
48
+ * is only about whether the server implements the Flight SQL API endpoints.
49
+ *
50
+ * The possible values are listed in `SqlSupportedTransaction`.
51
+ */
52
+ readonly FLIGHT_SQL_SERVER_TRANSACTION: 8;
53
+ /**
54
+ * FLIGHT_SQL_SERVER_CANCEL - Retrieves a boolean value indicating whether the Flight SQL Server supports explicit
55
+ * query cancellation (the CancelQuery action).
56
+ */
57
+ readonly FLIGHT_SQL_SERVER_CANCEL: 9;
58
+ /**
59
+ * FLIGHT_SQL_SERVER_BULK_INGESTION - Retrieves a boolean value indicating whether the Flight SQL Server supports executing
60
+ * bulk ingestion.
61
+ */
62
+ readonly FLIGHT_SQL_SERVER_BULK_INGESTION: 10;
63
+ /**
64
+ * FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED - Retrieves a boolean value indicating whether transactions are supported for bulk ingestion. If not, invoking
65
+ * the method commit in the context of a bulk ingestion is a noop, and the isolation level is
66
+ * `arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE`.
67
+ *
68
+ * Returns:
69
+ * - false: if bulk ingestion transactions are unsupported;
70
+ * - true: if bulk ingestion transactions are supported.
71
+ */
72
+ readonly FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED: 11;
73
+ /**
74
+ * FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT - Retrieves an int32 indicating the timeout (in milliseconds) for prepared statement handles.
75
+ *
76
+ * If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.
77
+ */
78
+ readonly FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT: 100;
79
+ /**
80
+ * FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT - Retrieves an int32 indicating the timeout (in milliseconds) for transactions, since transactions are not tied to a connection.
81
+ *
82
+ * If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.
83
+ */
84
+ readonly FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT: 101;
85
+ /**
86
+ * SQL_DDL_CATALOG - Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of catalogs.
87
+ *
88
+ * Returns:
89
+ * - false: if it doesn't support CREATE and DROP of catalogs.
90
+ * - true: if it supports CREATE and DROP of catalogs.
91
+ */
92
+ readonly SQL_DDL_CATALOG: 500;
93
+ /**
94
+ * SQL_DDL_SCHEMA - Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of schemas.
95
+ *
96
+ * Returns:
97
+ * - false: if it doesn't support CREATE and DROP of schemas.
98
+ * - true: if it supports CREATE and DROP of schemas.
99
+ */
100
+ readonly SQL_DDL_SCHEMA: 501;
101
+ /**
102
+ * SQL_DDL_TABLE - Indicates whether the Flight SQL Server supports CREATE and DROP of tables.
103
+ *
104
+ * Returns:
105
+ * - false: if it doesn't support CREATE and DROP of tables.
106
+ * - true: if it supports CREATE and DROP of tables.
107
+ */
108
+ readonly SQL_DDL_TABLE: 502;
109
+ /**
110
+ * SQL_IDENTIFIER_CASE - Retrieves an int32 ordinal representing the case sensitivity of catalog, table, schema and table names.
111
+ *
112
+ * The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.
113
+ */
114
+ readonly SQL_IDENTIFIER_CASE: 503;
115
+ /** SQL_IDENTIFIER_QUOTE_CHAR - Retrieves a UTF-8 string with the supported character(s) used to surround a delimited identifier. */
116
+ readonly SQL_IDENTIFIER_QUOTE_CHAR: 504;
117
+ /**
118
+ * SQL_QUOTED_IDENTIFIER_CASE - Retrieves an int32 describing the case sensitivity of quoted identifiers.
119
+ *
120
+ * The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.
121
+ */
122
+ readonly SQL_QUOTED_IDENTIFIER_CASE: 505;
123
+ /**
124
+ * SQL_ALL_TABLES_ARE_SELECTABLE - Retrieves a boolean value indicating whether all tables are selectable.
125
+ *
126
+ * Returns:
127
+ * - false: if not all tables are selectable or if none are;
128
+ * - true: if all tables are selectable.
129
+ */
130
+ readonly SQL_ALL_TABLES_ARE_SELECTABLE: 506;
131
+ /**
132
+ * SQL_NULL_ORDERING - Retrieves the null ordering.
133
+ *
134
+ * Returns an int32 ordinal for the null ordering being used, as described in
135
+ * `arrow.flight.protocol.sql.SqlNullOrdering`.
136
+ */
137
+ readonly SQL_NULL_ORDERING: 507;
138
+ /** SQL_KEYWORDS - Retrieves a UTF-8 string list with values of the supported keywords. */
139
+ readonly SQL_KEYWORDS: 508;
140
+ /** SQL_NUMERIC_FUNCTIONS - Retrieves a UTF-8 string list with values of the supported numeric functions. */
141
+ readonly SQL_NUMERIC_FUNCTIONS: 509;
142
+ /** SQL_STRING_FUNCTIONS - Retrieves a UTF-8 string list with values of the supported string functions. */
143
+ readonly SQL_STRING_FUNCTIONS: 510;
144
+ /** SQL_SYSTEM_FUNCTIONS - Retrieves a UTF-8 string list with values of the supported system functions. */
145
+ readonly SQL_SYSTEM_FUNCTIONS: 511;
146
+ /** SQL_DATETIME_FUNCTIONS - Retrieves a UTF-8 string list with values of the supported datetime functions. */
147
+ readonly SQL_DATETIME_FUNCTIONS: 512;
148
+ /**
149
+ * SQL_SEARCH_STRING_ESCAPE - Retrieves the UTF-8 string that can be used to escape wildcard characters.
150
+ * This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern
151
+ * (and therefore use one of the wildcard characters).
152
+ * The '_' character represents any single character; the '%' character represents any sequence of zero or more
153
+ * characters.
154
+ */
155
+ readonly SQL_SEARCH_STRING_ESCAPE: 513;
156
+ /**
157
+ * SQL_EXTRA_NAME_CHARACTERS - Retrieves a UTF-8 string with all the "extra" characters that can be used in unquoted identifier names
158
+ * (those beyond a-z, A-Z, 0-9 and _).
159
+ */
160
+ readonly SQL_EXTRA_NAME_CHARACTERS: 514;
161
+ /**
162
+ * SQL_SUPPORTS_COLUMN_ALIASING - Retrieves a boolean value indicating whether column aliasing is supported.
163
+ * If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns
164
+ * as required.
165
+ *
166
+ * Returns:
167
+ * - false: if column aliasing is unsupported;
168
+ * - true: if column aliasing is supported.
169
+ */
170
+ readonly SQL_SUPPORTS_COLUMN_ALIASING: 515;
171
+ /**
172
+ * SQL_NULL_PLUS_NULL_IS_NULL - Retrieves a boolean value indicating whether concatenations between null and non-null values being
173
+ * null are supported.
174
+ *
175
+ * Returns:
176
+ * - false: if concatenations between null and non-null values being null are unsupported;
177
+ * - true: if concatenations between null and non-null values being null are supported.
178
+ */
179
+ readonly SQL_NULL_PLUS_NULL_IS_NULL: 516;
180
+ /**
181
+ * SQL_SUPPORTS_CONVERT - Retrieves a map where the key is the type to convert from and the value is a list with the types to convert to,
182
+ * indicating the supported conversions. Each key and each item on the list value is a value to a predefined type on
183
+ * SqlSupportsConvert enum.
184
+ * The returned map will be: map<int32, list<int32>>
185
+ */
186
+ readonly SQL_SUPPORTS_CONVERT: 517;
187
+ /**
188
+ * SQL_SUPPORTS_TABLE_CORRELATION_NAMES - Retrieves a boolean value indicating whether, when table correlation names are supported,
189
+ * they are restricted to being different from the names of the tables.
190
+ *
191
+ * Returns:
192
+ * - false: if table correlation names are unsupported;
193
+ * - true: if table correlation names are supported.
194
+ */
195
+ readonly SQL_SUPPORTS_TABLE_CORRELATION_NAMES: 518;
196
+ /**
197
+ * SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES - Retrieves a boolean value indicating whether, when table correlation names are supported,
198
+ * they are restricted to being different from the names of the tables.
199
+ *
200
+ * Returns:
201
+ * - false: if different table correlation names are unsupported;
202
+ * - true: if different table correlation names are supported
203
+ */
204
+ readonly SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES: 519;
205
+ /**
206
+ * SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY - Retrieves a boolean value indicating whether expressions in ORDER BY lists are supported.
207
+ *
208
+ * Returns:
209
+ * - false: if expressions in ORDER BY are unsupported;
210
+ * - true: if expressions in ORDER BY are supported;
211
+ */
212
+ readonly SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY: 520;
213
+ /**
214
+ * SQL_SUPPORTS_ORDER_BY_UNRELATED - Retrieves a boolean value indicating whether using a column that is not in the SELECT statement in a GROUP BY
215
+ * clause is supported.
216
+ *
217
+ * Returns:
218
+ * - false: if using a column that is not in the SELECT statement in a GROUP BY clause is unsupported;
219
+ * - true: if using a column that is not in the SELECT statement in a GROUP BY clause is supported.
220
+ */
221
+ readonly SQL_SUPPORTS_ORDER_BY_UNRELATED: 521;
222
+ /**
223
+ * SQL_SUPPORTED_GROUP_BY - Retrieves the supported GROUP BY commands;
224
+ *
225
+ * Returns an int32 bitmask value representing the supported commands.
226
+ * The returned bitmask should be parsed in order to retrieve the supported commands.
227
+ *
228
+ * For instance:
229
+ * - return 0 (\b0) => [] (GROUP BY is unsupported);
230
+ * - return 1 (\b1) => [SQL_GROUP_BY_UNRELATED];
231
+ * - return 2 (\b10) => [SQL_GROUP_BY_BEYOND_SELECT];
232
+ * - return 3 (\b11) => [SQL_GROUP_BY_UNRELATED, SQL_GROUP_BY_BEYOND_SELECT].
233
+ * Valid GROUP BY types are described under `arrow.flight.protocol.sql.SqlSupportedGroupBy`.
234
+ */
235
+ readonly SQL_SUPPORTED_GROUP_BY: 522;
236
+ /**
237
+ * SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE - Retrieves a boolean value indicating whether specifying a LIKE escape clause is supported.
238
+ *
239
+ * Returns:
240
+ * - false: if specifying a LIKE escape clause is unsupported;
241
+ * - true: if specifying a LIKE escape clause is supported.
242
+ */
243
+ readonly SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE: 523;
244
+ /**
245
+ * SQL_SUPPORTS_NON_NULLABLE_COLUMNS - Retrieves a boolean value indicating whether columns may be defined as non-nullable.
246
+ *
247
+ * Returns:
248
+ * - false: if columns cannot be defined as non-nullable;
249
+ * - true: if columns may be defined as non-nullable.
250
+ */
251
+ readonly SQL_SUPPORTS_NON_NULLABLE_COLUMNS: 524;
252
+ /**
253
+ * SQL_SUPPORTED_GRAMMAR - Retrieves the supported SQL grammar level as per the ODBC specification.
254
+ *
255
+ * Returns an int32 bitmask value representing the supported SQL grammar level.
256
+ * The returned bitmask should be parsed in order to retrieve the supported grammar levels.
257
+ *
258
+ * For instance:
259
+ * - return 0 (\b0) => [] (SQL grammar is unsupported);
260
+ * - return 1 (\b1) => [SQL_MINIMUM_GRAMMAR];
261
+ * - return 2 (\b10) => [SQL_CORE_GRAMMAR];
262
+ * - return 3 (\b11) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR];
263
+ * - return 4 (\b100) => [SQL_EXTENDED_GRAMMAR];
264
+ * - return 5 (\b101) => [SQL_MINIMUM_GRAMMAR, SQL_EXTENDED_GRAMMAR];
265
+ * - return 6 (\b110) => [SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR];
266
+ * - return 7 (\b111) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR].
267
+ * Valid SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedSqlGrammar`.
268
+ */
269
+ readonly SQL_SUPPORTED_GRAMMAR: 525;
270
+ /**
271
+ * SQL_ANSI92_SUPPORTED_LEVEL - Retrieves the supported ANSI92 SQL grammar level.
272
+ *
273
+ * Returns an int32 bitmask value representing the supported ANSI92 SQL grammar level.
274
+ * The returned bitmask should be parsed in order to retrieve the supported commands.
275
+ *
276
+ * For instance:
277
+ * - return 0 (\b0) => [] (ANSI92 SQL grammar is unsupported);
278
+ * - return 1 (\b1) => [ANSI92_ENTRY_SQL];
279
+ * - return 2 (\b10) => [ANSI92_INTERMEDIATE_SQL];
280
+ * - return 3 (\b11) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL];
281
+ * - return 4 (\b100) => [ANSI92_FULL_SQL];
282
+ * - return 5 (\b101) => [ANSI92_ENTRY_SQL, ANSI92_FULL_SQL];
283
+ * - return 6 (\b110) => [ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL];
284
+ * - return 7 (\b111) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL].
285
+ * Valid ANSI92 SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel`.
286
+ */
287
+ readonly SQL_ANSI92_SUPPORTED_LEVEL: 526;
288
+ /**
289
+ * SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY - Retrieves a boolean value indicating whether the SQL Integrity Enhancement Facility is supported.
290
+ *
291
+ * Returns:
292
+ * - false: if the SQL Integrity Enhancement Facility is unsupported;
293
+ * - true: if the SQL Integrity Enhancement Facility is supported.
294
+ */
295
+ readonly SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY: 527;
296
+ /**
297
+ * SQL_OUTER_JOINS_SUPPORT_LEVEL - Retrieves the support level for SQL OUTER JOINs.
298
+ *
299
+ * Returns an int32 ordinal for the SQL ordering being used, as described in
300
+ * `arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel`.
301
+ */
302
+ readonly SQL_OUTER_JOINS_SUPPORT_LEVEL: 528;
303
+ /** SQL_SCHEMA_TERM - Retrieves a UTF-8 string with the preferred term for "schema". */
304
+ readonly SQL_SCHEMA_TERM: 529;
305
+ /** SQL_PROCEDURE_TERM - Retrieves a UTF-8 string with the preferred term for "procedure". */
306
+ readonly SQL_PROCEDURE_TERM: 530;
307
+ /**
308
+ * SQL_CATALOG_TERM - Retrieves a UTF-8 string with the preferred term for "catalog".
309
+ * If an empty string is returned it is assumed that the server does NOT support catalogs.
310
+ */
311
+ readonly SQL_CATALOG_TERM: 531;
312
+ /**
313
+ * SQL_CATALOG_AT_START - Retrieves a boolean value indicating whether a catalog appears at the start of a fully qualified table name.
314
+ *
315
+ * - false: if a catalog does not appear at the start of a fully qualified table name;
316
+ * - true: if a catalog appears at the start of a fully qualified table name.
317
+ */
318
+ readonly SQL_CATALOG_AT_START: 532;
319
+ /**
320
+ * SQL_SCHEMAS_SUPPORTED_ACTIONS - Retrieves the supported actions for a SQL schema.
321
+ *
322
+ * Returns an int32 bitmask value representing the supported actions for a SQL schema.
323
+ * The returned bitmask should be parsed in order to retrieve the supported actions for a SQL schema.
324
+ *
325
+ * For instance:
326
+ * - return 0 (\b0) => [] (no supported actions for SQL schema);
327
+ * - return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];
328
+ * - return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];
329
+ * - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
330
+ * - return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
331
+ * - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
332
+ * - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
333
+ * - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].
334
+ * Valid actions for a SQL schema are described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.
335
+ */
336
+ readonly SQL_SCHEMAS_SUPPORTED_ACTIONS: 533;
337
+ /**
338
+ * SQL_CATALOGS_SUPPORTED_ACTIONS - Retrieves the supported actions for a SQL catalog.
339
+ *
340
+ * Returns an int32 bitmask value representing the supported actions for a SQL catalog.
341
+ * The returned bitmask should be parsed in order to retrieve the supported actions for a SQL catalog.
342
+ *
343
+ * For instance:
344
+ * - return 0 (\b0) => [] (no supported actions for SQL catalog);
345
+ * - return 1 (\b1) => [SQL_ELEMENT_IN_PROCEDURE_CALLS];
346
+ * - return 2 (\b10) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS];
347
+ * - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
348
+ * - return 4 (\b100) => [SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
349
+ * - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
350
+ * - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
351
+ * - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].
352
+ * Valid actions for a SQL catalog are described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.
353
+ */
354
+ readonly SQL_CATALOGS_SUPPORTED_ACTIONS: 534;
355
+ /**
356
+ * SQL_SUPPORTED_POSITIONED_COMMANDS - Retrieves the supported SQL positioned commands.
357
+ *
358
+ * Returns an int32 bitmask value representing the supported SQL positioned commands.
359
+ * The returned bitmask should be parsed in order to retrieve the supported SQL positioned commands.
360
+ *
361
+ * For instance:
362
+ * - return 0 (\b0) => [] (no supported SQL positioned commands);
363
+ * - return 1 (\b1) => [SQL_POSITIONED_DELETE];
364
+ * - return 2 (\b10) => [SQL_POSITIONED_UPDATE];
365
+ * - return 3 (\b11) => [SQL_POSITIONED_DELETE, SQL_POSITIONED_UPDATE].
366
+ * Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlSupportedPositionedCommands`.
367
+ */
368
+ readonly SQL_SUPPORTED_POSITIONED_COMMANDS: 535;
369
+ /**
370
+ * SQL_SELECT_FOR_UPDATE_SUPPORTED - Retrieves a boolean value indicating whether SELECT FOR UPDATE statements are supported.
371
+ *
372
+ * Returns:
373
+ * - false: if SELECT FOR UPDATE statements are unsupported;
374
+ * - true: if SELECT FOR UPDATE statements are supported.
375
+ */
376
+ readonly SQL_SELECT_FOR_UPDATE_SUPPORTED: 536;
377
+ /**
378
+ * SQL_STORED_PROCEDURES_SUPPORTED - Retrieves a boolean value indicating whether stored procedure calls that use the stored procedure escape syntax
379
+ * are supported.
380
+ *
381
+ * Returns:
382
+ * - false: if stored procedure calls that use the stored procedure escape syntax are unsupported;
383
+ * - true: if stored procedure calls that use the stored procedure escape syntax are supported.
384
+ */
385
+ readonly SQL_STORED_PROCEDURES_SUPPORTED: 537;
386
+ /**
387
+ * SQL_SUPPORTED_SUBQUERIES - Retrieves the supported SQL subqueries.
388
+ *
389
+ * Returns an int32 bitmask value representing the supported SQL subqueries.
390
+ * The returned bitmask should be parsed in order to retrieve the supported SQL subqueries.
391
+ *
392
+ * For instance:
393
+ * - return 0 (\b0) => [] (no supported SQL subqueries);
394
+ * - return 1 (\b1) => [SQL_SUBQUERIES_IN_COMPARISONS];
395
+ * - return 2 (\b10) => [SQL_SUBQUERIES_IN_EXISTS];
396
+ * - return 3 (\b11) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS];
397
+ * - return 4 (\b100) => [SQL_SUBQUERIES_IN_INS];
398
+ * - return 5 (\b101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS];
399
+ * - return 6 (\b110) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_EXISTS];
400
+ * - return 7 (\b111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS];
401
+ * - return 8 (\b1000) => [SQL_SUBQUERIES_IN_QUANTIFIEDS];
402
+ * - return 9 (\b1001) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
403
+ * - return 10 (\b1010) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
404
+ * - return 11 (\b1011) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
405
+ * - return 12 (\b1100) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
406
+ * - return 13 (\b1101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
407
+ * - return 14 (\b1110) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
408
+ * - return 15 (\b1111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
409
+ * - ...
410
+ * Valid SQL subqueries are described under `arrow.flight.protocol.sql.SqlSupportedSubqueries`.
411
+ */
412
+ readonly SQL_SUPPORTED_SUBQUERIES: 538;
413
+ /**
414
+ * SQL_CORRELATED_SUBQUERIES_SUPPORTED - Retrieves a boolean value indicating whether correlated subqueries are supported.
415
+ *
416
+ * Returns:
417
+ * - false: if correlated subqueries are unsupported;
418
+ * - true: if correlated subqueries are supported.
419
+ */
420
+ readonly SQL_CORRELATED_SUBQUERIES_SUPPORTED: 539;
421
+ /**
422
+ * SQL_SUPPORTED_UNIONS - Retrieves the supported SQL UNIONs.
423
+ *
424
+ * Returns an int32 bitmask value representing the supported SQL UNIONs.
425
+ * The returned bitmask should be parsed in order to retrieve the supported SQL UNIONs.
426
+ *
427
+ * For instance:
428
+ * - return 0 (\b0) => [] (no supported SQL UNIONs);
429
+ * - return 1 (\b1) => [SQL_UNION];
430
+ * - return 2 (\b10) => [SQL_UNION_ALL];
431
+ * - return 3 (\b11) => [SQL_UNION, SQL_UNION_ALL].
432
+ * Valid SQL UNIONs are described under `arrow.flight.protocol.sql.SqlSupportedUnions`.
433
+ */
434
+ readonly SQL_SUPPORTED_UNIONS: 540;
435
+ /** SQL_MAX_BINARY_LITERAL_LENGTH - Retrieves an int64 value representing the maximum number of hex characters allowed in an inline binary literal. */
436
+ readonly SQL_MAX_BINARY_LITERAL_LENGTH: 541;
437
+ /** SQL_MAX_CHAR_LITERAL_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed for a character literal. */
438
+ readonly SQL_MAX_CHAR_LITERAL_LENGTH: 542;
439
+ /** SQL_MAX_COLUMN_NAME_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed for a column name. */
440
+ readonly SQL_MAX_COLUMN_NAME_LENGTH: 543;
441
+ /** SQL_MAX_COLUMNS_IN_GROUP_BY - Retrieves an int64 value representing the maximum number of columns allowed in a GROUP BY clause. */
442
+ readonly SQL_MAX_COLUMNS_IN_GROUP_BY: 544;
443
+ /** SQL_MAX_COLUMNS_IN_INDEX - Retrieves an int64 value representing the maximum number of columns allowed in an index. */
444
+ readonly SQL_MAX_COLUMNS_IN_INDEX: 545;
445
+ /** SQL_MAX_COLUMNS_IN_ORDER_BY - Retrieves an int64 value representing the maximum number of columns allowed in an ORDER BY clause. */
446
+ readonly SQL_MAX_COLUMNS_IN_ORDER_BY: 546;
447
+ /** SQL_MAX_COLUMNS_IN_SELECT - Retrieves an int64 value representing the maximum number of columns allowed in a SELECT list. */
448
+ readonly SQL_MAX_COLUMNS_IN_SELECT: 547;
449
+ /** SQL_MAX_COLUMNS_IN_TABLE - Retrieves an int64 value representing the maximum number of columns allowed in a table. */
450
+ readonly SQL_MAX_COLUMNS_IN_TABLE: 548;
451
+ /** SQL_MAX_CONNECTIONS - Retrieves an int64 value representing the maximum number of concurrent connections possible. */
452
+ readonly SQL_MAX_CONNECTIONS: 549;
453
+ /** SQL_MAX_CURSOR_NAME_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed in a cursor name. */
454
+ readonly SQL_MAX_CURSOR_NAME_LENGTH: 550;
455
+ /**
456
+ * SQL_MAX_INDEX_LENGTH - Retrieves an int64 value representing the maximum number of bytes allowed for an index,
457
+ * including all of the parts of the index.
458
+ */
459
+ readonly SQL_MAX_INDEX_LENGTH: 551;
460
+ /** SQL_DB_SCHEMA_NAME_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed in a schema name. */
461
+ readonly SQL_DB_SCHEMA_NAME_LENGTH: 552;
462
+ /** SQL_MAX_PROCEDURE_NAME_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed in a procedure name. */
463
+ readonly SQL_MAX_PROCEDURE_NAME_LENGTH: 553;
464
+ /** SQL_MAX_CATALOG_NAME_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed in a catalog name. */
465
+ readonly SQL_MAX_CATALOG_NAME_LENGTH: 554;
466
+ /** SQL_MAX_ROW_SIZE - Retrieves an int64 value representing the maximum number of bytes allowed in a single row. */
467
+ readonly SQL_MAX_ROW_SIZE: 555;
468
+ /**
469
+ * SQL_MAX_ROW_SIZE_INCLUDES_BLOBS - Retrieves a boolean indicating whether the return value for the JDBC method getMaxRowSize includes the SQL
470
+ * data types LONGVARCHAR and LONGVARBINARY.
471
+ *
472
+ * Returns:
473
+ * - false: if return value for the JDBC method getMaxRowSize does
474
+ * not include the SQL data types LONGVARCHAR and LONGVARBINARY;
475
+ * - true: if return value for the JDBC method getMaxRowSize includes
476
+ * the SQL data types LONGVARCHAR and LONGVARBINARY.
477
+ */
478
+ readonly SQL_MAX_ROW_SIZE_INCLUDES_BLOBS: 556;
479
+ /**
480
+ * SQL_MAX_STATEMENT_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed for an SQL statement;
481
+ * a result of 0 (zero) means that there is no limit or the limit is not known.
482
+ */
483
+ readonly SQL_MAX_STATEMENT_LENGTH: 557;
484
+ /** SQL_MAX_STATEMENTS - Retrieves an int64 value representing the maximum number of active statements that can be open at the same time. */
485
+ readonly SQL_MAX_STATEMENTS: 558;
486
+ /** SQL_MAX_TABLE_NAME_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed in a table name. */
487
+ readonly SQL_MAX_TABLE_NAME_LENGTH: 559;
488
+ /** SQL_MAX_TABLES_IN_SELECT - Retrieves an int64 value representing the maximum number of tables allowed in a SELECT statement. */
489
+ readonly SQL_MAX_TABLES_IN_SELECT: 560;
490
+ /** SQL_MAX_USERNAME_LENGTH - Retrieves an int64 value representing the maximum number of characters allowed in a user name. */
491
+ readonly SQL_MAX_USERNAME_LENGTH: 561;
492
+ /**
493
+ * SQL_DEFAULT_TRANSACTION_ISOLATION - Retrieves this database's default transaction isolation level as described in
494
+ * `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.
495
+ *
496
+ * Returns an int32 ordinal for the SQL transaction isolation level.
497
+ */
498
+ readonly SQL_DEFAULT_TRANSACTION_ISOLATION: 562;
499
+ /**
500
+ * SQL_TRANSACTIONS_SUPPORTED - Retrieves a boolean value indicating whether transactions are supported. If not, invoking the method commit is a
501
+ * noop, and the isolation level is `arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE`.
502
+ *
503
+ * Returns:
504
+ * - false: if transactions are unsupported;
505
+ * - true: if transactions are supported.
506
+ */
507
+ readonly SQL_TRANSACTIONS_SUPPORTED: 563;
508
+ /**
509
+ * SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS - Retrieves the supported transactions isolation levels.
510
+ *
511
+ * Returns an int32 bitmask value representing the supported transactions isolation levels.
512
+ * The returned bitmask should be parsed in order to retrieve the supported transactions isolation levels.
513
+ *
514
+ * For instance:
515
+ * - return 0 (\b0) => [] (no supported SQL transactions isolation levels);
516
+ * - return 1 (\b1) => [SQL_TRANSACTION_NONE];
517
+ * - return 2 (\b10) => [SQL_TRANSACTION_READ_UNCOMMITTED];
518
+ * - return 3 (\b11) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED];
519
+ * - return 4 (\b100) => [SQL_TRANSACTION_READ_COMMITTED];
520
+ * - return 5 (\b101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_COMMITTED];
521
+ * - return 6 (\b110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED];
522
+ * - return 7 (\b111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED];
523
+ * - return 8 (\b1000) => [SQL_TRANSACTION_REPEATABLE_READ];
524
+ * - return 9 (\b1001) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];
525
+ * - return 10 (\b1010) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
526
+ * - return 11 (\b1011) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
527
+ * - return 12 (\b1100) => [SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
528
+ * - return 13 (\b1101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
529
+ * - return 14 (\b1110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
530
+ * - return 15 (\b1111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_READ_COMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
531
+ * - return 16 (\b10000) => [SQL_TRANSACTION_SERIALIZABLE];
532
+ * - ...
533
+ * Valid SQL transaction isolation levels are described under `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.
534
+ */
535
+ readonly SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS: 564;
536
+ /**
537
+ * SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT - Retrieves a boolean value indicating whether a data definition statement within a transaction forces
538
+ * the transaction to commit.
539
+ *
540
+ * Returns:
541
+ * - false: if a data definition statement within a transaction does not force the transaction to commit;
542
+ * - true: if a data definition statement within a transaction forces the transaction to commit.
543
+ */
544
+ readonly SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT: 565;
545
+ /**
546
+ * SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED - Retrieves a boolean value indicating whether a data definition statement within a transaction is ignored.
547
+ *
548
+ * Returns:
549
+ * - false: if a data definition statement within a transaction is taken into account;
550
+ * - true: a data definition statement within a transaction is ignored.
551
+ */
552
+ readonly SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED: 566;
553
+ /**
554
+ * SQL_SUPPORTED_RESULT_SET_TYPES - Retrieves an int32 bitmask value representing the supported result set types.
555
+ * The returned bitmask should be parsed in order to retrieve the supported result set types.
556
+ *
557
+ * For instance:
558
+ * - return 0 (\b0) => [] (no supported result set types);
559
+ * - return 1 (\b1) => [SQL_RESULT_SET_TYPE_UNSPECIFIED];
560
+ * - return 2 (\b10) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY];
561
+ * - return 3 (\b11) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY];
562
+ * - return 4 (\b100) => [SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
563
+ * - return 5 (\b101) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
564
+ * - return 6 (\b110) => [SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
565
+ * - return 7 (\b111) => [SQL_RESULT_SET_TYPE_UNSPECIFIED, SQL_RESULT_SET_TYPE_FORWARD_ONLY, SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE];
566
+ * - return 8 (\b1000) => [SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE];
567
+ * - ...
568
+ * Valid result set types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetType`.
569
+ */
570
+ readonly SQL_SUPPORTED_RESULT_SET_TYPES: 567;
571
+ /**
572
+ * SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED - Returns an int32 bitmask value representing the concurrency types supported for
573
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_UNSPECIFIED`.
574
+ *
575
+ * For instance:
576
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
577
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
578
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
579
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
580
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
581
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
582
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
583
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
584
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
585
+ */
586
+ readonly SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED: 568;
587
+ /**
588
+ * SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY - Returns an int32 bitmask value representing the concurrency types supported for
589
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_FORWARD_ONLY`.
590
+ *
591
+ * For instance:
592
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
593
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
594
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
595
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
596
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
597
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
598
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
599
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
600
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
601
+ */
602
+ readonly SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY: 569;
603
+ /**
604
+ * SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE - Returns an int32 bitmask value representing the concurrency types supported for
605
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE`.
606
+ *
607
+ * For instance:
608
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
609
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
610
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
611
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
612
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
613
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
614
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
615
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
616
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
617
+ */
618
+ readonly SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE: 570;
619
+ /**
620
+ * SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE - Returns an int32 bitmask value representing the concurrency types supported for
621
+ * `arrow.flight.protocol.sql.SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE`.
622
+ *
623
+ * For instance:
624
+ * - return 0 (\b0) => [] (no supported concurrency types for this result set type)
625
+ * - return 1 (\b1) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED]
626
+ * - return 2 (\b10) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
627
+ * - return 3 (\b11) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY]
628
+ * - return 4 (\b100) => [SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
629
+ * - return 5 (\b101) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
630
+ * - return 6 (\b110) => [SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
631
+ * - return 7 (\b111) => [SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED, SQL_RESULT_SET_CONCURRENCY_READ_ONLY, SQL_RESULT_SET_CONCURRENCY_UPDATABLE]
632
+ * Valid result set concurrency types are described under `arrow.flight.protocol.sql.SqlSupportedResultSetConcurrency`.
633
+ */
634
+ readonly SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE: 571;
635
+ /**
636
+ * SQL_BATCH_UPDATES_SUPPORTED - Retrieves a boolean value indicating whether this database supports batch updates.
637
+ *
638
+ * - false: if this database does not support batch updates;
639
+ * - true: if this database supports batch updates.
640
+ */
641
+ readonly SQL_BATCH_UPDATES_SUPPORTED: 572;
642
+ /**
643
+ * SQL_SAVEPOINTS_SUPPORTED - Retrieves a boolean value indicating whether this database supports savepoints.
644
+ *
645
+ * Returns:
646
+ * - false: if this database does not support savepoints;
647
+ * - true: if this database supports savepoints.
648
+ */
649
+ readonly SQL_SAVEPOINTS_SUPPORTED: 573;
650
+ /**
651
+ * SQL_NAMED_PARAMETERS_SUPPORTED - Retrieves a boolean value indicating whether named parameters are supported in callable statements.
652
+ *
653
+ * Returns:
654
+ * - false: if named parameters in callable statements are unsupported;
655
+ * - true: if named parameters in callable statements are supported.
656
+ */
657
+ readonly SQL_NAMED_PARAMETERS_SUPPORTED: 574;
658
+ /**
659
+ * SQL_LOCATORS_UPDATE_COPY - Retrieves a boolean value indicating whether updates made to a LOB are made on a copy or directly to the LOB.
660
+ *
661
+ * Returns:
662
+ * - false: if updates made to a LOB are made directly to the LOB;
663
+ * - true: if updates made to a LOB are made on a copy.
664
+ */
665
+ readonly SQL_LOCATORS_UPDATE_COPY: 575;
666
+ /**
667
+ * SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED - Retrieves a boolean value indicating whether invoking user-defined or vendor functions
668
+ * using the stored procedure escape syntax is supported.
669
+ *
670
+ * Returns:
671
+ * - false: if invoking user-defined or vendor functions using the stored procedure escape syntax is unsupported;
672
+ * - true: if invoking user-defined or vendor functions using the stored procedure escape syntax is supported.
673
+ */
674
+ readonly SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED: 576;
675
+ readonly UNRECOGNIZED: -1;
676
+ };
677
+ export type SqlInfo = typeof SqlInfo[keyof typeof SqlInfo];
678
+ export declare namespace SqlInfo {
679
+ type FLIGHT_SQL_SERVER_NAME = typeof SqlInfo.FLIGHT_SQL_SERVER_NAME;
680
+ type FLIGHT_SQL_SERVER_VERSION = typeof SqlInfo.FLIGHT_SQL_SERVER_VERSION;
681
+ type FLIGHT_SQL_SERVER_ARROW_VERSION = typeof SqlInfo.FLIGHT_SQL_SERVER_ARROW_VERSION;
682
+ type FLIGHT_SQL_SERVER_READ_ONLY = typeof SqlInfo.FLIGHT_SQL_SERVER_READ_ONLY;
683
+ type FLIGHT_SQL_SERVER_SQL = typeof SqlInfo.FLIGHT_SQL_SERVER_SQL;
684
+ type FLIGHT_SQL_SERVER_SUBSTRAIT = typeof SqlInfo.FLIGHT_SQL_SERVER_SUBSTRAIT;
685
+ type FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION = typeof SqlInfo.FLIGHT_SQL_SERVER_SUBSTRAIT_MIN_VERSION;
686
+ type FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION = typeof SqlInfo.FLIGHT_SQL_SERVER_SUBSTRAIT_MAX_VERSION;
687
+ type FLIGHT_SQL_SERVER_TRANSACTION = typeof SqlInfo.FLIGHT_SQL_SERVER_TRANSACTION;
688
+ type FLIGHT_SQL_SERVER_CANCEL = typeof SqlInfo.FLIGHT_SQL_SERVER_CANCEL;
689
+ type FLIGHT_SQL_SERVER_BULK_INGESTION = typeof SqlInfo.FLIGHT_SQL_SERVER_BULK_INGESTION;
690
+ type FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED = typeof SqlInfo.FLIGHT_SQL_SERVER_INGEST_TRANSACTIONS_SUPPORTED;
691
+ type FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT = typeof SqlInfo.FLIGHT_SQL_SERVER_STATEMENT_TIMEOUT;
692
+ type FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT = typeof SqlInfo.FLIGHT_SQL_SERVER_TRANSACTION_TIMEOUT;
693
+ type SQL_DDL_CATALOG = typeof SqlInfo.SQL_DDL_CATALOG;
694
+ type SQL_DDL_SCHEMA = typeof SqlInfo.SQL_DDL_SCHEMA;
695
+ type SQL_DDL_TABLE = typeof SqlInfo.SQL_DDL_TABLE;
696
+ type SQL_IDENTIFIER_CASE = typeof SqlInfo.SQL_IDENTIFIER_CASE;
697
+ type SQL_IDENTIFIER_QUOTE_CHAR = typeof SqlInfo.SQL_IDENTIFIER_QUOTE_CHAR;
698
+ type SQL_QUOTED_IDENTIFIER_CASE = typeof SqlInfo.SQL_QUOTED_IDENTIFIER_CASE;
699
+ type SQL_ALL_TABLES_ARE_SELECTABLE = typeof SqlInfo.SQL_ALL_TABLES_ARE_SELECTABLE;
700
+ type SQL_NULL_ORDERING = typeof SqlInfo.SQL_NULL_ORDERING;
701
+ type SQL_KEYWORDS = typeof SqlInfo.SQL_KEYWORDS;
702
+ type SQL_NUMERIC_FUNCTIONS = typeof SqlInfo.SQL_NUMERIC_FUNCTIONS;
703
+ type SQL_STRING_FUNCTIONS = typeof SqlInfo.SQL_STRING_FUNCTIONS;
704
+ type SQL_SYSTEM_FUNCTIONS = typeof SqlInfo.SQL_SYSTEM_FUNCTIONS;
705
+ type SQL_DATETIME_FUNCTIONS = typeof SqlInfo.SQL_DATETIME_FUNCTIONS;
706
+ type SQL_SEARCH_STRING_ESCAPE = typeof SqlInfo.SQL_SEARCH_STRING_ESCAPE;
707
+ type SQL_EXTRA_NAME_CHARACTERS = typeof SqlInfo.SQL_EXTRA_NAME_CHARACTERS;
708
+ type SQL_SUPPORTS_COLUMN_ALIASING = typeof SqlInfo.SQL_SUPPORTS_COLUMN_ALIASING;
709
+ type SQL_NULL_PLUS_NULL_IS_NULL = typeof SqlInfo.SQL_NULL_PLUS_NULL_IS_NULL;
710
+ type SQL_SUPPORTS_CONVERT = typeof SqlInfo.SQL_SUPPORTS_CONVERT;
711
+ type SQL_SUPPORTS_TABLE_CORRELATION_NAMES = typeof SqlInfo.SQL_SUPPORTS_TABLE_CORRELATION_NAMES;
712
+ type SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES = typeof SqlInfo.SQL_SUPPORTS_DIFFERENT_TABLE_CORRELATION_NAMES;
713
+ type SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY = typeof SqlInfo.SQL_SUPPORTS_EXPRESSIONS_IN_ORDER_BY;
714
+ type SQL_SUPPORTS_ORDER_BY_UNRELATED = typeof SqlInfo.SQL_SUPPORTS_ORDER_BY_UNRELATED;
715
+ type SQL_SUPPORTED_GROUP_BY = typeof SqlInfo.SQL_SUPPORTED_GROUP_BY;
716
+ type SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE = typeof SqlInfo.SQL_SUPPORTS_LIKE_ESCAPE_CLAUSE;
717
+ type SQL_SUPPORTS_NON_NULLABLE_COLUMNS = typeof SqlInfo.SQL_SUPPORTS_NON_NULLABLE_COLUMNS;
718
+ type SQL_SUPPORTED_GRAMMAR = typeof SqlInfo.SQL_SUPPORTED_GRAMMAR;
719
+ type SQL_ANSI92_SUPPORTED_LEVEL = typeof SqlInfo.SQL_ANSI92_SUPPORTED_LEVEL;
720
+ type SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY = typeof SqlInfo.SQL_SUPPORTS_INTEGRITY_ENHANCEMENT_FACILITY;
721
+ type SQL_OUTER_JOINS_SUPPORT_LEVEL = typeof SqlInfo.SQL_OUTER_JOINS_SUPPORT_LEVEL;
722
+ type SQL_SCHEMA_TERM = typeof SqlInfo.SQL_SCHEMA_TERM;
723
+ type SQL_PROCEDURE_TERM = typeof SqlInfo.SQL_PROCEDURE_TERM;
724
+ type SQL_CATALOG_TERM = typeof SqlInfo.SQL_CATALOG_TERM;
725
+ type SQL_CATALOG_AT_START = typeof SqlInfo.SQL_CATALOG_AT_START;
726
+ type SQL_SCHEMAS_SUPPORTED_ACTIONS = typeof SqlInfo.SQL_SCHEMAS_SUPPORTED_ACTIONS;
727
+ type SQL_CATALOGS_SUPPORTED_ACTIONS = typeof SqlInfo.SQL_CATALOGS_SUPPORTED_ACTIONS;
728
+ type SQL_SUPPORTED_POSITIONED_COMMANDS = typeof SqlInfo.SQL_SUPPORTED_POSITIONED_COMMANDS;
729
+ type SQL_SELECT_FOR_UPDATE_SUPPORTED = typeof SqlInfo.SQL_SELECT_FOR_UPDATE_SUPPORTED;
730
+ type SQL_STORED_PROCEDURES_SUPPORTED = typeof SqlInfo.SQL_STORED_PROCEDURES_SUPPORTED;
731
+ type SQL_SUPPORTED_SUBQUERIES = typeof SqlInfo.SQL_SUPPORTED_SUBQUERIES;
732
+ type SQL_CORRELATED_SUBQUERIES_SUPPORTED = typeof SqlInfo.SQL_CORRELATED_SUBQUERIES_SUPPORTED;
733
+ type SQL_SUPPORTED_UNIONS = typeof SqlInfo.SQL_SUPPORTED_UNIONS;
734
+ type SQL_MAX_BINARY_LITERAL_LENGTH = typeof SqlInfo.SQL_MAX_BINARY_LITERAL_LENGTH;
735
+ type SQL_MAX_CHAR_LITERAL_LENGTH = typeof SqlInfo.SQL_MAX_CHAR_LITERAL_LENGTH;
736
+ type SQL_MAX_COLUMN_NAME_LENGTH = typeof SqlInfo.SQL_MAX_COLUMN_NAME_LENGTH;
737
+ type SQL_MAX_COLUMNS_IN_GROUP_BY = typeof SqlInfo.SQL_MAX_COLUMNS_IN_GROUP_BY;
738
+ type SQL_MAX_COLUMNS_IN_INDEX = typeof SqlInfo.SQL_MAX_COLUMNS_IN_INDEX;
739
+ type SQL_MAX_COLUMNS_IN_ORDER_BY = typeof SqlInfo.SQL_MAX_COLUMNS_IN_ORDER_BY;
740
+ type SQL_MAX_COLUMNS_IN_SELECT = typeof SqlInfo.SQL_MAX_COLUMNS_IN_SELECT;
741
+ type SQL_MAX_COLUMNS_IN_TABLE = typeof SqlInfo.SQL_MAX_COLUMNS_IN_TABLE;
742
+ type SQL_MAX_CONNECTIONS = typeof SqlInfo.SQL_MAX_CONNECTIONS;
743
+ type SQL_MAX_CURSOR_NAME_LENGTH = typeof SqlInfo.SQL_MAX_CURSOR_NAME_LENGTH;
744
+ type SQL_MAX_INDEX_LENGTH = typeof SqlInfo.SQL_MAX_INDEX_LENGTH;
745
+ type SQL_DB_SCHEMA_NAME_LENGTH = typeof SqlInfo.SQL_DB_SCHEMA_NAME_LENGTH;
746
+ type SQL_MAX_PROCEDURE_NAME_LENGTH = typeof SqlInfo.SQL_MAX_PROCEDURE_NAME_LENGTH;
747
+ type SQL_MAX_CATALOG_NAME_LENGTH = typeof SqlInfo.SQL_MAX_CATALOG_NAME_LENGTH;
748
+ type SQL_MAX_ROW_SIZE = typeof SqlInfo.SQL_MAX_ROW_SIZE;
749
+ type SQL_MAX_ROW_SIZE_INCLUDES_BLOBS = typeof SqlInfo.SQL_MAX_ROW_SIZE_INCLUDES_BLOBS;
750
+ type SQL_MAX_STATEMENT_LENGTH = typeof SqlInfo.SQL_MAX_STATEMENT_LENGTH;
751
+ type SQL_MAX_STATEMENTS = typeof SqlInfo.SQL_MAX_STATEMENTS;
752
+ type SQL_MAX_TABLE_NAME_LENGTH = typeof SqlInfo.SQL_MAX_TABLE_NAME_LENGTH;
753
+ type SQL_MAX_TABLES_IN_SELECT = typeof SqlInfo.SQL_MAX_TABLES_IN_SELECT;
754
+ type SQL_MAX_USERNAME_LENGTH = typeof SqlInfo.SQL_MAX_USERNAME_LENGTH;
755
+ type SQL_DEFAULT_TRANSACTION_ISOLATION = typeof SqlInfo.SQL_DEFAULT_TRANSACTION_ISOLATION;
756
+ type SQL_TRANSACTIONS_SUPPORTED = typeof SqlInfo.SQL_TRANSACTIONS_SUPPORTED;
757
+ type SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS = typeof SqlInfo.SQL_SUPPORTED_TRANSACTIONS_ISOLATION_LEVELS;
758
+ type SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT = typeof SqlInfo.SQL_DATA_DEFINITION_CAUSES_TRANSACTION_COMMIT;
759
+ type SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED = typeof SqlInfo.SQL_DATA_DEFINITIONS_IN_TRANSACTIONS_IGNORED;
760
+ type SQL_SUPPORTED_RESULT_SET_TYPES = typeof SqlInfo.SQL_SUPPORTED_RESULT_SET_TYPES;
761
+ type SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED = typeof SqlInfo.SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_UNSPECIFIED;
762
+ type SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY = typeof SqlInfo.SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_FORWARD_ONLY;
763
+ type SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE = typeof SqlInfo.SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_SENSITIVE;
764
+ type SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE = typeof SqlInfo.SQL_SUPPORTED_CONCURRENCIES_FOR_RESULT_SET_SCROLL_INSENSITIVE;
765
+ type SQL_BATCH_UPDATES_SUPPORTED = typeof SqlInfo.SQL_BATCH_UPDATES_SUPPORTED;
766
+ type SQL_SAVEPOINTS_SUPPORTED = typeof SqlInfo.SQL_SAVEPOINTS_SUPPORTED;
767
+ type SQL_NAMED_PARAMETERS_SUPPORTED = typeof SqlInfo.SQL_NAMED_PARAMETERS_SUPPORTED;
768
+ type SQL_LOCATORS_UPDATE_COPY = typeof SqlInfo.SQL_LOCATORS_UPDATE_COPY;
769
+ type SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED = typeof SqlInfo.SQL_STORED_FUNCTIONS_USING_CALL_SYNTAX_SUPPORTED;
770
+ type UNRECOGNIZED = typeof SqlInfo.UNRECOGNIZED;
771
+ }
772
+ export declare function sqlInfoFromJSON(object: any): SqlInfo;
773
+ export declare function sqlInfoToJSON(object: SqlInfo): string;
774
+ /** The level of support for Flight SQL transaction RPCs. */
775
+ export declare const SqlSupportedTransaction: {
776
+ /** SQL_SUPPORTED_TRANSACTION_NONE - Unknown/not indicated/no support */
777
+ readonly SQL_SUPPORTED_TRANSACTION_NONE: 0;
778
+ /**
779
+ * SQL_SUPPORTED_TRANSACTION_TRANSACTION - Transactions, but not savepoints.
780
+ * A savepoint is a mark within a transaction that can be individually
781
+ * rolled back to. Not all databases support savepoints.
782
+ */
783
+ readonly SQL_SUPPORTED_TRANSACTION_TRANSACTION: 1;
784
+ /** SQL_SUPPORTED_TRANSACTION_SAVEPOINT - Transactions and savepoints */
785
+ readonly SQL_SUPPORTED_TRANSACTION_SAVEPOINT: 2;
786
+ readonly UNRECOGNIZED: -1;
787
+ };
788
+ export type SqlSupportedTransaction = typeof SqlSupportedTransaction[keyof typeof SqlSupportedTransaction];
789
+ export declare namespace SqlSupportedTransaction {
790
+ type SQL_SUPPORTED_TRANSACTION_NONE = typeof SqlSupportedTransaction.SQL_SUPPORTED_TRANSACTION_NONE;
791
+ type SQL_SUPPORTED_TRANSACTION_TRANSACTION = typeof SqlSupportedTransaction.SQL_SUPPORTED_TRANSACTION_TRANSACTION;
792
+ type SQL_SUPPORTED_TRANSACTION_SAVEPOINT = typeof SqlSupportedTransaction.SQL_SUPPORTED_TRANSACTION_SAVEPOINT;
793
+ type UNRECOGNIZED = typeof SqlSupportedTransaction.UNRECOGNIZED;
794
+ }
795
+ export declare function sqlSupportedTransactionFromJSON(object: any): SqlSupportedTransaction;
796
+ export declare function sqlSupportedTransactionToJSON(object: SqlSupportedTransaction): string;
797
+ export declare const SqlSupportedCaseSensitivity: {
798
+ readonly SQL_CASE_SENSITIVITY_UNKNOWN: 0;
799
+ readonly SQL_CASE_SENSITIVITY_CASE_INSENSITIVE: 1;
800
+ readonly SQL_CASE_SENSITIVITY_UPPERCASE: 2;
801
+ readonly SQL_CASE_SENSITIVITY_LOWERCASE: 3;
802
+ readonly UNRECOGNIZED: -1;
803
+ };
804
+ export type SqlSupportedCaseSensitivity = typeof SqlSupportedCaseSensitivity[keyof typeof SqlSupportedCaseSensitivity];
805
+ export declare namespace SqlSupportedCaseSensitivity {
806
+ type SQL_CASE_SENSITIVITY_UNKNOWN = typeof SqlSupportedCaseSensitivity.SQL_CASE_SENSITIVITY_UNKNOWN;
807
+ type SQL_CASE_SENSITIVITY_CASE_INSENSITIVE = typeof SqlSupportedCaseSensitivity.SQL_CASE_SENSITIVITY_CASE_INSENSITIVE;
808
+ type SQL_CASE_SENSITIVITY_UPPERCASE = typeof SqlSupportedCaseSensitivity.SQL_CASE_SENSITIVITY_UPPERCASE;
809
+ type SQL_CASE_SENSITIVITY_LOWERCASE = typeof SqlSupportedCaseSensitivity.SQL_CASE_SENSITIVITY_LOWERCASE;
810
+ type UNRECOGNIZED = typeof SqlSupportedCaseSensitivity.UNRECOGNIZED;
811
+ }
812
+ export declare function sqlSupportedCaseSensitivityFromJSON(object: any): SqlSupportedCaseSensitivity;
813
+ export declare function sqlSupportedCaseSensitivityToJSON(object: SqlSupportedCaseSensitivity): string;
814
+ export declare const SqlNullOrdering: {
815
+ readonly SQL_NULLS_SORTED_HIGH: 0;
816
+ readonly SQL_NULLS_SORTED_LOW: 1;
817
+ readonly SQL_NULLS_SORTED_AT_START: 2;
818
+ readonly SQL_NULLS_SORTED_AT_END: 3;
819
+ readonly UNRECOGNIZED: -1;
820
+ };
821
+ export type SqlNullOrdering = typeof SqlNullOrdering[keyof typeof SqlNullOrdering];
822
+ export declare namespace SqlNullOrdering {
823
+ type SQL_NULLS_SORTED_HIGH = typeof SqlNullOrdering.SQL_NULLS_SORTED_HIGH;
824
+ type SQL_NULLS_SORTED_LOW = typeof SqlNullOrdering.SQL_NULLS_SORTED_LOW;
825
+ type SQL_NULLS_SORTED_AT_START = typeof SqlNullOrdering.SQL_NULLS_SORTED_AT_START;
826
+ type SQL_NULLS_SORTED_AT_END = typeof SqlNullOrdering.SQL_NULLS_SORTED_AT_END;
827
+ type UNRECOGNIZED = typeof SqlNullOrdering.UNRECOGNIZED;
828
+ }
829
+ export declare function sqlNullOrderingFromJSON(object: any): SqlNullOrdering;
830
+ export declare function sqlNullOrderingToJSON(object: SqlNullOrdering): string;
831
+ export declare const SupportedSqlGrammar: {
832
+ readonly SQL_MINIMUM_GRAMMAR: 0;
833
+ readonly SQL_CORE_GRAMMAR: 1;
834
+ readonly SQL_EXTENDED_GRAMMAR: 2;
835
+ readonly UNRECOGNIZED: -1;
836
+ };
837
+ export type SupportedSqlGrammar = typeof SupportedSqlGrammar[keyof typeof SupportedSqlGrammar];
838
+ export declare namespace SupportedSqlGrammar {
839
+ type SQL_MINIMUM_GRAMMAR = typeof SupportedSqlGrammar.SQL_MINIMUM_GRAMMAR;
840
+ type SQL_CORE_GRAMMAR = typeof SupportedSqlGrammar.SQL_CORE_GRAMMAR;
841
+ type SQL_EXTENDED_GRAMMAR = typeof SupportedSqlGrammar.SQL_EXTENDED_GRAMMAR;
842
+ type UNRECOGNIZED = typeof SupportedSqlGrammar.UNRECOGNIZED;
843
+ }
844
+ export declare function supportedSqlGrammarFromJSON(object: any): SupportedSqlGrammar;
845
+ export declare function supportedSqlGrammarToJSON(object: SupportedSqlGrammar): string;
846
+ export declare const SupportedAnsi92SqlGrammarLevel: {
847
+ readonly ANSI92_ENTRY_SQL: 0;
848
+ readonly ANSI92_INTERMEDIATE_SQL: 1;
849
+ readonly ANSI92_FULL_SQL: 2;
850
+ readonly UNRECOGNIZED: -1;
851
+ };
852
+ export type SupportedAnsi92SqlGrammarLevel = typeof SupportedAnsi92SqlGrammarLevel[keyof typeof SupportedAnsi92SqlGrammarLevel];
853
+ export declare namespace SupportedAnsi92SqlGrammarLevel {
854
+ type ANSI92_ENTRY_SQL = typeof SupportedAnsi92SqlGrammarLevel.ANSI92_ENTRY_SQL;
855
+ type ANSI92_INTERMEDIATE_SQL = typeof SupportedAnsi92SqlGrammarLevel.ANSI92_INTERMEDIATE_SQL;
856
+ type ANSI92_FULL_SQL = typeof SupportedAnsi92SqlGrammarLevel.ANSI92_FULL_SQL;
857
+ type UNRECOGNIZED = typeof SupportedAnsi92SqlGrammarLevel.UNRECOGNIZED;
858
+ }
859
+ export declare function supportedAnsi92SqlGrammarLevelFromJSON(object: any): SupportedAnsi92SqlGrammarLevel;
860
+ export declare function supportedAnsi92SqlGrammarLevelToJSON(object: SupportedAnsi92SqlGrammarLevel): string;
861
+ export declare const SqlOuterJoinsSupportLevel: {
862
+ readonly SQL_JOINS_UNSUPPORTED: 0;
863
+ readonly SQL_LIMITED_OUTER_JOINS: 1;
864
+ readonly SQL_FULL_OUTER_JOINS: 2;
865
+ readonly UNRECOGNIZED: -1;
866
+ };
867
+ export type SqlOuterJoinsSupportLevel = typeof SqlOuterJoinsSupportLevel[keyof typeof SqlOuterJoinsSupportLevel];
868
+ export declare namespace SqlOuterJoinsSupportLevel {
869
+ type SQL_JOINS_UNSUPPORTED = typeof SqlOuterJoinsSupportLevel.SQL_JOINS_UNSUPPORTED;
870
+ type SQL_LIMITED_OUTER_JOINS = typeof SqlOuterJoinsSupportLevel.SQL_LIMITED_OUTER_JOINS;
871
+ type SQL_FULL_OUTER_JOINS = typeof SqlOuterJoinsSupportLevel.SQL_FULL_OUTER_JOINS;
872
+ type UNRECOGNIZED = typeof SqlOuterJoinsSupportLevel.UNRECOGNIZED;
873
+ }
874
+ export declare function sqlOuterJoinsSupportLevelFromJSON(object: any): SqlOuterJoinsSupportLevel;
875
+ export declare function sqlOuterJoinsSupportLevelToJSON(object: SqlOuterJoinsSupportLevel): string;
876
+ export declare const SqlSupportedGroupBy: {
877
+ readonly SQL_GROUP_BY_UNRELATED: 0;
878
+ readonly SQL_GROUP_BY_BEYOND_SELECT: 1;
879
+ readonly UNRECOGNIZED: -1;
880
+ };
881
+ export type SqlSupportedGroupBy = typeof SqlSupportedGroupBy[keyof typeof SqlSupportedGroupBy];
882
+ export declare namespace SqlSupportedGroupBy {
883
+ type SQL_GROUP_BY_UNRELATED = typeof SqlSupportedGroupBy.SQL_GROUP_BY_UNRELATED;
884
+ type SQL_GROUP_BY_BEYOND_SELECT = typeof SqlSupportedGroupBy.SQL_GROUP_BY_BEYOND_SELECT;
885
+ type UNRECOGNIZED = typeof SqlSupportedGroupBy.UNRECOGNIZED;
886
+ }
887
+ export declare function sqlSupportedGroupByFromJSON(object: any): SqlSupportedGroupBy;
888
+ export declare function sqlSupportedGroupByToJSON(object: SqlSupportedGroupBy): string;
889
+ export declare const SqlSupportedElementActions: {
890
+ readonly SQL_ELEMENT_IN_PROCEDURE_CALLS: 0;
891
+ readonly SQL_ELEMENT_IN_INDEX_DEFINITIONS: 1;
892
+ readonly SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS: 2;
893
+ readonly UNRECOGNIZED: -1;
894
+ };
895
+ export type SqlSupportedElementActions = typeof SqlSupportedElementActions[keyof typeof SqlSupportedElementActions];
896
+ export declare namespace SqlSupportedElementActions {
897
+ type SQL_ELEMENT_IN_PROCEDURE_CALLS = typeof SqlSupportedElementActions.SQL_ELEMENT_IN_PROCEDURE_CALLS;
898
+ type SQL_ELEMENT_IN_INDEX_DEFINITIONS = typeof SqlSupportedElementActions.SQL_ELEMENT_IN_INDEX_DEFINITIONS;
899
+ type SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS = typeof SqlSupportedElementActions.SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS;
900
+ type UNRECOGNIZED = typeof SqlSupportedElementActions.UNRECOGNIZED;
901
+ }
902
+ export declare function sqlSupportedElementActionsFromJSON(object: any): SqlSupportedElementActions;
903
+ export declare function sqlSupportedElementActionsToJSON(object: SqlSupportedElementActions): string;
904
+ export declare const SqlSupportedPositionedCommands: {
905
+ readonly SQL_POSITIONED_DELETE: 0;
906
+ readonly SQL_POSITIONED_UPDATE: 1;
907
+ readonly UNRECOGNIZED: -1;
908
+ };
909
+ export type SqlSupportedPositionedCommands = typeof SqlSupportedPositionedCommands[keyof typeof SqlSupportedPositionedCommands];
910
+ export declare namespace SqlSupportedPositionedCommands {
911
+ type SQL_POSITIONED_DELETE = typeof SqlSupportedPositionedCommands.SQL_POSITIONED_DELETE;
912
+ type SQL_POSITIONED_UPDATE = typeof SqlSupportedPositionedCommands.SQL_POSITIONED_UPDATE;
913
+ type UNRECOGNIZED = typeof SqlSupportedPositionedCommands.UNRECOGNIZED;
914
+ }
915
+ export declare function sqlSupportedPositionedCommandsFromJSON(object: any): SqlSupportedPositionedCommands;
916
+ export declare function sqlSupportedPositionedCommandsToJSON(object: SqlSupportedPositionedCommands): string;
917
+ export declare const SqlSupportedSubqueries: {
918
+ readonly SQL_SUBQUERIES_IN_COMPARISONS: 0;
919
+ readonly SQL_SUBQUERIES_IN_EXISTS: 1;
920
+ readonly SQL_SUBQUERIES_IN_INS: 2;
921
+ readonly SQL_SUBQUERIES_IN_QUANTIFIEDS: 3;
922
+ readonly UNRECOGNIZED: -1;
923
+ };
924
+ export type SqlSupportedSubqueries = typeof SqlSupportedSubqueries[keyof typeof SqlSupportedSubqueries];
925
+ export declare namespace SqlSupportedSubqueries {
926
+ type SQL_SUBQUERIES_IN_COMPARISONS = typeof SqlSupportedSubqueries.SQL_SUBQUERIES_IN_COMPARISONS;
927
+ type SQL_SUBQUERIES_IN_EXISTS = typeof SqlSupportedSubqueries.SQL_SUBQUERIES_IN_EXISTS;
928
+ type SQL_SUBQUERIES_IN_INS = typeof SqlSupportedSubqueries.SQL_SUBQUERIES_IN_INS;
929
+ type SQL_SUBQUERIES_IN_QUANTIFIEDS = typeof SqlSupportedSubqueries.SQL_SUBQUERIES_IN_QUANTIFIEDS;
930
+ type UNRECOGNIZED = typeof SqlSupportedSubqueries.UNRECOGNIZED;
931
+ }
932
+ export declare function sqlSupportedSubqueriesFromJSON(object: any): SqlSupportedSubqueries;
933
+ export declare function sqlSupportedSubqueriesToJSON(object: SqlSupportedSubqueries): string;
934
+ export declare const SqlSupportedUnions: {
935
+ readonly SQL_UNION: 0;
936
+ readonly SQL_UNION_ALL: 1;
937
+ readonly UNRECOGNIZED: -1;
938
+ };
939
+ export type SqlSupportedUnions = typeof SqlSupportedUnions[keyof typeof SqlSupportedUnions];
940
+ export declare namespace SqlSupportedUnions {
941
+ type SQL_UNION = typeof SqlSupportedUnions.SQL_UNION;
942
+ type SQL_UNION_ALL = typeof SqlSupportedUnions.SQL_UNION_ALL;
943
+ type UNRECOGNIZED = typeof SqlSupportedUnions.UNRECOGNIZED;
944
+ }
945
+ export declare function sqlSupportedUnionsFromJSON(object: any): SqlSupportedUnions;
946
+ export declare function sqlSupportedUnionsToJSON(object: SqlSupportedUnions): string;
947
+ export declare const SqlTransactionIsolationLevel: {
948
+ readonly SQL_TRANSACTION_NONE: 0;
949
+ readonly SQL_TRANSACTION_READ_UNCOMMITTED: 1;
950
+ readonly SQL_TRANSACTION_READ_COMMITTED: 2;
951
+ readonly SQL_TRANSACTION_REPEATABLE_READ: 3;
952
+ readonly SQL_TRANSACTION_SERIALIZABLE: 4;
953
+ readonly UNRECOGNIZED: -1;
954
+ };
955
+ export type SqlTransactionIsolationLevel = typeof SqlTransactionIsolationLevel[keyof typeof SqlTransactionIsolationLevel];
956
+ export declare namespace SqlTransactionIsolationLevel {
957
+ type SQL_TRANSACTION_NONE = typeof SqlTransactionIsolationLevel.SQL_TRANSACTION_NONE;
958
+ type SQL_TRANSACTION_READ_UNCOMMITTED = typeof SqlTransactionIsolationLevel.SQL_TRANSACTION_READ_UNCOMMITTED;
959
+ type SQL_TRANSACTION_READ_COMMITTED = typeof SqlTransactionIsolationLevel.SQL_TRANSACTION_READ_COMMITTED;
960
+ type SQL_TRANSACTION_REPEATABLE_READ = typeof SqlTransactionIsolationLevel.SQL_TRANSACTION_REPEATABLE_READ;
961
+ type SQL_TRANSACTION_SERIALIZABLE = typeof SqlTransactionIsolationLevel.SQL_TRANSACTION_SERIALIZABLE;
962
+ type UNRECOGNIZED = typeof SqlTransactionIsolationLevel.UNRECOGNIZED;
963
+ }
964
+ export declare function sqlTransactionIsolationLevelFromJSON(object: any): SqlTransactionIsolationLevel;
965
+ export declare function sqlTransactionIsolationLevelToJSON(object: SqlTransactionIsolationLevel): string;
966
+ export declare const SqlSupportedTransactions: {
967
+ readonly SQL_TRANSACTION_UNSPECIFIED: 0;
968
+ readonly SQL_DATA_DEFINITION_TRANSACTIONS: 1;
969
+ readonly SQL_DATA_MANIPULATION_TRANSACTIONS: 2;
970
+ readonly UNRECOGNIZED: -1;
971
+ };
972
+ export type SqlSupportedTransactions = typeof SqlSupportedTransactions[keyof typeof SqlSupportedTransactions];
973
+ export declare namespace SqlSupportedTransactions {
974
+ type SQL_TRANSACTION_UNSPECIFIED = typeof SqlSupportedTransactions.SQL_TRANSACTION_UNSPECIFIED;
975
+ type SQL_DATA_DEFINITION_TRANSACTIONS = typeof SqlSupportedTransactions.SQL_DATA_DEFINITION_TRANSACTIONS;
976
+ type SQL_DATA_MANIPULATION_TRANSACTIONS = typeof SqlSupportedTransactions.SQL_DATA_MANIPULATION_TRANSACTIONS;
977
+ type UNRECOGNIZED = typeof SqlSupportedTransactions.UNRECOGNIZED;
978
+ }
979
+ export declare function sqlSupportedTransactionsFromJSON(object: any): SqlSupportedTransactions;
980
+ export declare function sqlSupportedTransactionsToJSON(object: SqlSupportedTransactions): string;
981
+ export declare const SqlSupportedResultSetType: {
982
+ readonly SQL_RESULT_SET_TYPE_UNSPECIFIED: 0;
983
+ readonly SQL_RESULT_SET_TYPE_FORWARD_ONLY: 1;
984
+ readonly SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE: 2;
985
+ readonly SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE: 3;
986
+ readonly UNRECOGNIZED: -1;
987
+ };
988
+ export type SqlSupportedResultSetType = typeof SqlSupportedResultSetType[keyof typeof SqlSupportedResultSetType];
989
+ export declare namespace SqlSupportedResultSetType {
990
+ type SQL_RESULT_SET_TYPE_UNSPECIFIED = typeof SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_UNSPECIFIED;
991
+ type SQL_RESULT_SET_TYPE_FORWARD_ONLY = typeof SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_FORWARD_ONLY;
992
+ type SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE = typeof SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_INSENSITIVE;
993
+ type SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE = typeof SqlSupportedResultSetType.SQL_RESULT_SET_TYPE_SCROLL_SENSITIVE;
994
+ type UNRECOGNIZED = typeof SqlSupportedResultSetType.UNRECOGNIZED;
995
+ }
996
+ export declare function sqlSupportedResultSetTypeFromJSON(object: any): SqlSupportedResultSetType;
997
+ export declare function sqlSupportedResultSetTypeToJSON(object: SqlSupportedResultSetType): string;
998
+ export declare const SqlSupportedResultSetConcurrency: {
999
+ readonly SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED: 0;
1000
+ readonly SQL_RESULT_SET_CONCURRENCY_READ_ONLY: 1;
1001
+ readonly SQL_RESULT_SET_CONCURRENCY_UPDATABLE: 2;
1002
+ readonly UNRECOGNIZED: -1;
1003
+ };
1004
+ export type SqlSupportedResultSetConcurrency = typeof SqlSupportedResultSetConcurrency[keyof typeof SqlSupportedResultSetConcurrency];
1005
+ export declare namespace SqlSupportedResultSetConcurrency {
1006
+ type SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED = typeof SqlSupportedResultSetConcurrency.SQL_RESULT_SET_CONCURRENCY_UNSPECIFIED;
1007
+ type SQL_RESULT_SET_CONCURRENCY_READ_ONLY = typeof SqlSupportedResultSetConcurrency.SQL_RESULT_SET_CONCURRENCY_READ_ONLY;
1008
+ type SQL_RESULT_SET_CONCURRENCY_UPDATABLE = typeof SqlSupportedResultSetConcurrency.SQL_RESULT_SET_CONCURRENCY_UPDATABLE;
1009
+ type UNRECOGNIZED = typeof SqlSupportedResultSetConcurrency.UNRECOGNIZED;
1010
+ }
1011
+ export declare function sqlSupportedResultSetConcurrencyFromJSON(object: any): SqlSupportedResultSetConcurrency;
1012
+ export declare function sqlSupportedResultSetConcurrencyToJSON(object: SqlSupportedResultSetConcurrency): string;
1013
+ export declare const SqlSupportsConvert: {
1014
+ readonly SQL_CONVERT_BIGINT: 0;
1015
+ readonly SQL_CONVERT_BINARY: 1;
1016
+ readonly SQL_CONVERT_BIT: 2;
1017
+ readonly SQL_CONVERT_CHAR: 3;
1018
+ readonly SQL_CONVERT_DATE: 4;
1019
+ readonly SQL_CONVERT_DECIMAL: 5;
1020
+ readonly SQL_CONVERT_FLOAT: 6;
1021
+ readonly SQL_CONVERT_INTEGER: 7;
1022
+ readonly SQL_CONVERT_INTERVAL_DAY_TIME: 8;
1023
+ readonly SQL_CONVERT_INTERVAL_YEAR_MONTH: 9;
1024
+ readonly SQL_CONVERT_LONGVARBINARY: 10;
1025
+ readonly SQL_CONVERT_LONGVARCHAR: 11;
1026
+ readonly SQL_CONVERT_NUMERIC: 12;
1027
+ readonly SQL_CONVERT_REAL: 13;
1028
+ readonly SQL_CONVERT_SMALLINT: 14;
1029
+ readonly SQL_CONVERT_TIME: 15;
1030
+ readonly SQL_CONVERT_TIMESTAMP: 16;
1031
+ readonly SQL_CONVERT_TINYINT: 17;
1032
+ readonly SQL_CONVERT_VARBINARY: 18;
1033
+ readonly SQL_CONVERT_VARCHAR: 19;
1034
+ readonly UNRECOGNIZED: -1;
1035
+ };
1036
+ export type SqlSupportsConvert = typeof SqlSupportsConvert[keyof typeof SqlSupportsConvert];
1037
+ export declare namespace SqlSupportsConvert {
1038
+ type SQL_CONVERT_BIGINT = typeof SqlSupportsConvert.SQL_CONVERT_BIGINT;
1039
+ type SQL_CONVERT_BINARY = typeof SqlSupportsConvert.SQL_CONVERT_BINARY;
1040
+ type SQL_CONVERT_BIT = typeof SqlSupportsConvert.SQL_CONVERT_BIT;
1041
+ type SQL_CONVERT_CHAR = typeof SqlSupportsConvert.SQL_CONVERT_CHAR;
1042
+ type SQL_CONVERT_DATE = typeof SqlSupportsConvert.SQL_CONVERT_DATE;
1043
+ type SQL_CONVERT_DECIMAL = typeof SqlSupportsConvert.SQL_CONVERT_DECIMAL;
1044
+ type SQL_CONVERT_FLOAT = typeof SqlSupportsConvert.SQL_CONVERT_FLOAT;
1045
+ type SQL_CONVERT_INTEGER = typeof SqlSupportsConvert.SQL_CONVERT_INTEGER;
1046
+ type SQL_CONVERT_INTERVAL_DAY_TIME = typeof SqlSupportsConvert.SQL_CONVERT_INTERVAL_DAY_TIME;
1047
+ type SQL_CONVERT_INTERVAL_YEAR_MONTH = typeof SqlSupportsConvert.SQL_CONVERT_INTERVAL_YEAR_MONTH;
1048
+ type SQL_CONVERT_LONGVARBINARY = typeof SqlSupportsConvert.SQL_CONVERT_LONGVARBINARY;
1049
+ type SQL_CONVERT_LONGVARCHAR = typeof SqlSupportsConvert.SQL_CONVERT_LONGVARCHAR;
1050
+ type SQL_CONVERT_NUMERIC = typeof SqlSupportsConvert.SQL_CONVERT_NUMERIC;
1051
+ type SQL_CONVERT_REAL = typeof SqlSupportsConvert.SQL_CONVERT_REAL;
1052
+ type SQL_CONVERT_SMALLINT = typeof SqlSupportsConvert.SQL_CONVERT_SMALLINT;
1053
+ type SQL_CONVERT_TIME = typeof SqlSupportsConvert.SQL_CONVERT_TIME;
1054
+ type SQL_CONVERT_TIMESTAMP = typeof SqlSupportsConvert.SQL_CONVERT_TIMESTAMP;
1055
+ type SQL_CONVERT_TINYINT = typeof SqlSupportsConvert.SQL_CONVERT_TINYINT;
1056
+ type SQL_CONVERT_VARBINARY = typeof SqlSupportsConvert.SQL_CONVERT_VARBINARY;
1057
+ type SQL_CONVERT_VARCHAR = typeof SqlSupportsConvert.SQL_CONVERT_VARCHAR;
1058
+ type UNRECOGNIZED = typeof SqlSupportsConvert.UNRECOGNIZED;
1059
+ }
1060
+ export declare function sqlSupportsConvertFromJSON(object: any): SqlSupportsConvert;
1061
+ export declare function sqlSupportsConvertToJSON(object: SqlSupportsConvert): string;
1062
+ /**
1063
+ * The JDBC/ODBC-defined type of any object.
1064
+ * All the values here are the same as in the JDBC and ODBC specs.
1065
+ */
1066
+ export declare const XdbcDataType: {
1067
+ readonly XDBC_UNKNOWN_TYPE: 0;
1068
+ readonly XDBC_CHAR: 1;
1069
+ readonly XDBC_NUMERIC: 2;
1070
+ readonly XDBC_DECIMAL: 3;
1071
+ readonly XDBC_INTEGER: 4;
1072
+ readonly XDBC_SMALLINT: 5;
1073
+ readonly XDBC_FLOAT: 6;
1074
+ readonly XDBC_REAL: 7;
1075
+ readonly XDBC_DOUBLE: 8;
1076
+ readonly XDBC_DATETIME: 9;
1077
+ readonly XDBC_INTERVAL: 10;
1078
+ readonly XDBC_VARCHAR: 12;
1079
+ readonly XDBC_DATE: 91;
1080
+ readonly XDBC_TIME: 92;
1081
+ readonly XDBC_TIMESTAMP: 93;
1082
+ readonly XDBC_LONGVARCHAR: -1;
1083
+ readonly XDBC_BINARY: -2;
1084
+ readonly XDBC_VARBINARY: -3;
1085
+ readonly XDBC_LONGVARBINARY: -4;
1086
+ readonly XDBC_BIGINT: -5;
1087
+ readonly XDBC_TINYINT: -6;
1088
+ readonly XDBC_BIT: -7;
1089
+ readonly XDBC_WCHAR: -8;
1090
+ readonly XDBC_WVARCHAR: -9;
1091
+ };
1092
+ export type XdbcDataType = typeof XdbcDataType[keyof typeof XdbcDataType];
1093
+ export declare namespace XdbcDataType {
1094
+ type XDBC_UNKNOWN_TYPE = typeof XdbcDataType.XDBC_UNKNOWN_TYPE;
1095
+ type XDBC_CHAR = typeof XdbcDataType.XDBC_CHAR;
1096
+ type XDBC_NUMERIC = typeof XdbcDataType.XDBC_NUMERIC;
1097
+ type XDBC_DECIMAL = typeof XdbcDataType.XDBC_DECIMAL;
1098
+ type XDBC_INTEGER = typeof XdbcDataType.XDBC_INTEGER;
1099
+ type XDBC_SMALLINT = typeof XdbcDataType.XDBC_SMALLINT;
1100
+ type XDBC_FLOAT = typeof XdbcDataType.XDBC_FLOAT;
1101
+ type XDBC_REAL = typeof XdbcDataType.XDBC_REAL;
1102
+ type XDBC_DOUBLE = typeof XdbcDataType.XDBC_DOUBLE;
1103
+ type XDBC_DATETIME = typeof XdbcDataType.XDBC_DATETIME;
1104
+ type XDBC_INTERVAL = typeof XdbcDataType.XDBC_INTERVAL;
1105
+ type XDBC_VARCHAR = typeof XdbcDataType.XDBC_VARCHAR;
1106
+ type XDBC_DATE = typeof XdbcDataType.XDBC_DATE;
1107
+ type XDBC_TIME = typeof XdbcDataType.XDBC_TIME;
1108
+ type XDBC_TIMESTAMP = typeof XdbcDataType.XDBC_TIMESTAMP;
1109
+ type XDBC_LONGVARCHAR = typeof XdbcDataType.XDBC_LONGVARCHAR;
1110
+ type XDBC_BINARY = typeof XdbcDataType.XDBC_BINARY;
1111
+ type XDBC_VARBINARY = typeof XdbcDataType.XDBC_VARBINARY;
1112
+ type XDBC_LONGVARBINARY = typeof XdbcDataType.XDBC_LONGVARBINARY;
1113
+ type XDBC_BIGINT = typeof XdbcDataType.XDBC_BIGINT;
1114
+ type XDBC_TINYINT = typeof XdbcDataType.XDBC_TINYINT;
1115
+ type XDBC_BIT = typeof XdbcDataType.XDBC_BIT;
1116
+ type XDBC_WCHAR = typeof XdbcDataType.XDBC_WCHAR;
1117
+ type XDBC_WVARCHAR = typeof XdbcDataType.XDBC_WVARCHAR;
1118
+ }
1119
+ export declare function xdbcDataTypeFromJSON(object: any): XdbcDataType;
1120
+ export declare function xdbcDataTypeToJSON(object: XdbcDataType): string;
1121
+ /** Detailed subtype information for XDBC_TYPE_DATETIME and XDBC_TYPE_INTERVAL. */
1122
+ export declare const XdbcDatetimeSubcode: {
1123
+ readonly XDBC_SUBCODE_UNKNOWN: 0;
1124
+ readonly XDBC_SUBCODE_YEAR: 1;
1125
+ readonly XDBC_SUBCODE_DATE: 1;
1126
+ readonly XDBC_SUBCODE_TIME: 2;
1127
+ readonly XDBC_SUBCODE_MONTH: 2;
1128
+ readonly XDBC_SUBCODE_TIMESTAMP: 3;
1129
+ readonly XDBC_SUBCODE_DAY: 3;
1130
+ readonly XDBC_SUBCODE_TIME_WITH_TIMEZONE: 4;
1131
+ readonly XDBC_SUBCODE_HOUR: 4;
1132
+ readonly XDBC_SUBCODE_TIMESTAMP_WITH_TIMEZONE: 5;
1133
+ readonly XDBC_SUBCODE_MINUTE: 5;
1134
+ readonly XDBC_SUBCODE_SECOND: 6;
1135
+ readonly XDBC_SUBCODE_YEAR_TO_MONTH: 7;
1136
+ readonly XDBC_SUBCODE_DAY_TO_HOUR: 8;
1137
+ readonly XDBC_SUBCODE_DAY_TO_MINUTE: 9;
1138
+ readonly XDBC_SUBCODE_DAY_TO_SECOND: 10;
1139
+ readonly XDBC_SUBCODE_HOUR_TO_MINUTE: 11;
1140
+ readonly XDBC_SUBCODE_HOUR_TO_SECOND: 12;
1141
+ readonly XDBC_SUBCODE_MINUTE_TO_SECOND: 13;
1142
+ readonly XDBC_SUBCODE_INTERVAL_YEAR: 101;
1143
+ readonly XDBC_SUBCODE_INTERVAL_MONTH: 102;
1144
+ readonly XDBC_SUBCODE_INTERVAL_DAY: 103;
1145
+ readonly XDBC_SUBCODE_INTERVAL_HOUR: 104;
1146
+ readonly XDBC_SUBCODE_INTERVAL_MINUTE: 105;
1147
+ readonly XDBC_SUBCODE_INTERVAL_SECOND: 106;
1148
+ readonly XDBC_SUBCODE_INTERVAL_YEAR_TO_MONTH: 107;
1149
+ readonly XDBC_SUBCODE_INTERVAL_DAY_TO_HOUR: 108;
1150
+ readonly XDBC_SUBCODE_INTERVAL_DAY_TO_MINUTE: 109;
1151
+ readonly XDBC_SUBCODE_INTERVAL_DAY_TO_SECOND: 110;
1152
+ readonly XDBC_SUBCODE_INTERVAL_HOUR_TO_MINUTE: 111;
1153
+ readonly XDBC_SUBCODE_INTERVAL_HOUR_TO_SECOND: 112;
1154
+ readonly XDBC_SUBCODE_INTERVAL_MINUTE_TO_SECOND: 113;
1155
+ readonly UNRECOGNIZED: -1;
1156
+ };
1157
+ export type XdbcDatetimeSubcode = typeof XdbcDatetimeSubcode[keyof typeof XdbcDatetimeSubcode];
1158
+ export declare namespace XdbcDatetimeSubcode {
1159
+ type XDBC_SUBCODE_UNKNOWN = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_UNKNOWN;
1160
+ type XDBC_SUBCODE_YEAR = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_YEAR;
1161
+ type XDBC_SUBCODE_DATE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_DATE;
1162
+ type XDBC_SUBCODE_TIME = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_TIME;
1163
+ type XDBC_SUBCODE_MONTH = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_MONTH;
1164
+ type XDBC_SUBCODE_TIMESTAMP = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_TIMESTAMP;
1165
+ type XDBC_SUBCODE_DAY = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_DAY;
1166
+ type XDBC_SUBCODE_TIME_WITH_TIMEZONE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_TIME_WITH_TIMEZONE;
1167
+ type XDBC_SUBCODE_HOUR = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_HOUR;
1168
+ type XDBC_SUBCODE_TIMESTAMP_WITH_TIMEZONE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_TIMESTAMP_WITH_TIMEZONE;
1169
+ type XDBC_SUBCODE_MINUTE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_MINUTE;
1170
+ type XDBC_SUBCODE_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_SECOND;
1171
+ type XDBC_SUBCODE_YEAR_TO_MONTH = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_YEAR_TO_MONTH;
1172
+ type XDBC_SUBCODE_DAY_TO_HOUR = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_DAY_TO_HOUR;
1173
+ type XDBC_SUBCODE_DAY_TO_MINUTE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_DAY_TO_MINUTE;
1174
+ type XDBC_SUBCODE_DAY_TO_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_DAY_TO_SECOND;
1175
+ type XDBC_SUBCODE_HOUR_TO_MINUTE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_HOUR_TO_MINUTE;
1176
+ type XDBC_SUBCODE_HOUR_TO_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_HOUR_TO_SECOND;
1177
+ type XDBC_SUBCODE_MINUTE_TO_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_MINUTE_TO_SECOND;
1178
+ type XDBC_SUBCODE_INTERVAL_YEAR = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_YEAR;
1179
+ type XDBC_SUBCODE_INTERVAL_MONTH = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_MONTH;
1180
+ type XDBC_SUBCODE_INTERVAL_DAY = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_DAY;
1181
+ type XDBC_SUBCODE_INTERVAL_HOUR = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_HOUR;
1182
+ type XDBC_SUBCODE_INTERVAL_MINUTE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_MINUTE;
1183
+ type XDBC_SUBCODE_INTERVAL_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_SECOND;
1184
+ type XDBC_SUBCODE_INTERVAL_YEAR_TO_MONTH = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_YEAR_TO_MONTH;
1185
+ type XDBC_SUBCODE_INTERVAL_DAY_TO_HOUR = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_DAY_TO_HOUR;
1186
+ type XDBC_SUBCODE_INTERVAL_DAY_TO_MINUTE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_DAY_TO_MINUTE;
1187
+ type XDBC_SUBCODE_INTERVAL_DAY_TO_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_DAY_TO_SECOND;
1188
+ type XDBC_SUBCODE_INTERVAL_HOUR_TO_MINUTE = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_HOUR_TO_MINUTE;
1189
+ type XDBC_SUBCODE_INTERVAL_HOUR_TO_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_HOUR_TO_SECOND;
1190
+ type XDBC_SUBCODE_INTERVAL_MINUTE_TO_SECOND = typeof XdbcDatetimeSubcode.XDBC_SUBCODE_INTERVAL_MINUTE_TO_SECOND;
1191
+ type UNRECOGNIZED = typeof XdbcDatetimeSubcode.UNRECOGNIZED;
1192
+ }
1193
+ export declare function xdbcDatetimeSubcodeFromJSON(object: any): XdbcDatetimeSubcode;
1194
+ export declare function xdbcDatetimeSubcodeToJSON(object: XdbcDatetimeSubcode): string;
1195
+ export declare const Nullable: {
1196
+ /** NULLABILITY_NO_NULLS - Indicates that the field does not allow the use of null values. */
1197
+ readonly NULLABILITY_NO_NULLS: 0;
1198
+ /** NULLABILITY_NULLABLE - Indicates that the fields allow the use of null values. */
1199
+ readonly NULLABILITY_NULLABLE: 1;
1200
+ /** NULLABILITY_UNKNOWN - Indicates that nullability of the fields cannot be determined. */
1201
+ readonly NULLABILITY_UNKNOWN: 2;
1202
+ readonly UNRECOGNIZED: -1;
1203
+ };
1204
+ export type Nullable = typeof Nullable[keyof typeof Nullable];
1205
+ export declare namespace Nullable {
1206
+ type NULLABILITY_NO_NULLS = typeof Nullable.NULLABILITY_NO_NULLS;
1207
+ type NULLABILITY_NULLABLE = typeof Nullable.NULLABILITY_NULLABLE;
1208
+ type NULLABILITY_UNKNOWN = typeof Nullable.NULLABILITY_UNKNOWN;
1209
+ type UNRECOGNIZED = typeof Nullable.UNRECOGNIZED;
1210
+ }
1211
+ export declare function nullableFromJSON(object: any): Nullable;
1212
+ export declare function nullableToJSON(object: Nullable): string;
1213
+ export declare const Searchable: {
1214
+ /** SEARCHABLE_NONE - Indicates that column cannot be used in a WHERE clause. */
1215
+ readonly SEARCHABLE_NONE: 0;
1216
+ /**
1217
+ * SEARCHABLE_CHAR - Indicates that the column can be used in a WHERE clause if it is using a
1218
+ * LIKE operator.
1219
+ */
1220
+ readonly SEARCHABLE_CHAR: 1;
1221
+ /**
1222
+ * SEARCHABLE_BASIC - Indicates that the column can be used In a WHERE clause with any
1223
+ * operator other than LIKE.
1224
+ *
1225
+ * - Allowed operators: comparison, quantified comparison, BETWEEN,
1226
+ * DISTINCT, IN, MATCH, and UNIQUE.
1227
+ */
1228
+ readonly SEARCHABLE_BASIC: 2;
1229
+ /** SEARCHABLE_FULL - Indicates that the column can be used in a WHERE clause using any operator. */
1230
+ readonly SEARCHABLE_FULL: 3;
1231
+ readonly UNRECOGNIZED: -1;
1232
+ };
1233
+ export type Searchable = typeof Searchable[keyof typeof Searchable];
1234
+ export declare namespace Searchable {
1235
+ type SEARCHABLE_NONE = typeof Searchable.SEARCHABLE_NONE;
1236
+ type SEARCHABLE_CHAR = typeof Searchable.SEARCHABLE_CHAR;
1237
+ type SEARCHABLE_BASIC = typeof Searchable.SEARCHABLE_BASIC;
1238
+ type SEARCHABLE_FULL = typeof Searchable.SEARCHABLE_FULL;
1239
+ type UNRECOGNIZED = typeof Searchable.UNRECOGNIZED;
1240
+ }
1241
+ export declare function searchableFromJSON(object: any): Searchable;
1242
+ export declare function searchableToJSON(object: Searchable): string;
1243
+ export declare const UpdateDeleteRules: {
1244
+ readonly CASCADE: 0;
1245
+ readonly RESTRICT: 1;
1246
+ readonly SET_NULL: 2;
1247
+ readonly NO_ACTION: 3;
1248
+ readonly SET_DEFAULT: 4;
1249
+ readonly UNRECOGNIZED: -1;
1250
+ };
1251
+ export type UpdateDeleteRules = typeof UpdateDeleteRules[keyof typeof UpdateDeleteRules];
1252
+ export declare namespace UpdateDeleteRules {
1253
+ type CASCADE = typeof UpdateDeleteRules.CASCADE;
1254
+ type RESTRICT = typeof UpdateDeleteRules.RESTRICT;
1255
+ type SET_NULL = typeof UpdateDeleteRules.SET_NULL;
1256
+ type NO_ACTION = typeof UpdateDeleteRules.NO_ACTION;
1257
+ type SET_DEFAULT = typeof UpdateDeleteRules.SET_DEFAULT;
1258
+ type UNRECOGNIZED = typeof UpdateDeleteRules.UNRECOGNIZED;
1259
+ }
1260
+ export declare function updateDeleteRulesFromJSON(object: any): UpdateDeleteRules;
1261
+ export declare function updateDeleteRulesToJSON(object: UpdateDeleteRules): string;
1262
+ /**
1263
+ * Represents a metadata request. Used in the command member of FlightDescriptor
1264
+ * for the following RPC calls:
1265
+ * - GetSchema: return the Arrow schema of the query.
1266
+ * - GetFlightInfo: execute the metadata request.
1267
+ *
1268
+ * The returned Arrow schema will be:
1269
+ * <
1270
+ * info_name: uint32 not null,
1271
+ * value: dense_union<
1272
+ * string_value: utf8,
1273
+ * bool_value: bool,
1274
+ * bigint_value: int64,
1275
+ * int32_bitmask: int32,
1276
+ * string_list: list<string_data: utf8>
1277
+ * int32_to_int32_list_map: map<key: int32, value: list<$data$: int32>>
1278
+ * >
1279
+ * where there is one row per requested piece of metadata information.
1280
+ */
1281
+ export interface CommandGetSqlInfo {
1282
+ /**
1283
+ * Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
1284
+ * Flight SQL clients with basic, SQL syntax and SQL functions related information.
1285
+ * More information types can be added in future releases.
1286
+ * E.g. more SQL syntax support types, scalar functions support, type conversion support etc.
1287
+ *
1288
+ * Note that the set of metadata may expand.
1289
+ *
1290
+ * Initially, Flight SQL will support the following information types:
1291
+ * - Server Information - Range [0-500)
1292
+ * - Syntax Information - Range [500-1000)
1293
+ * Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
1294
+ * Custom options should start at 10,000.
1295
+ *
1296
+ * If omitted, then all metadata will be retrieved.
1297
+ * Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
1298
+ * at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
1299
+ * If additional metadata is included, the metadata IDs should start from 10,000.
1300
+ */
1301
+ info: number[];
1302
+ }
1303
+ /**
1304
+ * Represents a request to retrieve information about data type supported on a Flight SQL enabled backend.
1305
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1306
+ * - GetSchema: return the schema of the query.
1307
+ * - GetFlightInfo: execute the catalog metadata request.
1308
+ *
1309
+ * The returned schema will be:
1310
+ * <
1311
+ * type_name: utf8 not null (The name of the data type, for example: VARCHAR, INTEGER, etc),
1312
+ * data_type: int32 not null (The SQL data type),
1313
+ * column_size: int32 (The maximum size supported by that column.
1314
+ * In case of exact numeric types, this represents the maximum precision.
1315
+ * In case of string types, this represents the character length.
1316
+ * In case of datetime data types, this represents the length in characters of the string representation.
1317
+ * NULL is returned for data types where column size is not applicable.),
1318
+ * literal_prefix: utf8 (Character or characters used to prefix a literal, NULL is returned for
1319
+ * data types where a literal prefix is not applicable.),
1320
+ * literal_suffix: utf8 (Character or characters used to terminate a literal,
1321
+ * NULL is returned for data types where a literal suffix is not applicable.),
1322
+ * create_params: list<utf8 not null>
1323
+ * (A list of keywords corresponding to which parameters can be used when creating
1324
+ * a column for that specific type.
1325
+ * NULL is returned if there are no parameters for the data type definition.),
1326
+ * nullable: int32 not null (Shows if the data type accepts a NULL value. The possible values can be seen in the
1327
+ * Nullable enum.),
1328
+ * case_sensitive: bool not null (Shows if a character data type is case-sensitive in collations and comparisons),
1329
+ * searchable: int32 not null (Shows how the data type is used in a WHERE clause. The possible values can be seen in the
1330
+ * Searchable enum.),
1331
+ * unsigned_attribute: bool (Shows if the data type is unsigned. NULL is returned if the attribute is
1332
+ * not applicable to the data type or the data type is not numeric.),
1333
+ * fixed_prec_scale: bool not null (Shows if the data type has predefined fixed precision and scale.),
1334
+ * auto_increment: bool (Shows if the data type is auto incremental. NULL is returned if the attribute
1335
+ * is not applicable to the data type or the data type is not numeric.),
1336
+ * local_type_name: utf8 (Localized version of the data source-dependent name of the data type. NULL
1337
+ * is returned if a localized name is not supported by the data source),
1338
+ * minimum_scale: int32 (The minimum scale of the data type on the data source.
1339
+ * If a data type has a fixed scale, the MINIMUM_SCALE and MAXIMUM_SCALE
1340
+ * columns both contain this value. NULL is returned if scale is not applicable.),
1341
+ * maximum_scale: int32 (The maximum scale of the data type on the data source.
1342
+ * NULL is returned if scale is not applicable.),
1343
+ * sql_data_type: int32 not null (The value of the SQL DATA TYPE which has the same values
1344
+ * as data_type value. Except for interval and datetime, which
1345
+ * uses generic values. More info about those types can be
1346
+ * obtained through datetime_subcode. The possible values can be seen
1347
+ * in the XdbcDataType enum.),
1348
+ * datetime_subcode: int32 (Only used when the SQL DATA TYPE is interval or datetime. It contains
1349
+ * its sub types. For type different from interval and datetime, this value
1350
+ * is NULL. The possible values can be seen in the XdbcDatetimeSubcode enum.),
1351
+ * num_prec_radix: int32 (If the data type is an approximate numeric type, this column contains
1352
+ * the value 2 to indicate that COLUMN_SIZE specifies a number of bits. For
1353
+ * exact numeric types, this column contains the value 10 to indicate that
1354
+ * column size specifies a number of decimal digits. Otherwise, this column is NULL.),
1355
+ * interval_precision: int32 (If the data type is an interval data type, then this column contains the value
1356
+ * of the interval leading precision. Otherwise, this column is NULL. This fields
1357
+ * is only relevant to be used by ODBC).
1358
+ * >
1359
+ * The returned data should be ordered by data_type and then by type_name.
1360
+ */
1361
+ export interface CommandGetXdbcTypeInfo {
1362
+ /** Specifies the data type to search for the info. */
1363
+ dataType?: number | undefined;
1364
+ }
1365
+ /**
1366
+ * Represents a request to retrieve the list of catalogs on a Flight SQL enabled backend.
1367
+ * The definition of a catalog depends on vendor/implementation. It is usually the database itself
1368
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1369
+ * - GetSchema: return the Arrow schema of the query.
1370
+ * - GetFlightInfo: execute the catalog metadata request.
1371
+ *
1372
+ * The returned Arrow schema will be:
1373
+ * <
1374
+ * catalog_name: utf8 not null
1375
+ * >
1376
+ * The returned data should be ordered by catalog_name.
1377
+ */
1378
+ export interface CommandGetCatalogs {
1379
+ }
1380
+ /**
1381
+ * Represents a request to retrieve the list of database schemas on a Flight SQL enabled backend.
1382
+ * The definition of a database schema depends on vendor/implementation. It is usually a collection of tables.
1383
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1384
+ * - GetSchema: return the Arrow schema of the query.
1385
+ * - GetFlightInfo: execute the catalog metadata request.
1386
+ *
1387
+ * The returned Arrow schema will be:
1388
+ * <
1389
+ * catalog_name: utf8,
1390
+ * db_schema_name: utf8 not null
1391
+ * >
1392
+ * The returned data should be ordered by catalog_name, then db_schema_name.
1393
+ */
1394
+ export interface CommandGetDbSchemas {
1395
+ /**
1396
+ * Specifies the Catalog to search for the tables.
1397
+ * An empty string retrieves those without a catalog.
1398
+ * If omitted the catalog name should not be used to narrow the search.
1399
+ */
1400
+ catalog?: string | undefined;
1401
+ /**
1402
+ * Specifies a filter pattern for schemas to search for.
1403
+ * When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search.
1404
+ * In the pattern string, two special characters can be used to denote matching rules:
1405
+ * - "%" means to match any substring with 0 or more characters.
1406
+ * - "_" means to match any one character.
1407
+ */
1408
+ dbSchemaFilterPattern?: string | undefined;
1409
+ }
1410
+ /**
1411
+ * Represents a request to retrieve the list of tables, and optionally their schemas, on a Flight SQL enabled backend.
1412
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1413
+ * - GetSchema: return the Arrow schema of the query.
1414
+ * - GetFlightInfo: execute the catalog metadata request.
1415
+ *
1416
+ * The returned Arrow schema will be:
1417
+ * <
1418
+ * catalog_name: utf8,
1419
+ * db_schema_name: utf8,
1420
+ * table_name: utf8 not null,
1421
+ * table_type: utf8 not null,
1422
+ * [optional] table_schema: bytes not null (schema of the table as described in Schema.fbs::Schema,
1423
+ * it is serialized as an IPC message.)
1424
+ * >
1425
+ * Fields on table_schema may contain the following metadata:
1426
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
1427
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
1428
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
1429
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
1430
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
1431
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
1432
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
1433
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
1434
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
1435
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
1436
+ * - 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.
1437
+ * The returned data should be ordered by catalog_name, db_schema_name, table_name, then table_type, followed by table_schema if requested.
1438
+ */
1439
+ export interface CommandGetTables {
1440
+ /**
1441
+ * Specifies the Catalog to search for the tables.
1442
+ * An empty string retrieves those without a catalog.
1443
+ * If omitted the catalog name should not be used to narrow the search.
1444
+ */
1445
+ catalog?: string | undefined;
1446
+ /**
1447
+ * Specifies a filter pattern for schemas to search for.
1448
+ * When no db_schema_filter_pattern is provided, all schemas matching other filters are searched.
1449
+ * In the pattern string, two special characters can be used to denote matching rules:
1450
+ * - "%" means to match any substring with 0 or more characters.
1451
+ * - "_" means to match any one character.
1452
+ */
1453
+ dbSchemaFilterPattern?: string | undefined;
1454
+ /**
1455
+ * Specifies a filter pattern for tables to search for.
1456
+ * When no table_name_filter_pattern is provided, all tables matching other filters are searched.
1457
+ * In the pattern string, two special characters can be used to denote matching rules:
1458
+ * - "%" means to match any substring with 0 or more characters.
1459
+ * - "_" means to match any one character.
1460
+ */
1461
+ tableNameFilterPattern?: string | undefined;
1462
+ /**
1463
+ * Specifies a filter of table types which must match.
1464
+ * The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
1465
+ * TABLE, VIEW, and SYSTEM TABLE are commonly supported.
1466
+ */
1467
+ tableTypes: string[];
1468
+ /** Specifies if the Arrow schema should be returned for found tables. */
1469
+ includeSchema: boolean;
1470
+ }
1471
+ /**
1472
+ * Represents a request to retrieve the list of table types on a Flight SQL enabled backend.
1473
+ * The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
1474
+ * TABLE, VIEW, and SYSTEM TABLE are commonly supported.
1475
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1476
+ * - GetSchema: return the Arrow schema of the query.
1477
+ * - GetFlightInfo: execute the catalog metadata request.
1478
+ *
1479
+ * The returned Arrow schema will be:
1480
+ * <
1481
+ * table_type: utf8 not null
1482
+ * >
1483
+ * The returned data should be ordered by table_type.
1484
+ */
1485
+ export interface CommandGetTableTypes {
1486
+ }
1487
+ /**
1488
+ * Represents a request to retrieve the primary keys of a table on a Flight SQL enabled backend.
1489
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1490
+ * - GetSchema: return the Arrow schema of the query.
1491
+ * - GetFlightInfo: execute the catalog metadata request.
1492
+ *
1493
+ * The returned Arrow schema will be:
1494
+ * <
1495
+ * catalog_name: utf8,
1496
+ * db_schema_name: utf8,
1497
+ * table_name: utf8 not null,
1498
+ * column_name: utf8 not null,
1499
+ * key_name: utf8,
1500
+ * key_sequence: int32 not null
1501
+ * >
1502
+ * The returned data should be ordered by catalog_name, db_schema_name, table_name, key_name, then key_sequence.
1503
+ */
1504
+ export interface CommandGetPrimaryKeys {
1505
+ /**
1506
+ * Specifies the catalog to search for the table.
1507
+ * An empty string retrieves those without a catalog.
1508
+ * If omitted the catalog name should not be used to narrow the search.
1509
+ */
1510
+ catalog?: string | undefined;
1511
+ /**
1512
+ * Specifies the schema to search for the table.
1513
+ * An empty string retrieves those without a schema.
1514
+ * If omitted the schema name should not be used to narrow the search.
1515
+ */
1516
+ dbSchema?: string | undefined;
1517
+ /** Specifies the table to get the primary keys for. */
1518
+ table: string;
1519
+ }
1520
+ /**
1521
+ * Represents a request to retrieve a description of the foreign key columns that reference the given table's
1522
+ * primary key columns (the foreign keys exported by a table) of a table on a Flight SQL enabled backend.
1523
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1524
+ * - GetSchema: return the Arrow schema of the query.
1525
+ * - GetFlightInfo: execute the catalog metadata request.
1526
+ *
1527
+ * The returned Arrow schema will be:
1528
+ * <
1529
+ * pk_catalog_name: utf8,
1530
+ * pk_db_schema_name: utf8,
1531
+ * pk_table_name: utf8 not null,
1532
+ * pk_column_name: utf8 not null,
1533
+ * fk_catalog_name: utf8,
1534
+ * fk_db_schema_name: utf8,
1535
+ * fk_table_name: utf8 not null,
1536
+ * fk_column_name: utf8 not null,
1537
+ * key_sequence: int32 not null,
1538
+ * fk_key_name: utf8,
1539
+ * pk_key_name: utf8,
1540
+ * update_rule: uint8 not null,
1541
+ * delete_rule: uint8 not null
1542
+ * >
1543
+ * The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence.
1544
+ * update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.
1545
+ */
1546
+ export interface CommandGetExportedKeys {
1547
+ /**
1548
+ * Specifies the catalog to search for the foreign key table.
1549
+ * An empty string retrieves those without a catalog.
1550
+ * If omitted the catalog name should not be used to narrow the search.
1551
+ */
1552
+ catalog?: string | undefined;
1553
+ /**
1554
+ * Specifies the schema to search for the foreign key table.
1555
+ * An empty string retrieves those without a schema.
1556
+ * If omitted the schema name should not be used to narrow the search.
1557
+ */
1558
+ dbSchema?: string | undefined;
1559
+ /** Specifies the foreign key table to get the foreign keys for. */
1560
+ table: string;
1561
+ }
1562
+ /**
1563
+ * Represents a request to retrieve the foreign keys of a table on a Flight SQL enabled backend.
1564
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1565
+ * - GetSchema: return the Arrow schema of the query.
1566
+ * - GetFlightInfo: execute the catalog metadata request.
1567
+ *
1568
+ * The returned Arrow schema will be:
1569
+ * <
1570
+ * pk_catalog_name: utf8,
1571
+ * pk_db_schema_name: utf8,
1572
+ * pk_table_name: utf8 not null,
1573
+ * pk_column_name: utf8 not null,
1574
+ * fk_catalog_name: utf8,
1575
+ * fk_db_schema_name: utf8,
1576
+ * fk_table_name: utf8 not null,
1577
+ * fk_column_name: utf8 not null,
1578
+ * key_sequence: int32 not null,
1579
+ * fk_key_name: utf8,
1580
+ * pk_key_name: utf8,
1581
+ * update_rule: uint8 not null,
1582
+ * delete_rule: uint8 not null
1583
+ * >
1584
+ * The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
1585
+ * update_rule and delete_rule returns a byte that is equivalent to actions:
1586
+ * - 0 = CASCADE
1587
+ * - 1 = RESTRICT
1588
+ * - 2 = SET NULL
1589
+ * - 3 = NO ACTION
1590
+ * - 4 = SET DEFAULT
1591
+ */
1592
+ export interface CommandGetImportedKeys {
1593
+ /**
1594
+ * Specifies the catalog to search for the primary key table.
1595
+ * An empty string retrieves those without a catalog.
1596
+ * If omitted the catalog name should not be used to narrow the search.
1597
+ */
1598
+ catalog?: string | undefined;
1599
+ /**
1600
+ * Specifies the schema to search for the primary key table.
1601
+ * An empty string retrieves those without a schema.
1602
+ * If omitted the schema name should not be used to narrow the search.
1603
+ */
1604
+ dbSchema?: string | undefined;
1605
+ /** Specifies the primary key table to get the foreign keys for. */
1606
+ table: string;
1607
+ }
1608
+ /**
1609
+ * Represents a request to retrieve a description of the foreign key columns in the given foreign key table that
1610
+ * reference the primary key or the columns representing a unique constraint of the parent table (could be the same
1611
+ * or a different table) on a Flight SQL enabled backend.
1612
+ * Used in the command member of FlightDescriptor for the following RPC calls:
1613
+ * - GetSchema: return the Arrow schema of the query.
1614
+ * - GetFlightInfo: execute the catalog metadata request.
1615
+ *
1616
+ * The returned Arrow schema will be:
1617
+ * <
1618
+ * pk_catalog_name: utf8,
1619
+ * pk_db_schema_name: utf8,
1620
+ * pk_table_name: utf8 not null,
1621
+ * pk_column_name: utf8 not null,
1622
+ * fk_catalog_name: utf8,
1623
+ * fk_db_schema_name: utf8,
1624
+ * fk_table_name: utf8 not null,
1625
+ * fk_column_name: utf8 not null,
1626
+ * key_sequence: int32 not null,
1627
+ * fk_key_name: utf8,
1628
+ * pk_key_name: utf8,
1629
+ * update_rule: uint8 not null,
1630
+ * delete_rule: uint8 not null
1631
+ * >
1632
+ * The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
1633
+ * update_rule and delete_rule returns a byte that is equivalent to actions:
1634
+ * - 0 = CASCADE
1635
+ * - 1 = RESTRICT
1636
+ * - 2 = SET NULL
1637
+ * - 3 = NO ACTION
1638
+ * - 4 = SET DEFAULT
1639
+ */
1640
+ export interface CommandGetCrossReference {
1641
+ /**
1642
+ * The catalog name where the parent table is.
1643
+ * An empty string retrieves those without a catalog.
1644
+ * If omitted the catalog name should not be used to narrow the search.
1645
+ */
1646
+ pkCatalog?: string | undefined;
1647
+ /**
1648
+ * The Schema name where the parent table is.
1649
+ * An empty string retrieves those without a schema.
1650
+ * If omitted the schema name should not be used to narrow the search.
1651
+ */
1652
+ pkDbSchema?: string | undefined;
1653
+ /** The parent table name. It cannot be null. */
1654
+ pkTable: string;
1655
+ /**
1656
+ * The catalog name where the foreign table is.
1657
+ * An empty string retrieves those without a catalog.
1658
+ * If omitted the catalog name should not be used to narrow the search.
1659
+ */
1660
+ fkCatalog?: string | undefined;
1661
+ /**
1662
+ * The schema name where the foreign table is.
1663
+ * An empty string retrieves those without a schema.
1664
+ * If omitted the schema name should not be used to narrow the search.
1665
+ */
1666
+ fkDbSchema?: string | undefined;
1667
+ /** The foreign table name. It cannot be null. */
1668
+ fkTable: string;
1669
+ }
1670
+ /** Request message for the "CreatePreparedStatement" action on a Flight SQL enabled backend. */
1671
+ export interface ActionCreatePreparedStatementRequest {
1672
+ /** The valid SQL string to create a prepared statement for. */
1673
+ query: string;
1674
+ /**
1675
+ * Create/execute the prepared statement as part of this transaction (if
1676
+ * unset, executions of the prepared statement will be auto-committed).
1677
+ */
1678
+ transactionId?: Buffer | undefined;
1679
+ }
1680
+ /** An embedded message describing a Substrait plan to execute. */
1681
+ export interface SubstraitPlan {
1682
+ /**
1683
+ * The serialized substrait.Plan to create a prepared statement for.
1684
+ * XXX(ARROW-16902): this is bytes instead of an embedded message
1685
+ * because Protobuf does not really support one DLL using Protobuf
1686
+ * definitions from another DLL.
1687
+ */
1688
+ plan: Buffer;
1689
+ /**
1690
+ * The Substrait release, e.g. "0.12.0". This information is not
1691
+ * tracked in the plan itself, so this is the only way for consumers
1692
+ * to potentially know if they can handle the plan.
1693
+ */
1694
+ version: string;
1695
+ }
1696
+ /** Request message for the "CreatePreparedSubstraitPlan" action on a Flight SQL enabled backend. */
1697
+ export interface ActionCreatePreparedSubstraitPlanRequest {
1698
+ /** The serialized substrait.Plan to create a prepared statement for. */
1699
+ plan: SubstraitPlan | undefined;
1700
+ /**
1701
+ * Create/execute the prepared statement as part of this transaction (if
1702
+ * unset, executions of the prepared statement will be auto-committed).
1703
+ */
1704
+ transactionId?: Buffer | undefined;
1705
+ }
1706
+ /**
1707
+ * Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.
1708
+ *
1709
+ * The resultant PreparedStatement can be closed either:
1710
+ * - Manually, through the "ClosePreparedStatement" action;
1711
+ * - Automatically, by a server timeout.
1712
+ *
1713
+ * The result should be wrapped in a google.protobuf.Any message.
1714
+ */
1715
+ export interface ActionCreatePreparedStatementResult {
1716
+ /** Opaque handle for the prepared statement on the server. */
1717
+ preparedStatementHandle: Buffer;
1718
+ /**
1719
+ * If a result set generating query was provided, dataset_schema contains the
1720
+ * schema of the result set. It should be an IPC-encapsulated Schema, as described in Schema.fbs.
1721
+ * For some queries, the schema of the results may depend on the schema of the parameters. The server
1722
+ * should provide its best guess as to the schema at this point. Clients must not assume that this
1723
+ * schema, if provided, will be accurate.
1724
+ */
1725
+ datasetSchema: Buffer;
1726
+ /**
1727
+ * If the query provided contained parameters, parameter_schema contains the
1728
+ * schema of the expected parameters. It should be an IPC-encapsulated Schema, as described in Schema.fbs.
1729
+ */
1730
+ parameterSchema: Buffer;
1731
+ }
1732
+ /**
1733
+ * Request message for the "ClosePreparedStatement" action on a Flight SQL enabled backend.
1734
+ * Closes server resources associated with the prepared statement handle.
1735
+ */
1736
+ export interface ActionClosePreparedStatementRequest {
1737
+ /** Opaque handle for the prepared statement on the server. */
1738
+ preparedStatementHandle: Buffer;
1739
+ }
1740
+ /**
1741
+ * Request message for the "BeginTransaction" action.
1742
+ * Begins a transaction.
1743
+ */
1744
+ export interface ActionBeginTransactionRequest {
1745
+ }
1746
+ /**
1747
+ * Request message for the "BeginSavepoint" action.
1748
+ * Creates a savepoint within a transaction.
1749
+ *
1750
+ * Only supported if FLIGHT_SQL_SERVER_TRANSACTION returns
1751
+ * SQL_SUPPORTED_TRANSACTION_SAVEPOINT.
1752
+ */
1753
+ export interface ActionBeginSavepointRequest {
1754
+ /** The transaction to which a savepoint belongs. */
1755
+ transactionId: Buffer;
1756
+ /** Name for the savepoint. */
1757
+ name: string;
1758
+ }
1759
+ /**
1760
+ * The result of a "BeginTransaction" action.
1761
+ *
1762
+ * The transaction can be manipulated with the "EndTransaction" action, or
1763
+ * automatically via server timeout. If the transaction times out, then it is
1764
+ * automatically rolled back.
1765
+ *
1766
+ * The result should be wrapped in a google.protobuf.Any message.
1767
+ */
1768
+ export interface ActionBeginTransactionResult {
1769
+ /** Opaque handle for the transaction on the server. */
1770
+ transactionId: Buffer;
1771
+ }
1772
+ /**
1773
+ * The result of a "BeginSavepoint" action.
1774
+ *
1775
+ * The transaction can be manipulated with the "EndSavepoint" action.
1776
+ * If the associated transaction is committed, rolled back, or times
1777
+ * out, then the savepoint is also invalidated.
1778
+ *
1779
+ * The result should be wrapped in a google.protobuf.Any message.
1780
+ */
1781
+ export interface ActionBeginSavepointResult {
1782
+ /** Opaque handle for the savepoint on the server. */
1783
+ savepointId: Buffer;
1784
+ }
1785
+ /**
1786
+ * Request message for the "EndTransaction" action.
1787
+ *
1788
+ * Commit (COMMIT) or rollback (ROLLBACK) the transaction.
1789
+ *
1790
+ * If the action completes successfully, the transaction handle is
1791
+ * invalidated, as are all associated savepoints.
1792
+ */
1793
+ export interface ActionEndTransactionRequest {
1794
+ /** Opaque handle for the transaction on the server. */
1795
+ transactionId: Buffer;
1796
+ /** Whether to commit/rollback the given transaction. */
1797
+ action: ActionEndTransactionRequest_EndTransaction;
1798
+ }
1799
+ export declare const ActionEndTransactionRequest_EndTransaction: {
1800
+ readonly END_TRANSACTION_UNSPECIFIED: 0;
1801
+ /** END_TRANSACTION_COMMIT - Commit the transaction. */
1802
+ readonly END_TRANSACTION_COMMIT: 1;
1803
+ /** END_TRANSACTION_ROLLBACK - Roll back the transaction. */
1804
+ readonly END_TRANSACTION_ROLLBACK: 2;
1805
+ readonly UNRECOGNIZED: -1;
1806
+ };
1807
+ export type ActionEndTransactionRequest_EndTransaction = typeof ActionEndTransactionRequest_EndTransaction[keyof typeof ActionEndTransactionRequest_EndTransaction];
1808
+ export declare namespace ActionEndTransactionRequest_EndTransaction {
1809
+ type END_TRANSACTION_UNSPECIFIED = typeof ActionEndTransactionRequest_EndTransaction.END_TRANSACTION_UNSPECIFIED;
1810
+ type END_TRANSACTION_COMMIT = typeof ActionEndTransactionRequest_EndTransaction.END_TRANSACTION_COMMIT;
1811
+ type END_TRANSACTION_ROLLBACK = typeof ActionEndTransactionRequest_EndTransaction.END_TRANSACTION_ROLLBACK;
1812
+ type UNRECOGNIZED = typeof ActionEndTransactionRequest_EndTransaction.UNRECOGNIZED;
1813
+ }
1814
+ export declare function actionEndTransactionRequest_EndTransactionFromJSON(object: any): ActionEndTransactionRequest_EndTransaction;
1815
+ export declare function actionEndTransactionRequest_EndTransactionToJSON(object: ActionEndTransactionRequest_EndTransaction): string;
1816
+ /**
1817
+ * Request message for the "EndSavepoint" action.
1818
+ *
1819
+ * Release (RELEASE) the savepoint or rollback (ROLLBACK) to the
1820
+ * savepoint.
1821
+ *
1822
+ * Releasing a savepoint invalidates that savepoint. Rolling back to
1823
+ * a savepoint does not invalidate the savepoint, but invalidates all
1824
+ * savepoints created after the current savepoint.
1825
+ */
1826
+ export interface ActionEndSavepointRequest {
1827
+ /** Opaque handle for the savepoint on the server. */
1828
+ savepointId: Buffer;
1829
+ /** Whether to rollback/release the given savepoint. */
1830
+ action: ActionEndSavepointRequest_EndSavepoint;
1831
+ }
1832
+ export declare const ActionEndSavepointRequest_EndSavepoint: {
1833
+ readonly END_SAVEPOINT_UNSPECIFIED: 0;
1834
+ /** END_SAVEPOINT_RELEASE - Release the savepoint. */
1835
+ readonly END_SAVEPOINT_RELEASE: 1;
1836
+ /** END_SAVEPOINT_ROLLBACK - Roll back to a savepoint. */
1837
+ readonly END_SAVEPOINT_ROLLBACK: 2;
1838
+ readonly UNRECOGNIZED: -1;
1839
+ };
1840
+ export type ActionEndSavepointRequest_EndSavepoint = typeof ActionEndSavepointRequest_EndSavepoint[keyof typeof ActionEndSavepointRequest_EndSavepoint];
1841
+ export declare namespace ActionEndSavepointRequest_EndSavepoint {
1842
+ type END_SAVEPOINT_UNSPECIFIED = typeof ActionEndSavepointRequest_EndSavepoint.END_SAVEPOINT_UNSPECIFIED;
1843
+ type END_SAVEPOINT_RELEASE = typeof ActionEndSavepointRequest_EndSavepoint.END_SAVEPOINT_RELEASE;
1844
+ type END_SAVEPOINT_ROLLBACK = typeof ActionEndSavepointRequest_EndSavepoint.END_SAVEPOINT_ROLLBACK;
1845
+ type UNRECOGNIZED = typeof ActionEndSavepointRequest_EndSavepoint.UNRECOGNIZED;
1846
+ }
1847
+ export declare function actionEndSavepointRequest_EndSavepointFromJSON(object: any): ActionEndSavepointRequest_EndSavepoint;
1848
+ export declare function actionEndSavepointRequest_EndSavepointToJSON(object: ActionEndSavepointRequest_EndSavepoint): string;
1849
+ /**
1850
+ * Represents a SQL query. Used in the command member of FlightDescriptor
1851
+ * for the following RPC calls:
1852
+ * - GetSchema: return the Arrow schema of the query.
1853
+ * Fields on this schema may contain the following metadata:
1854
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
1855
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
1856
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
1857
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
1858
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
1859
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
1860
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
1861
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
1862
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
1863
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
1864
+ * - 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.
1865
+ * - GetFlightInfo: execute the query.
1866
+ */
1867
+ export interface CommandStatementQuery {
1868
+ /** The SQL syntax. */
1869
+ query: string;
1870
+ /** Include the query as part of this transaction (if unset, the query is auto-committed). */
1871
+ transactionId?: Buffer | undefined;
1872
+ }
1873
+ /**
1874
+ * Represents a Substrait plan. Used in the command member of FlightDescriptor
1875
+ * for the following RPC calls:
1876
+ * - GetSchema: return the Arrow schema of the query.
1877
+ * Fields on this schema may contain the following metadata:
1878
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
1879
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
1880
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
1881
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
1882
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
1883
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
1884
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
1885
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
1886
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
1887
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
1888
+ * - 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.
1889
+ * - GetFlightInfo: execute the query.
1890
+ * - DoPut: execute the query.
1891
+ */
1892
+ export interface CommandStatementSubstraitPlan {
1893
+ /** A serialized substrait.Plan */
1894
+ plan: SubstraitPlan | undefined;
1895
+ /** Include the query as part of this transaction (if unset, the query is auto-committed). */
1896
+ transactionId?: Buffer | undefined;
1897
+ }
1898
+ /**
1899
+ * Represents a ticket resulting from GetFlightInfo with a CommandStatementQuery.
1900
+ * This should be used only once and treated as an opaque value, that is, clients should not attempt to parse this.
1901
+ */
1902
+ export interface TicketStatementQuery {
1903
+ /** Unique identifier for the instance of the statement to execute. */
1904
+ statementHandle: Buffer;
1905
+ }
1906
+ /**
1907
+ * Represents an instance of executing a prepared statement. Used in the command member of FlightDescriptor for
1908
+ * the following RPC calls:
1909
+ * - GetSchema: return the Arrow schema of the query.
1910
+ * Fields on this schema may contain the following metadata:
1911
+ * - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
1912
+ * - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
1913
+ * - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
1914
+ * - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
1915
+ * - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
1916
+ * - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
1917
+ * - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
1918
+ * - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise.
1919
+ * - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
1920
+ * - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
1921
+ * - 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.
1922
+ *
1923
+ * If the schema is retrieved after parameter values have been bound with DoPut, then the server should account
1924
+ * for the parameters when determining the schema.
1925
+ * - DoPut: bind parameter values. All of the bound parameter sets will be executed as a single atomic execution.
1926
+ * - GetFlightInfo: execute the prepared statement instance.
1927
+ */
1928
+ export interface CommandPreparedStatementQuery {
1929
+ /** Opaque handle for the prepared statement on the server. */
1930
+ preparedStatementHandle: Buffer;
1931
+ }
1932
+ /**
1933
+ * Represents a SQL update query. Used in the command member of FlightDescriptor
1934
+ * for the RPC call DoPut to cause the server to execute the included SQL update.
1935
+ */
1936
+ export interface CommandStatementUpdate {
1937
+ /** The SQL syntax. */
1938
+ query: string;
1939
+ /** Include the query as part of this transaction (if unset, the query is auto-committed). */
1940
+ transactionId?: Buffer | undefined;
1941
+ }
1942
+ /**
1943
+ * Represents a SQL update query. Used in the command member of FlightDescriptor
1944
+ * for the RPC call DoPut to cause the server to execute the included
1945
+ * prepared statement handle as an update.
1946
+ */
1947
+ export interface CommandPreparedStatementUpdate {
1948
+ /** Opaque handle for the prepared statement on the server. */
1949
+ preparedStatementHandle: Buffer;
1950
+ }
1951
+ /**
1952
+ * Represents a bulk ingestion request. Used in the command member of FlightDescriptor
1953
+ * for the RPC call DoPut to cause the server load the contents of the stream's
1954
+ * FlightData into the target destination.
1955
+ */
1956
+ export interface CommandStatementIngest {
1957
+ /** The behavior for handling the table definition. */
1958
+ tableDefinitionOptions: CommandStatementIngest_TableDefinitionOptions | undefined;
1959
+ /** The table to load data into. */
1960
+ table: string;
1961
+ /** The db_schema of the destination table to load data into. If unset, a backend-specific default may be used. */
1962
+ schema?: string | undefined;
1963
+ /** The catalog of the destination table to load data into. If unset, a backend-specific default may be used. */
1964
+ catalog?: string | undefined;
1965
+ /**
1966
+ * Store ingested data in a temporary table.
1967
+ * 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.
1968
+ * The namespacing may make use of a backend-specific schema and/or catalog.
1969
+ * The server should return an error if an explicit choice of schema or catalog is incompatible with the server's namespacing decision.
1970
+ */
1971
+ temporary: boolean;
1972
+ /** Perform the ingestion as part of this transaction. If specified, results should not be committed in the event of an error/cancellation. */
1973
+ transactionId?: Buffer | undefined;
1974
+ /** Backend-specific options. */
1975
+ options: {
1976
+ [key: string]: string;
1977
+ };
1978
+ }
1979
+ /** Options for table definition behavior */
1980
+ export interface CommandStatementIngest_TableDefinitionOptions {
1981
+ ifNotExist: CommandStatementIngest_TableDefinitionOptions_TableNotExistOption;
1982
+ ifExists: CommandStatementIngest_TableDefinitionOptions_TableExistsOption;
1983
+ }
1984
+ /** The action to take if the target table does not exist */
1985
+ export declare const CommandStatementIngest_TableDefinitionOptions_TableNotExistOption: {
1986
+ /** TABLE_NOT_EXIST_OPTION_UNSPECIFIED - Do not use. Servers should error if this is specified by a client. */
1987
+ readonly TABLE_NOT_EXIST_OPTION_UNSPECIFIED: 0;
1988
+ /** TABLE_NOT_EXIST_OPTION_CREATE - Create the table if it does not exist */
1989
+ readonly TABLE_NOT_EXIST_OPTION_CREATE: 1;
1990
+ /** TABLE_NOT_EXIST_OPTION_FAIL - Fail if the table does not exist */
1991
+ readonly TABLE_NOT_EXIST_OPTION_FAIL: 2;
1992
+ readonly UNRECOGNIZED: -1;
1993
+ };
1994
+ export type CommandStatementIngest_TableDefinitionOptions_TableNotExistOption = typeof CommandStatementIngest_TableDefinitionOptions_TableNotExistOption[keyof typeof CommandStatementIngest_TableDefinitionOptions_TableNotExistOption];
1995
+ export declare namespace CommandStatementIngest_TableDefinitionOptions_TableNotExistOption {
1996
+ type TABLE_NOT_EXIST_OPTION_UNSPECIFIED = typeof CommandStatementIngest_TableDefinitionOptions_TableNotExistOption.TABLE_NOT_EXIST_OPTION_UNSPECIFIED;
1997
+ type TABLE_NOT_EXIST_OPTION_CREATE = typeof CommandStatementIngest_TableDefinitionOptions_TableNotExistOption.TABLE_NOT_EXIST_OPTION_CREATE;
1998
+ type TABLE_NOT_EXIST_OPTION_FAIL = typeof CommandStatementIngest_TableDefinitionOptions_TableNotExistOption.TABLE_NOT_EXIST_OPTION_FAIL;
1999
+ type UNRECOGNIZED = typeof CommandStatementIngest_TableDefinitionOptions_TableNotExistOption.UNRECOGNIZED;
2000
+ }
2001
+ export declare function commandStatementIngest_TableDefinitionOptions_TableNotExistOptionFromJSON(object: any): CommandStatementIngest_TableDefinitionOptions_TableNotExistOption;
2002
+ export declare function commandStatementIngest_TableDefinitionOptions_TableNotExistOptionToJSON(object: CommandStatementIngest_TableDefinitionOptions_TableNotExistOption): string;
2003
+ /** The action to take if the target table already exists */
2004
+ export declare const CommandStatementIngest_TableDefinitionOptions_TableExistsOption: {
2005
+ /** TABLE_EXISTS_OPTION_UNSPECIFIED - Do not use. Servers should error if this is specified by a client. */
2006
+ readonly TABLE_EXISTS_OPTION_UNSPECIFIED: 0;
2007
+ /** TABLE_EXISTS_OPTION_FAIL - Fail if the table already exists */
2008
+ readonly TABLE_EXISTS_OPTION_FAIL: 1;
2009
+ /** TABLE_EXISTS_OPTION_APPEND - Append to the table if it already exists */
2010
+ readonly TABLE_EXISTS_OPTION_APPEND: 2;
2011
+ /** TABLE_EXISTS_OPTION_REPLACE - Drop and recreate the table if it already exists */
2012
+ readonly TABLE_EXISTS_OPTION_REPLACE: 3;
2013
+ readonly UNRECOGNIZED: -1;
2014
+ };
2015
+ export type CommandStatementIngest_TableDefinitionOptions_TableExistsOption = typeof CommandStatementIngest_TableDefinitionOptions_TableExistsOption[keyof typeof CommandStatementIngest_TableDefinitionOptions_TableExistsOption];
2016
+ export declare namespace CommandStatementIngest_TableDefinitionOptions_TableExistsOption {
2017
+ type TABLE_EXISTS_OPTION_UNSPECIFIED = typeof CommandStatementIngest_TableDefinitionOptions_TableExistsOption.TABLE_EXISTS_OPTION_UNSPECIFIED;
2018
+ type TABLE_EXISTS_OPTION_FAIL = typeof CommandStatementIngest_TableDefinitionOptions_TableExistsOption.TABLE_EXISTS_OPTION_FAIL;
2019
+ type TABLE_EXISTS_OPTION_APPEND = typeof CommandStatementIngest_TableDefinitionOptions_TableExistsOption.TABLE_EXISTS_OPTION_APPEND;
2020
+ type TABLE_EXISTS_OPTION_REPLACE = typeof CommandStatementIngest_TableDefinitionOptions_TableExistsOption.TABLE_EXISTS_OPTION_REPLACE;
2021
+ type UNRECOGNIZED = typeof CommandStatementIngest_TableDefinitionOptions_TableExistsOption.UNRECOGNIZED;
2022
+ }
2023
+ export declare function commandStatementIngest_TableDefinitionOptions_TableExistsOptionFromJSON(object: any): CommandStatementIngest_TableDefinitionOptions_TableExistsOption;
2024
+ export declare function commandStatementIngest_TableDefinitionOptions_TableExistsOptionToJSON(object: CommandStatementIngest_TableDefinitionOptions_TableExistsOption): string;
2025
+ export interface CommandStatementIngest_OptionsEntry {
2026
+ key: string;
2027
+ value: string;
2028
+ }
2029
+ /**
2030
+ * Returned from the RPC call DoPut when a CommandStatementUpdate,
2031
+ * CommandPreparedStatementUpdate, or CommandStatementIngest was
2032
+ * in the request, containing results from the update.
2033
+ */
2034
+ export interface DoPutUpdateResult {
2035
+ /**
2036
+ * The number of records updated. A return value of -1 represents
2037
+ * an unknown updated record count.
2038
+ */
2039
+ recordCount: number;
2040
+ }
2041
+ /**
2042
+ * An *optional* response returned when `DoPut` is called with `CommandPreparedStatementQuery`.
2043
+ *
2044
+ * *Note on legacy behavior*: previous versions of the protocol did not return any result for
2045
+ * this command, and that behavior should still be supported by clients. In that case, the client
2046
+ * can continue as though the fields in this message were not provided or set to sensible default values.
2047
+ */
2048
+ export interface DoPutPreparedStatementResult {
2049
+ /**
2050
+ * Represents a (potentially updated) opaque handle for the prepared statement on the server.
2051
+ * Because the handle could potentially be updated, any previous handles for this prepared
2052
+ * statement should be considered invalid, and all subsequent requests for this prepared
2053
+ * statement must use this new handle.
2054
+ * The updated handle allows implementing query parameters with stateless services.
2055
+ *
2056
+ * When an updated handle is not provided by the server, clients should continue
2057
+ * using the previous handle provided by `ActionCreatePreparedStatementResult`.
2058
+ */
2059
+ preparedStatementHandle?: Buffer | undefined;
2060
+ }
2061
+ /**
2062
+ * Request message for the "CancelQuery" action.
2063
+ *
2064
+ * Explicitly cancel a running query.
2065
+ *
2066
+ * This lets a single client explicitly cancel work, no matter how many clients
2067
+ * are involved/whether the query is distributed or not, given server support.
2068
+ * The transaction/statement is not rolled back; it is the application's job to
2069
+ * commit or rollback as appropriate. This only indicates the client no longer
2070
+ * wishes to read the remainder of the query results or continue submitting
2071
+ * data.
2072
+ *
2073
+ * This command is idempotent.
2074
+ *
2075
+ * This command is deprecated since 13.0.0. Use the "CancelFlightInfo"
2076
+ * action with DoAction instead.
2077
+ *
2078
+ * @deprecated
2079
+ */
2080
+ export interface ActionCancelQueryRequest {
2081
+ /**
2082
+ * The result of the GetFlightInfo RPC that initiated the query.
2083
+ * XXX(ARROW-16902): this must be a serialized FlightInfo, but is
2084
+ * rendered as bytes because Protobuf does not really support one
2085
+ * DLL using Protobuf definitions from another DLL.
2086
+ */
2087
+ info: Buffer;
2088
+ }
2089
+ /**
2090
+ * The result of cancelling a query.
2091
+ *
2092
+ * The result should be wrapped in a google.protobuf.Any message.
2093
+ *
2094
+ * This command is deprecated since 13.0.0. Use the "CancelFlightInfo"
2095
+ * action with DoAction instead.
2096
+ *
2097
+ * @deprecated
2098
+ */
2099
+ export interface ActionCancelQueryResult {
2100
+ result: ActionCancelQueryResult_CancelResult;
2101
+ }
2102
+ export declare const ActionCancelQueryResult_CancelResult: {
2103
+ /**
2104
+ * CANCEL_RESULT_UNSPECIFIED - The cancellation status is unknown. Servers should avoid using
2105
+ * this value (send a NOT_FOUND error if the requested query is
2106
+ * not known). Clients can retry the request.
2107
+ */
2108
+ readonly CANCEL_RESULT_UNSPECIFIED: 0;
2109
+ /**
2110
+ * CANCEL_RESULT_CANCELLED - The cancellation request is complete. Subsequent requests with
2111
+ * the same payload may return CANCELLED or a NOT_FOUND error.
2112
+ */
2113
+ readonly CANCEL_RESULT_CANCELLED: 1;
2114
+ /**
2115
+ * CANCEL_RESULT_CANCELLING - The cancellation request is in progress. The client may retry
2116
+ * the cancellation request.
2117
+ */
2118
+ readonly CANCEL_RESULT_CANCELLING: 2;
2119
+ /**
2120
+ * CANCEL_RESULT_NOT_CANCELLABLE - The query is not cancellable. The client should not retry the
2121
+ * cancellation request.
2122
+ */
2123
+ readonly CANCEL_RESULT_NOT_CANCELLABLE: 3;
2124
+ readonly UNRECOGNIZED: -1;
2125
+ };
2126
+ export type ActionCancelQueryResult_CancelResult = typeof ActionCancelQueryResult_CancelResult[keyof typeof ActionCancelQueryResult_CancelResult];
2127
+ export declare namespace ActionCancelQueryResult_CancelResult {
2128
+ type CANCEL_RESULT_UNSPECIFIED = typeof ActionCancelQueryResult_CancelResult.CANCEL_RESULT_UNSPECIFIED;
2129
+ type CANCEL_RESULT_CANCELLED = typeof ActionCancelQueryResult_CancelResult.CANCEL_RESULT_CANCELLED;
2130
+ type CANCEL_RESULT_CANCELLING = typeof ActionCancelQueryResult_CancelResult.CANCEL_RESULT_CANCELLING;
2131
+ type CANCEL_RESULT_NOT_CANCELLABLE = typeof ActionCancelQueryResult_CancelResult.CANCEL_RESULT_NOT_CANCELLABLE;
2132
+ type UNRECOGNIZED = typeof ActionCancelQueryResult_CancelResult.UNRECOGNIZED;
2133
+ }
2134
+ export declare function actionCancelQueryResult_CancelResultFromJSON(object: any): ActionCancelQueryResult_CancelResult;
2135
+ export declare function actionCancelQueryResult_CancelResultToJSON(object: ActionCancelQueryResult_CancelResult): string;
2136
+ export declare const CommandGetSqlInfo: MessageFns<CommandGetSqlInfo>;
2137
+ export declare const CommandGetXdbcTypeInfo: MessageFns<CommandGetXdbcTypeInfo>;
2138
+ export declare const CommandGetCatalogs: MessageFns<CommandGetCatalogs>;
2139
+ export declare const CommandGetDbSchemas: MessageFns<CommandGetDbSchemas>;
2140
+ export declare const CommandGetTables: MessageFns<CommandGetTables>;
2141
+ export declare const CommandGetTableTypes: MessageFns<CommandGetTableTypes>;
2142
+ export declare const CommandGetPrimaryKeys: MessageFns<CommandGetPrimaryKeys>;
2143
+ export declare const CommandGetExportedKeys: MessageFns<CommandGetExportedKeys>;
2144
+ export declare const CommandGetImportedKeys: MessageFns<CommandGetImportedKeys>;
2145
+ export declare const CommandGetCrossReference: MessageFns<CommandGetCrossReference>;
2146
+ export declare const ActionCreatePreparedStatementRequest: MessageFns<ActionCreatePreparedStatementRequest>;
2147
+ export declare const SubstraitPlan: MessageFns<SubstraitPlan>;
2148
+ export declare const ActionCreatePreparedSubstraitPlanRequest: MessageFns<ActionCreatePreparedSubstraitPlanRequest>;
2149
+ export declare const ActionCreatePreparedStatementResult: MessageFns<ActionCreatePreparedStatementResult>;
2150
+ export declare const ActionClosePreparedStatementRequest: MessageFns<ActionClosePreparedStatementRequest>;
2151
+ export declare const ActionBeginTransactionRequest: MessageFns<ActionBeginTransactionRequest>;
2152
+ export declare const ActionBeginSavepointRequest: MessageFns<ActionBeginSavepointRequest>;
2153
+ export declare const ActionBeginTransactionResult: MessageFns<ActionBeginTransactionResult>;
2154
+ export declare const ActionBeginSavepointResult: MessageFns<ActionBeginSavepointResult>;
2155
+ export declare const ActionEndTransactionRequest: MessageFns<ActionEndTransactionRequest>;
2156
+ export declare const ActionEndSavepointRequest: MessageFns<ActionEndSavepointRequest>;
2157
+ export declare const CommandStatementQuery: MessageFns<CommandStatementQuery>;
2158
+ export declare const CommandStatementSubstraitPlan: MessageFns<CommandStatementSubstraitPlan>;
2159
+ export declare const TicketStatementQuery: MessageFns<TicketStatementQuery>;
2160
+ export declare const CommandPreparedStatementQuery: MessageFns<CommandPreparedStatementQuery>;
2161
+ export declare const CommandStatementUpdate: MessageFns<CommandStatementUpdate>;
2162
+ export declare const CommandPreparedStatementUpdate: MessageFns<CommandPreparedStatementUpdate>;
2163
+ export declare const CommandStatementIngest: MessageFns<CommandStatementIngest>;
2164
+ export declare const CommandStatementIngest_TableDefinitionOptions: MessageFns<CommandStatementIngest_TableDefinitionOptions>;
2165
+ export declare const CommandStatementIngest_OptionsEntry: MessageFns<CommandStatementIngest_OptionsEntry>;
2166
+ export declare const DoPutUpdateResult: MessageFns<DoPutUpdateResult>;
2167
+ export declare const DoPutPreparedStatementResult: MessageFns<DoPutPreparedStatementResult>;
2168
+ export declare const ActionCancelQueryRequest: MessageFns<ActionCancelQueryRequest>;
2169
+ export declare const ActionCancelQueryResult: MessageFns<ActionCancelQueryResult>;
2170
+ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
2171
+ export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
2172
+ [K in keyof T]?: DeepPartial<T[K]>;
2173
+ } : Partial<T>;
2174
+ export interface MessageFns<T> {
2175
+ encode(message: T, writer?: BinaryWriter): BinaryWriter;
2176
+ decode(input: BinaryReader | Uint8Array, length?: number): T;
2177
+ fromJSON(object: any): T;
2178
+ toJSON(message: T): unknown;
2179
+ create(base?: DeepPartial<T>): T;
2180
+ fromPartial(object: DeepPartial<T>): T;
2181
+ }
2182
+ export {};
2183
+ //# sourceMappingURL=FlightSql.d.ts.map