Skip to content

docs: Add TVF documentation in develop/table-functions#27367

Merged
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-dev-table
Mar 24, 2026
Merged

docs: Add TVF documentation in develop/table-functions#27367
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-dev-table

Conversation

@steveburnett
Copy link
Copy Markdown
Contributor

@steveburnett steveburnett commented Mar 18, 2026

Description

Building on the work in #27333 , this PR adds developer documentation for table value functions (TVF) based on the Trino documentation Table Functions.

Adds a cross-reference link in https://github.com/prestodb/presto/blob/master/presto-docs/src/main/sphinx/functions/table.rst to the new page.

Motivation and Context

Adds developer documentation for TVFs in Presto.

Impact

Documentation.

Test Plan

Local doc builds.

Contributor checklist

  • Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.
  • If adding new dependencies, verified they have an OpenSSF Scorecard score of 5.0 or higher (or obtained explicit TSC approval for lower scores).

Release Notes

== RELEASE NOTES ==

General Changes
* Add developer documentation for :doc:`/developer/table-functions`. 

Summary by Sourcery

Add developer documentation for table value functions and cross-reference it from existing function documentation.

Documentation:

  • Introduce a new developer guide page describing table value functions (TVFs).
  • Link the TVF developer documentation from the general developer index and the table functions reference documentation.

@steveburnett steveburnett self-assigned this Mar 18, 2026
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Mar 18, 2026
@prestodb-ci prestodb-ci requested review from a team and ShahimSharafudeen and removed request for a team March 18, 2026 17:55
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 18, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds new developer documentation for table-valued functions (TVFs) and wires it into the existing developer and functions docs navigation, including a cross-reference from the table functions user docs.

File-Level Changes

Change Details Files
Introduce a dedicated developer documentation page for table-valued functions (TVFs).
  • Create a new Sphinx document describing how to implement and use TVFs from a developer perspective, modeled after Trino’s table functions docs
  • Document TVF concepts, syntax, and implementation guidance for Presto developers
  • Ensure the page is placed under the developer docs section and uses consistent headings/roles with existing developer docs
presto-docs/src/main/sphinx/develop/table-functions.rst
Integrate the new TVF developer documentation into the existing docs structure and cross-reference it from user-facing table functions docs.
  • Add the new TVF developer doc to the main developer docs index/navigation so it appears in the rendered sidebar/table of contents
  • Insert a cross-reference from the table functions user documentation to the new developer-focused page
  • Align link text and Sphinx directives with existing docs conventions
presto-docs/src/main/sphinx/develop.rst
presto-docs/src/main/sphinx/functions/table.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="presto-docs/src/main/sphinx/develop/table-functions.rst" line_range="273-274" />
<code_context>
+Access control
+==============
+
+The access control for table functions can be provided both on system and connector 
+level. It is based on the fully qualified table function name, which consists of 
+the catalog name, the schema name, and the function name, in the syntax of 
+catalog.schema.function.
</code_context>
<issue_to_address>
**suggestion (typo):** Clarify wording around "both on system and connector level".

Consider rephrasing to: "can be provided on both the system and connector levels."

```suggestion
The access control for table functions can be provided on both the system and connector 
levels. It is based on the fully qualified table function name, which consists of 
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Contributor

@aditi-pandit aditi-pandit left a comment

Choose a reason for hiding this comment

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

Thanks @steveburnett

@steveburnett
Copy link
Copy Markdown
Contributor Author

@tdcmeehan, please review when you can. Thanks!

@steveburnett
Copy link
Copy Markdown
Contributor Author

Note that the failing but not required CI check for the release note seems to be failing because of the Sourcery-added summary.

"com.facebook.presto.release.tasks.GenerateReleaseNotesTask Bad release notes for PR #0: expect section header, found [Summary by Sourcery]"

Perhaps the CI check needs to be revised to handle this.

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to ✅ Done in Presto Documentation Mar 24, 2026
@steveburnett steveburnett merged commit a0f735d into prestodb:master Mar 24, 2026
84 of 91 checks passed
@steveburnett steveburnett deleted the steveburnett-dev-table branch March 24, 2026 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs from:IBM PR from IBM

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

4 participants