Skip to content

docs: fix the Substrait round-trip instructions in the sqllogictest README #24855

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

Open
alexandrefimov wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix the Substrait round-trip instructions in the sqllogictest README #24855

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24a5536
docs: the Substrait round-trip test command needs the substrait feature
alexandrefimov Sep 1, 2026
28a9140
docs: CI runs the round-trip mode over one file, not none
alexandrefimov Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions datafusion/sqllogictest/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,17 +397,18 @@ generated DataFusion logical plan (SQL statement → DF logical → Substrait
Not all statements will be round-tripped, some statements like CREATE, INSERT, SET or EXPLAIN statements will be
issued as is, but any other statement will be round-tripped to/from Substrait.

_WARNING_: as there are still a lot of failures in this mode (https://github.com/apache/datafusion/issues/16248),
it is not enforced in the CI, instead, it needs to be run manually with the following command:
_WARNING_: this mode lives behind the `substrait` feature, and the full suite still reports failures. CI therefore
runs it over a single file, through `cargo xtask ci step test substrait`, which filters to `limit.slt`. Some of the
failures are collected in https://github.com/apache/datafusion/issues/16248. To run it over every file:

```shell
cargo test --test sqllogictests -- --substrait-round-trip
cargo test --test sqllogictests --features substrait -- --substrait-round-trip
```

For focusing on one specific failing test, a file:line filter can be used:

```shell
cargo test --test sqllogictests -- --substrait-round-trip binary.slt:23
cargo test --test sqllogictests --features substrait -- --substrait-round-trip binary.slt:23
```

## `.slt` file format
Expand Down
Loading