Apache DataFusion SQL Query Engine
docs: add runnable examples for `input_file_name()` and `file_row_index()` (#24634)
Andrew Lamb040b6d0b9945
diff --git a/datafusion/functions/src/core/file_row_index.rs b/datafusion/functions/src/core/file_row_index.rsindex 7b2667a8b8..e76b57e147 100644--- a/datafusion/functions/src/core/file_row_index.rs+++ b/datafusion/functions/src/core/file_row_index.rs@@ -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)]diff --git a/datafusion/functions/src/core/input_file_name.rs b/datafusion/functions/src/core/input_file_name.rsindex a47e9daaf8..555c498e57 100644--- a/datafusion/functions/src/core/input_file_name.rs+++ b/datafusion/functions/src/core/input_file_name.rs@@ -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)]diff --git a/docs/source/user-guide/sql/scalar_functions.md b/docs/source/user-guide/sql/scalar_functions.mdindex 44e697569a..bdc8efb1bd 100644--- a/docs/source/user-guide/sql/scalar_functions.md+++ b/docs/source/user-guide/sql/scalar_functions.md@@ -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`@@ -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`