Skip to content

Commit f8a22a5

Browse files
authored
docs: Fix some broken / missing links in the DataFusion documentation (#19958)
## Which issue does this PR close? ## Rationale for this change While reading the DataFusion documentation, I noticed a broken link here: <img width="787" height="885" alt="Screenshot 2026-01-23 at 9 34 43 AM" src="https://github.com/user-attachments/assets/9013151d-599b-4973-968e-0033c6614643" /> ## What changes are included in this PR? Fix several broken and missing links (this was done by codex and I reviewed the PR) ## Are these changes tested? Yes, by CI ## Are there any user-facing changes? Better docs. No functional changes intended
1 parent b6f7521 commit f8a22a5

File tree

7 files changed

+36
-12
lines changed

7 files changed

+36
-12
lines changed

datafusion/functions/src/datetime/to_timestamp.rs

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ use datafusion_macros::user_doc;
4242
description = r#"
4343
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000000<TZ>`) in the session time zone. Supports strings,
4444
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
45-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
45+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
46+
Strings that parse without a time zone are treated as if they are in the
4647
session time zone, or UTC if no session time zone is set.
4748
Integers, unsigned integers, and doubles are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00Z`).
4849
@@ -96,7 +97,8 @@ pub struct ToTimestampFunc {
9697
description = r#"
9798
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00<TZ>`) in the session time zone. Supports strings,
9899
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
99-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
100+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
101+
Strings that parse without a time zone are treated as if they are in the
100102
session time zone, or UTC if no session time zone is set.
101103
Integers, unsigned integers, and doubles are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00Z`).
102104
@@ -145,7 +147,8 @@ pub struct ToTimestampSecondsFunc {
145147
description = r#"
146148
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000<TZ>`) in the session time zone. Supports strings,
147149
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
148-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
150+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
151+
Strings that parse without a time zone are treated as if they are in the
149152
session time zone, or UTC if no session time zone is set.
150153
Integers, unsigned integers, and doubles are interpreted as milliseconds since the unix epoch (`1970-01-01T00:00:00Z`).
151154
@@ -194,7 +197,8 @@ pub struct ToTimestampMillisFunc {
194197
description = r#"
195198
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000000<TZ>`) in the session time zone. Supports strings,
196199
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
197-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
200+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
201+
Strings that parse without a time zone are treated as if they are in the
198202
session time zone, or UTC if no session time zone is set.
199203
Integers, unsigned integers, and doubles are interpreted as microseconds since the unix epoch (`1970-01-01T00:00:00Z`).
200204
@@ -243,7 +247,8 @@ pub struct ToTimestampMicrosFunc {
243247
description = r#"
244248
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000000000<TZ>`) in the session time zone. Supports strings,
245249
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
246-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
250+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
251+
Strings that parse without a time zone are treated as if they are in the
247252
session time zone. Integers, unsigned integers, and doubles are interpreted as nanoseconds since the unix epoch (`1970-01-01T00:00:00Z`).
248253
249254
The session time zone can be set using the statement `SET TIMEZONE = 'desired time zone'`.

datafusion/functions/src/datetime/to_unixtime.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,12 @@ use std::any::Any;
2727

2828
#[user_doc(
2929
doc_section(label = "Time and Date Functions"),
30-
description = "Converts a value to seconds since the unix epoch (`1970-01-01T00:00:00`). Supports strings, dates, timestamps, integer, unsigned integer, and float types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00') if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided. Integers, unsigned integers, and floats are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00`).",
30+
description = r#"
31+
Converts a value to seconds since the unix epoch (`1970-01-01T00:00:00`).
32+
Supports strings, dates, timestamps, integer, unsigned integer, and float types as input.
33+
Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
34+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
35+
Integers, unsigned integers, and floats are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00`)."#,
3136
syntax_example = "to_unixtime(expression[, ..., format_n])",
3237
sql_example = r#"
3338
```sql

docs/source/contributor-guide/testing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ locally by following the [instructions in the documentation].
104104

105105
[sqlite test suite]: https://www.sqlite.org/sqllogictest/dir?ci=tip
106106
[instructions in the documentation]: https://github.com/apache/datafusion/tree/main/datafusion/sqllogictest#running-tests-sqlite
107+
[extended.yml]: https://github.com/apache/datafusion/blob/main/.github/workflows/extended.yml
107108

108109
## Rust Integration Tests
109110

