Skip to content

Commit 1e246e3

Browse files
timsaucerclaude
andcommitted
docs: defer spark function list to API reference
Hand-maintained category list would drift from the actual module as upstream `datafusion-spark` adds/removes functions. Replace with a pointer to the AutoAPI-generated reference, which renders from the module itself. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 7a7f6b1 commit 1e246e3

1 file changed

Lines changed: 6 additions & 36 deletions

File tree

docs/source/user-guide/common-operations/spark-functions.rst

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -84,39 +84,9 @@ of the same name.
8484
The override applies for the lifetime of the session. To call DataFusion's
8585
built-in versions afterwards, create a fresh ``SessionContext``.
8686

87-
Function Categories
88-
-------------------
89-
90-
The full list is available in the
91-
:py:mod:`API reference <datafusion.functions.spark>`. Highlights by
92-
category:
93-
94-
- **String**: ``ascii``, ``base64``, ``char``, ``concat``, ``elt``,
95-
``format_string``, ``ilike``, ``is_valid_utf8``, ``length``, ``like``,
96-
``luhn_check``, ``make_valid_utf8``, ``soundex``, ``space``,
97-
``substring``, ``unbase64``.
98-
- **Math**: ``abs``, ``bin``, ``ceil``, ``csc``, ``expm1``, ``factorial``,
99-
``floor``, ``hex``, ``modulus``, ``negative``, ``pmod``, ``rint``,
100-
``round``, ``sec``, ``unhex``, ``width_bucket``.
101-
- **Datetime**: ``add_months``, ``date_add``, ``date_diff``, ``date_part``,
102-
``date_sub``, ``date_trunc``, ``from_utc_timestamp``, ``hour``,
103-
``last_day``, ``make_dt_interval``, ``make_interval``, ``minute``,
104-
``next_day``, ``second``, ``time_trunc``, ``to_utc_timestamp``,
105-
``trunc``, ``unix_date``, ``unix_micros``, ``unix_millis``,
106-
``unix_seconds``.
107-
- **Hash**: ``crc32``, ``sha1``, ``sha2``, ``xxhash64``.
108-
- **Array**: ``array``, ``array_contains``, ``array_repeat``, ``shuffle``,
109-
``slice``.
110-
- **Aggregate**: ``avg``, ``collect_list``, ``collect_set``, ``try_sum``.
111-
- **Bitwise**: ``bit_count``, ``bit_get``, ``bitwise_not``, ``shiftleft``,
112-
``shiftright``, ``shiftrightunsigned``.
113-
- **Bitmap**: ``bitmap_bit_position``, ``bitmap_bucket_number``,
114-
``bitmap_count``.
115-
- **Collection**: ``size``.
116-
- **Conditional**: ``if_`` (exposed under that name because ``if`` is a
117-
Python keyword).
118-
- **Conversion**: ``spark_cast``.
119-
- **JSON**: ``json_tuple``.
120-
- **Map**: ``map_from_arrays``, ``map_from_entries``, ``str_to_map``.
121-
- **URL**: ``parse_url``, ``try_parse_url``, ``url_decode``,
122-
``try_url_decode``, ``url_encode``.
87+
Function Reference
88+
------------------
89+
90+
The full, up-to-date list of available Spark functions — with signatures
91+
and per-function docstrings — lives in the
92+
:py:mod:`datafusion.functions.spark` API reference.

0 commit comments

Comments
 (0)