You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by gi...@apache.org on 2024/02/29 01:01:47 UTC
(arrow-datafusion) branch asf-site updated: Publish built docs triggered by ca37ce37933f7874d404364cb8c23438baceb46d
This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 1903b8aaf5 Publish built docs triggered by ca37ce37933f7874d404364cb8c23438baceb46d
1903b8aaf5 is described below
commit 1903b8aaf5a20aad4a1e6a85caa4d19ca10b0094
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Thu Feb 29 01:01:42 2024 +0000
Publish built docs triggered by ca37ce37933f7874d404364cb8c23438baceb46d
---
_sources/user-guide/sql/scalar_functions.md.txt | 23 +++-
searchindex.js | 2 +-
user-guide/sql/scalar_functions.html | 150 +++++++++++++++---------
3 files changed, 115 insertions(+), 60 deletions(-)
diff --git a/_sources/user-guide/sql/scalar_functions.md.txt b/_sources/user-guide/sql/scalar_functions.md.txt
index 4300cc62f3..cd1fbdabea 100644
--- a/_sources/user-guide/sql/scalar_functions.md.txt
+++ b/_sources/user-guide/sql/scalar_functions.md.txt
@@ -2924,7 +2924,28 @@ empty(array)
### `generate_series`
-_Alias of [range](#range)._
+Similar to the range function, but it includes the upper bound.
+
+```
+generate_series(start, stop, step)
+```
+
+#### Arguments
+
+- **start**: start of the range
+- **end**: end of the range (included)
+- **step**: increase by step (can not be 0)
+
+#### Example
+
+```
+❯ select generate_series(1,3);
++------------------------------------+
+| generate_series(Int64(1),Int64(3)) |
++------------------------------------+
+| [1, 2, 3] |
++------------------------------------+
+```
### `list_append`
diff --git a/searchindex.js b/searchindex.js
index 3f386f3312..68a7b0a015 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["contributor-guide/architecture", "contributor-guide/communication", "contributor-guide/index", "contributor-guide/quarterly_roadmap", "contributor-guide/roadmap", "contributor-guide/specification/index", "contributor-guide/specification/invariants", "contributor-guide/specification/output-field-name-semantic", "index", "library-user-guide/adding-udfs", "library-user-guide/building-logical-plans", "library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["contributor-guide/architecture", "contributor-guide/communication", "contributor-guide/index", "contributor-guide/quarterly_roadmap", "contributor-guide/roadmap", "contributor-guide/specification/index", "contributor-guide/specification/invariants", "contributor-guide/specification/output-field-name-semantic", "index", "library-user-guide/adding-udfs", "library-user-guide/building-logical-plans", "library-user-guide/catalogs", "library-user-guide/custom-tab [...]
\ No newline at end of file
diff --git a/user-guide/sql/scalar_functions.html b/user-guide/sql/scalar_functions.html
index 453c14cf00..3f182fda57 100644
--- a/user-guide/sql/scalar_functions.html
+++ b/user-guide/sql/scalar_functions.html
@@ -2866,6 +2866,18 @@
</span>
</code>
</a>
+ <ul class="nav section-nav flex-column">
+ <li class="toc-h4 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#id188">
+ Arguments
+ </a>
+ </li>
+ <li class="toc-h4 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#id189">
+ Example
+ </a>
+ </li>
+ </ul>
</li>
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#list-append">
@@ -3156,17 +3168,17 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id188">
+ <a class="reference internal nav-link" href="#id190">
Arguments
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id189">
+ <a class="reference internal nav-link" href="#id191">
Example
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id190">
+ <a class="reference internal nav-link" href="#id192">
Aliases
</a>
</li>
@@ -3191,12 +3203,12 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id191">
+ <a class="reference internal nav-link" href="#id193">
Arguments
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id192">
+ <a class="reference internal nav-link" href="#id194">
Aliases
</a>
</li>
@@ -3221,7 +3233,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id193">
+ <a class="reference internal nav-link" href="#id195">
Arguments
</a>
</li>
@@ -3237,12 +3249,12 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id194">
+ <a class="reference internal nav-link" href="#id196">
Arguments
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id195">
+ <a class="reference internal nav-link" href="#id197">
Aliases
</a>
</li>
@@ -3265,7 +3277,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id196">
+ <a class="reference internal nav-link" href="#id198">
Arguments
</a>
</li>
@@ -3288,7 +3300,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id197">
+ <a class="reference internal nav-link" href="#id199">
Arguments
</a>
</li>
@@ -3304,7 +3316,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id198">
+ <a class="reference internal nav-link" href="#id200">
Arguments
</a>
</li>
@@ -3320,7 +3332,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id199">
+ <a class="reference internal nav-link" href="#id201">
Arguments
</a>
</li>
@@ -3336,7 +3348,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id200">
+ <a class="reference internal nav-link" href="#id202">
Arguments
</a>
</li>
@@ -3352,7 +3364,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id201">
+ <a class="reference internal nav-link" href="#id203">
Arguments
</a>
</li>
@@ -3368,7 +3380,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id202">
+ <a class="reference internal nav-link" href="#id204">
Arguments
</a>
</li>
@@ -3391,12 +3403,12 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id203">
+ <a class="reference internal nav-link" href="#id205">
Arguments
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id204">
+ <a class="reference internal nav-link" href="#id206">
Example
</a>
</li>
@@ -3412,12 +3424,12 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id205">
+ <a class="reference internal nav-link" href="#id207">
Arguments
</a>
</li>
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id206">
+ <a class="reference internal nav-link" href="#id208">
Example
</a>
</li>
@@ -6533,7 +6545,29 @@ Can be a constant, column, or function, and any combination of array operators.<
</section>
<section id="generate-series">
<h3><code class="docutils literal notranslate"><span class="pre">generate_series</span></code><a class="headerlink" href="#generate-series" title="Link to this heading">¶</a></h3>
-<p><em>Alias of <a class="reference internal" href="#range">range</a>.</em></p>
+<p>Similar to the range function, but it includes the upper bound.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">generate_series</span><span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">stop</span><span class="p">,</span> <span class="n">step</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id188">
+<h4>Arguments<a class="headerlink" href="#id188" title="Link to this heading">¶</a></h4>
+<ul class="simple">
+<li><p><strong>start</strong>: start of the range</p></li>
+<li><p><strong>end</strong>: end of the range (included)</p></li>
+<li><p><strong>step</strong>: increase by step (can not be 0)</p></li>
+</ul>
+</section>
+<section id="id189">
+<h4>Example<a class="headerlink" href="#id189" title="Link to this heading">¶</a></h4>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>❯ select generate_series(1,3);
++------------------------------------+
+| generate_series(Int64(1),Int64(3)) |
++------------------------------------+
+| [1, 2, 3] |
++------------------------------------+
+</pre></div>
+</div>
+</section>
</section>
<section id="list-append">
<h3><code class="docutils literal notranslate"><span class="pre">list_append</span></code><a class="headerlink" href="#list-append" title="Link to this heading">¶</a></h3>
@@ -6665,16 +6699,16 @@ Can be a constant, column, or function, and any combination of array operators.<
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">make_array</span><span class="p">(</span><span class="n">expression1</span><span class="p">[,</span> <span class="o">...</span><span class="p">,</span> <span class="n">expression_n</span><span class="p">])</span>
</pre></div>
</div>
-<section id="id188">
-<h4>Arguments<a class="headerlink" href="#id188" title="Link to this heading">¶</a></h4>
+<section id="id190">
+<h4>Arguments<a class="headerlink" href="#id190" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression_n</strong>: Expression to include in the output array.
Can be a constant, column, or function, and any combination of arithmetic or
string operators.</p></li>
</ul>
</section>
-<section id="id189">
-<h4>Example<a class="headerlink" href="#id189" title="Link to this heading">¶</a></h4>
+<section id="id191">
+<h4>Example<a class="headerlink" href="#id191" title="Link to this heading">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>❯ select make_array(1, 2, 3, 4, 5);
+----------------------------------------------------------+
| make_array(Int64(1),Int64(2),Int64(3),Int64(4),Int64(5)) |
@@ -6684,8 +6718,8 @@ string operators.</p></li>
</pre></div>
</div>
</section>
-<section id="id190">
-<h4>Aliases<a class="headerlink" href="#id190" title="Link to this heading">¶</a></h4>
+<section id="id192">
+<h4>Aliases<a class="headerlink" href="#id192" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p>make_list</p></li>
</ul>
@@ -6701,16 +6735,16 @@ string operators.</p></li>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">starts_with</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">delimiter</span><span class="p">[,</span> <span class="n">null_str</span><span class="p">])</span>
</pre></div>
</div>
-<section id="id191">
-<h4>Arguments<a class="headerlink" href="#id191" title="Link to this heading">¶</a></h4>
+<section id="id193">
+<h4>Arguments<a class="headerlink" href="#id193" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>str</strong>: String expression to split.</p></li>
<li><p><strong>delimiter</strong>: Delimiter string to split on.</p></li>
<li><p><strong>null_str</strong>: Substring values to be replaced with <code class="docutils literal notranslate"><span class="pre">NULL</span></code></p></li>
</ul>
</section>
-<section id="id192">
-<h4>Aliases<a class="headerlink" href="#id192" title="Link to this heading">¶</a></h4>
+<section id="id194">
+<h4>Aliases<a class="headerlink" href="#id194" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p>string_to_list</p></li>
</ul>
@@ -6727,8 +6761,8 @@ string operators.</p></li>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">trim_array</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">n</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id193">
-<h4>Arguments<a class="headerlink" href="#id193" title="Link to this heading">¶</a></h4>
+<section id="id195">
+<h4>Arguments<a class="headerlink" href="#id195" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>array</strong>: Array expression.
Can be a constant, column, or function, and any combination of array operators.</p></li>
@@ -6741,16 +6775,16 @@ Can be a constant, column, or function, and any combination of array operators.<
<p>Returns an Arrow array between start and stop with step. <code class="docutils literal notranslate"><span class="pre">SELECT</span> <span class="pre">range(2,</span> <span class="pre">10,</span> <span class="pre">3)</span> <span class="pre">-></span> <span class="pre">[2,</span> <span class="pre">5,</span> <span class="pre">8]</span></code></p>
<p>The range start..end contains all values with start <= x < end. It is empty if start >= end.</p>
<p>Step can not be 0 (then the range will be nonsense.).</p>
-<section id="id194">
-<h4>Arguments<a class="headerlink" href="#id194" title="Link to this heading">¶</a></h4>
+<section id="id196">
+<h4>Arguments<a class="headerlink" href="#id196" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>start</strong>: start of the range</p></li>
<li><p><strong>end</strong>: end of the range (not included)</p></li>
<li><p><strong>step</strong>: increase by step (can not be 0)</p></li>
</ul>
</section>
-<section id="id195">
-<h4>Aliases<a class="headerlink" href="#id195" title="Link to this heading">¶</a></h4>
+<section id="id197">
+<h4>Aliases<a class="headerlink" href="#id197" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p>generate_series</p></li>
</ul>
@@ -6789,8 +6823,8 @@ a struct type of fields <code class="docutils literal notranslate"><span class="
<span class="o">+-----------------+</span>
</pre></div>
</div>
-<section id="id196">
-<h4>Arguments<a class="headerlink" href="#id196" title="Link to this heading">¶</a></h4>
+<section id="id198">
+<h4>Arguments<a class="headerlink" href="#id198" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression_n</strong>: Expression to include in the output struct.
Can be a constant, column, or function, and any combination of arithmetic or
@@ -6815,8 +6849,8 @@ string operators.</p></li>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">digest</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">algorithm</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id197">
-<h4>Arguments<a class="headerlink" href="#id197" title="Link to this heading">¶</a></h4>
+<section id="id199">
+<h4>Arguments<a class="headerlink" href="#id199" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: String expression to operate on.
Can be a constant, column, or function, and any combination of string operators.</p></li>
@@ -6842,8 +6876,8 @@ Must be one of:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">md5</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id198">
-<h4>Arguments<a class="headerlink" href="#id198" title="Link to this heading">¶</a></h4>
+<section id="id200">
+<h4>Arguments<a class="headerlink" href="#id200" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: String expression to operate on.
Can be a constant, column, or function, and any combination of string operators.</p></li>
@@ -6856,8 +6890,8 @@ Can be a constant, column, or function, and any combination of string operators.
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sha224</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id199">
-<h4>Arguments<a class="headerlink" href="#id199" title="Link to this heading">¶</a></h4>
+<section id="id201">
+<h4>Arguments<a class="headerlink" href="#id201" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: String expression to operate on.
Can be a constant, column, or function, and any combination of string operators.</p></li>
@@ -6870,8 +6904,8 @@ Can be a constant, column, or function, and any combination of string operators.
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sha256</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id200">
-<h4>Arguments<a class="headerlink" href="#id200" title="Link to this heading">¶</a></h4>
+<section id="id202">
+<h4>Arguments<a class="headerlink" href="#id202" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: String expression to operate on.
Can be a constant, column, or function, and any combination of string operators.</p></li>
@@ -6884,8 +6918,8 @@ Can be a constant, column, or function, and any combination of string operators.
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sha384</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id201">
-<h4>Arguments<a class="headerlink" href="#id201" title="Link to this heading">¶</a></h4>
+<section id="id203">
+<h4>Arguments<a class="headerlink" href="#id203" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: String expression to operate on.
Can be a constant, column, or function, and any combination of string operators.</p></li>
@@ -6898,8 +6932,8 @@ Can be a constant, column, or function, and any combination of string operators.
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">sha512</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id202">
-<h4>Arguments<a class="headerlink" href="#id202" title="Link to this heading">¶</a></h4>
+<section id="id204">
+<h4>Arguments<a class="headerlink" href="#id204" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: String expression to operate on.
Can be a constant, column, or function, and any combination of string operators.</p></li>
@@ -6919,8 +6953,8 @@ Can be a constant, column, or function, and any combination of string operators.
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">arrow_cast</span><span class="p">(</span><span class="n">expression</span><span class="p">,</span> <span class="n">datatype</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id203">
-<h4>Arguments<a class="headerlink" href="#id203" title="Link to this heading">¶</a></h4>
+<section id="id205">
+<h4>Arguments<a class="headerlink" href="#id205" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: Expression to cast.
Can be a constant, column, or function, and any combination of arithmetic or
@@ -6929,8 +6963,8 @@ string operators.</p></li>
to cast to, as a string. The format is the same as that returned by [<code class="docutils literal notranslate"><span class="pre">arrow_typeof</span></code>]</p></li>
</ul>
</section>
-<section id="id204">
-<h4>Example<a class="headerlink" href="#id204" title="Link to this heading">¶</a></h4>
+<section id="id206">
+<h4>Example<a class="headerlink" href="#id206" title="Link to this heading">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>❯ select arrow_cast(-5, 'Int8') as a,
arrow_cast('foo', 'Dictionary(Int32, Utf8)') as b,
arrow_cast('bar', 'LargeUtf8') as c,
@@ -6952,16 +6986,16 @@ to cast to, as a string. The format is the same as that returned by [<code class
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">arrow_typeof</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span>
</pre></div>
</div>
-<section id="id205">
-<h4>Arguments<a class="headerlink" href="#id205" title="Link to this heading">¶</a></h4>
+<section id="id207">
+<h4>Arguments<a class="headerlink" href="#id207" title="Link to this heading">¶</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: Expression to evaluate.
Can be a constant, column, or function, and any combination of arithmetic or
string operators.</p></li>
</ul>
</section>
-<section id="id206">
-<h4>Example<a class="headerlink" href="#id206" title="Link to this heading">¶</a></h4>
+<section id="id208">
+<h4>Example<a class="headerlink" href="#id208" title="Link to this heading">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>❯ select arrow_typeof('foo'), arrow_typeof(1);
+---------------------------+------------------------+
| arrow_typeof(Utf8("foo")) | arrow_typeof(Int64(1)) |