-
Notifications
You must be signed in to change notification settings - Fork 892
/
Copy patharrow.flight.protocol.sql.rs
2760 lines (2759 loc) · 136 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.
// This file is @generated by prost-build.
///
/// 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: int32 not null (The SQL data type),
/// column_size: int32 (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: int32 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: int32 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: int32 (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: int32 (The maximum scale of the data type on the data source.
/// NULL is returned if scale is not applicable.),
/// sql_data_type: int32 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: int32 (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: int32 (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: int32 (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: int32 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: int32 not null,
/// fk_key_name: utf8,
/// pk_key_name: utf8,
/// update_rule: uint8 not null,
/// delete_rule: uint8 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: int32 not null,
/// fk_key_name: utf8,
/// pk_key_name: utf8,
/// update_rule: uint8 not null,
/// delete_rule: uint8 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: int32 not null,
/// fk_key_name: utf8,
/// pk_key_name: utf8,
/// update_rule: uint8 not null,
/// delete_rule: uint8 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,
/// Create/execute the prepared statement as part of this transaction (if
/// unset, executions of the prepared statement will be auto-committed).
#[prost(bytes = "bytes", optional, tag = "2")]
pub transaction_id: ::core::option::Option<::prost::bytes::Bytes>,
}
///
/// An embedded message describing a Substrait plan to execute.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SubstraitPlan {
/// The serialized substrait.Plan to create a prepared statement for.
/// XXX(ARROW-16902): this is bytes instead of an embedded message
/// because Protobuf does not really support one DLL using Protobuf
/// definitions from another DLL.
#[prost(bytes = "bytes", tag = "1")]
pub plan: ::prost::bytes::Bytes,
/// The Substrait release, e.g. "0.12.0". This information is not
/// tracked in the plan itself, so this is the only way for consumers
/// to potentially know if they can handle the plan.
#[prost(string, tag = "2")]
pub version: ::prost::alloc::string::String,
}
///
/// Request message for the "CreatePreparedSubstraitPlan" action on a Flight SQL enabled backend.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionCreatePreparedSubstraitPlanRequest {
/// The serialized substrait.Plan to create a prepared statement for.
#[prost(message, optional, tag = "1")]
pub plan: ::core::option::Option<SubstraitPlan>,
/// Create/execute the prepared statement as part of this transaction (if
/// unset, executions of the prepared statement will be auto-committed).
#[prost(bytes = "bytes", optional, tag = "2")]
pub transaction_id: ::core::option::Option<::prost::bytes::Bytes>,
}
///
/// Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.
///
/// The resultant PreparedStatement can be closed either:
/// - Manually, through the "ClosePreparedStatement" action;
/// - Automatically, by a server timeout.
///
/// The result should be wrapped in a google.protobuf.Any message.
#[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 result set. It should be an IPC-encapsulated Schema, as described in Schema.fbs.
/// For some queries, the schema of the results may depend on the schema of the parameters. The server
/// should provide its best guess as to the schema at this point. Clients must not assume that this
/// schema, if provided, will be accurate.
#[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. It should be an IPC-encapsulated Schema, as described in Schema.fbs.
#[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,
}
///
/// Request message for the "BeginTransaction" action.
/// Begins a transaction.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionBeginTransactionRequest {}
///
/// Request message for the "BeginSavepoint" action.
/// Creates a savepoint within a transaction.
///
/// Only supported if FLIGHT_SQL_TRANSACTION is
/// FLIGHT_SQL_TRANSACTION_SUPPORT_SAVEPOINT.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionBeginSavepointRequest {
/// The transaction to which a savepoint belongs.
#[prost(bytes = "bytes", tag = "1")]
pub transaction_id: ::prost::bytes::Bytes,
/// Name for the savepoint.
#[prost(string, tag = "2")]
pub name: ::prost::alloc::string::String,
}
///
/// The result of a "BeginTransaction" action.
///
/// The transaction can be manipulated with the "EndTransaction" action, or
/// automatically via server timeout. If the transaction times out, then it is
/// automatically rolled back.
///
/// The result should be wrapped in a google.protobuf.Any message.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionBeginTransactionResult {
/// Opaque handle for the transaction on the server.
#[prost(bytes = "bytes", tag = "1")]
pub transaction_id: ::prost::bytes::Bytes,
}
///
/// The result of a "BeginSavepoint" action.
///
/// The transaction can be manipulated with the "EndSavepoint" action.
/// If the associated transaction is committed, rolled back, or times
/// out, then the savepoint is also invalidated.
///
/// The result should be wrapped in a google.protobuf.Any message.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionBeginSavepointResult {
/// Opaque handle for the savepoint on the server.
#[prost(bytes = "bytes", tag = "1")]
pub savepoint_id: ::prost::bytes::Bytes,
}
///
/// Request message for the "EndTransaction" action.
///
/// Commit (COMMIT) or rollback (ROLLBACK) the transaction.
///
/// If the action completes successfully, the transaction handle is
/// invalidated, as are all associated savepoints.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionEndTransactionRequest {
/// Opaque handle for the transaction on the server.
#[prost(bytes = "bytes", tag = "1")]
pub transaction_id: ::prost::bytes::Bytes,
/// Whether to commit/rollback the given transaction.
#[prost(enumeration = "action_end_transaction_request::EndTransaction", tag = "2")]
pub action: i32,
}
/// Nested message and enum types in `ActionEndTransactionRequest`.
pub mod action_end_transaction_request {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum EndTransaction {
Unspecified = 0,
/// Commit the transaction.
Commit = 1,
/// Roll back the transaction.
Rollback = 2,
}
impl EndTransaction {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
EndTransaction::Unspecified => "END_TRANSACTION_UNSPECIFIED",
EndTransaction::Commit => "END_TRANSACTION_COMMIT",
EndTransaction::Rollback => "END_TRANSACTION_ROLLBACK",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"END_TRANSACTION_UNSPECIFIED" => Some(Self::Unspecified),
"END_TRANSACTION_COMMIT" => Some(Self::Commit),
"END_TRANSACTION_ROLLBACK" => Some(Self::Rollback),
_ => None,
}
}
}
}
///
/// Request message for the "EndSavepoint" action.
///
/// Release (RELEASE) the savepoint or rollback (ROLLBACK) to the
/// savepoint.
///
/// Releasing a savepoint invalidates that savepoint. Rolling back to
/// a savepoint does not invalidate the savepoint, but invalidates all
/// savepoints created after the current savepoint.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionEndSavepointRequest {
/// Opaque handle for the savepoint on the server.
#[prost(bytes = "bytes", tag = "1")]
pub savepoint_id: ::prost::bytes::Bytes,
/// Whether to rollback/release the given savepoint.
#[prost(enumeration = "action_end_savepoint_request::EndSavepoint", tag = "2")]
pub action: i32,
}
/// Nested message and enum types in `ActionEndSavepointRequest`.
pub mod action_end_savepoint_request {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum EndSavepoint {
Unspecified = 0,
/// Release the savepoint.
Release = 1,
/// Roll back to a savepoint.
Rollback = 2,
}
impl EndSavepoint {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
EndSavepoint::Unspecified => "END_SAVEPOINT_UNSPECIFIED",
EndSavepoint::Release => "END_SAVEPOINT_RELEASE",
EndSavepoint::Rollback => "END_SAVEPOINT_ROLLBACK",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"END_SAVEPOINT_UNSPECIFIED" => Some(Self::Unspecified),
"END_SAVEPOINT_RELEASE" => Some(Self::Release),
"END_SAVEPOINT_ROLLBACK" => Some(Self::Rollback),
_ => None,
}
}
}
}
///
/// 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,
/// Include the query as part of this transaction (if unset, the query is auto-committed).
#[prost(bytes = "bytes", optional, tag = "2")]
pub transaction_id: ::core::option::Option<::prost::bytes::Bytes>,
}
///
/// Represents a Substrait plan. 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.
/// - DoPut: execute the query.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandStatementSubstraitPlan {
/// A serialized substrait.Plan
#[prost(message, optional, tag = "1")]
pub plan: ::core::option::Option<SubstraitPlan>,
/// Include the query as part of this transaction (if unset, the query is auto-committed).
#[prost(bytes = "bytes", optional, tag = "2")]
pub transaction_id: ::core::option::Option<::prost::bytes::Bytes>,
}
/// *
/// 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.
///
/// If the schema is retrieved after parameter values have been bound with DoPut, then the server should account
/// for the parameters when determining the schema.
/// - 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 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,
/// Include the query as part of this transaction (if unset, the query is auto-committed).
#[prost(bytes = "bytes", optional, tag = "2")]
pub transaction_id: ::core::option::Option<::prost::bytes::Bytes>,
}
///
/// Represents a SQL update query. Used in the command member of FlightDescriptor
/// for 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,
}
/// An *optional* response returned when `DoPut` is called with `CommandPreparedStatementQuery`.
///
/// *Note on legacy behavior*: previous versions of the protocol did not return any result for
/// this command, and that behavior should still be supported by clients. In that case, the client
/// can continue as though the fields in this message were not provided or set to sensible default values.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DoPutPreparedStatementResult {
/// Represents a (potentially updated) opaque handle for the prepared statement on the server.
/// Because the handle could potentially be updated, any previous handles for this prepared
/// statement should be considered invalid, and all subsequent requests for this prepared
/// statement must use this new handle.
/// The updated handle allows implementing query parameters with stateless services.
///
/// When an updated handle is not provided by the server, clients should contiue
/// using the previous handle provided by `ActionCreatePreparedStatementResonse`.
#[prost(bytes = "bytes", optional, tag = "1")]
pub prepared_statement_handle: ::core::option::Option<::prost::bytes::Bytes>,
}
///
/// Request message for the "CancelQuery" action.
///
/// Explicitly cancel a running query.
///
/// This lets a single client explicitly cancel work, no matter how many clients
/// are involved/whether the query is distributed or not, given server support.
/// The transaction/statement is not rolled back; it is the application's job to
/// commit or rollback as appropriate. This only indicates the client no longer
/// wishes to read the remainder of the query results or continue submitting
/// data.
///
/// This command is idempotent.
///
/// This command is deprecated since 13.0.0. Use the "CancelFlightInfo"
/// action with DoAction instead.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionCancelQueryRequest {
/// The result of the GetFlightInfo RPC that initiated the query.
/// XXX(ARROW-16902): this must be a serialized FlightInfo, but is
/// rendered as bytes because Protobuf does not really support one
/// DLL using Protobuf definitions from another DLL.
#[prost(bytes = "bytes", tag = "1")]
pub info: ::prost::bytes::Bytes,
}
///
/// The result of cancelling a query.
///
/// The result should be wrapped in a google.protobuf.Any message.
///
/// This command is deprecated since 13.0.0. Use the "CancelFlightInfo"
/// action with DoAction instead.
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionCancelQueryResult {
#[prost(enumeration = "action_cancel_query_result::CancelResult", tag = "1")]
pub result: i32,
}
/// Nested message and enum types in `ActionCancelQueryResult`.
pub mod action_cancel_query_result {
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum CancelResult {
/// The cancellation status is unknown. Servers should avoid using
/// this value (send a NOT_FOUND error if the requested query is
/// not known). Clients can retry the request.
Unspecified = 0,
/// The cancellation request is complete. Subsequent requests with
/// the same payload may return CANCELLED or a NOT_FOUND error.
Cancelled = 1,
/// The cancellation request is in progress. The client may retry
/// the cancellation request.
Cancelling = 2,
/// The query is not cancellable. The client should not retry the
/// cancellation request.
NotCancellable = 3,
}
impl CancelResult {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
CancelResult::Unspecified => "CANCEL_RESULT_UNSPECIFIED",
CancelResult::Cancelled => "CANCEL_RESULT_CANCELLED",
CancelResult::Cancelling => "CANCEL_RESULT_CANCELLING",
CancelResult::NotCancellable => "CANCEL_RESULT_NOT_CANCELLABLE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"CANCEL_RESULT_UNSPECIFIED" => Some(Self::Unspecified),
"CANCEL_RESULT_CANCELLED" => Some(Self::Cancelled),
"CANCEL_RESULT_CANCELLING" => Some(Self::Cancelling),
"CANCEL_RESULT_NOT_CANCELLABLE" => Some(Self::NotCancellable),
_ => None,
}
}
}
}
/// 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 executing
/// SQL queries.
///
/// Note that the absence of this info (as opposed to a false value) does not necessarily
/// mean that SQL is not supported, as this property was not originally defined.
FlightSqlServerSql = 4,
///
/// Retrieves a boolean value indicating whether the Flight SQL Server supports executing
/// Substrait plans.
FlightSqlServerSubstrait = 5,
///
/// Retrieves a string value indicating the minimum supported Substrait version, or null
/// if Substrait is not supported.
FlightSqlServerSubstraitMinVersion = 6,
///
/// Retrieves a string value indicating the maximum supported Substrait version, or null
/// if Substrait is not supported.
FlightSqlServerSubstraitMaxVersion = 7,
///
/// Retrieves an int32 indicating whether the Flight SQL Server supports the
/// BeginTransaction/EndTransaction/BeginSavepoint/EndSavepoint actions.
///
/// Even if this is not supported, the database may still support explicit "BEGIN
/// TRANSACTION"/"COMMIT" SQL statements (see SQL_TRANSACTIONS_SUPPORTED); this property
/// is only about whether the server implements the Flight SQL API endpoints.
///
/// The possible values are listed in `SqlSupportedTransaction`.
FlightSqlServerTransaction = 8,
///
/// Retrieves a boolean value indicating whether the Flight SQL Server supports explicit
/// query cancellation (the CancelQuery action).
FlightSqlServerCancel = 9,
///
/// Retrieves an int32 indicating the timeout (in milliseconds) for prepared statement handles.
///
/// If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.
FlightSqlServerStatementTimeout = 100,
///
/// Retrieves an int32 indicating the timeout (in milliseconds) for transactions, since transactions are not tied to a connection.
///
/// If 0, there is no timeout. Servers should reset the timeout when the handle is used in a command.
FlightSqlServerTransactionTimeout = 101,
///
/// 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.
///