docs/source/library-user-guide/query-optimizer.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -514,3 +514,5 @@ fn analyze_filter_example() -> Result<()> {
514514
Ok(())
515515
}
516516
```
517+
518+
[treenode api]: https://docs.rs/datafusion/latest/datafusion/common/tree_node/trait.TreeNode.html

docs/source/user-guide/arrow-introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,7 @@ When working with Arrow and RecordBatches, watch out for these common issues:
220220
- [Schema](https://docs.rs/arrow-schema/latest/arrow_schema/struct.Schema.html) - Describes the structure of a RecordBatch (column names and types)
221221

222222
[apache arrow]: https://arrow.apache.org/docs/index.html
223+
[arrow-rs]: https://github.com/apache/arrow-rs
223224
[`arc`]: https://doc.rust-lang.org/std/sync/struct.Arc.html
224225
[`arrayref`]: https://docs.rs/arrow-array/latest/arrow_array/array/type.ArrayRef.html
225226
[`cast`]: https://docs.rs/arrow/latest/arrow/compute/fn.cast.html

docs/source/user-guide/crate-configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ your Rust project. The [Configuration Settings] section lists options that
2424
control additional aspects DataFusion's runtime behavior.
2525

2626
[configuration settings]: configs.md
27+
[support for adding dependencies]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies
2728

2829
## Using the nightly DataFusion builds
2930

docs/source/user-guide/sql/scalar_functions.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2880,7 +2880,8 @@ Additional examples can be found [here](https://github.com/apache/datafusion/blo
28802880

28812881
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000000<TZ>`) in the session time zone. Supports strings,
28822882
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
2883-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
2883+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
2884+
Strings that parse without a time zone are treated as if they are in the
28842885
session time zone, or UTC if no session time zone is set.
28852886
Integers, unsigned integers, and doubles are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00Z`).
28862887

@@ -2928,7 +2929,8 @@ Additional examples can be found [here](https://github.com/apache/datafusion/blo
29282929

29292930
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000000<TZ>`) in the session time zone. Supports strings,
29302931
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
2931-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
2932+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
2933+
Strings that parse without a time zone are treated as if they are in the
29322934
session time zone, or UTC if no session time zone is set.
29332935
Integers, unsigned integers, and doubles are interpreted as microseconds since the unix epoch (`1970-01-01T00:00:00Z`).
29342936

@@ -2971,7 +2973,8 @@ Additional examples can be found [here](https://github.com/apache/datafusion/blo
29712973

29722974
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000<TZ>`) in the session time zone. Supports strings,
29732975
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
2974-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
2976+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
2977+
Strings that parse without a time zone are treated as if they are in the
29752978
session time zone, or UTC if no session time zone is set.
29762979
Integers, unsigned integers, and doubles are interpreted as milliseconds since the unix epoch (`1970-01-01T00:00:00Z`).
29772980

@@ -3014,7 +3017,8 @@ Additional examples can be found [here](https://github.com/apache/datafusion/blo
30143017

30153018
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00.000000000<TZ>`) in the session time zone. Supports strings,
30163019
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
3017-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
3020+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
3021+
Strings that parse without a time zone are treated as if they are in the
30183022
session time zone. Integers, unsigned integers, and doubles are interpreted as nanoseconds since the unix epoch (`1970-01-01T00:00:00Z`).
30193023

30203024
The session time zone can be set using the statement `SET TIMEZONE = 'desired time zone'`.
@@ -3056,7 +3060,8 @@ Additional examples can be found [here](https://github.com/apache/datafusion/blo
30563060

30573061
Converts a value to a timestamp (`YYYY-MM-DDT00:00:00<TZ>`) in the session time zone. Supports strings,
30583062
integer, unsigned integer, and double types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
3059-
if no [Chrono formats] are provided. Strings that parse without a time zone are treated as if they are in the
3063+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
3064+
Strings that parse without a time zone are treated as if they are in the
30603065
session time zone, or UTC if no session time zone is set.
30613066
Integers, unsigned integers, and doubles are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00Z`).
30623067

@@ -3097,7 +3102,11 @@ Additional examples can be found [here](https://github.com/apache/datafusion/blo
30973102

30983103
### `to_unixtime`
30993104

3100-
Converts a value to seconds since the unix epoch (`1970-01-01T00:00:00`). Supports strings, dates, timestamps, integer, unsigned integer, and float types as input. Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00') if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided. Integers, unsigned integers, and floats are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00`).
3105+
Converts a value to seconds since the unix epoch (`1970-01-01T00:00:00`).
3106+
Supports strings, dates, timestamps, integer, unsigned integer, and float types as input.
3107+
Strings are parsed as RFC3339 (e.g. '2023-07-20T05:44:00')
3108+
if no [Chrono formats](https://docs.rs/chrono/latest/chrono/format/strftime/index.html) are provided.
3109+
Integers, unsigned integers, and floats are interpreted as seconds since the unix epoch (`1970-01-01T00:00:00`).
31013110

31023111
```sql
31033112
to_unixtime(expression[, ..., format_n])

0 commit comments

Comments
 (0)