pyarrow.flight.FlightInfo#

class pyarrow.flight.FlightInfo(Schema schema, FlightDescriptor descriptor, endpoints, total_records=None, total_bytes=None, ordered=False, app_metadata='')#

Bases: _Weakrefable

A description of a Flight stream.

__init__()#

Create a FlightInfo object from a schema, descriptor, and endpoints.

Parameters:

schemaSchema, optional

the schema of the data in this flight.

descriptorFlightDescriptor

the descriptor for this flight.

endpointslist of FlightEndpoint

a list of endpoints where this flight is available.

total_recordsint, default None

the total records in this flight, -1 or None if unknown.

total_bytesint, default None

the total bytes in this flight, -1 or None if unknown.

orderedbool, default False

Whether endpoints are in the same order as the data.

app_metadatabytes or str, default

Application-defined opaque metadata.

Methods

__init__	Create a FlightInfo object from a schema, descriptor, and endpoints.
deserialize(cls,serialized)	Parse the wire-format representation of this type.
serialize(self)	Get the wire-format representation of this type.

Attributes

app_metadata	Application-defined opaque metadata.
descriptor	The descriptor of the data in this flight.
endpoints	The endpoints where this flight is available.
ordered	Whether endpoints are in the same order as the data.
schema	The schema of the data in this flight.
total_bytes	The size in bytes of the data in this flight, or -1 if unknown.
total_records	The total record count of this flight, or -1 if unknown.

app_metadata#

Application-defined opaque metadata.

There is no inherent or required relationship between this and the app_metadata fields in the FlightEndpoints or resulting FlightData messages. Since this metadata is application-defined, a given application could define there to be a relationship, but there is none required by the spec.

descriptor#

The descriptor of the data in this flight.

classmethod deserialize(cls, serialized)#

Parse the wire-format representation of this type.

Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types.

endpoints#

The endpoints where this flight is available.

ordered#

Whether endpoints are in the same order as the data.

schema#

The schema of the data in this flight.

serialize(self)#

Get the wire-format representation of this type.

Useful when interoperating with non-Flight systems (e.g. REST services) that may want to return Flight types.

total_bytes#

The size in bytes of the data in this flight, or -1 if unknown.

total_records#

The total record count of this flight, or -1 if unknown.