Morph MORPH
SIGN IN SIGN UP
apache / arrow UNCLAIMED

Apache Arrow is the universal columnar format and multi-language toolbox for fast data interchange and in-memory analytics

0 0 9 C++
Normal View History Raw
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
.. Licensed to the Apache Software Foundation (ASF) under one
.. or more contributor license agreements. See the NOTICE file
.. distributed with this work for additional information
.. regarding copyright ownership. The ASF licenses this file
.. to you under the Apache License, Version 2.0 (the
.. "License"); you may not use this file except in compliance
.. with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing,
.. software distributed under the License is distributed on an
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
.. KIND, either express or implied. See the License for the
.. specific language governing permissions and limitations
.. under the License.
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
.. default-domain:: cpp
.. highlight:: cpp
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
================
Arrow Flight RPC
================
ARROW-6629: [Doc] [C++] Add filesystem docs Also adds and improves other C++ doc items. Closes #5487 from pitrou/ARROW-6629-cpp-fs-docs and squashes the following commits: d47a00830 <Antoine Pitrou> Update docs/source/cpp/io.rst 895f04a13 <Antoine Pitrou> Try to fix Sphinx error on Travis c40e0e257 <Antoine Pitrou> ARROW-6629: Add filesystem docs Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Neal Richardson <neal.p.richardson@gmail.com>
2019-09-24 13:44:06 -07:00
.. note:: Flight is currently unstable. APIs are subject to change,
though we don't expect drastic changes.
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
Common Types
============
.. doxygenstruct:: arrow::flight::Action
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::ActionType
:project: arrow_cpp
:members:
ARROW-6855: [FlightRPC][C++][Python] Flight middleware for C++/Python This is likely not fully compatible with Java yet (I'm aware of one edge case where gRPC-Java does something different than gRPC-C++) - will address in a follow up with integration testing ([ARROW-5875](https://issues.apache.org/jira/browse/ARROW-5875)). Compared to the Java implementation, this one can make guarantees about which thread things are run on (so you can and must use thread-locals to communicate with application code from middleware). This uses the experimental gRPC interceptor interface to implement client middleware. Travis build: https://travis-ci.com/lihalite/arrow/builds/129755428 AppVeyor build: https://ci.appveyor.com/project/lihalite/arrow/builds/27777244 Closes #5552 from lihalite/flight-middleware-cpp and squashes the following commits: 03921d455 <David Li> Fix warnings/tests 69505a8db <David Li> Update middleware example 564783797 <David Li> Require headers to be ASCII e47d1709f <David Li> Don't rely on thread locals for server middleware f6d314bd1 <David Li> Remove unnecessary files d036c74d5 <David Li> Get rid of header iterator 7716ade3b <David Li> Address review feedback 99cf60f19 <David Li> Fix Flight tests on Windows 362341ef2 <David Li> Fix lints 65459ad97 <David Li> Add middleware to Flight docs 0be4009db <David Li> Fix Python TLS test 9e23952b9 <David Li> Fix Python middleware a1d9b5da7 <David Li> Add example of Flight/Python middleware 260deb84b <David Li> Rework C++ client middleware to require infallability 530e6fcc8 <David Li> Rework C++ middleware to require infalliability 53646bc6c <David Li> ARROW-6074: Flight middleware Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Wes McKinney <wesm+git@apache.org>
2019-10-11 09:21:18 -05:00
.. doxygenclass:: arrow::flight::AddCallHeaders
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::CallInfo
:project: arrow_cpp
:members:
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
.. doxygenstruct:: arrow::flight::Criteria
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::FlightDescriptor
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::FlightEndpoint
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::FlightInfo
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::FlightPayload
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::FlightListing
:project: arrow_cpp
:members:
ARROW-6855: [FlightRPC][C++][Python] Flight middleware for C++/Python This is likely not fully compatible with Java yet (I'm aware of one edge case where gRPC-Java does something different than gRPC-C++) - will address in a follow up with integration testing ([ARROW-5875](https://issues.apache.org/jira/browse/ARROW-5875)). Compared to the Java implementation, this one can make guarantees about which thread things are run on (so you can and must use thread-locals to communicate with application code from middleware). This uses the experimental gRPC interceptor interface to implement client middleware. Travis build: https://travis-ci.com/lihalite/arrow/builds/129755428 AppVeyor build: https://ci.appveyor.com/project/lihalite/arrow/builds/27777244 Closes #5552 from lihalite/flight-middleware-cpp and squashes the following commits: 03921d455 <David Li> Fix warnings/tests 69505a8db <David Li> Update middleware example 564783797 <David Li> Require headers to be ASCII e47d1709f <David Li> Don't rely on thread locals for server middleware f6d314bd1 <David Li> Remove unnecessary files d036c74d5 <David Li> Get rid of header iterator 7716ade3b <David Li> Address review feedback 99cf60f19 <David Li> Fix Flight tests on Windows 362341ef2 <David Li> Fix lints 65459ad97 <David Li> Add middleware to Flight docs 0be4009db <David Li> Fix Python TLS test 9e23952b9 <David Li> Fix Python middleware a1d9b5da7 <David Li> Add example of Flight/Python middleware 260deb84b <David Li> Rework C++ client middleware to require infallability 530e6fcc8 <David Li> Rework C++ middleware to require infalliability 53646bc6c <David Li> ARROW-6074: Flight middleware Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Wes McKinney <wesm+git@apache.org>
2019-10-11 09:21:18 -05:00
.. doxygenenum:: arrow::flight::FlightMethod
:project: arrow_cpp
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
.. doxygenstruct:: arrow::flight::Location
:project: arrow_cpp
:members:
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
.. doxygenclass:: arrow::flight::MetadataRecordBatchReader
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::Result
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::ResultStream
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::Ticket
:project: arrow_cpp
:members:
Clients
=======
.. doxygenclass:: arrow::flight::FlightClient
:project: arrow_cpp
:members:
ARROW-12089: [Doc] Fix Sphinx warnings This doesn't fix all warnings (some are due to limitations of Numpydoc, autodoc and Sphinx). Closes #9848 from pitrou/ARROW-12089-sphinx-warnings Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-03-31 13:51:03 +02:00
.. doxygenstruct:: arrow::flight::FlightClientOptions
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
:project: arrow_cpp
:members:
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
.. doxygenclass:: arrow::flight::FlightCallOptions
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::ClientAuthHandler
:project: arrow_cpp
:members:
ARROW-6855: [FlightRPC][C++][Python] Flight middleware for C++/Python This is likely not fully compatible with Java yet (I'm aware of one edge case where gRPC-Java does something different than gRPC-C++) - will address in a follow up with integration testing ([ARROW-5875](https://issues.apache.org/jira/browse/ARROW-5875)). Compared to the Java implementation, this one can make guarantees about which thread things are run on (so you can and must use thread-locals to communicate with application code from middleware). This uses the experimental gRPC interceptor interface to implement client middleware. Travis build: https://travis-ci.com/lihalite/arrow/builds/129755428 AppVeyor build: https://ci.appveyor.com/project/lihalite/arrow/builds/27777244 Closes #5552 from lihalite/flight-middleware-cpp and squashes the following commits: 03921d455 <David Li> Fix warnings/tests 69505a8db <David Li> Update middleware example 564783797 <David Li> Require headers to be ASCII e47d1709f <David Li> Don't rely on thread locals for server middleware f6d314bd1 <David Li> Remove unnecessary files d036c74d5 <David Li> Get rid of header iterator 7716ade3b <David Li> Address review feedback 99cf60f19 <David Li> Fix Flight tests on Windows 362341ef2 <David Li> Fix lints 65459ad97 <David Li> Add middleware to Flight docs 0be4009db <David Li> Fix Python TLS test 9e23952b9 <David Li> Fix Python middleware a1d9b5da7 <David Li> Add example of Flight/Python middleware 260deb84b <David Li> Rework C++ client middleware to require infallability 530e6fcc8 <David Li> Rework C++ middleware to require infalliability 53646bc6c <David Li> ARROW-6074: Flight middleware Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Wes McKinney <wesm+git@apache.org>
2019-10-11 09:21:18 -05:00
.. doxygenclass:: arrow::flight::ClientMiddleware
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::ClientMiddlewareFactory
:project: arrow_cpp
:members:
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
.. doxygentypedef:: arrow::flight::TimeoutDuration
:project: arrow_cpp
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
.. doxygenclass:: arrow::flight::FlightStreamReader
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::FlightStreamWriter
:project: arrow_cpp
:members:
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
Servers
=======
.. doxygenclass:: arrow::flight::FlightServerBase
:project: arrow_cpp
:members:
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
.. doxygenclass:: arrow::flight::FlightServerOptions
:project: arrow_cpp
:members:
.. doxygenstruct:: arrow::flight::CertKeyPair
:project: arrow_cpp
:members:
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
.. doxygenclass:: arrow::flight::FlightDataStream
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::FlightMessageReader
:project: arrow_cpp
:members:
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
.. doxygenclass:: arrow::flight::FlightMetadataWriter
:project: arrow_cpp
:members:
ARROW-4626: [Flight] Add application-defined metadata to DoGet/DoPut Also covers [ARROW-4627](https://issues.apache.org/jira/browse/ARROW-4627). This is quite an enormous change, if preferred, I can do my best to try and separate changes. Author: David Li <li.davidm96@gmail.com> Closes #4282 from lihalite/arrow-4626-application-metadata and squashes the following commits: 6f1cd8db7 <David Li> Rework interface for accessing server-sent metadata during DoPut 8fd99cd9b <David Li> Inline CompletableFuture in Flight acceptPut 4cebc543a <David Li> Mark flaky Flight test c551d8527 <David Li> Fix new CheckStyle violations 85e21699c <David Li> Fix Flight integration tests using metadata eff22393c <David Li> Use FlightStreamChunk in Flight/C++ 72c2a3fa0 <David Li> Try to always close FlightStream after acceptPut 1718d9b42 <David Li> Make FlightStream cancellable from acceptPut 7ac44df79 <David Li> Make Netty version consistent with gRPC 1225b67af <David Li> Use ArrowBuf instead of byte for Flight metadata ccfef2d1e <David Li> Disable Flight cancellation tests in CI 0484c333c <David Li> Pass Flight context to ListActions in Python b0f71d967 <David Li> Replace ARROW_EXPORT with ARROW_FLIGHT_EXPORT fdaa76e99 <David Li> Add client-side cancelation of DoGet operations b4dbc445e <David Li> Enable non-nested dictionary batches in Flight integration tests f7631a2fd <David Li> Add basic Arrow Flight docs a8ac27fb3 <David Li> Implement application metadata in Flight 86f4789ab <David Li> Add application metadata field to FlightData message
2019-06-26 14:19:36 -05:00
.. doxygenclass:: arrow::flight::RecordBatchStream
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::ServerAuthHandler
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::ServerCallContext
:project: arrow_cpp
:members:
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
ARROW-6855: [FlightRPC][C++][Python] Flight middleware for C++/Python This is likely not fully compatible with Java yet (I'm aware of one edge case where gRPC-Java does something different than gRPC-C++) - will address in a follow up with integration testing ([ARROW-5875](https://issues.apache.org/jira/browse/ARROW-5875)). Compared to the Java implementation, this one can make guarantees about which thread things are run on (so you can and must use thread-locals to communicate with application code from middleware). This uses the experimental gRPC interceptor interface to implement client middleware. Travis build: https://travis-ci.com/lihalite/arrow/builds/129755428 AppVeyor build: https://ci.appveyor.com/project/lihalite/arrow/builds/27777244 Closes #5552 from lihalite/flight-middleware-cpp and squashes the following commits: 03921d455 <David Li> Fix warnings/tests 69505a8db <David Li> Update middleware example 564783797 <David Li> Require headers to be ASCII e47d1709f <David Li> Don't rely on thread locals for server middleware f6d314bd1 <David Li> Remove unnecessary files d036c74d5 <David Li> Get rid of header iterator 7716ade3b <David Li> Address review feedback 99cf60f19 <David Li> Fix Flight tests on Windows 362341ef2 <David Li> Fix lints 65459ad97 <David Li> Add middleware to Flight docs 0be4009db <David Li> Fix Python TLS test 9e23952b9 <David Li> Fix Python middleware a1d9b5da7 <David Li> Add example of Flight/Python middleware 260deb84b <David Li> Rework C++ client middleware to require infallability 530e6fcc8 <David Li> Rework C++ middleware to require infalliability 53646bc6c <David Li> ARROW-6074: Flight middleware Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Wes McKinney <wesm+git@apache.org>
2019-10-11 09:21:18 -05:00
.. doxygenclass:: arrow::flight::ServerMiddleware
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::ServerMiddlewareFactory
:project: arrow_cpp
:members:
ARROW-6677: [FlightRPC][C++] Document Flight in C++ - Adds StatusDetail to the docs - Fixes the Doxygen config to work with `ARROW_FLIGHT_EXPORT` - Adds error codes to the format docs (though they're not part of the formal format) - Touches up some docstrings and adds missing classes to the API docs - Add a basic description of how to set up a Flight server/client in C++ Closes #5491 from lihalite/flight-docs and squashes the following commits: 294898302 <David Li> ARROW-6677: Document Flight in C++ Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 12:23:01 +02:00
.. doxygenclass:: arrow::flight::SimpleFlightListing
:project: arrow_cpp
:members:
.. doxygenclass:: arrow::flight::SimpleResultStream
:project: arrow_cpp
:members:
Error Handling
==============
Error handling uses the normal :class:`arrow::Status` class, combined
with a custom :class:`arrow::StatusDetail` object for Flight-specific
error codes.
.. doxygenenum:: arrow::flight::FlightStatusCode
:project: arrow_cpp
.. doxygenclass:: arrow::flight::FlightStatusDetail
:project: arrow_cpp
:members:
.. doxygenfunction:: arrow::flight::MakeFlightError
:project: arrow_cpp
ARROW-15282: [C++][FlightRPC] Split data methods from the underlying transport Defines interfaces to add new network transports to Arrow Flight, and rewrite the gRPC implementation in terms of these interfaces. The bulk of the new APIs are in `transport.h`. Where possible, code has been factored out so that transports have to implement as little as possible. Closes #12465 from lidavidm/arrow-15282 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2022-03-11 02:54:10 +00:00
Implementing Custom Transports
==============================
ARROW-16994: [Docs][CI] Clean up docs warnings (#13533) Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-07-07 09:16:29 -04:00
.. doxygenfile:: arrow/flight/transport.h
ARROW-15282: [C++][FlightRPC] Split data methods from the underlying transport Defines interfaces to add new network transports to Arrow Flight, and rewrite the gRPC implementation in terms of these interfaces. The bulk of the new APIs are in `transport.h`. Where possible, code has been factored out so that transports have to implement as little as possible. Closes #12465 from lidavidm/arrow-15282 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Yibo Cai <yibo.cai@arm.com>
2022-03-11 02:54:10 +00:00
:sections: briefdescription detaileddescription
Reference in New Issue Copy Permalink