Skip to content

flight.rst

Latest commit

 

History

History
115 lines (89 loc) · 2.56 KB

flight.rst

File metadata and controls

115 lines (89 loc) · 2.56 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.

Common Types

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

    Action
    ActionType
    DescriptorType
    FlightDescriptor
    FlightEndpoint
    FlightInfo
    Location
    MetadataRecordBatchReader
    MetadataRecordBatchWriter
    Ticket
    Result

Flight Client

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

    connect
    FlightCallOptions
    FlightClient
    FlightStreamReader
    FlightStreamWriter
    ClientMiddlewareFactory
    ClientMiddleware

Flight Server

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

    FlightDataStream
    FlightMetadataWriter
    FlightServerBase
    GeneratorStream
    RecordBatchStream
    ServerCallContext
    ServerMiddlewareFactory
    ServerMiddleware

Authentication

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

    ClientAuthHandler
    ServerAuthHandler

Errors

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

    FlightError
    FlightCancelledError
    FlightInternalError
    FlightServerError
    FlightTimedOutError
    FlightUnauthenticatedError
    FlightUnauthorizedError
    FlightUnavailableError
    FlightWriteSizeExceededError

Middleware

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

    FlightMethod
    CallInfo