deploy: substrait-io/substrait@bd4b431

relations/logical_relations/index.html

@@ -199,14 +199,37 @@
 <span class=w>  </span><span class=p>}</span>
 
 <span class=p>}</span>
-</code></pre></div> </div> </div> </div> <h2 id=fetch-operation>Fetch Operation<a class=headerlink href=#fetch-operation title="Permanent link">&para;</a></h2> <p>The fetch operation eliminates records outside a desired window. Typically corresponds to a fetch/offset SQL clause. Will only returns records between the start offset and the end offset.</p> <table> <thead> <tr> <th>Signature</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>Inputs</td> <td>1</td> </tr> <tr> <td>Outputs</td> <td>1</td> </tr> <tr> <td>Property Maintenance</td> <td>Maintains distribution and orderedness.</td> </tr> <tr> <td>Direct Output Order</td> <td>Unchanged from input.</td> </tr> </tbody> </table> <h3 id=fetch-properties>Fetch Properties<a class=headerlink href=#fetch-properties title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th>Property</th> <th>Description</th> <th>Required</th> </tr> </thead> <tbody> <tr> <td>Input</td> <td>A relational input, typically with a desired orderedness property.</td> <td>Required</td> </tr> <tr> <td>Offset</td> <td>A non-negative integer. Declares the offset for retrieval of records.</td> <td>Optional, defaults to 0.</td> </tr> <tr> <td>Count</td> <td>A non-negative integer or -1. Declares the number of records that should be returned. -1 signals that ALL records should be returned.</td> <td>Required</td> </tr> </tbody> </table> <div class="tabbed-set tabbed-alternate" data-tabs=8:1><input checked=checked id=__tabbed_8_1 name=__tabbed_8 type=radio><div class=tabbed-labels><label for=__tabbed_8_1>FetchRel Message</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=kd>message</span><span class=w> </span><span class=nc>FetchRel</span><span class=w> </span><span class=p>{</span>
+</code></pre></div> </div> </div> </div> <h2 id=fetch-operation>Fetch Operation<a class=headerlink href=#fetch-operation title="Permanent link">&para;</a></h2> <p>The fetch operation eliminates records outside a desired window. Typically corresponds to a fetch/offset SQL clause. Will only returns records between the start offset and the end offset.</p> <table> <thead> <tr> <th>Signature</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>Inputs</td> <td>1</td> </tr> <tr> <td>Outputs</td> <td>1</td> </tr> <tr> <td>Property Maintenance</td> <td>Maintains distribution and orderedness.</td> </tr> <tr> <td>Direct Output Order</td> <td>Unchanged from input.</td> </tr> </tbody> </table> <h3 id=fetch-properties>Fetch Properties<a class=headerlink href=#fetch-properties title="Permanent link">&para;</a></h3> <table> <thead> <tr> <th>Property</th> <th>Description</th> <th>Required</th> </tr> </thead> <tbody> <tr> <td>Input</td> <td>A relational input, typically with a desired orderedness property.</td> <td>Required</td> </tr> <tr> <td>Offset Expression</td> <td>An expression which evaluates to a non-negative integer or null (recommended type is <code>i64</code>). Declares the offset for retrieval of records. An expression evaluating to null is treated as 0.</td> <td>Optional, defaults to a 0 literal.</td> </tr> <tr> <td>Count Expression</td> <td>An expression which evaluates to a non-negative integer or null (recommended type is <code>i64</code>). Declares the number of records that should be returned. An expression evaluating to null indicates that all records should be returned.</td> <td>Optional, defaults to a null literal.</td> </tr> </tbody> </table> <div class="tabbed-set tabbed-alternate" data-tabs=8:1><input checked=checked id=__tabbed_8_1 name=__tabbed_8 type=radio><div class=tabbed-labels><label for=__tabbed_8_1>FetchRel Message</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=kd>message</span><span class=w> </span><span class=nc>FetchRel</span><span class=w> </span><span class=p>{</span>
 <span class=w>  </span><span class=n>RelCommon</span><span class=w> </span><span class=na>common</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>1</span><span class=p>;</span>
 <span class=w>  </span><span class=n>Rel</span><span class=w> </span><span class=na>input</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>2</span><span class=p>;</span>
