Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
jacques-n committed Aug 10, 2024
1 parent 4d93283 commit ceb2d67
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 53 deletions.
2 changes: 1 addition & 1 deletion extensions/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<span class=w> </span><span class=nt>value</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">ext.point</span>
<span class=w> </span><span class=nt>return</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">f64</span>
</code></pre></div> <p>Here, the choice for the name <code>ext</code> is arbitrary, as long as it does not conflict with anything else in the YAML file.</p> <h3 id=function-signature-compound-names>Function Signature Compound Names<a class=headerlink href=#function-signature-compound-names title="Permanent link">&para;</a></h3> <p>A YAML file may contain one or more functions by the same name. The key used in the function extension declaration to reference a function is a combination of the name of the function along with a list of the required input argument types. The format is as follows:</p> <div class=highlight><pre><span></span><code>&lt;function name&gt;:&lt;short_arg_type0&gt;_&lt;short_arg_type1&gt;_..._&lt;short_arg_typeN&gt;
</code></pre></div> <p>Rather than using a full data type representation, the input argument types (<code>short_arg_type</code>) are mapped to single-level short name. The mappings are listed in the table below.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>Every compound function signature must be unique. If two function implementations in a YAML file would generate the same compound function signature, then the YAML file is invalid and behavior is undefined.</p> </div> <table> <thead> <tr> <th>Argument Type</th> <th>Signature Name</th> </tr> </thead> <tbody> <tr> <td>Required Enumeration</td> <td>req</td> </tr> <tr> <td>i8</td> <td>i8</td> </tr> <tr> <td>i16</td> <td>i16</td> </tr> <tr> <td>i32</td> <td>i32</td> </tr> <tr> <td>i64</td> <td>i64</td> </tr> <tr> <td>fp32</td> <td>fp32</td> </tr> <tr> <td>fp64</td> <td>fp64</td> </tr> <tr> <td>string</td> <td>str</td> </tr> <tr> <td>binary</td> <td>vbin</td> </tr> <tr> <td>boolean</td> <td>bool</td> </tr> <tr> <td>timestamp</td> <td>ts</td> </tr> <tr> <td>timestamp_tz</td> <td>tstz</td> </tr> <tr> <td>date</td> <td>date</td> </tr> <tr> <td>time</td> <td>time</td> </tr> <tr> <td>interval_year</td> <td>iyear</td> </tr> <tr> <td>interval_day</td> <td>iday</td> </tr> <tr> <td>uuid</td> <td>uuid</td> </tr> <tr> <td>fixedchar&lt;N&gt;</td> <td>fchar</td> </tr> <tr> <td>varchar&lt;N&gt;</td> <td>vchar</td> </tr> <tr> <td>fixedbinary&lt;N&gt;</td> <td>fbin</td> </tr> <tr> <td>decimal&lt;P,S&gt;</td> <td>dec</td> </tr> <tr> <td>precision_timestamp&lt;P&gt;</td> <td>pts</td> </tr> <tr> <td>precision_timestamp_tz&lt;P&gt;</td> <td>ptstz</td> </tr> <tr> <td>struct&lt;T1,T2,&hellip;,TN&gt;</td> <td>struct</td> </tr> <tr> <td>list&lt;T&gt;</td> <td>list</td> </tr> <tr> <td>map&lt;K,V&gt;</td> <td>map</td> </tr> <tr> <td>any[\d]?</td> <td>any</td> </tr> <tr> <td>user defined type</td> <td>u!name</td> </tr> </tbody> </table> <h4 id=examples>Examples<a class=headerlink href=#examples title="Permanent link">&para;</a></h4> <table> <thead> <tr> <th>Function Signature</th> <th>Function Name</th> </tr> </thead> <tbody> <tr> <td><code>add(optional enumeration, i8, i8) =&gt; i8</code></td> <td><code>add:i8_i8</code></td> </tr> <tr> <td><code>avg(fp32) =&gt; fp32</code></td> <td><code>avg:fp32</code></td> </tr> <tr> <td><code>extract(required enumeration, timestamp) =&gt; i64</code></td> <td><code>extract:req_ts</code></td> </tr> <tr> <td><code>sum(any1) =&gt; any1</code></td> <td><code>sum:any</code></td> </tr> </tbody> </table> <h3 id=any-types>Any Types<a class=headerlink href=#any-types title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=nt>scalar_functions</span><span class=p>:</span>
</code></pre></div> <p>Rather than using a full data type representation, the input argument types (<code>short_arg_type</code>) are mapped to single-level short name. The mappings are listed in the table below.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>Every compound function signature must be unique. If two function implementations in a YAML file would generate the same compound function signature, then the YAML file is invalid and behavior is undefined.</p> </div> <table> <thead> <tr> <th>Argument Type</th> <th>Signature Name</th> </tr> </thead> <tbody> <tr> <td>Required Enumeration</td> <td>req</td> </tr> <tr> <td>i8</td> <td>i8</td> </tr> <tr> <td>i16</td> <td>i16</td> </tr> <tr> <td>i32</td> <td>i32</td> </tr> <tr> <td>i64</td> <td>i64</td> </tr> <tr> <td>fp32</td> <td>fp32</td> </tr> <tr> <td>fp64</td> <td>fp64</td> </tr> <tr> <td>string</td> <td>str</td> </tr> <tr> <td>binary</td> <td>vbin</td> </tr> <tr> <td>boolean</td> <td>bool</td> </tr> <tr> <td>timestamp</td> <td>ts</td> </tr> <tr> <td>timestamp_tz</td> <td>tstz</td> </tr> <tr> <td>date</td> <td>date</td> </tr> <tr> <td>time</td> <td>time</td> </tr> <tr> <td>interval_year</td> <td>iyear</td> </tr> <tr> <td>interval_day</td> <td>iday</td> </tr> <tr> <td>interval_compound</td> <td>icompound</td> </tr> <tr> <td>uuid</td> <td>uuid</td> </tr> <tr> <td>fixedchar&lt;N&gt;</td> <td>fchar</td> </tr> <tr> <td>varchar&lt;N&gt;</td> <td>vchar</td> </tr> <tr> <td>fixedbinary&lt;N&gt;</td> <td>fbin</td> </tr> <tr> <td>decimal&lt;P,S&gt;</td> <td>dec</td> </tr> <tr> <td>precision_timestamp&lt;P&gt;</td> <td>pts</td> </tr> <tr> <td>precision_timestamp_tz&lt;P&gt;</td> <td>ptstz</td> </tr> <tr> <td>struct&lt;T1,T2,&hellip;,TN&gt;</td> <td>struct</td> </tr> <tr> <td>list&lt;T&gt;</td> <td>list</td> </tr> <tr> <td>map&lt;K,V&gt;</td> <td>map</td> </tr> <tr> <td>any[\d]?</td> <td>any</td> </tr> <tr> <td>user defined type</td> <td>u!name</td> </tr> </tbody> </table> <h4 id=examples>Examples<a class=headerlink href=#examples title="Permanent link">&para;</a></h4> <table> <thead> <tr> <th>Function Signature</th> <th>Function Name</th> </tr> </thead> <tbody> <tr> <td><code>add(optional enumeration, i8, i8) =&gt; i8</code></td> <td><code>add:i8_i8</code></td> </tr> <tr> <td><code>avg(fp32) =&gt; fp32</code></td> <td><code>avg:fp32</code></td> </tr> <tr> <td><code>extract(required enumeration, timestamp) =&gt; i64</code></td> <td><code>extract:req_ts</code></td> </tr> <tr> <td><code>sum(any1) =&gt; any1</code></td> <td><code>sum:any</code></td> </tr> </tbody> </table> <h3 id=any-types>Any Types<a class=headerlink href=#any-types title="Permanent link">&para;</a></h3> <div class=highlight><pre><span></span><code><span class=nt>scalar_functions</span><span class=p>:</span>
<span class="p p-Indicator">-</span><span class=w> </span><span class=nt>name</span><span class=p>:</span><span class=w> </span><span class="l l-Scalar l-Scalar-Plain">foo</span>
<span class=w> </span><span class=nt>impls</span><span class=p>:</span>
<span class=w> </span><span class="p p-Indicator">-</span><span class=w> </span><span class=nt>args</span><span class=p>:</span>
Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json

