Skip to content

docs: add runnable examples for input_file_name() and file_row_index() #24634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alamb wants to merge 1 commit into
base: main
Choose a base branch
from
+40 −4
Open

docs: add runnable examples for input_file_name() and file_row_index() #24634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion datafusion/functions/src/core/file_row_index.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,16 @@ evaluation returns an error.
"#,
syntax_example = "file_row_index()",
sql_example = r#"```sql
SELECT file_row_index() FROM t;
> COPY (SELECT * from values (100), (200), (300)) to '/tmp/foo.parquet';

> select *, input_file_name(), file_row_index() from '/tmp/foo.parquet';
+---------+-------------------+------------------+
| column1 | input_file_name() | file_row_index() |
+---------+-------------------+------------------+
| 100 | tmp/foo.parquet | 0 |
| 200 | tmp/foo.parquet | 1 |
| 300 | tmp/foo.parquet | 2 |
+---------+-------------------+------------------+
```"#
)]
#[derive(Debug, PartialEq, Eq, Hash)]
Expand Down
11 changes: 10 additions & 1 deletion datafusion/functions/src/core/input_file_name.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,16 @@ evaluated outside a file scan, or was not pushed down into one), direct evaluati
"#,
syntax_example = "input_file_name()",
sql_example = r#"```sql
SELECT input_file_name() FROM t;
> COPY (SELECT * from values (100), (200), (300)) to '/tmp/foo.parquet';

> select *, input_file_name(), file_row_index() from '/tmp/foo.parquet';
+---------+-------------------+------------------+
| column1 | input_file_name() | file_row_index() |
+---------+-------------------+------------------+
| 100 | tmp/foo.parquet | 0 |
| 200 | tmp/foo.parquet | 1 |
| 300 | tmp/foo.parquet | 2 |
+---------+-------------------+------------------+
```"#
)]
#[derive(Debug, PartialEq, Eq, Hash)]
Expand Down
22 changes: 20 additions & 2 deletions docs/source/user-guide/sql/scalar_functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5960,7 +5960,16 @@ file_row_index()
#### Example

```sql
SELECT file_row_index() FROM t;
> COPY (SELECT * from values (100), (200), (300)) to '/tmp/foo.parquet';

> select *, input_file_name(), file_row_index() from '/tmp/foo.parquet';
+---------+-------------------+------------------+
| column1 | input_file_name() | file_row_index() |
+---------+-------------------+------------------+
| 100 | tmp/foo.parquet | 0 |
| 200 | tmp/foo.parquet | 1 |
| 300 | tmp/foo.parquet | 2 |
+---------+-------------------+------------------+
```

### `get_field`
Expand Down Expand Up @@ -6032,7 +6041,16 @@ input_file_name()
#### Example

```sql
SELECT input_file_name() FROM t;
> COPY (SELECT * from values (100), (200), (300)) to '/tmp/foo.parquet';

> select *, input_file_name(), file_row_index() from '/tmp/foo.parquet';
+---------+-------------------+------------------+
| column1 | input_file_name() | file_row_index() |
+---------+-------------------+------------------+
| 100 | tmp/foo.parquet | 0 |
| 200 | tmp/foo.parquet | 1 |
| 300 | tmp/foo.parquet | 2 |
+---------+-------------------+------------------+
```

### `try_cast_to_type`
Expand Down