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/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new b5f68d836e Publish built docs triggered by
7f29cb050acd055c5cb52d620282fe9cb8ac2af0
b5f68d836e is described below
commit b5f68d836e5c7573d7c227052563d4370489853a
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Mar 24 13:39:43 2026 +0000
Publish built docs triggered by 7f29cb050acd055c5cb52d620282fe9cb8ac2af0
---
_sources/user-guide/sql/scalar_functions.md.txt | 27 +++++++++++
searchindex.js | 2 +-
user-guide/sql/scalar_functions.html | 59 +++++++++++++++++++------
3 files changed, 74 insertions(+), 14 deletions(-)
diff --git a/_sources/user-guide/sql/scalar_functions.md.txt
b/_sources/user-guide/sql/scalar_functions.md.txt
index 918bae0f7d..5a8ef4db3d 100644
--- a/_sources/user-guide/sql/scalar_functions.md.txt
+++ b/_sources/user-guide/sql/scalar_functions.md.txt
@@ -5185,6 +5185,7 @@ union_tag(union_expression)
- [arrow_cast](#arrow_cast)
- [arrow_metadata](#arrow_metadata)
+- [arrow_try_cast](#arrow_try_cast)
- [arrow_typeof](#arrow_typeof)
- [get_field](#get_field)
- [version](#version)
@@ -5257,6 +5258,32 @@ arrow_metadata(expression[, key])
+-------------------------------+
```
+### `arrow_try_cast`
+
+Casts a value to a specific Arrow data type, returning NULL if the cast fails.
+
+```sql
+arrow_try_cast(expression, datatype)
+```
+
+#### Arguments
+
+- **expression**: Expression to cast. The expression can be a constant,
column, or function, and any combination of operators.
+- **datatype**: [Arrow data
type](https://docs.rs/arrow/latest/arrow/datatypes/enum.DataType.html) name to
cast to, as a string. The format is the same as that returned by
[`arrow_typeof`]
+
+#### Example
+
+```sql
+> select arrow_try_cast('123', 'Int64') as a,
+ arrow_try_cast('not_a_number', 'Int64') as b;
+
++-----+------+
+| a | b |
++-----+------+
+| 123 | NULL |
++-----+------+
+```
+
### `arrow_typeof`
Returns the name of the underlying [Arrow data
type](https://docs.rs/arrow/latest/arrow/datatypes/enum.DataType.html) of the
expression.
diff --git a/searchindex.js b/searchindex.js
index 862c841e15..1a34d82667 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"!=":[[72,"op-neq"]],"!~":[[72,"op-re-not-match"]],"!~*":[[72,"op-re-not-match-i"]],"!~~":[[72,"id19"]],"!~~*":[[72,"id20"]],"#":[[72,"op-bit-xor"]],"%":[[72,"op-modulo"]],"&":[[72,"op-bit-and"]],"(relation,
name) tuples in logical fields and logical columns are
unique":[[14,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[72,"op-multiply"]],"+":[[72,"op-plus"]],"-":[[72,"op-minus"]],"/":[[72,"op-divide"]],"1.
Array Literal Con [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"!=":[[72,"op-neq"]],"!~":[[72,"op-re-not-match"]],"!~*":[[72,"op-re-not-match-i"]],"!~~":[[72,"id19"]],"!~~*":[[72,"id20"]],"#":[[72,"op-bit-xor"]],"%":[[72,"op-modulo"]],"&":[[72,"op-bit-and"]],"(relation,
name) tuples in logical fields and logical columns are
unique":[[14,"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]],"*":[[72,"op-multiply"]],"+":[[72,"op-plus"]],"-":[[72,"op-minus"]],"/":[[72,"op-divide"]],"1.
Array Literal Con [...]
\ No newline at end of file
diff --git a/user-guide/sql/scalar_functions.html
b/user-guide/sql/scalar_functions.html
index bdb2c66044..a22db8b073 100644
--- a/user-guide/sql/scalar_functions.html
+++ b/user-guide/sql/scalar_functions.html
@@ -5846,6 +5846,7 @@ For <code class="docutils literal notranslate"><span
class="pre">make_map</span>
<ul class="simple">
<li><p><a class="reference internal" href="#arrow-cast">arrow_cast</a></p></li>
<li><p><a class="reference internal"
href="#arrow-metadata">arrow_metadata</a></p></li>
+<li><p><a class="reference internal"
href="#arrow-try-cast">arrow_try_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="#get-field">get_field</a></p></li>
<li><p><a class="reference internal" href="#version">version</a></p></li>
@@ -5920,20 +5921,47 @@ For <code class="docutils literal notranslate"><span
class="pre">make_map</span>
</div>
</section>
</section>
+<section id="arrow-try-cast">
+<h3><code class="docutils literal notranslate"><span
class="pre">arrow_try_cast</span></code><a class="headerlink"
href="#arrow-try-cast" title="Link to this heading">#</a></h3>
+<p>Casts a value to a specific Arrow data type, returning NULL if the cast
fails.</p>
+<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="n">arrow_try_cast</span><span
class="p">(</span><span class="n">expression</span><span
class="p">,</span><span class="w"> </span><span class="n">datatype</span><span
class="p">)</span>
+</pre></div>
+</div>
+<section id="id363">
+<h4>Arguments<a class="headerlink" href="#id363" title="Link to this
heading">#</a></h4>
+<ul class="simple">
+<li><p><strong>expression</strong>: Expression to cast. The expression can be
a constant, column, or function, and any combination of operators.</p></li>
+<li><p><strong>datatype</strong>: <a class="reference external"
href="https://docs.rs/arrow/latest/arrow/datatypes/enum.DataType.html";>Arrow
data type</a> name 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="id364">
+<h4>Example<a class="headerlink" href="#id364" title="Link to this
heading">#</a></h4>
+<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="k">select</span><span class="w"> </span><span
class="n">arrow_try_cast</span><span class="p">(</span><span
class="s1">'123'</span><span class="p">,</span><span class="w">
</span><span class="s1">'Int64'</span><span class="p">)</span><span
class="w"> </span><span class="k">as</span><span class="w"> </span><span
class="n">a</span><s [...]
+<span class="w"> </span><span class="n">arrow_try_cast</span><span
class="p">(</span><span class="s1">'not_a_number'</span><span
class="p">,</span><span class="w"> </span><span
class="s1">'Int64'</span><span class="p">)</span><span class="w">
</span><span class="k">as</span><span class="w"> </span><span
class="n">b</span><span class="p">;</span>
+
+<span class="o">+</span><span class="c1">-----+------+</span>
+<span class="o">|</span><span class="w"> </span><span class="n">a</span><span
class="w"> </span><span class="o">|</span><span class="w"> </span><span
class="n">b</span><span class="w"> </span><span class="o">|</span>
+<span class="o">+</span><span class="c1">-----+------+</span>
+<span class="o">|</span><span class="w"> </span><span
class="mi">123</span><span class="w"> </span><span class="o">|</span><span
class="w"> </span><span class="k">NULL</span><span class="w"> </span><span
class="o">|</span>
+<span class="o">+</span><span class="c1">-----+------+</span>
+</pre></div>
+</div>
+</section>
+</section>
<section id="arrow-typeof">
<h3><code class="docutils literal notranslate"><span
class="pre">arrow_typeof</span></code><a class="headerlink"
href="#arrow-typeof" title="Link to this heading">#</a></h3>
<p>Returns the name of the underlying <a class="reference external"
href="https://docs.rs/arrow/latest/arrow/datatypes/enum.DataType.html";>Arrow
data type</a> of the expression.</p>
<div class="highlight-sql 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="id363">
-<h4>Arguments<a class="headerlink" href="#id363" title="Link to this
heading">#</a></h4>
+<section id="id365">
+<h4>Arguments<a class="headerlink" href="#id365" title="Link to this
heading">#</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: Expression to evaluate. The expression can
be a constant, column, or function, and any combination of operators.</p></li>
</ul>
</section>
-<section id="id364">
-<h4>Example<a class="headerlink" href="#id364" title="Link to this
heading">#</a></h4>
+<section id="id366">
+<h4>Example<a class="headerlink" href="#id366" title="Link to this
heading">#</a></h4>
<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="k">select</span><span class="w"> </span><span
class="n">arrow_typeof</span><span class="p">(</span><span
class="s1">'foo'</span><span class="p">),</span><span class="w">
</span><span class="n">arrow_typeof</span><span class="p">(</span><span
class="mi">1</span><span class="p">);</span>
<span class="o">+</span><span
class="c1">---------------------------+------------------------+</span>
<span class="o">|</span><span class="w"> </span><span
class="n">arrow_typeof</span><span class="p">(</span><span
class="n">Utf8</span><span class="p">(</span><span
class="ss">"foo"</span><span class="p">))</span><span class="w">
</span><span class="o">|</span><span class="w"> </span><span
class="n">arrow_typeof</span><span class="p">(</span><span
class="n">Int64</span><span class="p">(</span><span class="mi">1</span><span
class="p">))</span><span class="w"> </span><span class=" [...]
@@ -5956,15 +5984,15 @@ Nested access like <code class="docutils literal
notranslate"><span class="pre">
<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="n">get_field</span><span
class="p">(</span><span class="n">expression</span><span
class="p">,</span><span class="w"> </span><span
class="n">field_name</span><span class="p">[,</span><span class="w">
</span><span class="n">field_name2</span><span class="p">,</span><span
class="w"> </span><span class="p">...])</span>
</pre></div>
</div>
-<section id="id365">
-<h4>Arguments<a class="headerlink" href="#id365" title="Link to this
heading">#</a></h4>
+<section id="id367">
+<h4>Arguments<a class="headerlink" href="#id367" title="Link to this
heading">#</a></h4>
<ul class="simple">
<li><p><strong>expression</strong>: The map or struct to retrieve a field
from.</p></li>
<li><p><strong>field_name</strong>: The field name(s) to access, in order for
nested access. Must evaluate to strings.</p></li>
</ul>
</section>
-<section id="id366">
-<h4>Example<a class="headerlink" href="#id366" title="Link to this
heading">#</a></h4>
+<section id="id368">
+<h4>Example<a class="headerlink" href="#id368" title="Link to this
heading">#</a></h4>
<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="c1">-- Access a field from a struct column</span>
<span class="o">></span><span class="w"> </span><span
class="k">create</span><span class="w"> </span><span
class="k">table</span><span class="w"> </span><span class="n">test</span><span
class="p">(</span><span class="w"> </span><span
class="n">struct_col</span><span class="p">)</span><span class="w">
</span><span class="k">as</span><span class="w"> </span><span
class="k">values</span>
<span class="w"> </span><span class="p">(</span><span
class="err">{</span><span class="n">name</span><span class="p">:</span><span
class="w"> </span><span class="s1">'Alice'</span><span
class="p">,</span><span class="w"> </span><span class="n">age</span><span
class="p">:</span><span class="w"> </span><span class="mi">30</span><span
class="err">}</span><span class="p">),</span>
@@ -6003,8 +6031,8 @@ Nested access like <code class="docutils literal
notranslate"><span class="pre">
<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="k">version</span><span
class="p">()</span>
</pre></div>
</div>
-<section id="id367">
-<h4>Example<a class="headerlink" href="#id367" title="Link to this
heading">#</a></h4>
+<section id="id369">
+<h4>Example<a class="headerlink" href="#id369" title="Link to this
heading">#</a></h4>
<div class="highlight-sql notranslate"><div
class="highlight"><pre><span></span><span class="o">></span><span class="w">
</span><span class="k">select</span><span class="w"> </span><span
class="k">version</span><span class="p">();</span>
<span class="o">+</span><span
class="c1">--------------------------------------------+</span>
<span class="o">|</span><span class="w"> </span><span
class="k">version</span><span class="p">()</span><span class="w">
</span><span class="o">|</span>
@@ -7016,18 +7044,23 @@ Nested access like <code class="docutils literal
notranslate"><span class="pre">
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#id362">Example</a></li>
</ul>
</li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#arrow-typeof"><code class="docutils literal notranslate"><span
class="pre">arrow_typeof</span></code></a><ul class="nav section-nav
flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#arrow-try-cast"><code class="docutils literal notranslate"><span
class="pre">arrow_try_cast</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="#id363">Arguments</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#id364">Example</a></li>
</ul>
</li>
-<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#get-field"><code class="docutils literal notranslate"><span
class="pre">get_field</span></code></a><ul class="nav section-nav flex-column">
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#arrow-typeof"><code class="docutils literal notranslate"><span
class="pre">arrow_typeof</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="#id365">Arguments</a></li>
<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#id366">Example</a></li>
</ul>
</li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#get-field"><code class="docutils literal notranslate"><span
class="pre">get_field</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="#id367">Arguments</a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#id368">Example</a></li>
+</ul>
+</li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link"
href="#version"><code class="docutils literal notranslate"><span
class="pre">version</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="#id367">Example</a></li>
+<li class="toc-h4 nav-item toc-entry"><a class="reference internal nav-link"
href="#id369">Example</a></li>
</ul>
</li>
</ul>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
