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.

Ticket(ticket)

A ticket for requesting a Flight stream.

Result(buf)

A result from executing an Action.

Flight Client

FlightCallOptions([timeout, write_options, ...])

RPC-layer options for a Flight call.

FlightClient(location[, tls_root_certs, ...])

A client to a Flight service.

ClientMiddlewareFactory

A factory for new middleware instances.

ClientMiddleware

Client-side middleware for a call, instantiated per RPC.

Flight Server

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.

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.

Middleware

FlightMethod(value)

The implemented methods in Flight.

CallInfo(method)

Information about a particular RPC for Flight middleware.