Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
velox committed Dec 7, 2024
1 parent 47ded12 commit fe0c1e1
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/_sources/configs.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Generic Configuration
- Maximum number of bytes to use for the normalized key in prefix-sort. Use 0 to disable prefix-sort.
* - prefixsort_min_rows
- integer
- 130
- 128
- Minimum number of rows to use prefix-sort. The default value has been derived using micro-benchmarking.

.. _expression-evaluation-conf:
Expand Down
15 changes: 15 additions & 0 deletions docs/_sources/monitoring/stats.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -190,3 +190,18 @@ These stats are reported by shuffle operators.
- Indicates the vector serde kind used by an operator for shuffle with 1
for Presto, 2 for CompactRow, 3 for UnsafeRow. It is reported by Exchange,
MergeExchange and PartitionedOutput operators for now.

PrefixSort
----------
These stats are reported by prefix sort.

.. list-table::
:widths: 50 25 50
:header-rows: 1

* - Stats
- Unit
- Description
* - numPrefixSortKeys
-
- The number of columns sorted using prefix sort.
2 changes: 1 addition & 1 deletion docs/configs.html
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ <h2>Generic Configuration<a class="headerlink" href="#generic-configuration" tit
</tr>
<tr class="row-odd"><td><p>prefixsort_min_rows</p></td>
<td><p>integer</p></td>
<td><p>130</p></td>
<td><p>128</p></td>
<td><p>Minimum number of rows to use prefix-sort. The default value has been derived using micro-benchmarking.</p></td>
</tr>
</tbody>
Expand Down
24 changes: 24 additions & 0 deletions docs/monitoring/stats.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,29 @@ <h2>Shuffle<a class="headerlink" href="#shuffle" title="Link to this heading">¶
</tbody>
</table>
</section>
<section id="prefixsort">
<h2>PrefixSort<a class="headerlink" href="#prefixsort" title="Link to this heading"></a></h2>
<p>These stats are reported by prefix sort.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 40.0%" />
<col style="width: 20.0%" />
<col style="width: 40.0%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Stats</p></th>
<th class="head"><p>Unit</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>numPrefixSortKeys</p></td>
<td></td>
<td><p>The number of columns sorted using prefix sort.</p></td>
</tr>
</tbody>
</table>
</section>
</section>


Expand All @@ -314,6 +337,7 @@ <h3><a href="../index.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#tablewriter">TableWriter</a></li>
<li><a class="reference internal" href="#spilling">Spilling</a></li>
<li><a class="reference internal" href="#shuffle">Shuffle</a></li>
<li><a class="reference internal" href="#prefixsort">PrefixSort</a></li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

0 comments on commit fe0c1e1

Please sign in to comment.