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)	The type of a FlightDescriptor.
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.
MetadataRecordBatchReader	The base class for readers for Flight streams.
MetadataRecordBatchWriter	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.
FlightStreamReader	A reader that can also be canceled.
FlightStreamWriter	A writer that also allows closing the write side of a stream.
ClientMiddlewareFactory	A factory for new middleware instances.
ClientMiddleware	Client-side middleware for a call, instantiated per RPC.

Flight Server

FlightDataStream	Abstract base class for Flight data streams.
FlightMetadataWriter	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.
ServerCallContext	Per-call state/context.
ServerMiddlewareFactory	A factory for new middleware instances.
ServerMiddleware	Server-side middleware for a call, instantiated per RPC.

Authentication

ClientAuthHandler	Authentication plugin for a client.
ServerAuthHandler	Authentication middleware for a server.

Errors

FlightError([message, extra_info])	The base class for Flight-specific errors.
FlightCancelledError	The operation was cancelled.
FlightInternalError	An error internal to the Flight server occurred.
FlightServerError	A server error occurred.
FlightTimedOutError	The Flight RPC call timed out.
FlightUnauthenticatedError	The client is not authenticated.
FlightUnauthorizedError	The client is not authorized to perform the given operation.
FlightUnavailableError	The server is not reachable or available.
FlightWriteSizeExceededError(message, limit, ...)	A write operation exceeded the client-configured limit.

Middleware

FlightMethod(value)	The implemented methods in Flight.
CallInfo(method)	Information about a particular RPC for Flight middleware.

previous

pyarrow.ipc.RecordBatchStreamWriter

next

pyarrow.flight.Action