Arrow Flight#
Warning
Flight is currently unstable. APIs are subject to change, though we don’t expect drastic changes.
Common Types#
Action(action_type, buf)
An action executable on a Flight service.
ActionType(type, description)
A type of action that is executable on a Flight service.
DescriptorType(value[, names, module, ...])
The type of a FlightDescriptor.
A description of a data stream available from a Flight service.
FlightEndpoint(ticket, locations[, ...])
A Flight stream, along with the ticket and locations to access it.
FlightInfo(Schema schema, ...[, ...])
A description of a Flight stream.
Location(uri)
The location of a Flight service.
The base class for readers for Flight streams.
A RecordBatchWriter that also allows writing application metadata.
Ticket(ticket)
A ticket for requesting a Flight stream.
Result(buf)
A result from executing an Action.
Flight Client#
connect(location, **kwargs)
Connect to a Flight server.
FlightCallOptions([timeout, write_options, ...])
RPC-layer options for a Flight call.
FlightClient(location[, tls_root_certs, ...])
A client to a Flight service.
A reader that can also be canceled.
A writer that also allows closing the write side of a stream.
A factory for new middleware instances.
Client-side middleware for a call, instantiated per RPC.
Flight Server#
Abstract base class for Flight data streams.
A sender for Flight metadata messages during a DoPut.
FlightServerBase([location, auth_handler, ...])
A Flight service definition.
GeneratorStream(schema, generator[, options])
A Flight data stream backed by a Python generator.
RecordBatchStream(data_source[, options])
A Flight data stream backed by RecordBatches.
Per-call state/context.
A factory for new middleware instances.
Server-side middleware for a call, instantiated per RPC.
Authentication#
Authentication plugin for a client.
Authentication middleware for a server.
Errors#
FlightError([message, extra_info])
The base class for Flight-specific errors.
The operation was cancelled.
An error internal to the Flight server occurred.
A server error occurred.
The Flight RPC call timed out.
The client is not authenticated.
The client is not authorized to perform the given operation.
The server is not reachable or available.
FlightWriteSizeExceededError(message, limit, ...)
A write operation exceeded the client-configured limit.
Middleware#
FlightMethod(value[, names, module, ...])
The implemented methods in Flight.
CallInfo(method)
Information about a particular RPC for Flight middleware.