-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Consolidate sql operations examples (#18142) #18743
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
Consolidate sql operations examples (#18142) #18743
Conversation
High-Level OverviewThis PR consolidates all cargo run --example sql_ops -- [analysis|dialect|frontend|query] |
2010YOUY01
left a comment
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.
LGTM, thank you so much!
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| //! This example shows how to use the structures that DataFusion provides to perform |
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.
| //! See `main.rs` for how to run it. | |
| //! | |
| //! This example shows how to use the structures that DataFusion provides to perform |
I just recently got slightly confused about how to run this new example setup, hope this can help.
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 is a good point - I added this
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.
After we finish with consolidating all examples, I'm going to work on this ##18529 to simplify working with examples
## Which issue does this PR close? Related to #18142 and #18743 ## Rationale for this change The catalog examples were moved under `datafusion-examples/examples/data_io/`, but the doc comments and user guide still point to the old paths. This leaves readers with 404s when they try to follow the examples, so the links need to be corrected. ## What changes are included in this PR? Correct the catalog example links so they point to the examples/data_io directory.
## Which issue does this PR close? Related to apache#18142 and apache#18743 ## Rationale for this change The catalog examples were moved under `datafusion-examples/examples/data_io/`, but the doc comments and user guide still point to the old paths. This leaves readers with 404s when they try to follow the examples, so the links need to be corrected. ## What changes are included in this PR? Correct the catalog example links so they point to the examples/data_io directory.
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes apache#123` indicates that this PR will close issue apache#123. --> - part of #apache#18142. ## Rationale for this change This PR is for consolidating all the `sql_ops` examples (analysis, dialect, frontend, query) into a single example binary. We are agreed on the pattern and we can apply it to the remaining examples <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> ## What changes are included in this PR? <!-- There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR. --> ## Are these changes tested? <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> --------- Co-authored-by: Sergey Zhukov <szhukov@aligntech.com>
Which issue does this PR close?
Rationale for this change
This PR is for consolidating all the
sql_opsexamples (analysis, dialect, frontend, query) into a single example binary. We are agreed on the pattern and we can apply it to the remaining examplesWhat changes are included in this PR?
Are these changes tested?
Are there any user-facing changes?