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 2023/06/06 19:00:04 UTC
[arrow-datafusion] branch asf-site updated: Publish built docs triggered by 44b83a10a665203b2ad069b642295cf2108e5273
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 a3b918520b Publish built docs triggered by 44b83a10a665203b2ad069b642295cf2108e5273
a3b918520b is described below
commit a3b918520b30d0ba83efd81f6199627dc30ed22a
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Tue Jun 6 18:59:57 2023 +0000
Publish built docs triggered by 44b83a10a665203b2ad069b642295cf2108e5273
---
_sources/user-guide/expressions.md.txt | 20 +
_sources/user-guide/sql/scalar_functions.md.txt | 243 +++++++++-
searchindex.js | 2 +-
user-guide/expressions.html | 62 +++
user-guide/sql/index.html | 1 +
user-guide/sql/scalar_functions.html | 572 +++++++++++++++++++++---
6 files changed, 828 insertions(+), 72 deletions(-)
diff --git a/_sources/user-guide/expressions.md.txt b/_sources/user-guide/expressions.md.txt
index f2305cb908..07f5923a6a 100644
--- a/_sources/user-guide/expressions.md.txt
+++ b/_sources/user-guide/expressions.md.txt
@@ -177,6 +177,26 @@ Unlike to some databases the math functions in Datafusion works the same way as
| trim(string) | Removes all characters, space by default from the string (`string`) |
| upper | Converts all characters in the string into upper case. Example: `upper('hello') -> HELLO` |
+## Array Expressions
+
+| Function | Notes |
+| ------------------------------------ | --------------------------------------------------------------- |
+| array_append(array, element) | Appends an element to the end of an array. |
+| array_concat(array[, ..., array_n]) | Concatenates arrays. |
+| array_dims(array) | Returns an array of the array's dimensions. |
+| array_fill(element, array) | Returns an array filled with copies of the given value. |
+| array_length(array, dimension) | Returns the length of the array dimension. |
+| array_ndims(array) | Returns the number of dimensions of the array. |
+| array_position(array, element) | Searches for an element in the array, returns first occurrence. |
+| array_positions(array, element) | Searches for an element in the array, returns all occurrences. |
+| array_prepend(array, element) | Prepends an element to the beginning of an array. |
+| array_remove(array, element) | Removes all elements equal to the given value from the array. |
+| array_replace(array, from, to) | Replaces a specified element with another specified element. |
+| array_to_string(array, delimeter) | Converts each element to its text representation. |
+| cardinality(array) | Returns the total number of elements in the array. |
+| make_array(value1, [value2 [, ...]]) | Returns an Arrow array using the specified input expressions. |
+| trim_array(array, n) | Removes the last n elements from the array. |
+
## Regular Expressions
| Function | Notes |
diff --git a/_sources/user-guide/sql/scalar_functions.md.txt b/_sources/user-guide/sql/scalar_functions.md.txt
index cbf9e2fa18..4b2a556806 100644
--- a/_sources/user-guide/sql/scalar_functions.md.txt
+++ b/_sources/user-guide/sql/scalar_functions.md.txt
@@ -1376,6 +1376,234 @@ from_unixtime(expression)
- **expression**: Expression to operate on.
Can be a constant, column, or function, and any combination of arithmetic operators.
+## Array Functions
+
+- [array_append](#array_append)
+- [array_concat](#array_concat)
+- [array_dims](#array_dims)
+- [array_fill](#array_fill)
+- [array_length](#array_length)
+- [array_ndims](#array_ndims)
+- [array_position](#array_position)
+- [array_positions](#array_positions)
+- [array_prepend](#array_prepend)
+- [array_remove](#array_remove)
+- [array_replace](#array_replace)
+- [array_to_string](#array_to_string)
+- [cardinality](#cardinality)
+- [make_array](#make_array)
+- [trim_array](#trim_array)
+
+### `array_append`
+
+Appends an element to the end of an array.
+
+```
+array_append(array, element)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **element**: Element to append to the array.
+
+### `array_concat`
+
+Concatenates arrays.
+
+```
+array_concat(array[, ..., array_n])
+```
+
+#### Arguments
+
+- **array**: Array expression to concatenate.
+ Can be a constant, column, or function, and any combination of array operators.
+- **array_n**: Subsequent array column or literal array to concatenate.
+
+### `array_dims`
+
+Returns an array of the array's dimensions.
+
+```
+array_dims(array)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+
+### `array_fill`
+
+Returns an array filled with copies of the given value.
+
+```
+array_fill(element, array)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **element**: Element to copy to the array.
+
+### `array_length`
+
+Returns the length of the array dimension.
+
+```
+array_length(array, dimension)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **dimension**: Array dimension.
+
+### `array_ndims`
+
+Returns the number of dimensions of the array.
+
+```
+array_ndims(array, element)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+
+### `array_position`
+
+Returns a string with an input string repeated a specified number.
+
+```
+array_position(array, element)
+array_position(array, element, index)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **element**: Element to search for position in the array.
+- **index**: Index at which to start searching.
+
+### `array_positions`
+
+Searches for an element in the array, returns all occurrences.
+
+```
+array_positions(array, element)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **element**: Element to search for positions in the array.
+
+### `array_prepend`
+
+Prepends an element to the beginning of an array.
+
+```
+array_prepend(element, array)
+```
+
+#### Arguments
+
+- **element**: Element to prepend to the array.
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+
+### `array_remove`
+
+Removes all elements equal to the given value from the array.
+
+```
+array_remove(array, element)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **element**: Element to be removed from the array.
+
+### `array_replace`
+
+Replaces a specified element with another specified element.
+
+```
+array_replace(array, from, to)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **from**: Initial element.
+- **to**: Final element.
+
+### `array_to_string`
+
+Converts each element to its text representation.
+
+```
+array_to_string(array, delimeter)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **delimeter**: Array element separator.
+
+### `cardinality`
+
+Returns the total number of elements in the array.
+
+```
+cardinality(array)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+
+### `make_array`
+
+Returns an Arrow array using the specified input expressions.
+
+```
+make_array(expression1[, ..., expression_n])
+```
+
+#### Arguments
+
+- **expression_n**: Expression to include in the output array.
+ Can be a constant, column, or function, and any combination of arithmetic or
+ string operators.
+
+### `trim_array`
+
+Removes the last n elements from the array.
+
+```
+trim_array(array, n)
+```
+
+#### Arguments
+
+- **array**: Array expression.
+ Can be a constant, column, or function, and any combination of array operators.
+- **n**: Element to trim the array.
+
## Hashing Functions
- [digest](#digest)
@@ -1476,25 +1704,10 @@ sha512(expression)
## Other Functions
-- [make_array](#make_array)
- [arrow_cast](#arrow_cast)
- [arrow_typeof](#arrow_typeof)
- [struct](#struct)
-### `make_array`
-
-Returns an Arrow array using the specified input expressions.
-
-```
-make_array(expression1[, ..., expression_n])
-```
-
-#### Arguments
-
-- **expression_n**: Expression to include in the output array.
- Can be a constant, column, or function, and any combination of arithmetic or
- string operators.
-
### `arrow_cast`
Casts a value to a specific Arrow data type:
diff --git a/searchindex.js b/searchindex.js
index b2e8a9ed0d..0c13ae68ae 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", "user-guide/cli", "user-guide/configs", "user-guide/dataframe", "user-guide/example-usage", "user-guide/expressions", "user-guide/faq", "use [...]
\ 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", "user-guide/cli", "user-guide/configs", "user-guide/dataframe", "user-guide/example-usage", "user-guide/expressions", "user-guide/faq", "use [...]
\ No newline at end of file
diff --git a/user-guide/expressions.html b/user-guide/expressions.html
index 3c101f6eb2..21bcc2e963 100644
--- a/user-guide/expressions.html
+++ b/user-guide/expressions.html
@@ -335,6 +335,11 @@
String Expressions
</a>
</li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-expressions">
+ Array Expressions
+ </a>
+ </li>
<li class="toc-h2 nav-item toc-entry">
<a class="reference internal nav-link" href="#regular-expressions">
Regular Expressions
@@ -803,6 +808,63 @@ expressions such as <code class="docutils literal notranslate"><span class="pre"
</tbody>
</table>
</section>
+<section id="array-expressions">
+<h2>Array Expressions<a class="headerlink" href="#array-expressions" title="Permalink to this heading">¶</a></h2>
+<table class="table">
+<thead>
+<tr class="row-odd"><th class="head"><p>Function</p></th>
+<th class="head"><p>Notes</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>array_append(array, element)</p></td>
+<td><p>Appends an element to the end of an array.</p></td>
+</tr>
+<tr class="row-odd"><td><p>array_concat(array[, …, array_n])</p></td>
+<td><p>Concatenates arrays.</p></td>
+</tr>
+<tr class="row-even"><td><p>array_dims(array)</p></td>
+<td><p>Returns an array of the array’s dimensions.</p></td>
+</tr>
+<tr class="row-odd"><td><p>array_fill(element, array)</p></td>
+<td><p>Returns an array filled with copies of the given value.</p></td>
+</tr>
+<tr class="row-even"><td><p>array_length(array, dimension)</p></td>
+<td><p>Returns the length of the array dimension.</p></td>
+</tr>
+<tr class="row-odd"><td><p>array_ndims(array)</p></td>
+<td><p>Returns the number of dimensions of the array.</p></td>
+</tr>
+<tr class="row-even"><td><p>array_position(array, element)</p></td>
+<td><p>Searches for an element in the array, returns first occurrence.</p></td>
+</tr>
+<tr class="row-odd"><td><p>array_positions(array, element)</p></td>
+<td><p>Searches for an element in the array, returns all occurrences.</p></td>
+</tr>
+<tr class="row-even"><td><p>array_prepend(array, element)</p></td>
+<td><p>Prepends an element to the beginning of an array.</p></td>
+</tr>
+<tr class="row-odd"><td><p>array_remove(array, element)</p></td>
+<td><p>Removes all elements equal to the given value from the array.</p></td>
+</tr>
+<tr class="row-even"><td><p>array_replace(array, from, to)</p></td>
+<td><p>Replaces a specified element with another specified element.</p></td>
+</tr>
+<tr class="row-odd"><td><p>array_to_string(array, delimeter)</p></td>
+<td><p>Converts each element to its text representation.</p></td>
+</tr>
+<tr class="row-even"><td><p>cardinality(array)</p></td>
+<td><p>Returns the total number of elements in the array.</p></td>
+</tr>
+<tr class="row-odd"><td><p>make_array(value1, [value2 [, …]])</p></td>
+<td><p>Returns an Arrow array using the specified input expressions.</p></td>
+</tr>
+<tr class="row-even"><td><p>trim_array(array, n)</p></td>
+<td><p>Removes the last n elements from the array.</p></td>
+</tr>
+</tbody>
+</table>
+</section>
<section id="regular-expressions">
<h2>Regular Expressions<a class="headerlink" href="#regular-expressions" title="Permalink to this heading">¶</a></h2>
<table class="table">
diff --git a/user-guide/sql/index.html b/user-guide/sql/index.html
index cd75c30a1d..d66b9af1c4 100644
--- a/user-guide/sql/index.html
+++ b/user-guide/sql/index.html
@@ -377,6 +377,7 @@
<li class="toctree-l2"><a class="reference internal" href="scalar_functions.html#string-functions">String Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="scalar_functions.html#regular-expression-functions">Regular Expression Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="scalar_functions.html#time-and-date-functions">Time and Date Functions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="scalar_functions.html#array-functions">Array Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="scalar_functions.html#hashing-functions">Hashing Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="scalar_functions.html#other-functions">Other Functions</a></li>
</ul>
diff --git a/user-guide/sql/scalar_functions.html b/user-guide/sql/scalar_functions.html
index 592ba76054..7b04f099d1 100644
--- a/user-guide/sql/scalar_functions.html
+++ b/user-guide/sql/scalar_functions.html
@@ -1586,15 +1586,15 @@
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link" href="#hashing-functions">
- Hashing Functions
+ <a class="reference internal nav-link" href="#array-functions">
+ Array Functions
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
- <a class="reference internal nav-link" href="#digest">
+ <a class="reference internal nav-link" href="#array-append">
<code class="docutils literal notranslate">
<span class="pre">
- digest
+ array_append
</span>
</code>
</a>
@@ -1607,10 +1607,10 @@
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
- <a class="reference internal nav-link" href="#md5">
+ <a class="reference internal nav-link" href="#array-concat">
<code class="docutils literal notranslate">
<span class="pre">
- md5
+ array_concat
</span>
</code>
</a>
@@ -1623,10 +1623,10 @@
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
- <a class="reference internal nav-link" href="#sha224">
+ <a class="reference internal nav-link" href="#array-dims">
<code class="docutils literal notranslate">
<span class="pre">
- sha224
+ array_dims
</span>
</code>
</a>
@@ -1639,10 +1639,10 @@
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
- <a class="reference internal nav-link" href="#sha256">
+ <a class="reference internal nav-link" href="#array-fill">
<code class="docutils literal notranslate">
<span class="pre">
- sha256
+ array_fill
</span>
</code>
</a>
@@ -1655,10 +1655,10 @@
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
- <a class="reference internal nav-link" href="#sha384">
+ <a class="reference internal nav-link" href="#array-length">
<code class="docutils literal notranslate">
<span class="pre">
- sha384
+ array_length
</span>
</code>
</a>
@@ -1671,10 +1671,10 @@
</ul>
</li>
<li class="toc-h3 nav-item toc-entry">
- <a class="reference internal nav-link" href="#sha512">
+ <a class="reference internal nav-link" href="#array-ndims">
<code class="docutils literal notranslate">
<span class="pre">
- sha512
+ array_ndims
</span>
</code>
</a>
@@ -1686,29 +1686,260 @@
</li>
</ul>
</li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-position">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ array_position
+ </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="#id81">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-positions">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ array_positions
+ </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="#id82">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-prepend">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ array_prepend
+ </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="#id83">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-remove">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ array_remove
+ </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="#id84">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-replace">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ array_replace
+ </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="#id85">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#array-to-string">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ array_to_string
+ </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="#id86">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#cardinality">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ cardinality
+ </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="#id87">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#make-array">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ make_array
+ </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="#id88">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#trim-array">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ trim_array
+ </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="#id89">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry">
- <a class="reference internal nav-link" href="#other-functions">
- Other Functions
+ <a class="reference internal nav-link" href="#hashing-functions">
+ Hashing Functions
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
- <a class="reference internal nav-link" href="#make-array">
+ <a class="reference internal nav-link" href="#digest">
<code class="docutils literal notranslate">
<span class="pre">
- make_array
+ digest
</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="#id81">
+ <a class="reference internal nav-link" href="#id90">
Arguments
</a>
</li>
</ul>
</li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#md5">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ md5
+ </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="#id91">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#sha224">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ sha224
+ </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="#id92">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#sha256">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ sha256
+ </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="#id93">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#sha384">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ sha384
+ </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="#id94">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h3 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#sha512">
+ <code class="docutils literal notranslate">
+ <span class="pre">
+ sha512
+ </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="#id95">
+ Arguments
+ </a>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link" href="#other-functions">
+ Other Functions
+ </a>
+ <ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry">
<a class="reference internal nav-link" href="#arrow-cast">
<code class="docutils literal notranslate">
@@ -1719,7 +1950,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id82">
+ <a class="reference internal nav-link" href="#id96">
Arguments
</a>
</li>
@@ -1735,7 +1966,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id83">
+ <a class="reference internal nav-link" href="#id97">
Arguments
</a>
</li>
@@ -1751,7 +1982,7 @@
</a>
<ul class="nav section-nav flex-column">
<li class="toc-h4 nav-item toc-entry">
- <a class="reference internal nav-link" href="#id84">
+ <a class="reference internal nav-link" href="#id98">
Arguments
</a>
</li>
@@ -3232,6 +3463,251 @@ Can be a constant, column, or function, and any combination of arithmetic operat
</section>
</section>
</section>
+<section id="array-functions">
+<h2>Array Functions<a class="headerlink" href="#array-functions" title="Permalink to this heading">¶</a></h2>
+<ul class="simple">
+<li><p><a class="reference internal" href="#array-append">array_append</a></p></li>
+<li><p><a class="reference internal" href="#array-concat">array_concat</a></p></li>
+<li><p><a class="reference internal" href="#array-dims">array_dims</a></p></li>
+<li><p><a class="reference internal" href="#array-fill">array_fill</a></p></li>
+<li><p><a class="reference internal" href="#array-length">array_length</a></p></li>
+<li><p><a class="reference internal" href="#array-ndims">array_ndims</a></p></li>
+<li><p><a class="reference internal" href="#array-position">array_position</a></p></li>
+<li><p><a class="reference internal" href="#array-positions">array_positions</a></p></li>
+<li><p><a class="reference internal" href="#array-prepend">array_prepend</a></p></li>
+<li><p><a class="reference internal" href="#array-remove">array_remove</a></p></li>
+<li><p><a class="reference internal" href="#array-replace">array_replace</a></p></li>
+<li><p><a class="reference internal" href="#array-to-string">array_to_string</a></p></li>
+<li><p><a class="reference internal" href="#cardinality">cardinality</a></p></li>
+<li><p><a class="reference internal" href="#make-array">make_array</a></p></li>
+<li><p><a class="reference internal" href="#trim-array">trim_array</a></p></li>
+</ul>
+<section id="array-append">
+<h3><code class="docutils literal notranslate"><span class="pre">array_append</span></code><a class="headerlink" href="#array-append" title="Permalink to this heading">¶</a></h3>
+<p>Appends an element to the end of an array.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_append</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">element</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id75">
+<h4>Arguments<a class="headerlink" href="#id75" title="Permalink 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>
+<li><p><strong>element</strong>: Element to append to the array.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-concat">
+<h3><code class="docutils literal notranslate"><span class="pre">array_concat</span></code><a class="headerlink" href="#array-concat" title="Permalink to this heading">¶</a></h3>
+<p>Concatenates arrays.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_concat</span><span class="p">(</span><span class="n">array</span><span class="p">[,</span> <span class="o">...</span><span class="p">,</span> <span class="n">array_n</span><span class="p">])</span>
+</pre></div>
+</div>
+<section id="id76">
+<h4>Arguments<a class="headerlink" href="#id76" title="Permalink to this heading">¶</a></h4>
+<ul class="simple">
+<li><p><strong>array</strong>: Array expression to concatenate.
+Can be a constant, column, or function, and any combination of array operators.</p></li>
+<li><p><strong>array_n</strong>: Subsequent array column or literal array to concatenate.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-dims">
+<h3><code class="docutils literal notranslate"><span class="pre">array_dims</span></code><a class="headerlink" href="#array-dims" title="Permalink to this heading">¶</a></h3>
+<p>Returns an array of the array’s dimensions.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_dims</span><span class="p">(</span><span class="n">array</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id77">
+<h4>Arguments<a class="headerlink" href="#id77" title="Permalink 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>
+</ul>
+</section>
+</section>
+<section id="array-fill">
+<h3><code class="docutils literal notranslate"><span class="pre">array_fill</span></code><a class="headerlink" href="#array-fill" title="Permalink to this heading">¶</a></h3>
+<p>Returns an array filled with copies of the given value.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_fill</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">array</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id78">
+<h4>Arguments<a class="headerlink" href="#id78" title="Permalink 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>
+<li><p><strong>element</strong>: Element to copy to the array.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-length">
+<h3><code class="docutils literal notranslate"><span class="pre">array_length</span></code><a class="headerlink" href="#array-length" title="Permalink to this heading">¶</a></h3>
+<p>Returns the length of the array dimension.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_length</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">dimension</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id79">
+<h4>Arguments<a class="headerlink" href="#id79" title="Permalink 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>
+<li><p><strong>dimension</strong>: Array dimension.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-ndims">
+<h3><code class="docutils literal notranslate"><span class="pre">array_ndims</span></code><a class="headerlink" href="#array-ndims" title="Permalink to this heading">¶</a></h3>
+<p>Returns the number of dimensions of the array.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_ndims</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">element</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id80">
+<h4>Arguments<a class="headerlink" href="#id80" title="Permalink 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>
+</ul>
+</section>
+</section>
+<section id="array-position">
+<h3><code class="docutils literal notranslate"><span class="pre">array_position</span></code><a class="headerlink" href="#array-position" title="Permalink to this heading">¶</a></h3>
+<p>Returns a string with an input string repeated a specified number.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_position</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">element</span><span class="p">)</span>
+<span class="n">array_position</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">element</span><span class="p">,</span> <span class="n">index</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id81">
+<h4>Arguments<a class="headerlink" href="#id81" title="Permalink 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>
+<li><p><strong>element</strong>: Element to search for position in the array.</p></li>
+<li><p><strong>index</strong>: Index at which to start searching.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-positions">
+<h3><code class="docutils literal notranslate"><span class="pre">array_positions</span></code><a class="headerlink" href="#array-positions" title="Permalink to this heading">¶</a></h3>
+<p>Searches for an element in the array, returns all occurrences.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_positions</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">element</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id82">
+<h4>Arguments<a class="headerlink" href="#id82" title="Permalink 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>
+<li><p><strong>element</strong>: Element to search for positions in the array.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-prepend">
+<h3><code class="docutils literal notranslate"><span class="pre">array_prepend</span></code><a class="headerlink" href="#array-prepend" title="Permalink to this heading">¶</a></h3>
+<p>Prepends an element to the beginning of an array.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_prepend</span><span class="p">(</span><span class="n">element</span><span class="p">,</span> <span class="n">array</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id83">
+<h4>Arguments<a class="headerlink" href="#id83" title="Permalink to this heading">¶</a></h4>
+<ul class="simple">
+<li><p><strong>element</strong>: Element to prepend to the array.</p></li>
+<li><p><strong>array</strong>: Array expression.
+Can be a constant, column, or function, and any combination of array operators.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-remove">
+<h3><code class="docutils literal notranslate"><span class="pre">array_remove</span></code><a class="headerlink" href="#array-remove" title="Permalink to this heading">¶</a></h3>
+<p>Removes all elements equal to the given value from the array.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_remove</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">element</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id84">
+<h4>Arguments<a class="headerlink" href="#id84" title="Permalink 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>
+<li><p><strong>element</strong>: Element to be removed from the array.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-replace">
+<h3><code class="docutils literal notranslate"><span class="pre">array_replace</span></code><a class="headerlink" href="#array-replace" title="Permalink to this heading">¶</a></h3>
+<p>Replaces a specified element with another specified element.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_replace</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">from</span><span class="p">,</span> <span class="n">to</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id85">
+<h4>Arguments<a class="headerlink" href="#id85" title="Permalink 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>
+<li><p><strong>from</strong>: Initial element.</p></li>
+<li><p><strong>to</strong>: Final element.</p></li>
+</ul>
+</section>
+</section>
+<section id="array-to-string">
+<h3><code class="docutils literal notranslate"><span class="pre">array_to_string</span></code><a class="headerlink" href="#array-to-string" title="Permalink to this heading">¶</a></h3>
+<p>Converts each element to its text representation.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">array_to_string</span><span class="p">(</span><span class="n">array</span><span class="p">,</span> <span class="n">delimeter</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id86">
+<h4>Arguments<a class="headerlink" href="#id86" title="Permalink 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>
+<li><p><strong>delimeter</strong>: Array element separator.</p></li>
+</ul>
+</section>
+</section>
+<section id="cardinality">
+<h3><code class="docutils literal notranslate"><span class="pre">cardinality</span></code><a class="headerlink" href="#cardinality" title="Permalink to this heading">¶</a></h3>
+<p>Returns the total number of elements in the array.</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cardinality</span><span class="p">(</span><span class="n">array</span><span class="p">)</span>
+</pre></div>
+</div>
+<section id="id87">
+<h4>Arguments<a class="headerlink" href="#id87" title="Permalink 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>
+</ul>
+</section>
+</section>
+<section id="make-array">
+<h3><code class="docutils literal notranslate"><span class="pre">make_array</span></code><a class="headerlink" href="#make-array" title="Permalink to this heading">¶</a></h3>
+<p>Returns an Arrow array using the specified input expressions.</p>
+<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="id88">
+<h4>Arguments<a class="headerlink" href="#id88" title="Permalink 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>
+<section id="trim-array">
+<h3><code class="docutils literal notranslate"><span class="pre">trim_array</span></code><a class="headerlink" href="#trim-array" title="Permalink to this heading">¶</a></h3>
+<p>Removes the last n elements from the array.</p>
+<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="id89">
+<h4>Arguments<a class="headerlink" href="#id89" title="Permalink 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>
+<li><p><strong>n</strong>: Element to trim the array.</p></li>
+</ul>
+</section>
+</section>
+</section>
<section id="hashing-functions">
<h2>Hashing Functions<a class="headerlink" href="#hashing-functions" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
@@ -3248,8 +3724,8 @@ Can be a constant, column, or function, and any combination of arithmetic operat
<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="id75">
-<h4>Arguments<a class="headerlink" href="#id75" title="Permalink to this heading">¶</a></h4>
+<section id="id90">
+<h4>Arguments<a class="headerlink" href="#id90" title="Permalink 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>
@@ -3275,8 +3751,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="id76">
-<h4>Arguments<a class="headerlink" href="#id76" title="Permalink to this heading">¶</a></h4>
+<section id="id91">
+<h4>Arguments<a class="headerlink" href="#id91" title="Permalink 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>
@@ -3289,8 +3765,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="id77">
-<h4>Arguments<a class="headerlink" href="#id77" title="Permalink to this heading">¶</a></h4>
+<section id="id92">
+<h4>Arguments<a class="headerlink" href="#id92" title="Permalink 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>
@@ -3303,8 +3779,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="id78">
-<h4>Arguments<a class="headerlink" href="#id78" title="Permalink to this heading">¶</a></h4>
+<section id="id93">
+<h4>Arguments<a class="headerlink" href="#id93" title="Permalink 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>
@@ -3317,8 +3793,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="id79">
-<h4>Arguments<a class="headerlink" href="#id79" title="Permalink to this heading">¶</a></h4>
+<section id="id94">
+<h4>Arguments<a class="headerlink" href="#id94" title="Permalink 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>
@@ -3331,8 +3807,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="id80">
-<h4>Arguments<a class="headerlink" href="#id80" title="Permalink to this heading">¶</a></h4>
+<section id="id95">
+<h4>Arguments<a class="headerlink" href="#id95" title="Permalink 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>
@@ -3343,34 +3819,18 @@ Can be a constant, column, or function, and any combination of string operators.
<section id="other-functions">
<h2>Other Functions<a class="headerlink" href="#other-functions" title="Permalink to this heading">¶</a></h2>
<ul class="simple">
-<li><p><a class="reference internal" href="#make-array">make_array</a></p></li>
<li><p><a class="reference internal" href="#arrow-cast">arrow_cast</a></p></li>
<li><p><a class="reference internal" href="#arrow-typeof">arrow_typeof</a></p></li>
<li><p><a class="reference internal" href="#struct">struct</a></p></li>
</ul>
-<section id="make-array">
-<h3><code class="docutils literal notranslate"><span class="pre">make_array</span></code><a class="headerlink" href="#make-array" title="Permalink to this heading">¶</a></h3>
-<p>Returns an Arrow array using the specified input expressions.</p>
-<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="id81">
-<h4>Arguments<a class="headerlink" href="#id81" title="Permalink 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>
<section id="arrow-cast">
<h3><code class="docutils literal notranslate"><span class="pre">arrow_cast</span></code><a class="headerlink" href="#arrow-cast" title="Permalink to this heading">¶</a></h3>
<p>Casts a value to a specific Arrow data type:</p>
<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="id82">
-<h4>Arguments<a class="headerlink" href="#id82" title="Permalink to this heading">¶</a></h4>
+<section id="id96">
+<h4>Arguments<a class="headerlink" href="#id96" title="Permalink 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
@@ -3386,8 +3846,8 @@ to cast to.</p></li>
<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="id83">
-<h4>Arguments<a class="headerlink" href="#id83" title="Permalink to this heading">¶</a></h4>
+<section id="id97">
+<h4>Arguments<a class="headerlink" href="#id97" title="Permalink 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
@@ -3403,8 +3863,8 @@ For example: <code class="docutils literal notranslate"><span class="pre">c0</sp
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">struct</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="id84">
-<h4>Arguments<a class="headerlink" href="#id84" title="Permalink to this heading">¶</a></h4>
+<section id="id98">
+<h4>Arguments<a class="headerlink" href="#id98" title="Permalink 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