This area of the Apache Arrow Experiments repository is for collaborative prototyping and research on the subject of sending and receiving data in Arrow IPC stream format (IANA media type application/vnd.apache.arrow.stream) over HTTP APIs.
The subdirectories beginning with get demonstrate clients receiving data from servers (HTTP GET request). Those beginning with post demonstrate clients sending data to servers (HTTP POST request).
| Subdirectory | Purpose |
|---|---|
| get_compressed | Demonstrates various ways of using compression when sending and receiving Arrow IPC stream data over HTTP |
| get_indirect | Demonstrates a two-step sequence for fetching Arrow data from a server, in which a JSON document provides the URIs for the Arrow data |
| get_multipart | Demonstrates how to send and receive a multipart HTTP response body (multipart/mixed) containing Arrow IPC stream data and other data |
| get_range | Demonstrates how to use HTTP range requests to download Arrow IPC stream data of known length in multiple requests |
| get_simple | Contains a large set of examples demonstrating the basics of fetching an Arrow IPC stream from a server to a client in 12+ languages |
| post_multipart | Demonstrates how to send and receive a multipart HTTP request body (multipart/form-data) containing Arrow IPC stream data and other data |
| post_simple | Demonstrates the basics of sending Arrow IPC stream data from a client to a server |
The intent of this work is to:
- Ensure excellent interoperability across languages.
- Allow implementation within existing HTTP APIs.
- Maximize performance.
- Minimize implementation complexity.
The end goal of this work is to inform and guide the creation of a set of conventions to be published in the Arrow documentation.
Important
Before contributing to this area of the repository, please see the related discussion on the Arrow developer mailing list and the Arrow GitHub issue listing the tasks that are a part of this effort.