Skip to content

Make SQL query consistent with API syntax expression in code examples #5303

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

Jump to bottom
Merged
alamb merged 2 commits into from
Feb 16, 2023
Merged

Make SQL query consistent with API syntax expression in code examples #5303

alamb merged 2 commits into from
Feb 16, 2023

Conversation

@ongchi
Copy link
Contributor

@ongchi ongchi commented Feb 16, 2023

Which issue does this PR close?

This is a minor document fix, does not introduce new features or fix bugs.

Rationale for this change

Examples are provides for both SQL query and DataFrame API respectively, and they should be semantically consistent.
The DataFrame API example on this page calls filter methods on df, but the DataFrame API one does not contains relevant part of WHERE expression, this could be confusing for newcomers.

What changes are included in this PR?

This PR adds WHERE express to SQL query examples to match API syntax expression.

Are these changes tested?

Code blocks should covered by doctest.

Are there any user-facing changes?

No.

@ongchi
Update code example
34c1092 
Make SQL query consistent with API syntax expression.
@ongchi
Update example in core/src/lib.rs
74d18ed
@github-actions github-actions bot added the core Core DataFusion crate label Feb 16, 2023
@ongchi ongchi marked this pull request as ready for review February 16, 2023 14:10
jackwener
jackwener approved these changes Feb 16, 2023
View reviewed changes
Copy link
Member

@jackwener jackwener left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make sense to me.
Thank you @ongchi

alamb
alamb approved these changes Feb 16, 2023
View reviewed changes
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @ongchi !

@alamb alamb merged commit fd75ba4 into apache:main Feb 16, 2023
@ursabot
Copy link

ursabot commented Feb 16, 2023

Benchmark runs are scheduled for baseline = afb73be and contender = fd75ba4. fd75ba4 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ec2-t3-xlarge-us-east-2] ec2-t3-xlarge-us-east-2
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on test-mac-arm] test-mac-arm
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ursa-i9-9960x] ursa-i9-9960x
[Skipped ⚠️ Benchmarking of arrow-datafusion-commits is not supported on ursa-thinkcentre-m75q] ursa-thinkcentre-m75q
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

@ongchi ongchi deleted the doc-example-fix branch February 16, 2023 22:12
jiangzhx pushed a commit to jiangzhx/arrow-datafusion that referenced this pull request Feb 24, 2023
@ongchi @jiangzhx
Make SQL query consistent with API syntax expression in code examples (…
a99cb26 
…apache#5303)

* Update code example

Make SQL query consistent with API syntax expression.

* Update example in core/src/lib.rs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alamb alamb alamb approved these changes

@jackwener jackwener jackwener approved these changes

Assignees

No one assigned

Labels

core Core DataFusion crate

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ongchi @ursabot @alamb @jackwener