Skip to content

flight.rst

Latest commit

 

History

History
82 lines (61 loc) · 2.07 KB

flight.rst

File metadata and controls

82 lines (61 loc) · 2.07 KB
.. currentmodule:: pyarrow.flight

Arrow Flight

.. ifconfig:: not flight_enabled

   .. error::
      This documentation was built without Flight enabled.  The Flight
      API docs are not available.

Warning

Flight is currently unstable. APIs are subject to change, though we don't expect drastic changes.

Warning

Flight is currently not distributed as part of wheels or in Conda - it is only available when built from source appropriately.

Common Types

.. autosummary::
   :toctree: ../generated/

    Action
    ActionType
    DescriptorType
    FlightDescriptor
    FlightEndpoint
    FlightInfo
    Location
    Ticket
    Result

Flight Client

.. autosummary::
   :toctree: ../generated/

    FlightCallOptions
    FlightClient

Flight Server

.. autosummary::
   :toctree: ../generated/

    FlightServerBase
    GeneratorStream
    RecordBatchStream

Authentication

.. autosummary::
   :toctree: ../generated/

    ClientAuthHandler
    ServerAuthHandler