Commit bdfe987
authored
Document the relationship between FileFormat::projection / FileFormat::filter and FileScanConfig::output_ordering (#20196)
## Which issue does this PR close?
- closes #20173
- Similar to #20188
## Rationale for this change
I spent a long time trying to figure out what was going on in our fork
after
a DataFusion 52 upgrade, and the root cause was that the output_ordering
in DataFusion
52 does *NOT* include the projection (more details here
#20173 (comment))
This was not clear to me from the DataFusion code or documentation, and
I think
it would be helpful to clarify this in the documentation.
## What changes are included in this PR?
1. Document FileScanConfig::output_ordering better
## 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.
-->1 parent cc670e8 commit bdfe987
1 file changed
Lines changed: 17 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
168 | 168 | | |
169 | 169 | | |
170 | 170 | | |
171 | | - | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
172 | 178 | | |
173 | 179 | | |
174 | 180 | | |
| |||
441 | 447 | | |
442 | 448 | | |
443 | 449 | | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
444 | 457 | | |
445 | 458 | | |
446 | 459 | | |
| |||
716 | 729 | | |
717 | 730 | | |
718 | 731 | | |
| 732 | + | |
| 733 | + | |
| 734 | + | |
719 | 735 | | |
720 | 736 | | |
721 | 737 | | |
| |||
0 commit comments