1.. Licensed to the Apache Software Foundation (ASF) under one 2.. or more contributor license agreements. See the NOTICE file 3.. distributed with this work for additional information 4.. regarding copyright ownership. The ASF licenses this file 5.. to you under the Apache License, Version 2.0 (the 6.. "License"); you may not use this file except in compliance 7.. with the License. You may obtain a copy of the License at 8 9.. http://www.apache.org/licenses/LICENSE-2.0 10 11.. Unless required by applicable law or agreed to in writing, 12.. software distributed under the License is distributed on an 13.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 14.. KIND, either express or implied. See the License for the 15.. specific language governing permissions and limitations 16.. under the License. 17 18.. currentmodule:: pyarrow.flight 19 20Arrow Flight 21============ 22 23.. ifconfig:: not flight_enabled 24 25 .. error:: 26 This documentation was built without Flight enabled. The Flight 27 API docs are not available. 28 29.. NOTE We still generate those API docs (with empty docstrings) 30.. when Flight is disabled and `pyarrow.flight` mocked (see conf.py). 31.. Otherwise we'd get autodoc warnings, see https://github.com/sphinx-doc/sphinx/issues/4770 32 33.. warning:: Flight is currently unstable. APIs are subject to change, 34 though we don't expect drastic changes. 35 36.. warning:: Flight is currently not distributed as part of wheels or 37 in Conda - it is only available when built from source 38 appropriately. 39 40Common Types 41------------ 42 43.. autosummary:: 44 :toctree: ../generated/ 45 46 Action 47 ActionType 48 DescriptorType 49 FlightDescriptor 50 FlightEndpoint 51 FlightInfo 52 Location 53 Ticket 54 Result 55 56Flight Client 57------------- 58 59.. autosummary:: 60 :toctree: ../generated/ 61 62 FlightCallOptions 63 FlightClient 64 ClientMiddlewareFactory 65 ClientMiddleware 66 67Flight Server 68------------- 69 70.. autosummary:: 71 :toctree: ../generated/ 72 73 FlightServerBase 74 GeneratorStream 75 RecordBatchStream 76 ServerMiddlewareFactory 77 ServerMiddleware 78 79Authentication 80-------------- 81 82.. autosummary:: 83 :toctree: ../generated/ 84 85 ClientAuthHandler 86 ServerAuthHandler 87 88Middleware 89---------- 90 91.. autosummary:: 92 :toctree: ../generated/ 93 94 FlightMethod 95 CallInfo 96