Skip to content

Comments

[docs] Add admin/properties-session.rst#23811

Closed
steveburnett wants to merge 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-java-session-properties
Closed

[docs] Add admin/properties-session.rst#23811
steveburnett wants to merge 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-java-session-properties

Conversation

@steveburnett
Copy link
Contributor

@steveburnett steveburnett commented Oct 11, 2024

Description

Builds on the work in #23852 by separating the Java session properties in Properties Reference to a separate page.

How I did this:

  • Copied properties.rst and renamed it as properties-session.rst.
  • In properties.rst, deleted every sentence like This can also be specified on a per-query basis using the join_distribution_type session property. or This config property can be overridden by the join_spill_enabled session property.
  • Light revision to the introductory text at the beginning of the page, and added a link to the new properties-session.rst file.
  • Updated the admin.rst index file to include the new properties-session.rst.

In the new properties-session.rst:

  • For each entry in Properties Reference that contained a sentence like
    This can also be specified on a per-query basis using the join_distribution_type session property. , I:

    1. replaced the config property name with the session property name
    2. deleted the sentence about the session property
  • For each entry that did not contain a sentence referencing a session property, I deleted the entry.

Exceptions to the above:

  • In Properties Reference, task_writer_count and task_partitioned_writer_count appear to be session properties so I deleted them from this file and included them in properties_session.rst.
  • In Properties Reference, the current config property entries for optimizer.treat-low-confidence-zero-estimation-as-unknown and optimizer.retry-query-with-history-based-optimization describe the treat-low-confidence-zero-estimation-as-unknown session property and retry-query-with-history-based-optimization session property, which I am uncertain of because of the use of dashes instead of underscores in their names. I created entries for them in properties-session.rst, but I'd ask those session property names be checked.

NOTE: the intended scope of this PR is to separate the session properties doc from the configuration properties doc. I wasn't planning to add new doc for undocumented session properties in this PR, new entries can be added as future doc PRs.

Motivation and Context

Parallelizes the Presto doc with the Presto C++ doc structure in #23852.

Impact

Documentation.

Test Plan

Contributor checklist

  • Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
  • 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.

Release Notes

== NO RELEASE NOTE ==

Copy link
Contributor

@tdcmeehan tdcmeehan left a comment

Choose a reason for hiding this comment

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

Content looks good, let's link between the session properties and the config properties.

@steveburnett
Copy link
Contributor Author

Closing this PR as it's replaced by #23888.

@steveburnett steveburnett deleted the steveburnett-java-session-properties branch October 24, 2024 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants