Skip to content

GH-46475: [Documentation][C++][Compute] Consolidate Acero developer docs #46476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+1,235 −1,232
Open

GH-46475: [Documentation][C++][Compute] Consolidate Acero developer docs #46476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/source/cpp/streaming_execution.rst → docs/source/cpp/acero.rst
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note this is renamed from "streaming_execution.rst" to "acero.rst" which is more explicit (and shorter). Because "Acero" has become a much more well-known name I assume.

Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,3 @@ be formulated and executed.
acero/overview
acero/user_guide
acero/substrait
acero/developer_guide
692 changes: 0 additions & 692 deletions docs/source/cpp/acero/developer_guide.rst
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/cpp/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ User Guide
tables
compute
gandiva
streaming_execution
acero
io
ipc
orc
Expand Down
1,201 changes: 668 additions & 533 deletions docs/source/developers/cpp/acero.rst
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file is moved from "docs/source/cpp/acero/developer_guide.rst" with two small tweaks:

  1. Changing the title from "Developer’s Guide" to "Developing Acero" (which is more aligned with the naming of other docs at the same level).
  2. Adding the "Others" section at the bottom as a TOC to enclose sub-docs which are too elaborate to be inlined (currently only swiss_table.rst).

Please note the original "acero.rst" was moved to "acero/swiss_table.rst" (I was thinking about inlining it however found it too long), but git doesn't recognize this pattern and shows many diffs. The actual changes are just the two places mentioned above.

Large diffs are not rendered by default.

0 ...urce/developers/cpp/img/swiss_table_1.jpg → ...evelopers/cpp/acero/img/swiss_table_1.jpg
View file
Open in desktop
File renamed without changes
0 ...rce/developers/cpp/img/swiss_table_10.jpg → ...velopers/cpp/acero/img/swiss_table_10.jpg
View file
Open in desktop
File renamed without changes
0 ...rce/developers/cpp/img/swiss_table_11.jpg → ...velopers/cpp/acero/img/swiss_table_11.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_2.jpg → ...evelopers/cpp/acero/img/swiss_table_2.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_3.jpg → ...evelopers/cpp/acero/img/swiss_table_3.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_4.jpg → ...evelopers/cpp/acero/img/swiss_table_4.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_5.jpg → ...evelopers/cpp/acero/img/swiss_table_5.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_6.jpg → ...evelopers/cpp/acero/img/swiss_table_6.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_7.jpg → ...evelopers/cpp/acero/img/swiss_table_7.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_8.jpg → ...evelopers/cpp/acero/img/swiss_table_8.jpg
View file
Open in desktop
File renamed without changes
0 ...urce/developers/cpp/img/swiss_table_9.jpg → ...evelopers/cpp/acero/img/swiss_table_9.jpg
View file
Open in desktop
File renamed without changes
561 changes: 561 additions & 0 deletions docs/source/developers/cpp/acero/swiss_table.rst
View file
Open in desktop
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned in other comment, this is renamed from "developers/cpp/acero.rst".

Large diffs are not rendered by default.

0 docs/source/cpp/acero/async.md → docs/source/developers/cpp/img/async.md
View file
Open in desktop
File renamed without changes.
0 docs/source/cpp/acero/async.svg → docs/source/developers/cpp/img/async.svg
View file
Open in desktop
File renamed without changes
0 docs/source/cpp/acero/dist_plan.svg → docs/source/developers/cpp/img/dist_plan.svg
View file
Open in desktop
File renamed without changes
0 docs/source/cpp/acero/microbatch.svg → .../source/developers/cpp/img/microbatch.svg
View file
Open in desktop
File renamed without changes
0 docs/source/cpp/acero/ordered.svg → docs/source/developers/cpp/img/ordered.svg
View file
Open in desktop
File renamed without changes
0 docs/source/cpp/acero/pipeline.svg → docs/source/developers/cpp/img/pipeline.svg
View file
Open in desktop
File renamed without changes
0 docs/source/cpp/acero/pipeline_task.svg → ...urce/developers/cpp/img/pipeline_task.svg
View file
Open in desktop
File renamed without changes
4 changes: 2 additions & 2 deletions docs/source/java/substrait.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
Substrait
=========

The ``arrow-dataset`` module can execute Substrait_ plans via the :doc:`Acero <../cpp/streaming_execution>`
The ``arrow-dataset`` module can execute Substrait_ plans via the :doc:`Acero <../cpp/acero>`
query engine.

.. contents::
Expand Down Expand Up @@ -199,5 +199,5 @@ This Java program:

.. _`Substrait`: https://substrait.io/
.. _`Substrait Java`: https://github.com/substrait-io/substrait-java
.. _`Acero`: https://arrow.apache.org/docs/cpp/streaming_execution.html
.. _`Acero`: https://arrow.apache.org/docs/cpp/acero.html
.. _`Extended Expression`: https://github.com/substrait-io/substrait/blob/main/site/docs/expressions/extended_expression.md
2 changes: 1 addition & 1 deletion docs/source/python/api/acero.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ and to execute this efficiently in a batched manner.

.. seealso::

:doc:`Acero C++ user guide <../../cpp/streaming_execution>`
:doc:`Acero C++ user guide <../../cpp/acero>`

:ref:`api.substrait`
Alternative way to run Acero from a standardized Substrait plan.
4 changes: 2 additions & 2 deletions docs/source/python/integration/substrait.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The ``arrow-substrait`` module implements support for the Substrait_ format,
enabling conversion to and from Arrow objects.

The ``arrow-dataset`` module can execute Substrait_ plans via the
:doc:`Acero <../cpp/streaming_execution>` query engine.
:doc:`Acero <../cpp/acero>` query engine.

.. contents::

Expand Down Expand Up @@ -245,5 +245,5 @@ the expressions can be passed to the dataset scanner in the form of

.. _`Substrait`: https://substrait.io/
.. _`Substrait Python`: https://github.com/substrait-io/substrait-python
.. _`Acero`: https://arrow.apache.org/docs/cpp/streaming_execution.html
.. _`Acero`: https://arrow.apache.org/docs/cpp/acero.html
.. _`Extended Expression`: https://github.com/substrait-io/substrait/blob/main/site/docs/expressions/extended_expression.md