-<span class=w>  </span><span class=c1>// the offset expressed in number of records</span>
-<span class=w>  </span><span class=kt>int64</span><span class=w> </span><span class=na>offset</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>3</span><span class=p>;</span>
-<span class=w>  </span><span class=c1>// the amount of records to return</span>
-<span class=w>  </span><span class=c1>// use -1 to signal that ALL records should be returned</span>
-<span class=w>  </span><span class=kt>int64</span><span class=w> </span><span class=na>count</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>4</span><span class=p>;</span>
+<span class=w>  </span><span class=c1>// Note: A oneof field is inherently optional, whereas individual fields</span>
+<span class=w>  </span><span class=c1>// within a oneof cannot be marked as optional. The unset state of offset</span>
+<span class=w>  </span><span class=c1>// should therefore be checked at the oneof level. Unset is treated as 0.</span>
+<span class=w>  </span><span class=k>oneof</span><span class=w> </span><span class=n>offset_mode</span><span class=w> </span><span class=p>{</span>
+<span class=w>    </span><span class=c1>// the offset expressed in number of records</span>
+<span class=w>    </span><span class=c1>// Deprecated: use `offset_expr` instead</span>
+<span class=w>    </span><span class=kt>int64</span><span class=w> </span><span class=na>offset</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>3</span><span class=w> </span><span class=p>[</span><span class=na>deprecated</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kc>true</span><span class=p>];</span>
+<span class=w>    </span><span class=c1>// Expression evaluated into a non-negative integer specifying the number</span>
+<span class=w>    </span><span class=c1>// of records to skip. An expression evaluating to null is treated as 0.</span>
+<span class=w>    </span><span class=c1>// Evaluating to a negative integer should result in an error.</span>
+<span class=w>    </span><span class=c1>// Recommended type for offset is int64.</span>
+<span class=w>    </span><span class=n>Expression</span><span class=w> </span><span class=na>offset_expr</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>5</span><span class=p>;</span>
+<span class=w>  </span><span class=p>}</span>
+<span class=w>  </span><span class=c1>// Note: A oneof field is inherently optional, whereas individual fields</span>
+<span class=w>  </span><span class=c1>// within a oneof cannot be marked as optional. The unset state of count</span>
+<span class=w>  </span><span class=c1>// should therefore be checked at the oneof level. Unset is treated as ALL.</span>
+<span class=w>  </span><span class=k>oneof</span><span class=w> </span><span class=n>count_mode</span><span class=w> </span><span class=p>{</span>
+<span class=w>    </span><span class=c1>// the amount of records to return</span>
+<span class=w>    </span><span class=c1>// use -1 to signal that ALL records should be returned</span>
+<span class=w>    </span><span class=c1>// Deprecated: use `count_expr` instead</span>
+<span class=w>    </span><span class=kt>int64</span><span class=w> </span><span class=na>count</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>4</span><span class=w> </span><span class=p>[</span><span class=na>deprecated</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=kc>true</span><span class=p>];</span>
+<span class=w>    </span><span class=c1>// Expression evaluated into a non-negative integer specifying the number</span>
+<span class=w>    </span><span class=c1>// of records to return. An expression evaluating to null signals that ALL</span>
+<span class=w>    </span><span class=c1>// records should be returned.</span>
+<span class=w>    </span><span class=c1>// Evaluating to a negative integer should result in an error.</span>
+<span class=w>    </span><span class=c1>// Recommended type for count is int64.</span>
+<span class=w>    </span><span class=n>Expression</span><span class=w> </span><span class=na>count_expr</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>6</span><span class=p>;</span>
+<span class=w>  </span><span class=p>}</span>
 <span class=w>  </span><span class=n>substrait.extensions.AdvancedExtension</span><span class=w> </span><span class=na>advanced_extension</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=mi>10</span><span class=p>;</span>
 
 <span class=p>}</span>