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 bbe341c249 Publish built docs triggered by
6b1e9c6a3ae95b7065e902d99d9fde66f0f8e054
bbe341c249 is described below
commit bbe341c249dd44ff161bdbbaa58381a748247fd6
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Jan 3 12:25:33 2024 +0000
Publish built docs triggered by 6b1e9c6a3ae95b7065e902d99d9fde66f0f8e054
---
_sources/library-user-guide/adding-udfs.md.txt | 7 ++++++-
library-user-guide/adding-udfs.html | 3 ++-
searchindex.js | 2 +-
3 files changed, 9 insertions(+), 3 deletions(-)
diff --git a/_sources/library-user-guide/adding-udfs.md.txt
b/_sources/library-user-guide/adding-udfs.md.txt
index c51e4de323..1f687f978f 100644
--- a/_sources/library-user-guide/adding-udfs.md.txt
+++ b/_sources/library-user-guide/adding-udfs.md.txt
@@ -201,7 +201,8 @@ fn make_partition_evaluator() -> Result<Box<dyn
PartitionEvaluator>> {
### Registering a Window UDF
-To register a Window UDF, you need to wrap the function implementation in a
`WindowUDF` struct and then register it with the `SessionContext`. DataFusion
provides the `create_udwf` helper functions to make this easier.
+To register a Window UDF, you need to wrap the function implementation in a
[`WindowUDF`] struct and then register it with the `SessionContext`. DataFusion
provides the [`create_udwf`] helper functions to make this easier.
+There is a lower level API with more functionality but is more complex, that
is documented in [`advanced_udwf.rs`].
```rust
use datafusion::logical_expr::{Volatility, create_udwf};
@@ -218,6 +219,10 @@ let smooth_it = create_udwf(
);
```
+[`windowudf`]:
https://docs.rs/datafusion/latest/datafusion/logical_expr/struct.WindowUDF.html
+[`create_udwf`]:
https://docs.rs/datafusion/latest/datafusion/logical_expr/fn.create_udwf.html
+[`advanced_udwf.rs`]:
https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs
+
The `create_udwf` has five arguments to check:
- The first argument is the name of the function. This is the name that will
be used in SQL queries.
diff --git a/library-user-guide/adding-udfs.html
b/library-user-guide/adding-udfs.html
index f6898892ab..68b069b82c 100644
--- a/library-user-guide/adding-udfs.html
+++ b/library-user-guide/adding-udfs.html
@@ -633,7 +633,8 @@ There is a lower level API with more functionality but is
more complex, that is
</div>
<section id="registering-a-window-udf">
<h3>Registering a Window UDF<a class="headerlink"
href="#registering-a-window-udf" title="Link to this heading">ΒΆ</a></h3>
-<p>To register a Window UDF, you need to wrap the function implementation in a
<code class="docutils literal notranslate"><span
class="pre">WindowUDF</span></code> struct and then register it with the <code
class="docutils literal notranslate"><span
class="pre">SessionContext</span></code>. DataFusion provides the <code
class="docutils literal notranslate"><span
class="pre">create_udwf</span></code> helper functions to make this easier.</p>
+<p>To register a Window UDF, you need to wrap the function implementation in a
<a class="reference external"
href="https://docs.rs/datafusion/latest/datafusion/logical_expr/struct.WindowUDF.html";><code
class="docutils literal notranslate"><span
class="pre">WindowUDF</span></code></a> struct and then register it with the
<code class="docutils literal notranslate"><span
class="pre">SessionContext</span></code>. DataFusion provides the <a
class="reference external" href="https://docs.rs/dat [...]
+There is a lower level API with more functionality but is more complex, that
is documented in <a class="reference external"
href="https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/advanced_udwf.rs";><code
class="docutils literal notranslate"><span
class="pre">advanced_udwf.rs</span></code></a>.</p>
<div class="highlight-rust notranslate"><div
class="highlight"><pre><span></span><span class="k">use</span><span class="w">
</span><span class="n">datafusion</span>::<span
class="n">logical_expr</span>::<span class="p">{</span><span
class="n">Volatility</span><span class="p">,</span><span class="w">
</span><span class="n">create_udwf</span><span class="p">};</span>
<span class="k">use</span><span class="w"> </span><span
class="n">datafusion</span>::<span class="n">arrow</span>::<span
class="n">datatypes</span>::<span class="n">DataType</span><span
class="p">;</span>
<span class="k">use</span><span class="w"> </span><span
class="n">std</span>::<span class="n">sync</span>::<span
class="n">Arc</span><span class="p">;</span>
diff --git a/searchindex.js b/searchindex.js
index c69000928a..b69abb6b0c 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
