This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-staging
in repository https://gitbox.apache.org/repos/asf/datafusion-python.git
The following commit(s) were added to refs/heads/asf-staging by this push:
new 45d4e546 Publish built docs triggered by
93f4c34bf5a4afae2547d5ccb677143d1833ebf0
45d4e546 is described below
commit 45d4e54630a07697120fc6139a0622f57d6f6477
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Tue Mar 17 06:52:14 2026 +0000
Publish built docs triggered by 93f4c34bf5a4afae2547d5ccb677143d1833ebf0
---
.../autoapi/datafusion/functions/index.rst.txt | 282 +++++++++++++++++-
autoapi/datafusion/functions/index.html | 323 ++++++++++++++++++++-
searchindex.js | 2 +-
user-guide/common-operations/aggregations.html | 36 +--
user-guide/common-operations/basic-info.html | 46 +--
user-guide/common-operations/functions.html | 20 +-
6 files changed, 651 insertions(+), 58 deletions(-)
diff --git a/_sources/autoapi/datafusion/functions/index.rst.txt
b/_sources/autoapi/datafusion/functions/index.rst.txt
index 02a0c3a1..0b25cf15 100644
--- a/_sources/autoapi/datafusion/functions/index.rst.txt
+++ b/_sources/autoapi/datafusion/functions/index.rst.txt
@@ -320,7 +320,14 @@ Module Contents
:param name: The alias name
:param metadata: Optional metadata to attach to the column
- :returns: An expression with the given alias
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2]})
+ >>> df.select(
+ ... dfn.functions.alias(dfn.col("a"), "b")
+ ... ).collect_column("b")[0].as_py()
+ 1
.. py:function:: approx_distinct(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -337,6 +344,15 @@ Module Contents
:param expression: Values to check for distinct entries
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 1, 2, 3]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.approx_distinct(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py() == 3
+ True
+
.. py:function:: approx_median(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -351,6 +367,15 @@ Module Contents
:param expression: Values to find the median for
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.approx_median(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: approx_percentile_cont(sort_expression: datafusion.expr.Expr
| datafusion.expr.SortExpr, percentile: float, num_centroids: int | None =
None, filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -374,6 +399,15 @@ Module Contents
:param num_centroids: Max bin size for the t-digest algorithm
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0, 4.0, 5.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.approx_percentile_cont(dfn.col("a"),
0.5).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 3.0
+
.. py:function:: approx_percentile_cont_with_weight(sort_expression:
datafusion.expr.Expr | datafusion.expr.SortExpr, weight: datafusion.expr.Expr,
percentile: float, num_centroids: int | None = None, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -391,6 +425,16 @@ Module Contents
:param num_centroids: Max bin size for the t-digest algorithm
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0], "w": [1.0, 1.0, 1.0]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.approx_percentile_cont_with_weight(dfn.col("a"),
+ ... dfn.col("w"), 0.5).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: array(*args: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -506,7 +550,7 @@ Module Contents
Converts each element to its text representation.
- This is an alias for :py:func:`array_to_string`.
+ .. seealso:: This is an alias for :py:func:`array_to_string`.
.. py:function:: array_length(array: datafusion.expr.Expr) ->
datafusion.expr.Expr
@@ -622,6 +666,15 @@ Module Contents
Converts each element to its text representation.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [[1, 2, 3]]})
+ >>> result = df.select(
+ ... dfn.functions.array_to_string(dfn.col("a"),
dfn.lit(",")).alias("s"))
+ >>> result.collect_column("s")[0].as_py()
+ '1,2,3'
+
.. py:function:: array_union(array1: datafusion.expr.Expr, array2:
datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -742,6 +795,14 @@ Module Contents
:param expression: Values to combine into an array
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate([], [dfn.functions.avg(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: bit_and(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -755,6 +816,14 @@ Module Contents
:param expression: Argument to perform bitwise calculation on
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [7, 3]})
+ >>> result = df.aggregate([],
[dfn.functions.bit_and(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 3
+
.. py:function:: bit_length(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -773,6 +842,14 @@ Module Contents
:param expression: Argument to perform bitwise calculation on
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2]})
+ >>> result = df.aggregate([],
[dfn.functions.bit_or(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 3
+
.. py:function:: bit_xor(expression: datafusion.expr.Expr, distinct: bool =
False, filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -787,6 +864,14 @@ Module Contents
:param distinct: If True, evaluate each unique value of expression only once
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [5, 3]})
+ >>> result = df.aggregate([],
[dfn.functions.bit_xor(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 6
+
.. py:function:: bool_and(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -801,6 +886,14 @@ Module Contents
:param expression: Argument to perform calculation on
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [True, True, False]})
+ >>> result = df.aggregate([],
[dfn.functions.bool_and(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ False
+
.. py:function:: bool_or(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -815,6 +908,14 @@ Module Contents
:param expression: Argument to perform calculation on
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [False, False, True]})
+ >>> result = df.aggregate([],
[dfn.functions.bool_or(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ True
+
.. py:function:: btrim(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -834,6 +935,16 @@ Module Contents
expression ``expr``. See :py:class:`~datafusion.expr.CaseBuilder` for
detailed usage.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.select(
+ ... dfn.functions.case(dfn.col("a")).when(dfn.lit(1),
+ ... dfn.lit("one")).otherwise(dfn.lit("other")).alias("c"))
+ >>> result.collect_column("c")[0].as_py()
+ 'one'
+
.. py:function:: cbrt(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -894,6 +1005,13 @@ Module Contents
Creates a column reference expression.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> df.select(dfn.functions.col("a")).collect_column("a")[0].as_py()
+ 1
+
.. py:function:: concat(*args: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -901,6 +1019,16 @@ Module Contents
NULL arguments are ignored.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": ["hello"], "b": [" world"]})
+ >>> result = df.select(
+ ... dfn.functions.concat(dfn.col("a"), dfn.col("b")).alias("c")
+ ... )
+ >>> result.collect_column("c")[0].as_py()
+ 'hello world'
+
.. py:function:: concat_ws(separator: str, *args: datafusion.expr.Expr) ->
datafusion.expr.Expr
@@ -908,6 +1036,15 @@ Module Contents
``NULL`` arguments are ignored. ``separator`` should not be ``NULL``.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": ["hello"], "b": ["world"]})
+ >>> result = df.select(
+ ... dfn.functions.concat_ws("-", dfn.col("a"), dfn.col("b")).alias("c"))
+ >>> result.collect_column("c")[0].as_py()
+ 'hello-world'
+
.. py:function:: corr(value_y: datafusion.expr.Expr, value_x:
datafusion.expr.Expr, filter: datafusion.expr.Expr | None = None) ->
datafusion.expr.Expr
@@ -981,6 +1118,14 @@ Module Contents
:param distinct: If True, a single entry for each distinct value will be in
the result
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.aggregate([],
[dfn.functions.count(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 3
+
.. py:function:: count_star(filter: datafusion.expr.Expr | None = None) ->
datafusion.expr.Expr
@@ -993,6 +1138,14 @@ Module Contents
:param filter: If provided, only count rows for which the filter is True
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.aggregate([], [dfn.functions.count_star().alias("cnt")])
+ >>> result.collect_column("cnt")[0].as_py()
+ 3
+
.. py:function:: covar(value_y: datafusion.expr.Expr, value_x:
datafusion.expr.Expr, filter: datafusion.expr.Expr | None = None) ->
datafusion.expr.Expr
@@ -1099,6 +1252,15 @@ Module Contents
Decode the ``input``, using the ``encoding``. encoding can be base64 or hex.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": ["aGVsbG8="]})
+ >>> result = df.select(
+ ... dfn.functions.decode(dfn.col("a"), dfn.lit("base64")).alias("dec"))
+ >>> result.collect_column("dec")[0].as_py()
+ b'hello'
+
.. py:function:: degrees(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1147,6 +1309,15 @@ Module Contents
Standard algorithms are md5, sha224, sha256, sha384, sha512, blake2s,
blake2b, and blake3.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": ["hello"]})
+ >>> result = df.select(
+ ... dfn.functions.digest(dfn.col("a"), dfn.lit("md5")).alias("d"))
+ >>> len(result.collect_column("d")[0].as_py()) > 0
+ True
+
.. py:function:: empty(array: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1157,6 +1328,15 @@ Module Contents
Encode the ``input``, using the ``encoding``. encoding can be base64 or hex.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": ["hello"]})
+ >>> result = df.select(
+ ... dfn.functions.encode(dfn.col("a"), dfn.lit("base64")).alias("enc"))
+ >>> result.collect_column("enc")[0].as_py()
+ 'aGVsbG8'
+
.. py:function:: ends_with(arg: datafusion.expr.Expr, suffix:
datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1270,6 +1450,18 @@ Module Contents
Returns whether the argument is contained within the list ``values``.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.select(
+ ... dfn.functions.in_list(
+ ... dfn.col("a"), [dfn.lit(1), dfn.lit(3)]
+ ... ).alias("in")
+ ... )
+ >>> result.collect_column("in").to_pylist()
+ [True, False, True]
+
.. py:function:: initcap(string: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1283,6 +1475,14 @@ Module Contents
Returns true if a given number is +NaN or -NaN otherwise returns false.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, np.nan]})
+ >>> result = df.select(dfn.functions.isnan(dfn.col("a")).alias("isnan"))
+ >>> result.collect_column("isnan")[1].as_py()
+ True
+
.. py:function:: iszero(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1492,6 +1692,8 @@ Module Contents
This is an alias for :py:func:`array_to_string`.
+ .. seealso:: This is an alias for :py:func:`array_to_string`.
+
.. py:function:: list_length(array: datafusion.expr.Expr) ->
datafusion.expr.Expr
@@ -1618,7 +1820,7 @@ Module Contents
Converts each element to its text representation.
- This is an alias for :py:func:`array_to_string`.
+ .. seealso:: This is an alias for :py:func:`array_to_string`.
.. py:function:: list_union(array1: datafusion.expr.Expr, array2:
datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1730,6 +1932,14 @@ Module Contents
:param expression: The value to find the maximum of
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.aggregate([], [dfn.functions.max(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 3
+
.. py:function:: md5(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -1750,6 +1960,14 @@ Module Contents
This is an alias for :py:func:`avg`.
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate([], [dfn.functions.mean(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: median(expression: datafusion.expr.Expr, distinct: bool =
False, filter: datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -1765,6 +1983,14 @@ Module Contents
:param distinct: If True, a single entry for each distinct value will be in
the result
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1.0, 2.0, 3.0]})
+ >>> result = df.aggregate([],
[dfn.functions.median(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 2.0
+
.. py:function:: min(expression: datafusion.expr.Expr, filter:
datafusion.expr.Expr | None = None) -> datafusion.expr.Expr
@@ -1776,6 +2002,14 @@ Module Contents
:param expression: The value to find the minimum of
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.aggregate([], [dfn.functions.min(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 1
+
.. py:function:: named_struct(name_pairs: list[tuple[str,
datafusion.expr.Expr]]) -> datafusion.expr.Expr
@@ -1874,6 +2108,15 @@ Module Contents
This can be used to perform the inverse operation of the COALESCE
expression.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2], "b": [1, 3]})
+ >>> result = df.select(
+ ... dfn.functions.nullif(dfn.col("a"), dfn.col("b")).alias("nullif"))
+ >>> result.collect_column("nullif").to_pylist()
+ [None, 2]
+
.. py:function:: nvl(x: datafusion.expr.Expr, y: datafusion.expr.Expr) ->
datafusion.expr.Expr
@@ -1901,6 +2144,12 @@ Module Contents
Creates a new sort expression.
+ .. rubric:: Examples
+
+ >>> sort_expr = dfn.functions.order_by(dfn.col("a"), ascending=False)
+ >>> sort_expr.ascending()
+ False
+
.. py:function:: overlay(string: datafusion.expr.Expr, substring:
datafusion.expr.Expr, start: datafusion.expr.Expr, length: datafusion.expr.Expr
| None = None) -> datafusion.expr.Expr
@@ -2539,6 +2788,15 @@ Module Contents
df.aggregate([], string_agg(col("a"), ",", order_by="b"))
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": ["x", "y", "z"]})
+ >>> result = df.aggregate(
+ ... [], [dfn.functions.string_agg(dfn.col("a"), ",",
order_by="a").alias("s")])
+ >>> result.collect_column("s")[0].as_py()
+ 'x,y,z'
+
.. py:function:: strpos(string: datafusion.expr.Expr, substring:
datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -2596,6 +2854,14 @@ Module Contents
:param expression: Values to combine into an array
:param filter: If provided, only compute against rows for which the filter
is True
+ Examples:
+ ---------
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.aggregate([], [dfn.functions.sum(dfn.col("a")).alias("v")])
+ >>> result.collect_column("v")[0].as_py()
+ 6
+
.. py:function:: tan(arg: datafusion.expr.Expr) -> datafusion.expr.Expr
@@ -2799,6 +3065,16 @@ Module Contents
expression ``expr``. See :py:class:`~datafusion.expr.CaseBuilder` for
detailed usage.
+ .. rubric:: Examples
+
+ >>> ctx = dfn.SessionContext()
+ >>> df = ctx.from_pydict({"a": [1, 2, 3]})
+ >>> result = df.select(
+ ... dfn.functions.when(dfn.col("a") > dfn.lit(2),
+ ... dfn.lit("big")).otherwise(dfn.lit("small")).alias("c"))
+ >>> result.collect_column("c")[2].as_py()
+ 'big'
+
.. py:function:: window(name: str, args: list[datafusion.expr.Expr],
partition_by: list[datafusion.expr.Expr] | datafusion.expr.Expr | None = None,
order_by: list[datafusion.expr.SortKey] | datafusion.expr.SortKey | None =
None, window_frame: datafusion.expr.WindowFrame | None = None, filter:
datafusion.expr.Expr | None = None, distinct: bool = False, ctx:
datafusion.context.SessionContext | None = None) -> datafusion.expr.Expr
diff --git a/autoapi/datafusion/functions/index.html
b/autoapi/datafusion/functions/index.html
index 840d037c..14bae86d 100644
--- a/autoapi/datafusion/functions/index.html
+++ b/autoapi/datafusion/functions/index.html
@@ -3492,10 +3492,16 @@
<li><p><strong>metadata</strong> – Optional metadata to attach to the
column</p></li>
</ul>
</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>An expression with the given alias</p>
-</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">df</span><span
class="o">.</span><span class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">alias</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="s2">"b"</span><span class="p">)</span>
+<span class="gp">... </span><span class="p">)</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"b"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -3515,6 +3521,17 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="examples">
+<h3>Examples:<a class="headerlink" href="#examples" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span
class="p">,</span> <span class="mi">3</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">approx_distinct</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">))</span><span class="o">.</span><span class="n">alias</span><span
class="p">(</span><sp [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span> <span
class="o">==</span> <span class="mi">3</span>
+<span class="go">True</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -3533,6 +3550,17 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id1">
+<h3>Examples:<a class="headerlink" href="#id1" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">approx_median</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">))</span><span class="o">.</span><span class="n">alias</span><span
class="p">(</span><span [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -3559,6 +3587,17 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id2">
+<h3>Examples:<a class="headerlink" href="#id2" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">,</span> <span class="mf">4.0</span><span class="p">,</span> < [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">approx_percentile_cont</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">),</span> <span class="mf">0.5</span><span class="p">)</span><span
class="o">.</s [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3.0</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -3580,6 +3619,18 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id3">
+<h3>Examples:<a class="headerlink" href="#id3" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">],</span> <span class="s2">"w"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">approx_percentile_cont_with_weight</span><span
class="p">(</span><span class="n">dfn</span><span class="o">.</span><span
class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"w"</span><span class="p">),</span> <span
class="mf">0.5</span><span class="p">)</span><span class="o">.</span><span
class="n">alias</span><span class="p">(</span><span
class="s2">"v"</span><span class="p">)])</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -3709,7 +3760,10 @@ array. Otherwise, it returns false.</p>
<dt class="sig sig-object py" id="datafusion.functions.array_join">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">array_join</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafu [...]
<dd><p>Converts each element to its text representation.</p>
+<div class="admonition seealso">
+<p class="admonition-title">See also</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.array_to_string"
title="datafusion.functions.array_to_string"><code class="xref py py-func
docutils literal notranslate"><span
class="pre">array_to_string()</span></code></a>.</p>
+</div>
</dd></dl>
<dl class="py function">
@@ -3845,6 +3899,15 @@ be filled with the given <code class="docutils literal
notranslate"><span class=
<dt class="sig sig-object py" id="datafusion.functions.array_to_string">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">array_to_string</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">d [...]
<dd><p>Converts each element to its text representation.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">array_to_string</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">lit</span><span class="p">(</span><span class="s2">"," [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"s"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">'1,2,3'</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -3977,6 +4040,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id4">
+<h3>Examples:<a class="headerlink" href="#id4" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">avg</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span class
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -3994,6 +4067,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id5">
+<h3>Examples:<a class="headerlink" href="#id5" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">7</span><span class="p">,</span> <span
class="mi">3</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">bit_and</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span c
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -4017,6 +4100,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id6">
+<h3>Examples:<a class="headerlink" href="#id6" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">bit_or</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span cl
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -4035,6 +4128,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id7">
+<h3>Examples:<a class="headerlink" href="#id7" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">5</span><span class="p">,</span> <span
class="mi">3</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">bit_xor</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span c
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">6</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -4053,6 +4156,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id8">
+<h3>Examples:<a class="headerlink" href="#id8" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="kc">True</span><span class="p">,</span> <span
class="kc">True</span><span class="p">,</span> <span
class="kc">False</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">bool_and</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">False</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -4071,6 +4184,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id9">
+<h3>Examples:<a class="headerlink" href="#id9" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="kc">False</span><span class="p">,</span> <span
class="kc">False</span><span class="p">,</span> <span
class="kc">True</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">bool_or</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span c
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">True</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -4092,6 +4215,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<p>Create a <a class="reference internal"
href="../expr/index.html#datafusion.expr.CaseBuilder"
title="datafusion.expr.CaseBuilder"><code class="xref py py-class docutils
literal notranslate"><span class="pre">CaseBuilder</span></code></a> to match
cases for the
expression <code class="docutils literal notranslate"><span
class="pre">expr</span></code>. See <a class="reference internal"
href="../expr/index.html#datafusion.expr.CaseBuilder"
title="datafusion.expr.CaseBuilder"><code class="xref py py-class docutils
literal notranslate"><span class="pre">CaseBuilder</span></code></a> for
detailed usage.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">case</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">))</span><span
class="o">.</span><span class="n">when</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n"> [...]
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">lit</span><span class="p">(</span><span
class="s2">"one"</span><span class="p">))</span><span
class="o">.</span><span class="n">otherwise</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span
class="p">(</span><span class="s2">"other"</span><span
class="p">))</span><span class="o">.</span><span class="n">alias</spa [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"c"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">'one'</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4159,6 +4292,13 @@ detailed usage.</p>
<dt class="sig sig-object py" id="datafusion.functions.col">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">col</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">name</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em><span class="sig-paren">)</span> <span
class="sig-return"><span class="sig-return-icon">→< [...]
<dd><p>Creates a column reference expression.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">df</span><span
class="o">.</span><span class="n">select</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">))</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"a"</span><span class=" [...]
+<span class="go">1</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4166,6 +4306,16 @@ detailed usage.</p>
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">concat</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="o"><span
class="pre">*</span></span><span class="n"><span
class="pre">args</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="d [...]
<dd><p>Concatenates the text representations of all the arguments.</p>
<p>NULL arguments are ignored.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="s2">"hello"</span><span
class="p">],</span> <span class="s2">"b"</span><span
class="p">:</span> <span class="p">[</span><span class="s2">"
world"</span><span class="p [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">concat</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"b"</span>< [...]
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"c"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">'hello world'</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4173,6 +4323,15 @@ detailed usage.</p>
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">concat_ws</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">separator</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><span
class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span
class="pre">*</span></span><span class=" [...]
<dd><p>Concatenates the list <code class="docutils literal notranslate"><span
class="pre">args</span></code> with the separator.</p>
<p><code class="docutils literal notranslate"><span
class="pre">NULL</span></code> arguments are ignored. <code class="docutils
literal notranslate"><span class="pre">separator</span></code> should not be
<code class="docutils literal notranslate"><span
class="pre">NULL</span></code>.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="s2">"hello"</span><span
class="p">],</span> <span class="s2">"b"</span><span
class="p">:</span> <span class="p">[</span><span
class="s2">"world"</span><span class="p" [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">concat_ws</span><span class="p">(</span><span
class="s2">"-"</span><span class="p">,</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">col</sp [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"c"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">'hello-world'</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4257,6 +4416,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id10">
+<h3>Examples:<a class="headerlink" href="#id10" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">count</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span cla
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -4271,6 +4440,14 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<dd class="field-odd"><p><strong>filter</strong> – If provided, only count
rows for which the filter is True</p>
</dd>
</dl>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">count_star</span><span class="p">()</span><span
class="o">.</span><span class="n">alias</span><span class="p">(</span><span
class="s2">"cnt& [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"cnt"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4397,6 +4574,15 @@ column names or expressions.</p></li>
<dt class="sig sig-object py" id="datafusion.functions.decode">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">decode</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafusion [...]
<dd><p>Decode the <code class="docutils literal notranslate"><span
class="pre">input</span></code>, using the <code class="docutils literal
notranslate"><span class="pre">encoding</span></code>. encoding can be base64
or hex.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="s2">"aGVsbG8="</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">decode</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span
class="p">(</span><span class="s2">"base64"</s [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"dec"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">b'hello'</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4452,6 +4638,15 @@ column names or expressions.</p></li>
<dd><p>Computes the binary hash of an expression using the specified
algorithm.</p>
<p>Standard algorithms are md5, sha224, sha256, sha384, sha512, blake2s,
blake2b, and blake3.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="s2">"hello"</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">digest</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span
class="p">(</span><span class="s2">"md5"</span [...]
+<span class="gp">>>> </span><span class="nb">len</span><span
class="p">(</span><span class="n">result</span><span class="o">.</span><span
class="n">collect_column</span><span class="p">(</span><span
class="s2">"d"</span><span class="p">)[</span><span
class="mi">0</span><span class="p">]</span><span class="o">.</span><span
class="n">as_py</span><span class="p">())</span> <span class="o">></span>
<span class="mi">0</span>
+<span class="go">True</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4464,6 +4659,15 @@ blake2b, and blake3.</p>
<dt class="sig sig-object py" id="datafusion.functions.encode">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">encode</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafusion [...]
<dd><p>Encode the <code class="docutils literal notranslate"><span
class="pre">input</span></code>, using the <code class="docutils literal
notranslate"><span class="pre">encoding</span></code>. encoding can be base64
or hex.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="s2">"hello"</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">encode</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span
class="p">(</span><span class="s2">"base64"</s [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"enc"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">'aGVsbG8'</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4588,6 +4792,18 @@ column names or expressions.</p></li>
<dt class="sig sig-object py" id="datafusion.functions.in_list">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">in_list</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">arg</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafusion [...]
<dd><p>Returns whether the argument is contained within the list <code
class="docutils literal notranslate"><span class="pre">values</span></code>.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">in_list</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">lit</span><span class="p">(</span><span class="mi">1</span><span
class="p">),</span> <span class="n">dfn</span><span class="o">.</span><span
class="n">lit</span><span class="p">(</span><span class="mi">3 [...]
+<span class="gp">... </span> <span class="p">)</span><span
class="o">.</span><span class="n">alias</span><span class="p">(</span><span
class="s2">"in"</span><span class="p">)</span>
+<span class="gp">... </span><span class="p">)</span>
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"in"</span><span
class="p">)</span><span class="o">.</span><span class="n">to_pylist</span><span
class="p">()</span>
+<span class="go">[True, False, True]</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4602,6 +4818,14 @@ characters to lowercase.</p>
<dt class="sig sig-object py" id="datafusion.functions.isnan">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">isnan</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafusion. [...]
<dd><p>Returns true if a given number is +NaN or -NaN otherwise returns
false.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="n">np</span><span class="o">.</span><span class="n">nan</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">isnan</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><sp [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"isnan"</span><span
class="p">)[</span><span class="mi">1</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">True</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -4829,6 +5053,10 @@ column names or expressions.</p></li>
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">list_join</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafus [...]
<dd><p>Converts each element to its text representation.</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.array_to_string"
title="datafusion.functions.array_to_string"><code class="xref py py-func
docutils literal notranslate"><span
class="pre">array_to_string()</span></code></a>.</p>
+<div class="admonition seealso">
+<p class="admonition-title">See also</p>
+<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.array_to_string"
title="datafusion.functions.array_to_string"><code class="xref py py-func
docutils literal notranslate"><span
class="pre">array_to_string()</span></code></a>.</p>
+</div>
</dd></dl>
<dl class="py function">
@@ -4956,7 +5184,10 @@ filled with the given <code class="docutils literal
notranslate"><span class="pr
<dt class="sig sig-object py" id="datafusion.functions.list_to_string">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">list_to_string</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">da [...]
<dd><p>Converts each element to its text representation.</p>
+<div class="admonition seealso">
+<p class="admonition-title">See also</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.array_to_string"
title="datafusion.functions.array_to_string"><code class="xref py py-func
docutils literal notranslate"><span
class="pre">array_to_string()</span></code></a>.</p>
+</div>
</dd></dl>
<dl class="py function">
@@ -5079,6 +5310,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id11">
+<h3>Examples:<a class="headerlink" href="#id11" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">max</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span class
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">3</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -5100,6 +5341,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">mean</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expression</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafu [...]
<dd><p>Returns the average (mean) value of the argument.</p>
<p>This is an alias for <a class="reference internal"
href="#datafusion.functions.avg" title="datafusion.functions.avg"><code
class="xref py py-func docutils literal notranslate"><span
class="pre">avg()</span></code></a>.</p>
+<section id="id12">
+<h3>Examples:<a class="headerlink" href="#id12" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">mean</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span clas
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -5119,6 +5370,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id13">
+<h3>Examples:<a class="headerlink" href="#id13" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mf">1.0</span><span class="p">,</span> <span
class="mf">2.0</span><span class="p">,</span> <span class="mf">3.0</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">median</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span cl
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">2.0</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -5135,6 +5396,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id14">
+<h3>Examples:<a class="headerlink" href="#id14" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">min</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span class
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">1</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -5245,6 +5516,15 @@ column names or expressions.</p></li>
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">nullif</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr1</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafusio [...]
<dd><p>Returns NULL if expr1 equals expr2; otherwise it returns expr1.</p>
<p>This can be used to perform the inverse operation of the COALESCE
expression.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">],</span> <span
class="s2">"b"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</sp [...]
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">nullif</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"b"</span>< [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"nullif"</span><span
class="p">)</span><span class="o">.</span><span class="n">to_pylist</span><span
class="p">()</span>
+<span class="go">[None, 2]</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -5275,6 +5555,12 @@ column names or expressions.</p></li>
<dt class="sig sig-object py" id="datafusion.functions.order_by">
<span class="sig-prename descclassname"><span
class="pre">datafusion.functions.</span></span><span class="sig-name
descname"><span class="pre">order_by</span></span><span
class="sig-paren">(</span><em class="sig-param"><span class="n"><span
class="pre">expr</span></span><span class="p"><span
class="pre">:</span></span><span class="w"> </span><span class="n"><a
class="reference internal" href="../expr/index.html#datafusion.expr.Expr"
title="datafusion.expr.Expr"><span class="pre">datafusi [...]
<dd><p>Creates a new sort expression.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">sort_expr</span> <span class="o">=</span> <span
class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">order_by</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span c [...]
+<span class="gp">>>> </span><span class="n">sort_expr</span><span
class="o">.</span><span class="n">ascending</span><span class="p">()</span>
+<span class="go">False</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
@@ -6003,6 +6289,17 @@ column names or expressions.</p></li>
<div class="highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="n">df</span><span
class="o">.</span><span class="n">aggregate</span><span class="p">([],</span>
<span class="n">string_agg</span><span class="p">(</span><span
class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">),</span> <span
class="s2">","</span><span class="p">,</span> <span
class="n">order_by</span><span class="o">=</span><span class= [...]
</pre></div>
</div>
+<section id="id15">
+<h3>Examples:<a class="headerlink" href="#id15" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="s2">"x"</span><span class="p">,</span>
<span class="s2">"y"</span><span class="p">,</span> <span
class="s2">"z"</span><span class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">(</span>
+<span class="gp">... </span> <span class="p">[],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">string_agg</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">col</span><span
class="p">(</span><span class="s2">"a"</span><span
class="p">),</span> <span class="s2">","</span><span
class="p">,</span> <span class="n">order [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"s"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">'x,y,z'</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -6068,6 +6365,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
</ul>
</dd>
</dl>
+<section id="id16">
+<h3>Examples:<a class="headerlink" href="#id16" title="Link to this
heading">¶</a></h3>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">aggregate</span><span class="p">([],</span> <span
class="p">[</span><span class="n">dfn</span><span class="o">.</span><span
class="n">functions</span><span class="o">.</span><span
class="n">sum</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span class
[...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"v"</span><span
class="p">)[</span><span class="mi">0</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">6</span>
+</pre></div>
+</div>
+</section>
</dd></dl>
<dl class="py function">
@@ -6284,6 +6591,16 @@ the options <code class="docutils literal
notranslate"><span class="pre">order_b
<p>Create a <a class="reference internal"
href="../expr/index.html#datafusion.expr.CaseBuilder"
title="datafusion.expr.CaseBuilder"><code class="xref py py-class docutils
literal notranslate"><span class="pre">CaseBuilder</span></code></a> to match
cases for the
expression <code class="docutils literal notranslate"><span
class="pre">expr</span></code>. See <a class="reference internal"
href="../expr/index.html#datafusion.expr.CaseBuilder"
title="datafusion.expr.CaseBuilder"><code class="xref py py-class docutils
literal notranslate"><span class="pre">CaseBuilder</span></code></a> for
detailed usage.</p>
+<p class="rubric">Examples</p>
+<div class="doctest highlight-default notranslate"><div
class="highlight"><pre><span></span><span class="gp">>>> </span><span
class="n">ctx</span> <span class="o">=</span> <span class="n">dfn</span><span
class="o">.</span><span class="n">SessionContext</span><span class="p">()</span>
+<span class="gp">>>> </span><span class="n">df</span> <span
class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span
class="n">from_pydict</span><span class="p">({</span><span
class="s2">"a"</span><span class="p">:</span> <span
class="p">[</span><span class="mi">1</span><span class="p">,</span> <span
class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span
class="p">]})</span>
+<span class="gp">>>> </span><span class="n">result</span> <span
class="o">=</span> <span class="n">df</span><span class="o">.</span><span
class="n">select</span><span class="p">(</span>
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">functions</span><span class="o">.</span><span
class="n">when</span><span class="p">(</span><span class="n">dfn</span><span
class="o">.</span><span class="n">col</span><span class="p">(</span><span
class="s2">"a"</span><span class="p">)</span> <span
class="o">></span> <span class="n">dfn</span><span class="o">.</span><span
class="n">lit</span><span class="p">(</span><span class=" [...]
+<span class="gp">... </span> <span class="n">dfn</span><span
class="o">.</span><span class="n">lit</span><span class="p">(</span><span
class="s2">"big"</span><span class="p">))</span><span
class="o">.</span><span class="n">otherwise</span><span class="p">(</span><span
class="n">dfn</span><span class="o">.</span><span class="n">lit</span><span
class="p">(</span><span class="s2">"small"</span><span
class="p">))</span><span class="o">.</span><span class="n">alias</spa [...]
+<span class="gp">>>> </span><span class="n">result</span><span
class="o">.</span><span class="n">collect_column</span><span
class="p">(</span><span class="s2">"c"</span><span
class="p">)[</span><span class="mi">2</span><span class="p">]</span><span
class="o">.</span><span class="n">as_py</span><span class="p">()</span>
+<span class="go">'big'</span>
+</pre></div>
+</div>
</dd></dl>
<dl class="py function">
diff --git a/searchindex.js b/searchindex.js
index df32a631..a5f14f8c 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"API Reference": [[19, null]], "Additional
Resources": [[37, "additional-resources"]], "Aggregate Functions": [[24,
"aggregate-functions"], [31, "aggregate-functions"], [33,
"aggregate-functions"]], "Aggregation": [[24, null]], "Alternative Approach":
[[20, "alternative-approach"]], "Apache Iceberg": [[35, "apache-iceberg"]],
"Arrays": [[26, "arrays"]], "Arrow": [[39, null]], "Attributes": [[4,
"attributes"], [5, "attributes"], [7, "attributes"], [12, "attr [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"API Reference": [[19, null]], "Additional
Resources": [[37, "additional-resources"]], "Aggregate Functions": [[24,
"aggregate-functions"], [31, "aggregate-functions"], [33,
"aggregate-functions"]], "Aggregation": [[24, null]], "Alternative Approach":
[[20, "alternative-approach"]], "Apache Iceberg": [[35, "apache-iceberg"]],
"Arrays": [[26, "arrays"]], "Arrow": [[39, null]], "Attributes": [[4,
"attributes"], [5, "attributes"], [7, "attributes"], [12, "attr [...]
\ No newline at end of file
diff --git a/user-guide/common-operations/aggregations.html
b/user-guide/common-operations/aggregations.html
index c2fbbf15..98191d88 100644
--- a/user-guide/common-operations/aggregations.html
+++ b/user-guide/common-operations/aggregations.html
@@ -620,15 +620,15 @@ Pokemon set. Since there will be many entries of <code
class="docutils literal n
<span
class="o">+----------+--------------------------------------------------+</span>
<span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span>
<span class="o">|</span> <span class="n">Type</span> <span
class="mi">2</span> <span class="n">List</span>
<span class="o">|</span>
<span
class="o">+----------+--------------------------------------------------+</span>
-<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Poison</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="n">Grass</span><span class="p">]</span> <span
class="o">|</span>
-<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Ground</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Steel</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Grass</span><span class="p">,</span> <span
class="p">,</span> <span class="n">Poison</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Steel</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Flying</span><span
class="p">]</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Fairy</span> <span
class="o">|</span> <span class="p">[]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Flying</span><span
class="p">,</span> <span class="n">Fairy</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Fairy</span><span
class="p">]</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Poison</span><span
class="p">]</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Dragon</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="p">]</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Fighting</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span
class="p">,</span> <span class="n">Dark</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">,</span> <span
class="n">Psychic</span><span class="p">,</span> <span
class="n">Ice</span><span class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Psychic</span><span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Dragon</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Flying</span><span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="p">,</span> <span class="n">Ice</span><span
class="p">,</span> <span class="n">Fighting</span><span class="p">,</span>
<span class="n">Poison</span><span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span
class="n">Psychic</span><span class="p">]</span> <span class="o">|</span>
<span class="o">|</span> <span class="n">Ground</span> <span
class="o">|</span> <span class="p">[,</span> <span class="n">Rock</span><span
class="p">]</span> <span
class="o">|</span>
<span
class="o">+----------+--------------------------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
@@ -644,15 +644,15 @@ entries entirely removed. The second is we can use the
<code class="docutils lit
<span
class="o">+----------+------------------------------------------------+</span>
<span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span>
<span class="o">|</span> <span class="n">Type</span> <span
class="mi">2</span> <span class="n">List</span>
<span class="o">|</span>
<span
class="o">+----------+------------------------------------------------+</span>
-<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Grass</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="n">Poison</span><span class="p">]</span> <span
class="o">|</span>
-<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Grass</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">]</span> <span
class="o">|</span>
+<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Ground</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Steel</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Fairy</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Dragon</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Psychic</span><span
class="p">,</span> <span class="n">Dark</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">,</span> <span class="n">Ice</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span
class="n">Fighting</span><span class="p">]</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">Rock</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Water</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="n">Ground</span><span class="p">]</span> <span
class="o">|</span>
+<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Ice</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span
class="n">Fighting</span><span class="p">,</span> <span
class="n">Psychic</span><span class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Rock</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Ground</span><span class="p">,</span> <span
class="n">Water</span><span class="p">]</span> <span
class="o">|</span>
<span class="o">|</span> <span class="n">Ghost</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">]</span> <span
class="o">|</span>
<span
class="o">+----------+------------------------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
@@ -663,15 +663,15 @@ entries entirely removed. The second is we can use the
<code class="docutils lit
<span
class="o">+----------+------------------------------------------------+</span>
<span class="o">|</span> <span class="n">Type</span> <span class="mi">1</span>
<span class="o">|</span> <span class="n">Type</span> <span
class="mi">2</span> <span class="n">List</span>
<span class="o">|</span>
<span
class="o">+----------+------------------------------------------------+</span>
-<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Grass</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">]</span> <span
class="o">|</span>
-<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Ground</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Steel</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Bug</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">,</span> <span
class="n">Grass</span><span class="p">]</span> <span
class="o">|</span>
+<span class="o">|</span> <span class="n">Poison</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Ground</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Electric</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Steel</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Fairy</span> <span
class="o">|</span> <span
class="o">|</span>
-<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Fairy</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Normal</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Fairy</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Ice</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
<span class="o">|</span> <span class="n">Grass</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Poison</span><span
class="p">,</span> <span class="n">Psychic</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Dragon</span><span
class="p">,</span> <span class="n">Flying</span><span class="p">]</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Dark</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">,</span> <span
class="n">Fighting</span><span class="p">,</span> <span
class="n">Psychic</span><span class="p">,</span> <span
class="n">Flying</span><span class="p">,</span> <span class="n">Ice</span><span
class="p">]</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">Fire</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Dragon</span><span class="p">]</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="n">Water</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Flying</span><span
class="p">,</span> <span class="n">Fighting</span><span class="p">,</span>
<span class="n">Psychic</span><span class="p">,</span> <span
class="n">Dark</span><span class="p">,</span> <span class="n">Ice</span><span
class="p">,</span> <span class="n">Poison</span><span class="p">]</span> <span
class="o">|</span>
<span class="o">|</span> <span class="n">Ground</span> <span
class="o">|</span> <span class="p">[</span><span class="n">Rock</span><span
class="p">]</span> <span
class="o">|</span>
<span
class="o">+----------+------------------------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
diff --git a/user-guide/common-operations/basic-info.html
b/user-guide/common-operations/basic-info.html
index 3e915d71..29bba054 100644
--- a/user-guide/common-operations/basic-info.html
+++ b/user-guide/common-operations/basic-info.html
@@ -456,11 +456,11 @@
<span class="o">+-----+---------+--------+--------+</span>
<span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span>
<span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span class="n">groups</span>
<span class="o">|</span>
<span class="o">+-----+---------+--------+--------+</span>
-<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">958</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">220</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">3</span> <span class="o">|</span>
<span class="n">java</span> <span class="o">|</span> <span
class="mi">842</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">4</span> <span class="o">|</span>
<span class="n">haskell</span> <span class="o">|</span> <span
class="mi">940</span> <span class="o">|</span> <span class="n">C</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">5</span> <span class="o">|</span>
<span class="n">go</span> <span class="o">|</span> <span
class="mi">619</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">504</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">61</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">3</span> <span class="o">|</span>
<span class="n">java</span> <span class="o">|</span> <span
class="mi">253</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">4</span> <span class="o">|</span>
<span class="n">haskell</span> <span class="o">|</span> <span
class="mi">19</span> <span class="o">|</span> <span class="n">C</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">5</span> <span class="o">|</span>
<span class="n">go</span> <span class="o">|</span> <span
class="mi">9</span> <span class="o">|</span> <span class="n">B</span>
<span class="o">|</span>
<span class="o">+-----+---------+--------+--------+</span>
</pre></div>
</div>
@@ -471,8 +471,8 @@
<span class="o">+-----+--------+--------+--------+</span>
<span class="o">|</span> <span class="n">nrs</span> <span class="o">|</span>
<span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span class="n">groups</span>
<span class="o">|</span>
<span class="o">+-----+--------+--------+--------+</span>
-<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">958</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
-<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">220</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">1</span> <span class="o">|</span>
<span class="n">python</span> <span class="o">|</span> <span
class="mi">504</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
+<span class="o">|</span> <span class="mi">2</span> <span class="o">|</span>
<span class="n">ruby</span> <span class="o">|</span> <span
class="mi">61</span> <span class="o">|</span> <span class="n">A</span>
<span class="o">|</span>
<span class="o">+-----+--------+--------+--------+</span>
</pre></div>
</div>
@@ -490,28 +490,28 @@ passing them to an Arrow table, and then converting them
to a pandas DataFrame.<
<div class="highlight-ipython notranslate"><div
class="highlight"><pre><span></span><span class="n">In</span> <span
class="p">[</span><span class="mi">8</span><span class="p">]:</span> <span
class="n">df</span><span class="o">.</span><span
class="n">to_pandas</span><span class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span
class="mi">8</span><span class="p">]:</span>
<span class="n">nrs</span> <span class="n">names</span> <span
class="n">random</span> <span class="n">groups</span>
-<span class="mi">0</span> <span class="mi">1</span> <span
class="n">python</span> <span class="mi">958</span> <span
class="n">A</span>
-<span class="mi">1</span> <span class="mi">2</span> <span
class="n">ruby</span> <span class="mi">220</span> <span
class="n">A</span>
-<span class="mi">2</span> <span class="mi">3</span> <span
class="n">java</span> <span class="mi">842</span> <span
class="n">B</span>
-<span class="mi">3</span> <span class="mi">4</span> <span
class="n">haskell</span> <span class="mi">940</span> <span
class="n">C</span>
-<span class="mi">4</span> <span class="mi">5</span> <span
class="n">go</span> <span class="mi">619</span> <span
class="n">B</span>
+<span class="mi">0</span> <span class="mi">1</span> <span
class="n">python</span> <span class="mi">504</span> <span
class="n">A</span>
+<span class="mi">1</span> <span class="mi">2</span> <span
class="n">ruby</span> <span class="mi">61</span> <span
class="n">A</span>
+<span class="mi">2</span> <span class="mi">3</span> <span
class="n">java</span> <span class="mi">253</span> <span
class="n">B</span>
+<span class="mi">3</span> <span class="mi">4</span> <span
class="n">haskell</span> <span class="mi">19</span> <span
class="n">C</span>
+<span class="mi">4</span> <span class="mi">5</span> <span
class="n">go</span> <span class="mi">9</span> <span
class="n">B</span>
</pre></div>
</div>
<p><a class="reference internal"
href="../../autoapi/datafusion/dataframe/index.html#datafusion.dataframe.DataFrame.describe"
title="datafusion.dataframe.DataFrame.describe"><code class="xref py py-func
docutils literal notranslate"><span class="pre">describe()</span></code></a>
shows a quick statistic summary of your data:</p>
<div class="highlight-ipython notranslate"><div
class="highlight"><pre><span></span><span class="n">In</span> <span
class="p">[</span><span class="mi">9</span><span class="p">]:</span> <span
class="n">df</span><span class="o">.</span><span class="n">describe</span><span
class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span
class="mi">9</span><span class="p">]:</span>
<span class="n">DataFrame</span><span class="p">()</span>
-<span
class="o">+------------+--------------------+-------+-------------------+--------+</span>
-<span class="o">|</span> <span class="n">describe</span> <span
class="o">|</span> <span class="n">nrs</span> <span
class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span
class="n">groups</span> <span class="o">|</span>
-<span
class="o">+------------+--------------------+-------+-------------------+--------+</span>
-<span class="o">|</span> <span class="n">count</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span
class="mf">5.0</span> <span class="o">|</span> <span
class="mi">5</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">null_count</span> <span
class="o">|</span> <span class="mf">0.0</span> <span
class="o">|</span> <span class="mi">0</span> <span class="o">|</span> <span
class="mf">0.0</span> <span class="o">|</span> <span
class="mi">0</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">mean</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">715.8</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">std</span> <span
class="o">|</span> <span class="mf">1.5811388300841898</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">308.2372462892828</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
-<span class="o">|</span> <span class="nb">min</span> <span
class="o">|</span> <span class="mf">1.0</span> <span
class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span
class="mf">220.0</span> <span class="o">|</span> <span
class="n">A</span> <span class="o">|</span>
-<span class="o">|</span> <span class="nb">max</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span
class="mf">958.0</span> <span class="o">|</span> <span
class="n">C</span> <span class="o">|</span>
-<span class="o">|</span> <span class="n">median</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">842.0</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
-<span
class="o">+------------+--------------------+-------+-------------------+--------+</span>
+<span
class="o">+------------+--------------------+-------+--------------------+--------+</span>
+<span class="o">|</span> <span class="n">describe</span> <span
class="o">|</span> <span class="n">nrs</span> <span
class="o">|</span> <span class="n">names</span> <span class="o">|</span> <span
class="n">random</span> <span class="o">|</span> <span
class="n">groups</span> <span class="o">|</span>
+<span
class="o">+------------+--------------------+-------+--------------------+--------+</span>
+<span class="o">|</span> <span class="n">count</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="mi">5</span> <span class="o">|</span> <span
class="mf">5.0</span> <span class="o">|</span> <span
class="mi">5</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">null_count</span> <span
class="o">|</span> <span class="mf">0.0</span> <span
class="o">|</span> <span class="mi">0</span> <span class="o">|</span> <span
class="mf">0.0</span> <span class="o">|</span> <span
class="mi">0</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">mean</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">169.2</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">std</span> <span
class="o">|</span> <span class="mf">1.5811388300841898</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">211.56842864662013</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
+<span class="o">|</span> <span class="nb">min</span> <span
class="o">|</span> <span class="mf">1.0</span> <span
class="o">|</span> <span class="n">go</span> <span class="o">|</span> <span
class="mf">9.0</span> <span class="o">|</span> <span
class="n">A</span> <span class="o">|</span>
+<span class="o">|</span> <span class="nb">max</span> <span
class="o">|</span> <span class="mf">5.0</span> <span
class="o">|</span> <span class="n">ruby</span> <span class="o">|</span> <span
class="mf">504.0</span> <span class="o">|</span> <span
class="n">C</span> <span class="o">|</span>
+<span class="o">|</span> <span class="n">median</span> <span
class="o">|</span> <span class="mf">3.0</span> <span
class="o">|</span> <span class="n">null</span> <span class="o">|</span> <span
class="mf">61.0</span> <span class="o">|</span> <span
class="n">null</span> <span class="o">|</span>
+<span
class="o">+------------+--------------------+-------+--------------------+--------+</span>
</pre></div>
</div>
</section>
diff --git a/user-guide/common-operations/functions.html
b/user-guide/common-operations/functions.html
index 8a02ede3..aafdc83a 100644
--- a/user-guide/common-operations/functions.html
+++ b/user-guide/common-operations/functions.html
@@ -566,16 +566,16 @@ In here we will cover some of the more popular use cases.
If you want to view al
<span class="o">+-------------------------------+</span>
<span class="o">|</span> <span class="n">now</span><span class="p">()</span>
<span class="o">|</span>
<span class="o">+-------------------------------+</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
-<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">51</span><span class="p">:</span><span
class="mf">03.219331723</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
+<span class="o">|</span> <span class="mi">2026</span><span
class="o">-</span><span class="mi">03</span><span class="o">-</span><span
class="mi">17</span><span class="n">T06</span><span class="p">:</span><span
class="mi">52</span><span class="p">:</span><span
class="mf">01.621865136</span> <span class="o">|</span>
<span class="o">+-------------------------------+</span>
<span class="n">Data</span> <span class="n">truncated</span><span
class="o">.</span>
</pre></div>
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
