Skip to content

Conversation

@cj-zhukov
Copy link
Contributor

Which issue does this PR close?

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

What changes are included in this PR?

Are these changes tested?

Are there any user-facing changes?

@cj-zhukov
Copy link
Contributor Author

High-Level Overview

This PR consolidates all sql_ops examples (analysis, dialect, frontend, query) into a single example binary.
Previously, each example had its own file, but now they can be executed via subcommands using:

cargo run --example sql_ops -- [analysis|dialect|frontend|query]

Copy link
Contributor

@2010YOUY01 2010YOUY01 left a 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
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
//! 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.

Copy link
Contributor Author

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

Copy link
Contributor Author

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

github-merge-queue bot pushed a commit that referenced this pull request Nov 17, 2025
## 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.
@alamb alamb added this pull request to the merge queue Nov 19, 2025
Merged via the queue into apache:main with commit b1af8fe Nov 19, 2025
28 checks passed
@cj-zhukov cj-zhukov deleted the cj-zhukov/consolidate-examples-sql-ops branch November 20, 2025 12:25
logan-keede pushed a commit to logan-keede/datafusion that referenced this pull request Nov 23, 2025
## 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.
logan-keede pushed a commit to logan-keede/datafusion that referenced this pull request Nov 23, 2025
## 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants