-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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.
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
Improve doc on lowercase treatment of columns on SQL #3385
Conversation
Adds specific note on lowercase treatment of columns on SQL This example is the first thing newcomers see when they start with datafusion (literally the second page on the docs) so it should be clearer.
add note on the use of default lower-case for SQL query
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @nanicpc -- I think the notes are great. I am not sure about the change to the example code.
@@ -19,6 +19,8 @@ | |||
|
|||
# Example Usage | |||
|
|||
In this example some simple processing is performed on a csv file. Please be aware that all identifiers are made lower-case in SQL, so if your csv file has capital letters (ex: Name) you should put your column name in double quotes or the example won't work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This note is great
Codecov Report
@@ Coverage Diff @@
## master #3385 +/- ##
=======================================
Coverage 85.58% 85.58%
=======================================
Files 296 296
Lines 54175 54187 +12
=======================================
+ Hits 46364 46377 +13
+ Misses 7811 7810 -1
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Marking as draft to signify this PR has planned changes (and make it easier to find PRs that are in need of review). Please mark "ready for review" when it is next ready or if this change was a mistake. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @nanicpc
What do you think about changing the introductory example in the user guide @andygrove ? Given it is the first thing some people see I think there is a potential reason to keep it as simple as possible (and thus maybe it would be nice to leave it uncapitalized, and add add a link about the important subtlety of capitalization to somewhere later? If you agree I will merge this PR and then make a follow on PR that tries to retain the simple initial example as well as the capitalized example |
That sounds great. Thanks @alamb |
Thanks again @nanicpc |
Benchmark runs are scheduled for baseline = d5c361b and contender = d5e6736. d5e6736 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
Follow on PR in #3815 |
Adds specific note on lowercase treatment of columns on SQL
Which issue does this PR close?
Closes #2374
Rationale for this change
This example is the first thing newcomers see when they start with datafusion (literally the second page on the docs) so it should be clearer.
What changes are included in this PR?
Improvements on the Documentation: