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/01/09 17:27:55 UTC
(arrow-datafusion) branch asf-site updated: Publish built docs triggered by 85719df5f2fff12a1752c47086a4a9cf158c28da
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 5337b907f0 Publish built docs triggered by 85719df5f2fff12a1752c47086a4a9cf158c28da
5337b907f0 is described below
commit 5337b907f0673d4a1bd4f09e4d3169d5d94b1470
Author: github-actions[bot] <gi...@users.noreply.github.com>
AuthorDate: Tue Jan 9 17:27:51 2024 +0000
Publish built docs triggered by 85719df5f2fff12a1752c47086a4a9cf158c28da
---
_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 1f687f978f..64dc25411d 100644
--- a/_sources/library-user-guide/adding-udfs.md.txt
+++ b/_sources/library-user-guide/adding-udfs.md.txt
@@ -398,7 +398,8 @@ impl Accumulator for GeometricMean {
### registering an Aggregate UDF
-To register a Aggreate UDF, you need to wrap the function implementation in a `AggregateUDF` struct and then register it with the `SessionContext`. DataFusion provides the `create_udaf` helper functions to make this easier.
+To register a Aggreate UDF, you need to wrap the function implementation in a [`AggregateUDF`] struct and then register it with the `SessionContext`. DataFusion provides the [`create_udaf`] helper functions to make this easier.
+There is a lower level API with more functionality but is more complex, that is documented in [`advanced_udaf.rs`].
```rust
use datafusion::logical_expr::{Volatility, create_udaf};
@@ -421,6 +422,10 @@ let geometric_mean = create_udaf(
);
```
+[`aggregateudf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/struct.AggregateUDF.html
+[`create_udaf`]: https://docs.rs/datafusion/latest/datafusion/logical_expr/fn.create_udaf.html
+[`advanced_udaf.rs`]: https://github.com/apache/arrow-datafusion/blob/main/datafusion-examples/examples/advanced_udaf.rs
+
The `create_udaf` has six 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 6e2ca79b41..abe035b546 100644
--- a/library-user-guide/adding-udfs.html
+++ b/library-user-guide/adding-udfs.html
@@ -814,7 +814,8 @@ green,10.3,1996-04-12T12:05:04.000000000
</div>
<section id="registering-an-aggregate-udf">
<h3>registering an Aggregate UDF<a class="headerlink" href="#registering-an-aggregate-udf" title="Link to this heading">ΒΆ</a></h3>
-<p>To register a Aggreate UDF, you need to wrap the function implementation in a <code class="docutils literal notranslate"><span class="pre">AggregateUDF</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_udaf</span></code> helper functions to make this easier.</p>
+<p>To register a Aggreate UDF, you need to wrap the function implementation in a <a class="reference external" href="https://docs.rs/datafusion/latest/datafusion/logical_expr/struct.AggregateUDF.html"><code class="docutils literal notranslate"><span class="pre">AggregateUDF</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://doc [...]
+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_udaf.rs"><code class="docutils literal notranslate"><span class="pre">advanced_udaf.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_udaf</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 b69abb6b0c..ed01a5700e 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