Large diffs are not rendered by default.

100 changes: 50 additions & 50 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,252 +2,252 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://substrait.io/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/about/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/faq/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/governance/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/community/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/community/powered_by/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/aggregate_functions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/embedded_functions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/extended_expression/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/field_references/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/scalar_functions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/specialized_record_expressions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/subqueries/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/table_functions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/user_defined_functions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/expressions/window_functions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_aggregate_approx/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_aggregate_decimal_output/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_aggregate_generic/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_arithmetic/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_arithmetic_decimal/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_boolean/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_comparison/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_datetime/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_geometry/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_logarithmic/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_rounding/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_set/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/extensions/functions_string/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/relations/basics/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/relations/embedded_relations/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/relations/logical_relations/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/relations/physical_relations/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/relations/user_defined_relations/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/serialization/basics/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/serialization/binary_serialization/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/serialization/text_serialization/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/spec/extending/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/spec/specification/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/spec/technology_principles/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/spec/versioning/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/tools/producer_tools/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/tools/substrait_validator/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/tools/third_party_tools/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/tutorial/sql_to_substrait/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/types/type_classes/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/types/type_parsing/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/types/type_system/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://substrait.io/types/type_variations/</loc>
<lastmod>2024-08-08</lastmod>
<lastmod>2024-08-10</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
Binary file not shown.
2 changes: 1 addition & 1 deletion types/type_classes/index.html

Large diffs are not rendered by default.

0 comments on commit ceb2d67

Please sign in to comment.