Skip to content

Revise example usage section headings #22909

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

Merged
alamb merged 3 commits into from
Aug 20, 2026
Merged

Revise example usage section headings #22909

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0baef1b
Revise example usage section headings
Tchoupinax Jun 11, 2026
99c84d0
Merge branch 'apache:main' into patch-1
Tchoupinax Aug 19, 2026
aed9c28
docs: nest identifier examples under capitalization section
Tchoupinax Aug 19, 2026
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
8 changes: 5 additions & 3 deletions docs/source/user-guide/example-usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::*;
Expand All @@ -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::*;
Expand All @@ -170,7 +172,7 @@ async fn main() -> datafusion::error::Result<()> {
}
```

## Output from both examples
Output from both examples:

```text
+---+--------+
Expand Down