forked from apache/arrow-rs
-
Notifications
You must be signed in to change notification settings - Fork 3
/
arrow.flight.protocol.rs
1144 lines (1143 loc) · 50.8 KB
/
arrow.flight.protocol.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.
///
/// The request that a client provides to a server on handshake.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HandshakeRequest {
///
/// A defined protocol version
#[prost(uint64, tag="1")]
pub protocol_version: u64,
///
/// Arbitrary auth/handshake info.
#[prost(bytes="vec", tag="2")]
pub payload: ::prost::alloc::vec::Vec<u8>,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HandshakeResponse {
///
/// A defined protocol version
#[prost(uint64, tag="1")]
pub protocol_version: u64,
///
/// Arbitrary auth/handshake info.
#[prost(bytes="vec", tag="2")]
pub payload: ::prost::alloc::vec::Vec<u8>,
}
///
/// A message for doing simple auth.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BasicAuth {
#[prost(string, tag="2")]
pub username: ::prost::alloc::string::String,
#[prost(string, tag="3")]
pub password: ::prost::alloc::string::String,
}
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Empty {
}
///
/// Describes an available action, including both the name used for execution
/// along with a short description of the purpose of the action.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ActionType {
#[prost(string, tag="1")]
pub r#type: ::prost::alloc::string::String,
#[prost(string, tag="2")]
pub description: ::prost::alloc::string::String,
}
///
/// A service specific expression that can be used to return a limited set
/// of available Arrow Flight streams.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Criteria {
#[prost(bytes="vec", tag="1")]
pub expression: ::prost::alloc::vec::Vec<u8>,
}
///
/// An opaque action specific for the service.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Action {
#[prost(string, tag="1")]
pub r#type: ::prost::alloc::string::String,
#[prost(bytes="vec", tag="2")]
pub body: ::prost::alloc::vec::Vec<u8>,
}
///
/// An opaque result returned after executing an action.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Result {
#[prost(bytes="vec", tag="1")]
pub body: ::prost::alloc::vec::Vec<u8>,
}
///
/// Wrap the result of a getSchema call
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SchemaResult {
/// schema of the dataset as described in Schema.fbs::Schema.
#[prost(bytes="vec", tag="1")]
pub schema: ::prost::alloc::vec::Vec<u8>,
}
///
/// The name or tag for a Flight. May be used as a way to retrieve or generate
/// a flight or be used to expose a set of previously defined flights.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlightDescriptor {
#[prost(enumeration="flight_descriptor::DescriptorType", tag="1")]
pub r#type: i32,
///
/// Opaque value used to express a command. Should only be defined when
/// type = CMD.
#[prost(bytes="vec", tag="2")]
pub cmd: ::prost::alloc::vec::Vec<u8>,
///
/// List of strings identifying a particular dataset. Should only be defined
/// when type = PATH.
#[prost(string, repeated, tag="3")]
pub path: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Nested message and enum types in `FlightDescriptor`.
pub mod flight_descriptor {
///
/// Describes what type of descriptor is defined.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum DescriptorType {
/// Protobuf pattern, not used.
Unknown = 0,
///
/// A named path that identifies a dataset. A path is composed of a string
/// or list of strings describing a particular dataset. This is conceptually
/// similar to a path inside a filesystem.
Path = 1,
///
/// An opaque command to generate a dataset.
Cmd = 2,
}
impl DescriptorType {
/// 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 {
DescriptorType::Unknown => "UNKNOWN",
DescriptorType::Path => "PATH",
DescriptorType::Cmd => "CMD",
}
}
}
}
///
/// The access coordinates for retrieval of a dataset. With a FlightInfo, a
/// consumer is able to determine how to retrieve a dataset.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlightInfo {
/// schema of the dataset as described in Schema.fbs::Schema.
#[prost(bytes="vec", tag="1")]
pub schema: ::prost::alloc::vec::Vec<u8>,
///
/// The descriptor associated with this info.
#[prost(message, optional, tag="2")]
pub flight_descriptor: ::core::option::Option<FlightDescriptor>,
///
/// A list of endpoints associated with the flight. To consume the whole
/// flight, all endpoints must be consumed.
#[prost(message, repeated, tag="3")]
pub endpoint: ::prost::alloc::vec::Vec<FlightEndpoint>,
/// Set these to -1 if unknown.
#[prost(int64, tag="4")]
pub total_records: i64,
#[prost(int64, tag="5")]
pub total_bytes: i64,
}
///
/// A particular stream or split associated with a flight.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlightEndpoint {
///
/// Token used to retrieve this stream.
#[prost(message, optional, tag="1")]
pub ticket: ::core::option::Option<Ticket>,
///
/// A list of URIs where this ticket can be redeemed. If the list is
/// empty, the expectation is that the ticket can only be redeemed on the
/// current service where the ticket was generated.
#[prost(message, repeated, tag="2")]
pub location: ::prost::alloc::vec::Vec<Location>,
}
///
/// A location where a Flight service will accept retrieval of a particular
/// stream given a ticket.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Location {
#[prost(string, tag="1")]
pub uri: ::prost::alloc::string::String,
}
///
/// An opaque identifier that the service can use to retrieve a particular
/// portion of a stream.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Ticket {
#[prost(bytes="vec", tag="1")]
pub ticket: ::prost::alloc::vec::Vec<u8>,
}
///
/// A batch of Arrow data as part of a stream of batches.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FlightData {
///
/// The descriptor of the data. This is only relevant when a client is
/// starting a new DoPut stream.
#[prost(message, optional, tag="1")]
pub flight_descriptor: ::core::option::Option<FlightDescriptor>,
///
/// Header for message data as described in Message.fbs::Message.
#[prost(bytes="vec", tag="2")]
pub data_header: ::prost::alloc::vec::Vec<u8>,
///
/// Application-defined metadata.
#[prost(bytes="vec", tag="3")]
pub app_metadata: ::prost::alloc::vec::Vec<u8>,
///
/// The actual batch of Arrow data. Preferably handled with minimal-copies
/// coming last in the definition to help with sidecar patterns (it is
/// expected that some implementations will fetch this field off the wire
/// with specialized code to avoid extra memory copies).
#[prost(bytes="vec", tag="1000")]
pub data_body: ::prost::alloc::vec::Vec<u8>,
}
/// *
/// The response message associated with the submission of a DoPut.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PutResult {
#[prost(bytes="vec", tag="1")]
pub app_metadata: ::prost::alloc::vec::Vec<u8>,
}
/// Generated client implementations.
pub mod flight_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
///
/// A flight service is an endpoint for retrieving or storing Arrow data. A
/// flight service can expose one or more predefined endpoints that can be
/// accessed using the Arrow Flight Protocol. Additionally, a flight service
/// can expose a set of actions that are available.
#[derive(Debug, Clone)]
pub struct FlightServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl FlightServiceClient<tonic::transport::Channel> {
/// Attempt to create a new client by connecting to a given endpoint.
pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
where
D: std::convert::TryInto<tonic::transport::Endpoint>,
D::Error: Into<StdError>,
{
let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
Ok(Self::new(conn))
}
}
impl<T> FlightServiceClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> FlightServiceClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + Send + Sync,
{
FlightServiceClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
///
/// Handshake between client and server. Depending on the server, the
/// handshake may be required to determine the token that should be used for
/// future operations. Both request and response are streams to allow multiple
/// round-trips depending on auth mechanism.
pub async fn handshake(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::HandshakeRequest>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::HandshakeResponse>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/Handshake",
);
self.inner.streaming(request.into_streaming_request(), path, codec).await
}
///
/// Get a list of available streams given a particular criteria. Most flight
/// services will expose one or more streams that are readily available for
/// retrieval. This api allows listing the streams available for
/// consumption. A user can also provide a criteria. The criteria can limit
/// the subset of streams that can be listed via this interface. Each flight
/// service allows its own definition of how to consume criteria.
pub async fn list_flights(
&mut self,
request: impl tonic::IntoRequest<super::Criteria>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::FlightInfo>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/ListFlights",
);
self.inner.server_streaming(request.into_request(), path, codec).await
}
///
/// For a given FlightDescriptor, get information about how the flight can be
/// consumed. This is a useful interface if the consumer of the interface
/// already can identify the specific flight to consume. This interface can
/// also allow a consumer to generate a flight stream through a specified
/// descriptor. For example, a flight descriptor might be something that
/// includes a SQL statement or a Pickled Python operation that will be
/// executed. In those cases, the descriptor will not be previously available
/// within the list of available streams provided by ListFlights but will be
/// available for consumption for the duration defined by the specific flight
/// service.
pub async fn get_flight_info(
&mut self,
request: impl tonic::IntoRequest<super::FlightDescriptor>,
) -> Result<tonic::Response<super::FlightInfo>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/GetFlightInfo",
);
self.inner.unary(request.into_request(), path, codec).await
}
///
/// For a given FlightDescriptor, get the Schema as described in Schema.fbs::Schema
/// This is used when a consumer needs the Schema of flight stream. Similar to
/// GetFlightInfo this interface may generate a new flight that was not previously
/// available in ListFlights.
pub async fn get_schema(
&mut self,
request: impl tonic::IntoRequest<super::FlightDescriptor>,
) -> Result<tonic::Response<super::SchemaResult>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/GetSchema",
);
self.inner.unary(request.into_request(), path, codec).await
}
///
/// Retrieve a single stream associated with a particular descriptor
/// associated with the referenced ticket. A Flight can be composed of one or
/// more streams where each stream can be retrieved using a separate opaque
/// ticket that the flight service uses for managing a collection of streams.
pub async fn do_get(
&mut self,
request: impl tonic::IntoRequest<super::Ticket>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::FlightData>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/DoGet",
);
self.inner.server_streaming(request.into_request(), path, codec).await
}
///
/// Push a stream to the flight service associated with a particular
/// flight stream. This allows a client of a flight service to upload a stream
/// of data. Depending on the particular flight service, a client consumer
/// could be allowed to upload a single stream per descriptor or an unlimited
/// number. In the latter, the service might implement a 'seal' action that
/// can be applied to a descriptor once all streams are uploaded.
pub async fn do_put(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::FlightData>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::PutResult>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/DoPut",
);
self.inner.streaming(request.into_streaming_request(), path, codec).await
}
///
/// Open a bidirectional data channel for a given descriptor. This
/// allows clients to send and receive arbitrary Arrow data and
/// application-specific metadata in a single logical stream. In
/// contrast to DoGet/DoPut, this is more suited for clients
/// offloading computation (rather than storage) to a Flight service.
pub async fn do_exchange(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::FlightData>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::FlightData>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/DoExchange",
);
self.inner.streaming(request.into_streaming_request(), path, codec).await
}
///
/// Flight services can support an arbitrary number of simple actions in
/// addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut
/// operations that are potentially available. DoAction allows a flight client
/// to do a specific action against a flight service. An action includes
/// opaque request and response objects that are specific to the type action
/// being undertaken.
pub async fn do_action(
&mut self,
request: impl tonic::IntoRequest<super::Action>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::Result>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/DoAction",
);
self.inner.server_streaming(request.into_request(), path, codec).await
}
///
/// A flight service exposes all of the available action types that it has
/// along with descriptions. This allows different flight consumers to
/// understand the capabilities of the flight service.
pub async fn list_actions(
&mut self,
request: impl tonic::IntoRequest<super::Empty>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::ActionType>>,
tonic::Status,
> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/arrow.flight.protocol.FlightService/ListActions",
);
self.inner.server_streaming(request.into_request(), path, codec).await
}
}
}
/// Generated server implementations.
pub mod flight_service_server {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
///Generated trait containing gRPC methods that should be implemented for use with FlightServiceServer.
#[async_trait]
pub trait FlightService: Send + Sync + 'static {
///Server streaming response type for the Handshake method.
type HandshakeStream: futures_core::Stream<
Item = Result<super::HandshakeResponse, tonic::Status>,
>
+ Send
+ 'static;
///
/// Handshake between client and server. Depending on the server, the
/// handshake may be required to determine the token that should be used for
/// future operations. Both request and response are streams to allow multiple
/// round-trips depending on auth mechanism.
async fn handshake(
&self,
request: tonic::Request<tonic::Streaming<super::HandshakeRequest>>,
) -> Result<tonic::Response<Self::HandshakeStream>, tonic::Status>;
///Server streaming response type for the ListFlights method.
type ListFlightsStream: futures_core::Stream<
Item = Result<super::FlightInfo, tonic::Status>,
>
+ Send
+ 'static;
///
/// Get a list of available streams given a particular criteria. Most flight
/// services will expose one or more streams that are readily available for
/// retrieval. This api allows listing the streams available for
/// consumption. A user can also provide a criteria. The criteria can limit
/// the subset of streams that can be listed via this interface. Each flight
/// service allows its own definition of how to consume criteria.
async fn list_flights(
&self,
request: tonic::Request<super::Criteria>,
) -> Result<tonic::Response<Self::ListFlightsStream>, tonic::Status>;
///
/// For a given FlightDescriptor, get information about how the flight can be
/// consumed. This is a useful interface if the consumer of the interface
/// already can identify the specific flight to consume. This interface can
/// also allow a consumer to generate a flight stream through a specified
/// descriptor. For example, a flight descriptor might be something that
/// includes a SQL statement or a Pickled Python operation that will be
/// executed. In those cases, the descriptor will not be previously available
/// within the list of available streams provided by ListFlights but will be
/// available for consumption for the duration defined by the specific flight
/// service.
async fn get_flight_info(
&self,
request: tonic::Request<super::FlightDescriptor>,
) -> Result<tonic::Response<super::FlightInfo>, tonic::Status>;
///
/// For a given FlightDescriptor, get the Schema as described in Schema.fbs::Schema
/// This is used when a consumer needs the Schema of flight stream. Similar to
/// GetFlightInfo this interface may generate a new flight that was not previously
/// available in ListFlights.
async fn get_schema(
&self,
request: tonic::Request<super::FlightDescriptor>,
) -> Result<tonic::Response<super::SchemaResult>, tonic::Status>;
///Server streaming response type for the DoGet method.
type DoGetStream: futures_core::Stream<
Item = Result<super::FlightData, tonic::Status>,
>
+ Send
+ 'static;
///
/// Retrieve a single stream associated with a particular descriptor
/// associated with the referenced ticket. A Flight can be composed of one or
/// more streams where each stream can be retrieved using a separate opaque
/// ticket that the flight service uses for managing a collection of streams.
async fn do_get(
&self,
request: tonic::Request<super::Ticket>,
) -> Result<tonic::Response<Self::DoGetStream>, tonic::Status>;
///Server streaming response type for the DoPut method.
type DoPutStream: futures_core::Stream<
Item = Result<super::PutResult, tonic::Status>,
>
+ Send
+ 'static;
///
/// Push a stream to the flight service associated with a particular
/// flight stream. This allows a client of a flight service to upload a stream
/// of data. Depending on the particular flight service, a client consumer
/// could be allowed to upload a single stream per descriptor or an unlimited
/// number. In the latter, the service might implement a 'seal' action that
/// can be applied to a descriptor once all streams are uploaded.
async fn do_put(
&self,
request: tonic::Request<tonic::Streaming<super::FlightData>>,
) -> Result<tonic::Response<Self::DoPutStream>, tonic::Status>;
///Server streaming response type for the DoExchange method.
type DoExchangeStream: futures_core::Stream<
Item = Result<super::FlightData, tonic::Status>,
>
+ Send
+ 'static;
///
/// Open a bidirectional data channel for a given descriptor. This
/// allows clients to send and receive arbitrary Arrow data and
/// application-specific metadata in a single logical stream. In
/// contrast to DoGet/DoPut, this is more suited for clients
/// offloading computation (rather than storage) to a Flight service.
async fn do_exchange(
&self,
request: tonic::Request<tonic::Streaming<super::FlightData>>,
) -> Result<tonic::Response<Self::DoExchangeStream>, tonic::Status>;
///Server streaming response type for the DoAction method.
type DoActionStream: futures_core::Stream<
Item = Result<super::Result, tonic::Status>,
>
+ Send
+ 'static;
///
/// Flight services can support an arbitrary number of simple actions in
/// addition to the possible ListFlights, GetFlightInfo, DoGet, DoPut
/// operations that are potentially available. DoAction allows a flight client
/// to do a specific action against a flight service. An action includes
/// opaque request and response objects that are specific to the type action
/// being undertaken.
async fn do_action(
&self,
request: tonic::Request<super::Action>,
) -> Result<tonic::Response<Self::DoActionStream>, tonic::Status>;
///Server streaming response type for the ListActions method.
type ListActionsStream: futures_core::Stream<
Item = Result<super::ActionType, tonic::Status>,
>
+ Send
+ 'static;
///
/// A flight service exposes all of the available action types that it has
/// along with descriptions. This allows different flight consumers to
/// understand the capabilities of the flight service.
async fn list_actions(
&self,
request: tonic::Request<super::Empty>,
) -> Result<tonic::Response<Self::ListActionsStream>, tonic::Status>;
}
///
/// A flight service is an endpoint for retrieving or storing Arrow data. A
/// flight service can expose one or more predefined endpoints that can be
/// accessed using the Arrow Flight Protocol. Additionally, a flight service
/// can expose a set of actions that are available.
#[derive(Debug)]
pub struct FlightServiceServer<T: FlightService> {
inner: _Inner<T>,
accept_compression_encodings: EnabledCompressionEncodings,
send_compression_encodings: EnabledCompressionEncodings,
}
struct _Inner<T>(Arc<T>);
impl<T: FlightService> FlightServiceServer<T> {
pub fn new(inner: T) -> Self {
Self::from_arc(Arc::new(inner))
}
pub fn from_arc(inner: Arc<T>) -> Self {
let inner = _Inner(inner);
Self {
inner,
accept_compression_encodings: Default::default(),
send_compression_encodings: Default::default(),
}
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> InterceptedService<Self, F>
where
F: tonic::service::Interceptor,
{
InterceptedService::new(Self::new(inner), interceptor)
}
/// Enable decompressing requests with the given encoding.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.accept_compression_encodings.enable(encoding);
self
}
/// Compress responses with the given encoding, if the client supports it.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.send_compression_encodings.enable(encoding);
self
}
}
impl<T, B> tonic::codegen::Service<http::Request<B>> for FlightServiceServer<T>
where
T: FlightService,
B: Body + Send + 'static,
B::Error: Into<StdError> + Send + 'static,
{
type Response = http::Response<tonic::body::BoxBody>;
type Error = std::convert::Infallible;
type Future = BoxFuture<Self::Response, Self::Error>;
fn poll_ready(
&mut self,
_cx: &mut Context<'_>,
) -> Poll<Result<(), Self::Error>> {
Poll::Ready(Ok(()))
}
fn call(&mut self, req: http::Request<B>) -> Self::Future {
let inner = self.inner.clone();
match req.uri().path() {
"/arrow.flight.protocol.FlightService/Handshake" => {
#[allow(non_camel_case_types)]
struct HandshakeSvc<T: FlightService>(pub Arc<T>);
impl<
T: FlightService,
> tonic::server::StreamingService<super::HandshakeRequest>
for HandshakeSvc<T> {
type Response = super::HandshakeResponse;
type ResponseStream = T::HandshakeStream;
type Future = BoxFuture<
tonic::Response<Self::ResponseStream>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<
tonic::Streaming<super::HandshakeRequest>,
>,
) -> Self::Future {
let inner = self.0.clone();
let fut = async move { (*inner).handshake(request).await };
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
let inner = inner.0;
let method = HandshakeSvc(inner);
let codec = tonic::codec::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
);
let res = grpc.streaming(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/arrow.flight.protocol.FlightService/ListFlights" => {
#[allow(non_camel_case_types)]
struct ListFlightsSvc<T: FlightService>(pub Arc<T>);
impl<
T: FlightService,
> tonic::server::ServerStreamingService<super::Criteria>
for ListFlightsSvc<T> {
type Response = super::FlightInfo;
type ResponseStream = T::ListFlightsStream;
type Future = BoxFuture<
tonic::Response<Self::ResponseStream>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<super::Criteria>,
) -> Self::Future {
let inner = self.0.clone();
let fut = async move {
(*inner).list_flights(request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
let inner = inner.0;
let method = ListFlightsSvc(inner);
let codec = tonic::codec::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
);
let res = grpc.server_streaming(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/arrow.flight.protocol.FlightService/GetFlightInfo" => {
#[allow(non_camel_case_types)]
struct GetFlightInfoSvc<T: FlightService>(pub Arc<T>);
impl<
T: FlightService,
> tonic::server::UnaryService<super::FlightDescriptor>
for GetFlightInfoSvc<T> {
type Response = super::FlightInfo;
type Future = BoxFuture<
tonic::Response<Self::Response>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<super::FlightDescriptor>,
) -> Self::Future {
let inner = self.0.clone();
let fut = async move {
(*inner).get_flight_info(request).await
};
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
let inner = inner.0;
let method = GetFlightInfoSvc(inner);
let codec = tonic::codec::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
);
let res = grpc.unary(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/arrow.flight.protocol.FlightService/GetSchema" => {
#[allow(non_camel_case_types)]
struct GetSchemaSvc<T: FlightService>(pub Arc<T>);
impl<
T: FlightService,
> tonic::server::UnaryService<super::FlightDescriptor>
for GetSchemaSvc<T> {
type Response = super::SchemaResult;
type Future = BoxFuture<
tonic::Response<Self::Response>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<super::FlightDescriptor>,
) -> Self::Future {
let inner = self.0.clone();
let fut = async move { (*inner).get_schema(request).await };
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
let inner = inner.0;
let method = GetSchemaSvc(inner);
let codec = tonic::codec::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
);
let res = grpc.unary(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/arrow.flight.protocol.FlightService/DoGet" => {
#[allow(non_camel_case_types)]
struct DoGetSvc<T: FlightService>(pub Arc<T>);
impl<
T: FlightService,
> tonic::server::ServerStreamingService<super::Ticket>
for DoGetSvc<T> {
type Response = super::FlightData;
type ResponseStream = T::DoGetStream;
type Future = BoxFuture<
tonic::Response<Self::ResponseStream>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<super::Ticket>,
) -> Self::Future {
let inner = self.0.clone();
let fut = async move { (*inner).do_get(request).await };
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
let inner = inner.0;
let method = DoGetSvc(inner);
let codec = tonic::codec::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
);
let res = grpc.server_streaming(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/arrow.flight.protocol.FlightService/DoPut" => {
#[allow(non_camel_case_types)]
struct DoPutSvc<T: FlightService>(pub Arc<T>);
impl<
T: FlightService,
> tonic::server::StreamingService<super::FlightData>
for DoPutSvc<T> {
type Response = super::PutResult;
type ResponseStream = T::DoPutStream;
type Future = BoxFuture<
tonic::Response<Self::ResponseStream>,
tonic::Status,
>;
fn call(
&mut self,
request: tonic::Request<tonic::Streaming<super::FlightData>>,
) -> Self::Future {
let inner = self.0.clone();
let fut = async move { (*inner).do_put(request).await };
Box::pin(fut)
}
}
let accept_compression_encodings = self.accept_compression_encodings;
let send_compression_encodings = self.send_compression_encodings;
let inner = self.inner.clone();
let fut = async move {
let inner = inner.0;
let method = DoPutSvc(inner);
let codec = tonic::codec::ProstCodec::default();
let mut grpc = tonic::server::Grpc::new(codec)
.apply_compression_config(
accept_compression_encodings,
send_compression_encodings,
);
let res = grpc.streaming(method, req).await;
Ok(res)
};
Box::pin(fut)
}
"/arrow.flight.protocol.FlightService/DoExchange" => {
#[allow(non_camel_case_types)]
struct DoExchangeSvc<T: FlightService>(pub Arc<T>);
impl<
T: FlightService,
> tonic::server::StreamingService<super::FlightData>
for DoExchangeSvc<T> {
type Response = super::FlightData;
type ResponseStream = T::DoExchangeStream;
type Future = BoxFuture<
tonic::Response<Self::ResponseStream>,
tonic::Status,
>;
fn call(