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 16 C++
Normal View History Raw
ARROW-356: Add documentation about reading Parquet Assumes #192. Author: Uwe L. Korn <uwelk@xhochy.com> Closes #193 from xhochy/ARROW-356 and squashes the following commits: 530484f [Uwe L. Korn] Mention new setup instructions 06b2f9c [Uwe L. Korn] Add tables describing dtype support 0467e0e [Uwe L. Korn] Move installation instructions into Sphinx docs 744202a [Uwe L. Korn] Document Pandas<->Arrow conversion b5b4df5 [Uwe L. Korn] ARROW-356: Add documentation about reading Parquet
2016-11-11 14:18:09 -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-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
*************
API Reference
*************
ARROW-356: Add documentation about reading Parquet Assumes #192. Author: Uwe L. Korn <uwelk@xhochy.com> Closes #193 from xhochy/ARROW-356 and squashes the following commits: 530484f [Uwe L. Korn] Mention new setup instructions 06b2f9c [Uwe L. Korn] Add tables describing dtype support 0467e0e [Uwe L. Korn] Move installation instructions into Sphinx docs 744202a [Uwe L. Korn] Document Pandas<->Arrow conversion b5b4df5 [Uwe L. Korn] ARROW-356: Add documentation about reading Parquet
2016-11-11 14:18:09 -05:00
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
.. toctree::
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
:maxdepth: 3
ARROW-356: Add documentation about reading Parquet Assumes #192. Author: Uwe L. Korn <uwelk@xhochy.com> Closes #193 from xhochy/ARROW-356 and squashes the following commits: 530484f [Uwe L. Korn] Mention new setup instructions 06b2f9c [Uwe L. Korn] Add tables describing dtype support 0467e0e [Uwe L. Korn] Move installation instructions into Sphinx docs 744202a [Uwe L. Korn] Document Pandas<->Arrow conversion b5b4df5 [Uwe L. Korn] ARROW-356: Add documentation about reading Parquet
2016-11-11 14:18:09 -05:00
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
api/support
ARROW-3834: [Doc] Merge C++ and Python documentation Author: Uwe L. Korn <uwelk@xhochy.com> Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Wes McKinney <wesm+git@apache.org> Closes #2856 from xhochy/doc-merge and squashes the following commits: 5b687ffa7 <Wes McKinney> Add simple README for the format/ directory 071d16ad7 <Uwe L. Korn> Move format specifications back to /format/ 337088bfd <Uwe L. Korn> Review comments fbe99c96c <Uwe L. Korn> Add more C++ docs 78a5eaf4b <Uwe L. Korn> Fix Python docs build 0b4dd3341 <Uwe L. Korn> Rename doc to docs 918e76244 <Uwe L. Korn> Convert format docs to reST 7aeff65ef <Uwe L. Korn> Add doc generation to docker-compose 185cba8fb <Uwe L. Korn> Add pre-commit check for RAT 671d24466 <Uwe L. Korn> Fix references to format documents bdd824c87 <Uwe L. Korn> Move doc to top-level 985d42806 <Uwe L. Korn> Move Sphinx doc to top-level directory f7d5e92d9 <Uwe L. Korn> Build C++ API docs 7850db8a6 <Uwe L. Korn> Add breathe as a requirement d4cf54259 <Uwe L. Korn> Fix linter issues fd75660e6 <Korn, Uwe> Fix Sphinx build for sphinx>=1.8 9be6fbe6f <Korn, Uwe> Merge C++ and Python documentation
2018-12-05 19:54:57 -06:00
api/memory
ARROW-14702: [Doc][C++] Document threading model Closes #12670 from westonpace/feature/ARROW-14702--document-threading-model Authored-by: Weston Pace <weston.pace@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-03-28 15:41:44 +02:00
api/thread
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
api/datatype
api/array
GH-46318: [Docs][C++] Add Extension Array/Type documents (#46319) ### Rationale for this change There are no Extension Array/Type documentation in the [API Reference page](https://arrow.apache.org/docs/cpp/api.html). ### What changes are included in this PR? Add Extension Array / Type API documents. ### Are these changes tested? No. (Add document only) ### Are there any user-facing changes? No. * GitHub Issue: #46318 Authored-by: Hiroyuki Sato <hiroysato@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
2025-05-06 23:24:56 +09:00
api/extension
ARROW-8989: [C++][Doc] Document available compute functions Also fix glaring bugs in arithmetic kernels (signed overflow detection was broken). Closes #7695 from pitrou/ARROW-8989-doc-compute-functions Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Wes McKinney <wesm@apache.org>
2020-07-13 12:48:30 -05:00
api/scalar
ARROW-3986: [C++] Write prose documentation Author: Antoine Pitrou <antoine@python.org> Closes #3149 from pitrou/ARROW-3986-cpp-prose-doc and squashes the following commits: 77e37940 <Antoine Pitrou> ARROW-3986: Write prose documentation
2018-12-11 15:16:06 +01:00
api/builder
ARROW-3986: [C++] Document memory management and table APIs Author: Antoine Pitrou <antoine@python.org> Closes #3159 from pitrou/ARROW-3986-more-prose-documentation and squashes the following commits: 4e8ff421d <Antoine Pitrou> ARROW-3986: Document memory management and table APIs
2018-12-12 10:58:11 -06:00
api/table
ARROW-9761: [C/C++] Add experimental C stream inferface The goal is to have a standardized ABI to communicate streams of homogeneous arrays or record batches (for example for database result sets). The trickiest part is error reporting. This proposal tries to strike a compromise between simplicity (an integer error code mapping to errno values) and expressivity (an optional description string for application-specific and context-specific details). Closes #8052 from pitrou/ARROW-9761-c-array-stream Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-10-01 12:00:12 +02:00
api/c_abi
ARROW-8989: [C++][Doc] Document available compute functions Also fix glaring bugs in arithmetic kernels (signed overflow detection was broken). Closes #7695 from pitrou/ARROW-8989-doc-compute-functions Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Wes McKinney <wesm@apache.org>
2020-07-13 12:48:30 -05:00
api/compute
GH-32335: [C++][Docs] Add design document for Acero (#35320) ### Rationale for this change The documentation for Acero was incomplete. This PR refactors the existing documentation and adds several entirely new sections to form a complete design document for Acero. ### What changes are included in this PR? Some existing documentation is cleaned up. Acero documentation is moved into its own folder and broken into several pages. ### Are these changes tested? The documentation is built as part of the CI but I wouldn't say it is fully tested. ### Are there any user-facing changes? There are not code changes (other than the removal of two legacy methods) but there are many user-facing documentation changes. * Closes: #32335 Lead-authored-by: Weston Pace <weston.pace@gmail.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Signed-off-by: Weston Pace <weston.pace@gmail.com>
2023-05-19 08:49:42 -07:00
api/acero
ARROW-17812: [Gandiva][Docs] Add C++ Gandiva User Guide (#14200) Lead-authored-by: Will Jones <willjones127@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Will Jones <willjones127@gmail.com>
2022-11-08 15:12:17 -08:00
api/gandiva
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
api/tensor
ARROW-4307: [C++] Fix Doxygen warnings Also document a few more C++ classes, and turn Doxygen warnings into errors. Author: Antoine Pitrou <antoine@python.org> Closes #3446 from pitrou/ARROW-4307-fix-doxygen-warnings and squashes the following commits: c2bb03e4c <Antoine Pitrou> ARROW-4307: Fix Doxygen warnings
2019-01-22 18:30:14 -06:00
api/utilities
ARROW-15435: [C++][Doc] Improve API docs coverage Add some classes or functions that were missing. Some parts of the public API, such as pretty-printing, are still uncovered and should be handled in individual JIRAs. Closes #12273 from pitrou/ARROW-15435-cpp-api-docs-coverage Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2022-01-27 16:27:02 +01:00
api/async
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
api/io
ARROW-10887: [Doc][C++] Document C++ IPC API Also add some tables of contents here and there for long nested documents. Closes #8914 from pitrou/ARROW-10887-doc-ipc-api Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2020-12-16 14:00:08 +01:00
api/ipc
ARROW-6630: [Doc] Document C++ file formats Closes #5500 from pitrou/ARROW-6630-file-format-docs and squashes the following commits: aa5c57dc2 <Antoine Pitrou> ARROW-6630: Document C++ file formats Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-09-25 18:31:36 +02:00
api/formats
ARROW-4307: [C++] Fix Doxygen warnings Also document a few more C++ classes, and turn Doxygen warnings into errors. Author: Antoine Pitrou <antoine@python.org> Closes #3446 from pitrou/ARROW-4307-fix-doxygen-warnings and squashes the following commits: c2bb03e4c <Antoine Pitrou> ARROW-4307: Fix Doxygen warnings
2019-01-22 18:30:14 -06:00
api/cuda
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
api/flight
ARROW-14698: [Docs][FlightRPC] Add API docs for Flight SQL This improves the protocol docs and adds C++ API documentation. Java already has Javadocs so this PR doesn't touch anything there. Closes #12616 from lidavidm/arrow-14698 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2022-04-08 11:31:54 -04:00
api/flightsql
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
api/filesystem
ARROW-11677: [C++][Docs] Add basic C++ datasets documentation This is mostly based on the Python documentation. This also adds a new C++ example to accompany the documentation. Closes #9810 from lidavidm/arrow-11677 Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: David Li <li.davidm96@gmail.com>
2021-04-14 09:30:32 -04:00
api/dataset
Reference in New Issue Copy Permalink