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