docs(native): Add documentation for Presto C++ Installation #26718
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
saurabhmahawar
requested review from
a team,
elharo and
steveburnett
as code owners
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds new Sphinx documentation describing how to install and run the Presto C++ worker, including build, configuration, and integration steps, by introducing a dedicated installation guide and wiring it into the existing Presto C++ docs hierarchy. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- Since you’ve moved content under
presto_cpp/installation.rst, make surepresto-cpp.rst(and any relevant toctrees) links to this new doc so it’s discoverable from the main navigation. - Check for any existing references or deep links to
presto-cpp.rstthat should now point to the newpresto_cpp/installation.rstpath to avoid broken links in the published docs.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Since you’ve moved content under `presto_cpp/installation.rst`, make sure `presto-cpp.rst` (and any relevant toctrees) links to this new doc so it’s discoverable from the main navigation.
- Check for any existing references or deep links to `presto-cpp.rst` that should now point to the new `presto_cpp/installation.rst` path to avoid broken links in the published docs.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
steveburnett
requested changes
Dec 2, 2025
Contributor
steveburnett
left a comment
steveburnett
left a comment
There was a problem hiding this comment.
Thanks for the doc! I made a lot of notes, mostly formatting and phrasing to fit the tone of technical documentation. Some suggestions and ideas for you to consider.
github-project-automation
bot
moved this from 🆕 Unprioritized
to 🏗 In progress
in Presto Documentation
saurabhmahawar
force-pushed
the
presto-cpp-installation
branch
from
4a14b2d to
e3a5a8d
Compare
steveburnett
requested changes
Dec 4, 2025
Contributor
steveburnett
left a comment
steveburnett
left a comment
There was a problem hiding this comment.
Thanks for the revision! This is looking better, so this review is mostly focused on revision suggestions to improve the consistency of the tone with the rest of the Presto documentation.
I have tried to explain my comments and suggestions. Let me know if you have any questions or concerns about these and we can discuss them if you want to.
| :backlinks: none | ||
| :depth: 1 | ||
|
|
||
| This shows how to install and run a lightweight Presto cluster utilizing a PrestoDB Java Coordinator and Prestissimo (C++) Workers using Docker. |
Contributor
There was a problem hiding this comment.
Suggested change
| This shows how to install and run a lightweight Presto cluster utilizing a PrestoDB Java Coordinator and Prestissimo (C++) Workers using Docker. | |
| This shows how to install and run a lightweight Presto cluster utilizing a PrestoDB Java Coordinator and Prestissimo (Presto C++) Workers using Docker. | |
| For more information about Presto C++, see the :ref:`presto-cpp:overview`. |
This new page in the Presto documentation does not have to explain what is Prestissimo, we can refer to the existing doc for that, and focus this page on how to deploy Presto with Prestissimo workers.
|
|
||
| The setup uses Meta's high-performance Velox engine for worker-side query execution. We will configure a cluster and run a test query with the built-in TPCH connector. | ||
|
|
||
| Introducing Prestissimo (Presto C++ Worker) |
Contributor
There was a problem hiding this comment.
Please delete lines 14-23, as we are leveraging the existing doc with the new sentence in line 10.
| * Docker installed. | ||
| * Basic familiarity with the terminal and shell commands. | ||
|
|
||
| Setup Guide |
Contributor
There was a problem hiding this comment.
Delete this heading, and the formatting line below it.
| Setup Guide | ||
| ----------- | ||
|
|
||
| The recommended directory structure uses ``presto-lab`` as the root directory. |
Contributor
There was a problem hiding this comment.
Move this sentence to become the first sentence after the heading Create a Working Directory.
|
|
||
| The Coordinator requires configuration to define its role, enable the discovery service, and set up a catalog for querying. | ||
|
|
||
| A. Create Configuration Directory |
Contributor
There was a problem hiding this comment.
Suggested change
| A. Create Configuration Directory | |
| 1. Create Configuration Directory |
| * The setting ``platform: linux/amd64`` is essential for users running on Apple Silicon Macs. | ||
| * The ``volumes`` section mounts your local configuration directories (``./coordinator/etc``, ``./worker-1/etc``) into the container's expected path (``/opt/presto-server/etc``). | ||
|
|
||
| Step 5: Start the Cluster and Verify |
Contributor
There was a problem hiding this comment.
Suggested change
| Step 5: Start the Cluster and Verify | |
| Start the Cluster and Verify |
| Step 5: Start the Cluster and Verify | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| A. Start the Cluster |
Contributor
There was a problem hiding this comment.
Suggested change
| A. Start the Cluster | |
| 1. Start the Cluster |
|
|
||
| docker compose up -d | ||
|
|
||
| B. Verify |
Contributor
There was a problem hiding this comment.
Suggested change
| B. Verify | |
| 2. Verify |
|
|
||
| 1. **Check the Web UI:** Open the Presto Web UI at http://localhost:8080. | ||
|
|
||
| * *Verification Result:* You should see the UI displaying 3 Active Workers (1 Coordinator and 2 Workers). |
Contributor
There was a problem hiding this comment.
Suggested change
| * *Verification Result:* You should see the UI displaying 3 Active Workers (1 Coordinator and 2 Workers). | |
| You should see the UI displaying 3 Active Workers (1 Coordinator and 2 Workers). |
|
|
||
| * *Verification Result:* You should see the UI displaying 3 Active Workers (1 Coordinator and 2 Workers). | ||
|
|
||
| 2. **Check Detailed Node Status (SQL Query):** Run the following query to check the detailed status and metadata about every node (Coordinator and Workers). |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. **Check Detailed Node Status (SQL Query):** Run the following query to check the detailed status and metadata about every node (Coordinator and Workers). | |
| 2. **Check Detailed Node Status**: Run the following SQL query to check the detailed status and metadata about every node (Coordinator and Workers). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added new documentation explaining how to use the Presto C++ engine.
The documentation provides step-by-step instructions for configuring, and running the Presto C++ worker
Motivation and Context
There was no consolidated or beginner-friendly documentation for Presto C++ in the open-source project.
Users often had difficulty understanding how to build and run the C++ worker, what dependencies were required, and how it integrates with a Presto coordinator.
Impact
There is no performance impact.
Test Plan
Contributor checklist
Release Notes