-
Notifications
You must be signed in to change notification settings - Fork 849
/
Copy patharrow.flight.protocol.sql.rs
2284 lines (2283 loc) · 115 KB
/
arrow.flight.protocol.sql.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// This file was automatically generated through the build.rs script, and should not be edited.
///
/// Represents a metadata request. Used in the command member of FlightDescriptor
/// for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the metadata request.
///
/// The returned Arrow schema will be:
/// <
/// info_name: uint32 not null,
/// value: dense_union<
/// string_value: utf8,
/// bool_value: bool,
/// bigint_value: int64,
/// int32_bitmask: int32,
/// string_list: list<string_data: utf8>
/// int32_to_int32_list_map: map<key: int32, value: list<$data$: int32>>
/// >
/// where there is one row per requested piece of metadata information.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetSqlInfo {
///
/// Values are modelled after ODBC's SQLGetInfo() function. This information is intended to provide
/// Flight SQL clients with basic, SQL syntax and SQL functions related information.
/// More information types can be added in future releases.
/// E.g. more SQL syntax support types, scalar functions support, type conversion support etc.
///
/// Note that the set of metadata may expand.
///
/// Initially, Flight SQL will support the following information types:
/// - Server Information - Range [0-500)
/// - Syntax Information - Range [500-1000)
/// Range [0-10,000) is reserved for defaults (see SqlInfo enum for default options).
/// Custom options should start at 10,000.
///
/// If omitted, then all metadata will be retrieved.
/// Flight SQL Servers may choose to include additional metadata above and beyond the specified set, however they must
/// at least return the specified set. IDs ranging from 0 to 10,000 (exclusive) are reserved for future use.
/// If additional metadata is included, the metadata IDs should start from 10,000.
#[prost(uint32, repeated, tag = "1")]
pub info: ::prost::alloc::vec::Vec<u32>,
}
///
/// Represents a request to retrieve information about data type supported on a Flight SQL enabled backend.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned schema will be:
/// <
/// type_name: utf8 not null (The name of the data type, for example: VARCHAR, INTEGER, etc),
/// data_type: int not null (The SQL data type),
/// column_size: int (The maximum size supported by that column.
/// In case of exact numeric types, this represents the maximum precision.
/// In case of string types, this represents the character length.
/// In case of datetime data types, this represents the length in characters of the string representation.
/// NULL is returned for data types where column size is not applicable.),
/// literal_prefix: utf8 (Character or characters used to prefix a literal, NULL is returned for
/// data types where a literal prefix is not applicable.),
/// literal_suffix: utf8 (Character or characters used to terminate a literal,
/// NULL is returned for data types where a literal suffix is not applicable.),
/// create_params: list<utf8 not null>
/// (A list of keywords corresponding to which parameters can be used when creating
/// a column for that specific type.
/// NULL is returned if there are no parameters for the data type definition.),
/// nullable: int not null (Shows if the data type accepts a NULL value. The possible values can be seen in the
/// Nullable enum.),
/// case_sensitive: bool not null (Shows if a character data type is case-sensitive in collations and comparisons),
/// searchable: int not null (Shows how the data type is used in a WHERE clause. The possible values can be seen in the
/// Searchable enum.),
/// unsigned_attribute: bool (Shows if the data type is unsigned. NULL is returned if the attribute is
/// not applicable to the data type or the data type is not numeric.),
/// fixed_prec_scale: bool not null (Shows if the data type has predefined fixed precision and scale.),
/// auto_increment: bool (Shows if the data type is auto incremental. NULL is returned if the attribute
/// is not applicable to the data type or the data type is not numeric.),
/// local_type_name: utf8 (Localized version of the data source-dependent name of the data type. NULL
/// is returned if a localized name is not supported by the data source),
/// minimum_scale: int (The minimum scale of the data type on the data source.
/// If a data type has a fixed scale, the MINIMUM_SCALE and MAXIMUM_SCALE
/// columns both contain this value. NULL is returned if scale is not applicable.),
/// maximum_scale: int (The maximum scale of the data type on the data source.
/// NULL is returned if scale is not applicable.),
/// sql_data_type: int not null (The value of the SQL DATA TYPE which has the same values
/// as data_type value. Except for interval and datetime, which
/// uses generic values. More info about those types can be
/// obtained through datetime_subcode. The possible values can be seen
/// in the XdbcDataType enum.),
/// datetime_subcode: int (Only used when the SQL DATA TYPE is interval or datetime. It contains
/// its sub types. For type different from interval and datetime, this value
/// is NULL. The possible values can be seen in the XdbcDatetimeSubcode enum.),
/// num_prec_radix: int (If the data type is an approximate numeric type, this column contains
/// the value 2 to indicate that COLUMN_SIZE specifies a number of bits. For
/// exact numeric types, this column contains the value 10 to indicate that
/// column size specifies a number of decimal digits. Otherwise, this column is NULL.),
/// interval_precision: int (If the data type is an interval data type, then this column contains the value
/// of the interval leading precision. Otherwise, this column is NULL. This fields
/// is only relevant to be used by ODBC).
/// >
/// The returned data should be ordered by data_type and then by type_name.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetXdbcTypeInfo {
///
/// Specifies the data type to search for the info.
#[prost(int32, optional, tag = "1")]
pub data_type: ::core::option::Option<i32>,
}
///
/// Represents a request to retrieve the list of catalogs on a Flight SQL enabled backend.
/// The definition of a catalog depends on vendor/implementation. It is usually the database itself
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// catalog_name: utf8 not null
/// >
/// The returned data should be ordered by catalog_name.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetCatalogs {}
///
/// Represents a request to retrieve the list of database schemas on a Flight SQL enabled backend.
/// The definition of a database schema depends on vendor/implementation. It is usually a collection of tables.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// catalog_name: utf8,
/// db_schema_name: utf8 not null
/// >
/// The returned data should be ordered by catalog_name, then db_schema_name.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetDbSchemas {
///
/// Specifies the Catalog to search for the tables.
/// An empty string retrieves those without a catalog.
/// If omitted the catalog name should not be used to narrow the search.
#[prost(string, optional, tag = "1")]
pub catalog: ::core::option::Option<::prost::alloc::string::String>,
///
/// Specifies a filter pattern for schemas to search for.
/// When no db_schema_filter_pattern is provided, the pattern will not be used to narrow the search.
/// In the pattern string, two special characters can be used to denote matching rules:
/// - "%" means to match any substring with 0 or more characters.
/// - "_" means to match any one character.
#[prost(string, optional, tag = "2")]
pub db_schema_filter_pattern: ::core::option::Option<::prost::alloc::string::String>,
}
///
/// Represents a request to retrieve the list of tables, and optionally their schemas, on a Flight SQL enabled backend.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// catalog_name: utf8,
/// db_schema_name: utf8,
/// table_name: utf8 not null,
/// table_type: utf8 not null,
/// \[optional\] table_schema: bytes not null (schema of the table as described in Schema.fbs::Schema,
/// it is serialized as an IPC message.)
/// >
/// Fields on table_schema may contain the following metadata:
/// - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
/// - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
/// - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
/// - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
/// - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
/// - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
/// - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case sensitive, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
/// The returned data should be ordered by catalog_name, db_schema_name, table_name, then table_type, followed by table_schema if requested.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetTables {
///
/// Specifies the Catalog to search for the tables.
/// An empty string retrieves those without a catalog.
/// If omitted the catalog name should not be used to narrow the search.
#[prost(string, optional, tag = "1")]
pub catalog: ::core::option::Option<::prost::alloc::string::String>,
///
/// Specifies a filter pattern for schemas to search for.
/// When no db_schema_filter_pattern is provided, all schemas matching other filters are searched.
/// In the pattern string, two special characters can be used to denote matching rules:
/// - "%" means to match any substring with 0 or more characters.
/// - "_" means to match any one character.
#[prost(string, optional, tag = "2")]
pub db_schema_filter_pattern: ::core::option::Option<::prost::alloc::string::String>,
///
/// Specifies a filter pattern for tables to search for.
/// When no table_name_filter_pattern is provided, all tables matching other filters are searched.
/// In the pattern string, two special characters can be used to denote matching rules:
/// - "%" means to match any substring with 0 or more characters.
/// - "_" means to match any one character.
#[prost(string, optional, tag = "3")]
pub table_name_filter_pattern: ::core::option::Option<
::prost::alloc::string::String,
>,
///
/// Specifies a filter of table types which must match.
/// The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
/// TABLE, VIEW, and SYSTEM TABLE are commonly supported.
#[prost(string, repeated, tag = "4")]
pub table_types: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Specifies if the Arrow schema should be returned for found tables.
#[prost(bool, tag = "5")]
pub include_schema: bool,
}
///
/// Represents a request to retrieve the list of table types on a Flight SQL enabled backend.
/// The table types depend on vendor/implementation. It is usually used to separate tables from views or system tables.
/// TABLE, VIEW, and SYSTEM TABLE are commonly supported.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// table_type: utf8 not null
/// >
/// The returned data should be ordered by table_type.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetTableTypes {}
///
/// Represents a request to retrieve the primary keys of a table on a Flight SQL enabled backend.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// catalog_name: utf8,
/// db_schema_name: utf8,
/// table_name: utf8 not null,
/// column_name: utf8 not null,
/// key_name: utf8,
/// key_sequence: int not null
/// >
/// The returned data should be ordered by catalog_name, db_schema_name, table_name, key_name, then key_sequence.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetPrimaryKeys {
///
/// Specifies the catalog to search for the table.
/// An empty string retrieves those without a catalog.
/// If omitted the catalog name should not be used to narrow the search.
#[prost(string, optional, tag = "1")]
pub catalog: ::core::option::Option<::prost::alloc::string::String>,
///
/// Specifies the schema to search for the table.
/// An empty string retrieves those without a schema.
/// If omitted the schema name should not be used to narrow the search.
#[prost(string, optional, tag = "2")]
pub db_schema: ::core::option::Option<::prost::alloc::string::String>,
/// Specifies the table to get the primary keys for.
#[prost(string, tag = "3")]
pub table: ::prost::alloc::string::String,
}
///
/// Represents a request to retrieve a description of the foreign key columns that reference the given table's
/// primary key columns (the foreign keys exported by a table) of a table on a Flight SQL enabled backend.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// pk_catalog_name: utf8,
/// pk_db_schema_name: utf8,
/// pk_table_name: utf8 not null,
/// pk_column_name: utf8 not null,
/// fk_catalog_name: utf8,
/// fk_db_schema_name: utf8,
/// fk_table_name: utf8 not null,
/// fk_column_name: utf8 not null,
/// key_sequence: int not null,
/// fk_key_name: utf8,
/// pk_key_name: utf8,
/// update_rule: uint1 not null,
/// delete_rule: uint1 not null
/// >
/// The returned data should be ordered by fk_catalog_name, fk_db_schema_name, fk_table_name, fk_key_name, then key_sequence.
/// update_rule and delete_rule returns a byte that is equivalent to actions declared on UpdateDeleteRules enum.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetExportedKeys {
///
/// Specifies the catalog to search for the foreign key table.
/// An empty string retrieves those without a catalog.
/// If omitted the catalog name should not be used to narrow the search.
#[prost(string, optional, tag = "1")]
pub catalog: ::core::option::Option<::prost::alloc::string::String>,
///
/// Specifies the schema to search for the foreign key table.
/// An empty string retrieves those without a schema.
/// If omitted the schema name should not be used to narrow the search.
#[prost(string, optional, tag = "2")]
pub db_schema: ::core::option::Option<::prost::alloc::string::String>,
/// Specifies the foreign key table to get the foreign keys for.
#[prost(string, tag = "3")]
pub table: ::prost::alloc::string::String,
}
///
/// Represents a request to retrieve the foreign keys of a table on a Flight SQL enabled backend.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// pk_catalog_name: utf8,
/// pk_db_schema_name: utf8,
/// pk_table_name: utf8 not null,
/// pk_column_name: utf8 not null,
/// fk_catalog_name: utf8,
/// fk_db_schema_name: utf8,
/// fk_table_name: utf8 not null,
/// fk_column_name: utf8 not null,
/// key_sequence: int not null,
/// fk_key_name: utf8,
/// pk_key_name: utf8,
/// update_rule: uint1 not null,
/// delete_rule: uint1 not null
/// >
/// The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
/// update_rule and delete_rule returns a byte that is equivalent to actions:
/// - 0 = CASCADE
/// - 1 = RESTRICT
/// - 2 = SET NULL
/// - 3 = NO ACTION
/// - 4 = SET DEFAULT
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetImportedKeys {
///
/// Specifies the catalog to search for the primary key table.
/// An empty string retrieves those without a catalog.
/// If omitted the catalog name should not be used to narrow the search.
#[prost(string, optional, tag = "1")]
pub catalog: ::core::option::Option<::prost::alloc::string::String>,
///
/// Specifies the schema to search for the primary key table.
/// An empty string retrieves those without a schema.
/// If omitted the schema name should not be used to narrow the search.
#[prost(string, optional, tag = "2")]
pub db_schema: ::core::option::Option<::prost::alloc::string::String>,
/// Specifies the primary key table to get the foreign keys for.
#[prost(string, tag = "3")]
pub table: ::prost::alloc::string::String,
}
///
/// Represents a request to retrieve a description of the foreign key columns in the given foreign key table that
/// reference the primary key or the columns representing a unique constraint of the parent table (could be the same
/// or a different table) on a Flight SQL enabled backend.
/// Used in the command member of FlightDescriptor for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// - GetFlightInfo: execute the catalog metadata request.
///
/// The returned Arrow schema will be:
/// <
/// pk_catalog_name: utf8,
/// pk_db_schema_name: utf8,
/// pk_table_name: utf8 not null,
/// pk_column_name: utf8 not null,
/// fk_catalog_name: utf8,
/// fk_db_schema_name: utf8,
/// fk_table_name: utf8 not null,
/// fk_column_name: utf8 not null,
/// key_sequence: int not null,
/// fk_key_name: utf8,
/// pk_key_name: utf8,
/// update_rule: uint1 not null,
/// delete_rule: uint1 not null
/// >
/// The returned data should be ordered by pk_catalog_name, pk_db_schema_name, pk_table_name, pk_key_name, then key_sequence.
/// update_rule and delete_rule returns a byte that is equivalent to actions:
/// - 0 = CASCADE
/// - 1 = RESTRICT
/// - 2 = SET NULL
/// - 3 = NO ACTION
/// - 4 = SET DEFAULT
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandGetCrossReference {
/// *
/// The catalog name where the parent table is.
/// An empty string retrieves those without a catalog.
/// If omitted the catalog name should not be used to narrow the search.
#[prost(string, optional, tag = "1")]
pub pk_catalog: ::core::option::Option<::prost::alloc::string::String>,
/// *
/// The Schema name where the parent table is.
/// An empty string retrieves those without a schema.
/// If omitted the schema name should not be used to narrow the search.
#[prost(string, optional, tag = "2")]
pub pk_db_schema: ::core::option::Option<::prost::alloc::string::String>,
/// *
/// The parent table name. It cannot be null.
#[prost(string, tag = "3")]
pub pk_table: ::prost::alloc::string::String,
/// *
/// The catalog name where the foreign table is.
/// An empty string retrieves those without a catalog.
/// If omitted the catalog name should not be used to narrow the search.
#[prost(string, optional, tag = "4")]
pub fk_catalog: ::core::option::Option<::prost::alloc::string::String>,
/// *
/// The schema name where the foreign table is.
/// An empty string retrieves those without a schema.
/// If omitted the schema name should not be used to narrow the search.
#[prost(string, optional, tag = "5")]
pub fk_db_schema: ::core::option::Option<::prost::alloc::string::String>,
/// *
/// The foreign table name. It cannot be null.
#[prost(string, tag = "6")]
pub fk_table: ::prost::alloc::string::String,
}
///
/// Request message for the "CreatePreparedStatement" action on a Flight SQL enabled backend.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionCreatePreparedStatementRequest {
/// The valid SQL string to create a prepared statement for.
#[prost(string, tag = "1")]
pub query: ::prost::alloc::string::String,
}
///
/// Wrap the result of a "GetPreparedStatement" action.
///
/// The resultant PreparedStatement can be closed either:
/// - Manually, through the "ClosePreparedStatement" action;
/// - Automatically, by a server timeout.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionCreatePreparedStatementResult {
/// Opaque handle for the prepared statement on the server.
#[prost(bytes = "bytes", tag = "1")]
pub prepared_statement_handle: ::prost::bytes::Bytes,
/// If a result set generating query was provided, dataset_schema contains the
/// schema of the dataset as described in Schema.fbs::Schema, it is serialized as an IPC message.
#[prost(bytes = "bytes", tag = "2")]
pub dataset_schema: ::prost::bytes::Bytes,
/// If the query provided contained parameters, parameter_schema contains the
/// schema of the expected parameters as described in Schema.fbs::Schema, it is serialized as an IPC message.
#[prost(bytes = "bytes", tag = "3")]
pub parameter_schema: ::prost::bytes::Bytes,
}
///
/// Request message for the "ClosePreparedStatement" action on a Flight SQL enabled backend.
/// Closes server resources associated with the prepared statement handle.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionClosePreparedStatementRequest {
/// Opaque handle for the prepared statement on the server.
#[prost(bytes = "bytes", tag = "1")]
pub prepared_statement_handle: ::prost::bytes::Bytes,
}
///
/// Represents a SQL query. Used in the command member of FlightDescriptor
/// for the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// Fields on this schema may contain the following metadata:
/// - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
/// - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
/// - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
/// - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
/// - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
/// - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
/// - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case sensitive, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
/// - GetFlightInfo: execute the query.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandStatementQuery {
/// The SQL syntax.
#[prost(string, tag = "1")]
pub query: ::prost::alloc::string::String,
}
/// *
/// Represents a ticket resulting from GetFlightInfo with a CommandStatementQuery.
/// This should be used only once and treated as an opaque value, that is, clients should not attempt to parse this.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TicketStatementQuery {
/// Unique identifier for the instance of the statement to execute.
#[prost(bytes = "bytes", tag = "1")]
pub statement_handle: ::prost::bytes::Bytes,
}
///
/// Represents an instance of executing a prepared statement. Used in the command member of FlightDescriptor for
/// the following RPC calls:
/// - GetSchema: return the Arrow schema of the query.
/// Fields on this schema may contain the following metadata:
/// - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name
/// - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name
/// - ARROW:FLIGHT:SQL:TABLE_NAME - Table name
/// - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column.
/// - ARROW:FLIGHT:SQL:PRECISION - Column precision/size
/// - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable
/// - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case sensitive, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise.
/// - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise.
/// - DoPut: bind parameter values. All of the bound parameter sets will be executed as a single atomic execution.
/// - GetFlightInfo: execute the prepared statement instance.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandPreparedStatementQuery {
/// Opaque handle for the prepared statement on the server.
#[prost(bytes = "bytes", tag = "1")]
pub prepared_statement_handle: ::prost::bytes::Bytes,
}
///
/// Represents a SQL update query. Used in the command member of FlightDescriptor
/// for the the RPC call DoPut to cause the server to execute the included SQL update.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandStatementUpdate {
/// The SQL syntax.
#[prost(string, tag = "1")]
pub query: ::prost::alloc::string::String,
}
///
/// Represents a SQL update query. Used in the command member of FlightDescriptor
/// for the the RPC call DoPut to cause the server to execute the included
/// prepared statement handle as an update.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandPreparedStatementUpdate {
/// Opaque handle for the prepared statement on the server.
#[prost(bytes = "bytes", tag = "1")]
pub prepared_statement_handle: ::prost::bytes::Bytes,
}
///
/// Returned from the RPC call DoPut when a CommandStatementUpdate
/// CommandPreparedStatementUpdate was in the request, containing
/// results from the update.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DoPutUpdateResult {
/// The number of records updated. A return value of -1 represents
/// an unknown updated record count.
#[prost(int64, tag = "1")]
pub record_count: i64,
}
/// Options for CommandGetSqlInfo.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum SqlInfo {
/// Retrieves a UTF-8 string with the name of the Flight SQL Server.
FlightSqlServerName = 0,
/// Retrieves a UTF-8 string with the native version of the Flight SQL Server.
FlightSqlServerVersion = 1,
/// Retrieves a UTF-8 string with the Arrow format version of the Flight SQL Server.
FlightSqlServerArrowVersion = 2,
///
/// Retrieves a boolean value indicating whether the Flight SQL Server is read only.
///
/// Returns:
/// - false: if read-write
/// - true: if read only
FlightSqlServerReadOnly = 3,
///
/// Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of catalogs.
///
/// Returns:
/// - false: if it doesn't support CREATE and DROP of catalogs.
/// - true: if it supports CREATE and DROP of catalogs.
SqlDdlCatalog = 500,
///
/// Retrieves a boolean value indicating whether the Flight SQL Server supports CREATE and DROP of schemas.
///
/// Returns:
/// - false: if it doesn't support CREATE and DROP of schemas.
/// - true: if it supports CREATE and DROP of schemas.
SqlDdlSchema = 501,
///
/// Indicates whether the Flight SQL Server supports CREATE and DROP of tables.
///
/// Returns:
/// - false: if it doesn't support CREATE and DROP of tables.
/// - true: if it supports CREATE and DROP of tables.
SqlDdlTable = 502,
///
/// Retrieves a int32 ordinal representing the case sensitivity of catalog, table, schema and table names.
///
/// The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.
SqlIdentifierCase = 503,
/// Retrieves a UTF-8 string with the supported character(s) used to surround a delimited identifier.
SqlIdentifierQuoteChar = 504,
///
/// Retrieves a int32 describing the case sensitivity of quoted identifiers.
///
/// The possible values are listed in `arrow.flight.protocol.sql.SqlSupportedCaseSensitivity`.
SqlQuotedIdentifierCase = 505,
///
/// Retrieves a boolean value indicating whether all tables are selectable.
///
/// Returns:
/// - false: if not all tables are selectable or if none are;
/// - true: if all tables are selectable.
SqlAllTablesAreSelectable = 506,
///
/// Retrieves the null ordering.
///
/// Returns a int32 ordinal for the null ordering being used, as described in
/// `arrow.flight.protocol.sql.SqlNullOrdering`.
SqlNullOrdering = 507,
/// Retrieves a UTF-8 string list with values of the supported keywords.
SqlKeywords = 508,
/// Retrieves a UTF-8 string list with values of the supported numeric functions.
SqlNumericFunctions = 509,
/// Retrieves a UTF-8 string list with values of the supported string functions.
SqlStringFunctions = 510,
/// Retrieves a UTF-8 string list with values of the supported system functions.
SqlSystemFunctions = 511,
/// Retrieves a UTF-8 string list with values of the supported datetime functions.
SqlDatetimeFunctions = 512,
///
/// Retrieves the UTF-8 string that can be used to escape wildcard characters.
/// This is the string that can be used to escape '_' or '%' in the catalog search parameters that are a pattern
/// (and therefore use one of the wildcard characters).
/// The '_' character represents any single character; the '%' character represents any sequence of zero or more
/// characters.
SqlSearchStringEscape = 513,
///
/// Retrieves a UTF-8 string with all the "extra" characters that can be used in unquoted identifier names
/// (those beyond a-z, A-Z, 0-9 and _).
SqlExtraNameCharacters = 514,
///
/// Retrieves a boolean value indicating whether column aliasing is supported.
/// If so, the SQL AS clause can be used to provide names for computed columns or to provide alias names for columns
/// as required.
///
/// Returns:
/// - false: if column aliasing is unsupported;
/// - true: if column aliasing is supported.
SqlSupportsColumnAliasing = 515,
///
/// Retrieves a boolean value indicating whether concatenations between null and non-null values being
/// null are supported.
///
/// - Returns:
/// - false: if concatenations between null and non-null values being null are unsupported;
/// - true: if concatenations between null and non-null values being null are supported.
SqlNullPlusNullIsNull = 516,
///
/// Retrieves a map where the key is the type to convert from and the value is a list with the types to convert to,
/// indicating the supported conversions. Each key and each item on the list value is a value to a predefined type on
/// SqlSupportsConvert enum.
/// The returned map will be: map<int32, list<int32>>
SqlSupportsConvert = 517,
///
/// Retrieves a boolean value indicating whether, when table correlation names are supported,
/// they are restricted to being different from the names of the tables.
///
/// Returns:
/// - false: if table correlation names are unsupported;
/// - true: if table correlation names are supported.
SqlSupportsTableCorrelationNames = 518,
///
/// Retrieves a boolean value indicating whether, when table correlation names are supported,
/// they are restricted to being different from the names of the tables.
///
/// Returns:
/// - false: if different table correlation names are unsupported;
/// - true: if different table correlation names are supported
SqlSupportsDifferentTableCorrelationNames = 519,
///
/// Retrieves a boolean value indicating whether expressions in ORDER BY lists are supported.
///
/// Returns:
/// - false: if expressions in ORDER BY are unsupported;
/// - true: if expressions in ORDER BY are supported;
SqlSupportsExpressionsInOrderBy = 520,
///
/// Retrieves a boolean value indicating whether using a column that is not in the SELECT statement in a GROUP BY
/// clause is supported.
///
/// Returns:
/// - false: if using a column that is not in the SELECT statement in a GROUP BY clause is unsupported;
/// - true: if using a column that is not in the SELECT statement in a GROUP BY clause is supported.
SqlSupportsOrderByUnrelated = 521,
///
/// Retrieves the supported GROUP BY commands;
///
/// Returns an int32 bitmask value representing the supported commands.
/// The returned bitmask should be parsed in order to retrieve the supported commands.
///
/// For instance:
/// - return 0 (\b0) => [] (GROUP BY is unsupported);
/// - return 1 (\b1) => \[SQL_GROUP_BY_UNRELATED\];
/// - return 2 (\b10) => \[SQL_GROUP_BY_BEYOND_SELECT\];
/// - return 3 (\b11) => [SQL_GROUP_BY_UNRELATED, SQL_GROUP_BY_BEYOND_SELECT].
/// Valid GROUP BY types are described under `arrow.flight.protocol.sql.SqlSupportedGroupBy`.
SqlSupportedGroupBy = 522,
///
/// Retrieves a boolean value indicating whether specifying a LIKE escape clause is supported.
///
/// Returns:
/// - false: if specifying a LIKE escape clause is unsupported;
/// - true: if specifying a LIKE escape clause is supported.
SqlSupportsLikeEscapeClause = 523,
///
/// Retrieves a boolean value indicating whether columns may be defined as non-nullable.
///
/// Returns:
/// - false: if columns cannot be defined as non-nullable;
/// - true: if columns may be defined as non-nullable.
SqlSupportsNonNullableColumns = 524,
///
/// Retrieves the supported SQL grammar level as per the ODBC specification.
///
/// Returns an int32 bitmask value representing the supported SQL grammar level.
/// The returned bitmask should be parsed in order to retrieve the supported grammar levels.
///
/// For instance:
/// - return 0 (\b0) => [] (SQL grammar is unsupported);
/// - return 1 (\b1) => \[SQL_MINIMUM_GRAMMAR\];
/// - return 2 (\b10) => \[SQL_CORE_GRAMMAR\];
/// - return 3 (\b11) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR];
/// - return 4 (\b100) => \[SQL_EXTENDED_GRAMMAR\];
/// - return 5 (\b101) => [SQL_MINIMUM_GRAMMAR, SQL_EXTENDED_GRAMMAR];
/// - return 6 (\b110) => [SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR];
/// - return 7 (\b111) => [SQL_MINIMUM_GRAMMAR, SQL_CORE_GRAMMAR, SQL_EXTENDED_GRAMMAR].
/// Valid SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedSqlGrammar`.
SqlSupportedGrammar = 525,
///
/// Retrieves the supported ANSI92 SQL grammar level.
///
/// Returns an int32 bitmask value representing the supported ANSI92 SQL grammar level.
/// The returned bitmask should be parsed in order to retrieve the supported commands.
///
/// For instance:
/// - return 0 (\b0) => [] (ANSI92 SQL grammar is unsupported);
/// - return 1 (\b1) => \[ANSI92_ENTRY_SQL\];
/// - return 2 (\b10) => \[ANSI92_INTERMEDIATE_SQL\];
/// - return 3 (\b11) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL];
/// - return 4 (\b100) => \[ANSI92_FULL_SQL\];
/// - return 5 (\b101) => [ANSI92_ENTRY_SQL, ANSI92_FULL_SQL];
/// - return 6 (\b110) => [ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL];
/// - return 7 (\b111) => [ANSI92_ENTRY_SQL, ANSI92_INTERMEDIATE_SQL, ANSI92_FULL_SQL].
/// Valid ANSI92 SQL grammar levels are described under `arrow.flight.protocol.sql.SupportedAnsi92SqlGrammarLevel`.
SqlAnsi92SupportedLevel = 526,
///
/// Retrieves a boolean value indicating whether the SQL Integrity Enhancement Facility is supported.
///
/// Returns:
/// - false: if the SQL Integrity Enhancement Facility is supported;
/// - true: if the SQL Integrity Enhancement Facility is supported.
SqlSupportsIntegrityEnhancementFacility = 527,
///
/// Retrieves the support level for SQL OUTER JOINs.
///
/// Returns a int32 ordinal for the SQL ordering being used, as described in
/// `arrow.flight.protocol.sql.SqlOuterJoinsSupportLevel`.
SqlOuterJoinsSupportLevel = 528,
/// Retrieves a UTF-8 string with the preferred term for "schema".
SqlSchemaTerm = 529,
/// Retrieves a UTF-8 string with the preferred term for "procedure".
SqlProcedureTerm = 530,
///
/// Retrieves a UTF-8 string with the preferred term for "catalog".
/// If a empty string is returned its assumed that the server does NOT supports catalogs.
SqlCatalogTerm = 531,
///
/// Retrieves a boolean value indicating whether a catalog appears at the start of a fully qualified table name.
///
/// - false: if a catalog does not appear at the start of a fully qualified table name;
/// - true: if a catalog appears at the start of a fully qualified table name.
SqlCatalogAtStart = 532,
///
/// Retrieves the supported actions for a SQL schema.
///
/// Returns an int32 bitmask value representing the supported actions for a SQL schema.
/// The returned bitmask should be parsed in order to retrieve the supported actions for a SQL schema.
///
/// For instance:
/// - return 0 (\b0) => [] (no supported actions for SQL schema);
/// - return 1 (\b1) => \[SQL_ELEMENT_IN_PROCEDURE_CALLS\];
/// - return 2 (\b10) => \[SQL_ELEMENT_IN_INDEX_DEFINITIONS\];
/// - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
/// - return 4 (\b100) => \[SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS\];
/// - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
/// - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
/// - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].
/// Valid actions for a SQL schema described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.
SqlSchemasSupportedActions = 533,
///
/// Retrieves the supported actions for a SQL schema.
///
/// Returns an int32 bitmask value representing the supported actions for a SQL catalog.
/// The returned bitmask should be parsed in order to retrieve the supported actions for a SQL catalog.
///
/// For instance:
/// - return 0 (\b0) => [] (no supported actions for SQL catalog);
/// - return 1 (\b1) => \[SQL_ELEMENT_IN_PROCEDURE_CALLS\];
/// - return 2 (\b10) => \[SQL_ELEMENT_IN_INDEX_DEFINITIONS\];
/// - return 3 (\b11) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS];
/// - return 4 (\b100) => \[SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS\];
/// - return 5 (\b101) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
/// - return 6 (\b110) => [SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS];
/// - return 7 (\b111) => [SQL_ELEMENT_IN_PROCEDURE_CALLS, SQL_ELEMENT_IN_INDEX_DEFINITIONS, SQL_ELEMENT_IN_PRIVILEGE_DEFINITIONS].
/// Valid actions for a SQL catalog are described under `arrow.flight.protocol.sql.SqlSupportedElementActions`.
SqlCatalogsSupportedActions = 534,
///
/// Retrieves the supported SQL positioned commands.
///
/// Returns an int32 bitmask value representing the supported SQL positioned commands.
/// The returned bitmask should be parsed in order to retrieve the supported SQL positioned commands.
///
/// For instance:
/// - return 0 (\b0) => [] (no supported SQL positioned commands);
/// - return 1 (\b1) => \[SQL_POSITIONED_DELETE\];
/// - return 2 (\b10) => \[SQL_POSITIONED_UPDATE\];
/// - return 3 (\b11) => [SQL_POSITIONED_DELETE, SQL_POSITIONED_UPDATE].
/// Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlSupportedPositionedCommands`.
SqlSupportedPositionedCommands = 535,
///
/// Retrieves a boolean value indicating whether SELECT FOR UPDATE statements are supported.
///
/// Returns:
/// - false: if SELECT FOR UPDATE statements are unsupported;
/// - true: if SELECT FOR UPDATE statements are supported.
SqlSelectForUpdateSupported = 536,
///
/// Retrieves a boolean value indicating whether stored procedure calls that use the stored procedure escape syntax
/// are supported.
///
/// Returns:
/// - false: if stored procedure calls that use the stored procedure escape syntax are unsupported;
/// - true: if stored procedure calls that use the stored procedure escape syntax are supported.
SqlStoredProceduresSupported = 537,
///
/// Retrieves the supported SQL subqueries.
///
/// Returns an int32 bitmask value representing the supported SQL subqueries.
/// The returned bitmask should be parsed in order to retrieve the supported SQL subqueries.
///
/// For instance:
/// - return 0 (\b0) => [] (no supported SQL subqueries);
/// - return 1 (\b1) => \[SQL_SUBQUERIES_IN_COMPARISONS\];
/// - return 2 (\b10) => \[SQL_SUBQUERIES_IN_EXISTS\];
/// - return 3 (\b11) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS];
/// - return 4 (\b100) => \[SQL_SUBQUERIES_IN_INS\];
/// - return 5 (\b101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS];
/// - return 6 (\b110) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_EXISTS];
/// - return 7 (\b111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS];
/// - return 8 (\b1000) => \[SQL_SUBQUERIES_IN_QUANTIFIEDS\];
/// - return 9 (\b1001) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
/// - return 10 (\b1010) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
/// - return 11 (\b1011) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
/// - return 12 (\b1100) => [SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
/// - return 13 (\b1101) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
/// - return 14 (\b1110) => [SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
/// - return 15 (\b1111) => [SQL_SUBQUERIES_IN_COMPARISONS, SQL_SUBQUERIES_IN_EXISTS, SQL_SUBQUERIES_IN_INS, SQL_SUBQUERIES_IN_QUANTIFIEDS];
/// - ...
/// Valid SQL subqueries are described under `arrow.flight.protocol.sql.SqlSupportedSubqueries`.
SqlSupportedSubqueries = 538,
///
/// Retrieves a boolean value indicating whether correlated subqueries are supported.
///
/// Returns:
/// - false: if correlated subqueries are unsupported;
/// - true: if correlated subqueries are supported.
SqlCorrelatedSubqueriesSupported = 539,
///
/// Retrieves the supported SQL UNIONs.
///
/// Returns an int32 bitmask value representing the supported SQL UNIONs.
/// The returned bitmask should be parsed in order to retrieve the supported SQL UNIONs.
///
/// For instance:
/// - return 0 (\b0) => [] (no supported SQL positioned commands);
/// - return 1 (\b1) => \[SQL_UNION\];
/// - return 2 (\b10) => \[SQL_UNION_ALL\];
/// - return 3 (\b11) => [SQL_UNION, SQL_UNION_ALL].
/// Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlSupportedUnions`.
SqlSupportedUnions = 540,
/// Retrieves a int64 value representing the maximum number of hex characters allowed in an inline binary literal.
SqlMaxBinaryLiteralLength = 541,
/// Retrieves a int64 value representing the maximum number of characters allowed for a character literal.
SqlMaxCharLiteralLength = 542,
/// Retrieves a int64 value representing the maximum number of characters allowed for a column name.
SqlMaxColumnNameLength = 543,
/// Retrieves a int64 value representing the the maximum number of columns allowed in a GROUP BY clause.
SqlMaxColumnsInGroupBy = 544,
/// Retrieves a int64 value representing the maximum number of columns allowed in an index.
SqlMaxColumnsInIndex = 545,
/// Retrieves a int64 value representing the maximum number of columns allowed in an ORDER BY clause.
SqlMaxColumnsInOrderBy = 546,
/// Retrieves a int64 value representing the maximum number of columns allowed in a SELECT list.
SqlMaxColumnsInSelect = 547,
/// Retrieves a int64 value representing the maximum number of columns allowed in a table.
SqlMaxColumnsInTable = 548,
/// Retrieves a int64 value representing the maximum number of concurrent connections possible.
SqlMaxConnections = 549,
/// Retrieves a int64 value the maximum number of characters allowed in a cursor name.
SqlMaxCursorNameLength = 550,
///
/// Retrieves a int64 value representing the maximum number of bytes allowed for an index,
/// including all of the parts of the index.
SqlMaxIndexLength = 551,
/// Retrieves a int64 value representing the maximum number of characters allowed in a schema name.
SqlDbSchemaNameLength = 552,
/// Retrieves a int64 value representing the maximum number of characters allowed in a procedure name.
SqlMaxProcedureNameLength = 553,
/// Retrieves a int64 value representing the maximum number of characters allowed in a catalog name.
SqlMaxCatalogNameLength = 554,
/// Retrieves a int64 value representing the maximum number of bytes allowed in a single row.
SqlMaxRowSize = 555,
///
/// Retrieves a boolean indicating whether the return value for the JDBC method getMaxRowSize includes the SQL
/// data types LONGVARCHAR and LONGVARBINARY.
///
/// Returns:
/// - false: if return value for the JDBC method getMaxRowSize does
/// not include the SQL data types LONGVARCHAR and LONGVARBINARY;
/// - true: if return value for the JDBC method getMaxRowSize includes
/// the SQL data types LONGVARCHAR and LONGVARBINARY.
SqlMaxRowSizeIncludesBlobs = 556,
///
/// Retrieves a int64 value representing the maximum number of characters allowed for an SQL statement;
/// a result of 0 (zero) means that there is no limit or the limit is not known.
SqlMaxStatementLength = 557,
/// Retrieves a int64 value representing the maximum number of active statements that can be open at the same time.
SqlMaxStatements = 558,
/// Retrieves a int64 value representing the maximum number of characters allowed in a table name.
SqlMaxTableNameLength = 559,
/// Retrieves a int64 value representing the maximum number of tables allowed in a SELECT statement.
SqlMaxTablesInSelect = 560,
/// Retrieves a int64 value representing the maximum number of characters allowed in a user name.
SqlMaxUsernameLength = 561,
///
/// Retrieves this database's default transaction isolation level as described in
/// `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.
///
/// Returns a int32 ordinal for the SQL transaction isolation level.
SqlDefaultTransactionIsolation = 562,
///
/// Retrieves a boolean value indicating whether transactions are supported. If not, invoking the method commit is a
/// noop, and the isolation level is `arrow.flight.protocol.sql.SqlTransactionIsolationLevel.TRANSACTION_NONE`.
///
/// Returns:
/// - false: if transactions are unsupported;
/// - true: if transactions are supported.
SqlTransactionsSupported = 563,
///
/// Retrieves the supported transactions isolation levels.
///
/// Returns an int32 bitmask value representing the supported transactions isolation levels.
/// The returned bitmask should be parsed in order to retrieve the supported transactions isolation levels.
///
/// For instance:
/// - return 0 (\b0) => [] (no supported SQL transactions isolation levels);
/// - return 1 (\b1) => \[SQL_TRANSACTION_NONE\];
/// - return 2 (\b10) => \[SQL_TRANSACTION_READ_UNCOMMITTED\];
/// - return 3 (\b11) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED];
/// - return 4 (\b100) => \[SQL_TRANSACTION_REPEATABLE_READ\];
/// - return 5 (\b101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 6 (\b110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 7 (\b111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 8 (\b1000) => \[SQL_TRANSACTION_REPEATABLE_READ\];
/// - return 9 (\b1001) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 10 (\b1010) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 11 (\b1011) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 12 (\b1100) => [SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 13 (\b1101) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 14 (\b1110) => [SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 15 (\b1111) => [SQL_TRANSACTION_NONE, SQL_TRANSACTION_READ_UNCOMMITTED, SQL_TRANSACTION_REPEATABLE_READ, SQL_TRANSACTION_REPEATABLE_READ];
/// - return 16 (\b10000) => \[SQL_TRANSACTION_SERIALIZABLE\];
/// - ...
/// Valid SQL positioned commands are described under `arrow.flight.protocol.sql.SqlTransactionIsolationLevel`.
SqlSupportedTransactionsIsolationLevels = 564,
///
/// Retrieves a boolean value indicating whether a data definition statement within a transaction forces
/// the transaction to commit.
///
/// Returns:
/// - false: if a data definition statement within a transaction does not force the transaction to commit;
/// - true: if a data definition statement within a transaction forces the transaction to commit.
SqlDataDefinitionCausesTransactionCommit = 565,
///
/// Retrieves a boolean value indicating whether a data definition statement within a transaction is ignored.
///
/// Returns: