This is an automated email from the ASF dual-hosted git repository.
github-merge-queue[bot] pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/main by this push:
new 93834e1eb7 Revise example usage section headings (#22909)
93834e1eb7 is described below
commit 93834e1eb72c9f8065c011f0c3d95e132fe73fe9
Author: Tchoupinax <[email protected]>
AuthorDate: Thu Aug 20 19:09:26 2026 +0000
Revise example usage section headings (#22909)
Hello,
Just reading the documentation and was confused by given example. They
are pretty similar. I was even thinking about merging them and only keep
one example with operator and one with SQL.
At least, example title should be renamed with `example 2` or `#2` to be
less confusing IMO.
What do you think?
Thanks for your work!
---------
Co-authored-by: Cursor <[email protected]>
---
docs/source/user-guide/example-usage.md | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/docs/source/user-guide/example-usage.md
b/docs/source/user-guide/example-usage.md
index 6f2419b9cd..3d89405385 100644
--- a/docs/source/user-guide/example-usage.md
+++ b/docs/source/user-guide/example-usage.md
@@ -123,9 +123,11 @@ unexpectedly.
Please be aware that all identifiers are effectively made lower-case in SQL,
so if your csv file has capital letters (ex: `Name`) you must put your column
name in double quotes or the examples won't work.
+This behavior can be disabled by setting the
`datafusion.sql_parser.enable_ident_normalization` config to `false`. See
[Configuration Settings](configs.md) for details.
+
To illustrate this behavior, consider the
[`capitalized_example.csv`](../../../datafusion/core/tests/data/capitalized_example.csv)
file:
-## Run a SQL query against data stored in a CSV:
+- Using the SQL API:
```rust
use datafusion::prelude::*;
@@ -145,7 +147,7 @@ async fn main() -> datafusion::error::Result<()> {
}
```
-## Use the DataFrame API to process data stored in a CSV:
+- Using the DataFrame API:
```rust
use datafusion::prelude::*;
@@ -170,7 +172,7 @@ async fn main() -> datafusion::error::Result<()> {
}
```
-## Output from both examples
+Output from both examples:
```text
+---+--------+
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
