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 92ebdd2ade Publish built docs triggered by
4cd3c433004a7a6825643d6b3911db720efe5f76
92ebdd2ade is described below
commit 92ebdd2ade1ddfda0923d41c1ac28f210e4d7b76
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Mon Mar 11 06:59:50 2024 +0000
Publish built docs triggered by 4cd3c433004a7a6825643d6b3911db720efe5f76
---
_sources/user-guide/expressions.md.txt | 73 +++++++++++++------------
_sources/user-guide/sql/scalar_functions.md.txt | 1 +
searchindex.js | 2 +-
user-guide/expressions.html | 5 +-
user-guide/sql/scalar_functions.html | 3 +-
5 files changed, 45 insertions(+), 39 deletions(-)
diff --git a/_sources/user-guide/expressions.md.txt
b/_sources/user-guide/expressions.md.txt
index dcb599b9b3..17da8c3fc2 100644
--- a/_sources/user-guide/expressions.md.txt
+++ b/_sources/user-guide/expressions.md.txt
@@ -207,42 +207,43 @@ select log(-1), log(0), sqrt(-1);
## Array Expressions
-| Syntax | Description
|
-| -------------------------------------- |
------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| array_append(array, element) | Appends an element to the end of an
array. `array_append([1, 2, 3], 4) -> [1, 2, 3, 4]`
|
-| array_concat(array[, ..., array_n]) | Concatenates arrays.
`array_concat([1, 2, 3], [4, 5, 6]) -> [1, 2, 3, 4, 5, 6]`
|
-| array_has(array, element) | Returns true if the array contains
the element `array_has([1,2,3], 1) -> true`
|
-| array_has_all(array, sub-array) | Returns true if all elements of
sub-array exist in array `array_has_all([1,2,3], [1,3]) -> true`
|
-| array_has_any(array, sub-array) | Returns true if any elements exist
in both arrays `array_has_any([1,2,3], [1,4]) -> true`
|
-| array_dims(array) | Returns an array of the array's
dimensions. `array_dims([[1, 2, 3], [4, 5, 6]]) -> [2, 3]`
|
-| array_distinct(array) | Returns distinct values from the
array after removing duplicates. `array_distinct([1, 3, 2, 3, 1, 2, 4]) -> [1,
2, 3, 4]` |
-| array_element(array, index) | Extracts the element with the index
n from the array `array_element([1, 2, 3, 4], 3) -> 3`
|
-| flatten(array) | Converts an array of arrays to a
flat array `flatten([[1], [2, 3], [4, 5, 6]]) -> [1, 2, 3, 4, 5, 6]`
|
-| array_length(array, dimension) | Returns the length of the array
dimension. `array_length([1, 2, 3, 4, 5]) -> 5`
|
-| array_ndims(array) | Returns the number of dimensions of
the array. `array_ndims([[1, 2, 3], [4, 5, 6]]) -> 2`
|
-| array_pop_front(array) | Returns the array without the first
element. `array_pop_front([1, 2, 3]) -> [2, 3]`
|
-| array_pop_back(array) | Returns the array without the last
element. `array_pop_back([1, 2, 3]) -> [1, 2]`
|
-| array_position(array, element) | Searches for an element in the
array, returns first occurrence. `array_position([1, 2, 2, 3, 4], 2) -> 2`
|
-| array_positions(array, element) | Searches for an element in the
array, returns all occurrences. `array_positions([1, 2, 2, 3, 4], 2) -> [2, 3]`
|
-| array_prepend(array, element) | Prepends an element to the
beginning of an array. `array_prepend(1, [2, 3, 4]) -> [1, 2, 3, 4]`
|
-| array_repeat(element, count) | Returns an array containing element
`count` times. `array_repeat(1, 3) -> [1, 1, 1]`
|
-| array_remove(array, element) | Removes the first element from the
array equal to the given value. `array_remove([1, 2, 2, 3, 2, 1, 4], 2) -> [1,
2, 3, 2, 1, 4]` |
-| array_remove_n(array, element, max) | Removes the first `max` elements
from the array equal to the given value. `array_remove_n([1, 2, 2, 3, 2, 1, 4],
2, 2) -> [1, 3, 2, 1, 4]` |
-| array_remove_all(array, element) | Removes all elements from the array
equal to the given value. `array_remove_all([1, 2, 2, 3, 2, 1, 4], 2) -> [1, 3,
1, 4]` |
-| array_replace(array, from, to) | Replaces the first occurrence of
the specified element with another specified element. `array_replace([1, 2, 2,
3, 2, 1, 4], 2, 5) -> [1, 5, 2, 3, 2, 1, 4]` |
-| array_replace_n(array, from, to, max) | Replaces the first `max`
occurrences of the specified element with another specified element.
`array_replace_n([1, 2, 2, 3, 2, 1, 4], 2, 5, 2) -> [1, 5, 5, 3, 2, 1, 4]` |
-| array_replace_all(array, from, to) | Replaces all occurrences of the
specified element with another specified element. `array_replace_all([1, 2, 2,
3, 2, 1, 4], 2, 5) -> [1, 5, 5, 3, 5, 1, 4]` |
-| array_slice(array, begin,end) | Returns a slice of the array.
`array_slice([1, 2, 3, 4, 5, 6, 7, 8], 3, 6) -> [3, 4, 5, 6]`
|
-| array_slice(array, begin, end, stride) | Returns a slice of the array with
added stride feature. `array_slice([1, 2, 3, 4, 5, 6, 7, 8], 3, 6, 2) -> [3, 5,
6]` |
-| array_to_string(array, delimiter) | Converts each element to its text
representation. `array_to_string([1, 2, 3, 4], ',') -> 1,2,3,4`
|
-| array_intersect(array1, array2) | Returns an array of the elements in
the intersection of array1 and array2. `array_intersect([1, 2, 3, 4], [5, 6, 3,
4]) -> [3, 4]` |
-| array_union(array1, array2) | Returns an array of the elements in
the union of array1 and array2 without duplicates. `array_union([1, 2, 3, 4],
[5, 6, 3, 4]) -> [1, 2, 3, 4, 5, 6]` |
-| array_except(array1, array2) | Returns an array of the elements
that appear in the first array but not in the second. `array_except([1, 2, 3,
4], [5, 6, 3, 4]) -> [3, 4]` |
-| array_resize(array, size, value) | Resizes the list to contain size
elements. Initializes new elements with value or empty if value is not set.
`array_resize([1, 2, 3], 5, 0) -> [1, 2, 3, 4, 5, 6]` |
-| cardinality(array) | Returns the total number of
elements in the array. `cardinality([[1, 2, 3], [4, 5, 6]]) -> 6`
|
-| make_array(value1, [value2 [, ...]]) | Returns an Arrow array using the
specified input expressions. `make_array(1, 2, 3) -> [1, 2, 3]`
|
-| range(start [, stop, step]) | Returns an Arrow array between
start and stop with step. `SELECT range(2, 10, 3) -> [2, 5, 8]`
|
-| trim_array(array, n) | Deprecated
|
+| Syntax | Description
|
+| ---------------------------------------------- |
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
+| array_append(array, element) | Appends an element to the
end of an array. `array_append([1, 2, 3], 4) -> [1, 2, 3, 4]`
|
+| array_concat(array[, ..., array_n]) | Concatenates arrays.
`array_concat([1, 2, 3], [4, 5, 6]) -> [1, 2, 3, 4, 5, 6]`
|
+| array_has(array, element) | Returns true if the array
contains the element `array_has([1,2,3], 1) -> true`
|
+| array_has_all(array, sub-array) | Returns true if all
elements of sub-array exist in array `array_has_all([1,2,3], [1,3]) -> true`
|
+| array_has_any(array, sub-array) | Returns true if any
elements exist in both arrays `array_has_any([1,2,3], [1,4]) -> true`
|
+| array_dims(array) | Returns an array of the
array's dimensions. `array_dims([[1, 2, 3], [4, 5, 6]]) -> [2, 3]`
|
+| array_distinct(array) | Returns distinct values
from the array after removing duplicates. `array_distinct([1, 3, 2, 3, 1, 2,
4]) -> [1, 2, 3, 4]`
|
+| array_element(array, index) | Extracts the element with
the index n from the array `array_element([1, 2, 3, 4], 3) -> 3`
|
+| flatten(array) | Converts an array of arrays
to a flat array `flatten([[1], [2, 3], [4, 5, 6]]) -> [1, 2, 3, 4, 5, 6]`
|
+| array_length(array, dimension) | Returns the length of the
array dimension. `array_length([1, 2, 3, 4, 5]) -> 5`
|
+| array_ndims(array) | Returns the number of
dimensions of the array. `array_ndims([[1, 2, 3], [4, 5, 6]]) -> 2`
|
+| array_pop_front(array) | Returns the array without
the first element. `array_pop_front([1, 2, 3]) -> [2, 3]`
|
+| array_pop_back(array) | Returns the array without
the last element. `array_pop_back([1, 2, 3]) -> [1, 2]`
|
+| array_position(array, element) | Searches for an element in
the array, returns first occurrence. `array_position([1, 2, 2, 3, 4], 2) -> 2`
|
+| array_positions(array, element) | Searches for an element in
the array, returns all occurrences. `array_positions([1, 2, 2, 3, 4], 2) -> [2,
3]`
|
+| array_prepend(array, element) | Prepends an element to the
beginning of an array. `array_prepend(1, [2, 3, 4]) -> [1, 2, 3, 4]`
|
+| array_repeat(element, count) | Returns an array containing
element `count` times. `array_repeat(1, 3) -> [1, 1, 1]`
|
+| array_remove(array, element) | Removes the first element
from the array equal to the given value. `array_remove([1, 2, 2, 3, 2, 1, 4],
2) -> [1, 2, 3, 2, 1, 4]`
|
+| array_remove_n(array, element, max) | Removes the first `max`
elements from the array equal to the given value. `array_remove_n([1, 2, 2, 3,
2, 1, 4], 2, 2) -> [1, 3, 2, 1, 4]`
|
+| array_remove_all(array, element) | Removes all elements from
the array equal to the given value. `array_remove_all([1, 2, 2, 3, 2, 1, 4], 2)
-> [1, 3, 1, 4]`
|
+| array_replace(array, from, to) | Replaces the first
occurrence of the specified element with another specified element.
`array_replace([1, 2, 2, 3, 2, 1, 4], 2, 5) -> [1, 5, 2, 3, 2, 1, 4]`
|
+| array_replace_n(array, from, to, max) | Replaces the first `max`
occurrences of the specified element with another specified element.
`array_replace_n([1, 2, 2, 3, 2, 1, 4], 2, 5, 2) -> [1, 5, 5, 3, 2, 1, 4]`
|
+| array_replace_all(array, from, to) | Replaces all occurrences of
the specified element with another specified element. `array_replace_all([1, 2,
2, 3, 2, 1, 4], 2, 5) -> [1, 5, 5, 3, 5, 1, 4]`
|
+| array_slice(array, begin,end) | Returns a slice of the
array. `array_slice([1, 2, 3, 4, 5, 6, 7, 8], 3, 6) -> [3, 4, 5, 6]`
|
+| array_slice(array, begin, end, stride) | Returns a slice of the
array with added stride feature. `array_slice([1, 2, 3, 4, 5, 6, 7, 8], 3, 6,
2) -> [3, 5, 6]`
|
+| array_to_string(array, delimiter) | Converts each element to
its text representation. `array_to_string([1, 2, 3, 4], ',') -> 1,2,3,4`
|
+| array_intersect(array1, array2) | Returns an array of the
elements in the intersection of array1 and array2. `array_intersect([1, 2, 3,
4], [5, 6, 3, 4]) -> [3, 4]`
|
+| array_union(array1, array2) | Returns an array of the
elements in the union of array1 and array2 without duplicates. `array_union([1,
2, 3, 4], [5, 6, 3, 4]) -> [1, 2, 3, 4, 5, 6]`
|
+| array_except(array1, array2) | Returns an array of the
elements that appear in the first array but not in the second.
`array_except([1, 2, 3, 4], [5, 6, 3, 4]) -> [3, 4]`
|
+| array_resize(array, size, value) | Resizes the list to contain
size elements. Initializes new elements with value or empty if value is not
set. `array_resize([1, 2, 3], 5, 0) -> [1, 2, 3, 4, 5, 6]`
|
+| cardinality(array) | Returns the total number of
elements in the array. `cardinality([[1, 2, 3], [4, 5, 6]]) -> 6`
|
+| make_array(value1, [value2 [, ...]]) | Returns an Arrow array
using the specified input expressions. `make_array(1, 2, 3) -> [1, 2, 3]`
|
+| range(start [, stop, step]) | Returns an Arrow array
between start and stop with step. `SELECT range(2, 10, 3) -> [2, 5, 8]`
|
+| string_to_array(array, delimiter, null_string) | Splits a `string` based on
a `delimiter` and returns an array of parts. Any parts matching the optional
`null_string` will be replaced with `NULL`. `string_to_array('abc#def#ghi',
'#', ' ') -> ['abc', 'def', 'ghi']` |
+| trim_array(array, n) | Deprecated
|
## Regular Expressions
diff --git a/_sources/user-guide/sql/scalar_functions.md.txt
b/_sources/user-guide/sql/scalar_functions.md.txt
index b0385b4923..7496039116 100644
--- a/_sources/user-guide/sql/scalar_functions.md.txt
+++ b/_sources/user-guide/sql/scalar_functions.md.txt
@@ -3113,6 +3113,7 @@ _Alias of [make_array](#make_array)._
### `string_to_array`
Splits a string in to an array of substrings based on a delimiter. Any
substrings matching the optional `null_str` argument are replaced with NULL.
+`SELECT string_to_array('abc##def', '##')` or `SELECT string_to_array('abc
def', ' ', 'def')`
```
starts_with(str, delimiter[, null_str])
diff --git a/searchindex.js b/searchindex.js
index b4577fb155..83297ace5d 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/expressions.html b/user-guide/expressions.html
index 3e2a8c043e..c3d1ee237e 100644
--- a/user-guide/expressions.html
+++ b/user-guide/expressions.html
@@ -1018,7 +1018,10 @@ but these operators always return a <code
class="docutils literal notranslate"><
<tr class="row-even"><td><p>range(start [, stop, step])</p></td>
<td><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></td>
</tr>
-<tr class="row-odd"><td><p>trim_array(array, n)</p></td>
+<tr class="row-odd"><td><p>string_to_array(array, delimiter,
null_string)</p></td>
+<td><p>Splits a <code class="docutils literal notranslate"><span
class="pre">string</span></code> based on a <code class="docutils literal
notranslate"><span class="pre">delimiter</span></code> and returns an array of
parts. Any parts matching the optional <code class="docutils literal
notranslate"><span class="pre">null_string</span></code> will be replaced with
<code class="docutils literal notranslate"><span
class="pre">NULL</span></code>. <code class="docutils literal notranslate"><s
[...]
+</tr>
+<tr class="row-even"><td><p>trim_array(array, n)</p></td>
<td><p>Deprecated</p></td>
</tr>
</tbody>
diff --git a/user-guide/sql/scalar_functions.html
b/user-guide/sql/scalar_functions.html
index 1fd5286908..c82feae2d0 100644
--- a/user-guide/sql/scalar_functions.html
+++ b/user-guide/sql/scalar_functions.html
@@ -6745,7 +6745,8 @@ string operators.</p></li>
</section>
<section id="string-to-array">
<h3><code class="docutils literal notranslate"><span
class="pre">string_to_array</span></code><a class="headerlink"
href="#string-to-array" title="Link to this heading">ΒΆ</a></h3>
-<p>Splits a string in to an array of substrings based on a delimiter. Any
substrings matching the optional <code class="docutils literal
notranslate"><span class="pre">null_str</span></code> argument are replaced
with NULL.</p>
+<p>Splits a string in to an array of substrings based on a delimiter. Any
substrings matching the optional <code class="docutils literal
notranslate"><span class="pre">null_str</span></code> argument are replaced
with NULL.
+<code class="docutils literal notranslate"><span class="pre">SELECT</span>
<span class="pre">string_to_array('abc##def',</span> <span
class="pre">'##')</span></code> or <code class="docutils literal
notranslate"><span class="pre">SELECT</span> <span
class="pre">string_to_array('abc</span> <span class="pre">def',</span> <span
class="pre">'</span> <span class="pre">',</span> <span
class="pre">'def')</span></code></p>
<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>
