pyspiral 0.1.0__cp310-abi3-macosx_11_0_arm64.whl

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