Crate arrow_flight 

A native Rust implementation of Apache Arrow Flight for exchanging Arrow data between processes.

Please see the arrow-flight crates.io page for feature flags and more information.

Overview

This crate contains:

1. Low level prost generated structs for Flight gRPC protobuf messages, such as FlightData, FlightInfo, Location and Ticket.

2. Low level [tonic] generated flight_service_client and flight_service_server.

3. Support for Flight SQL in sql. Requires the flight-sql feature of this crate to be activated.

Platform Support

Only little-endian platforms are officially supported and tested in CI. Big-endian platforms are not tested in CI and may not work correctly. Fixes for big-endian platforms are welcome and handled on a best-effort basis, but compatibility is not guaranteed.

Re-exports

pub use client::FlightClient;

pub use gen::Action;

pub use gen::ActionType;

pub use gen::BasicAuth;

pub use gen::CancelFlightInfoRequest;

pub use gen::CancelFlightInfoResult;

pub use gen::CancelStatus;

pub use gen::Criteria;

pub use gen::Empty;

pub use gen::FlightData;

pub use gen::FlightDescriptor;

pub use gen::FlightEndpoint;

pub use gen::FlightInfo;

pub use gen::HandshakeRequest;

pub use gen::HandshakeResponse;

pub use gen::Location;

pub use gen::PollInfo;

pub use gen::PutResult;

pub use gen::RenewFlightEndpointRequest;

pub use gen::Result;

pub use gen::SchemaResult;

pub use gen::Ticket;

pub(crate) use flight_descriptor::DescriptorType; 🔒

pub(crate) use convert; 🔒

pub(crate) use writer; 🔒

pub(crate) use writer::EncodedData; 🔒

pub(crate) use writer::IpcWriteOptions; 🔒

pub(crate) use ArrowError; 🔒

pub(crate) use Schema; 🔒

pub(crate) use arrow_ipc::convert::try_schema_from_ipc_buffer; 🔒

pub(crate) use base64::Engine; 🔒

pub(crate) use base64::prelude::BASE64_STANDARD; 🔒

pub(crate) use bytes::Bytes; 🔒

pub(crate) use prost_types::Timestamp; 🔒

pub(crate) use fmt; 🔒

pub(crate) use ops::Deref; 🔒

Modules

client

Mid Level FlightClient

decode

Decoder to create RecordBatch streams from FlightData streams. See FlightRecordBatchStream.

encode

Encoder to create FlightData streams from RecordBatch streams. See FlightDataEncoderBuilder.

error

Common error types

flight_descriptor

Defines a Flight for generation or retrieval.

flight_service_client

Low Level [tonic] FlightServiceClient.

flight_service_server

Low Level [tonic] FlightServiceServer and FlightService.

gen 🔒

sql

Support for execute SQL queries using Apache Arrow Flight SQL.

streams 🔒

FallibleRequestStream and FallibleTonicResponseStream adapters

trailers 🔒

Helper to extract HTTP/gRPC trailers from a tonic stream.

utils

Utilities to assist with reading and writing Arrow data as Flight messages

Structs

IpcMessage

IpcMessage represents a Schema in the format expected in FlightInfo.schema

SchemaAsIpc

SchemaAsIpc represents a pairing of a Schema with IpcWriteOptions

Functions

flight_schema_as_encoded_data 🔒

flight_schema_as_flatbuffer 🔒

limited_fmt 🔒

Limits the output of value to limit…

schema_to_ipc_format 🔒

Type Aliases

ArrowResult 🔒