Skip to content

Apache DataFusion SQL Query Engine

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

Aleksandr Efimov3767e88ec449
diff --git a/datafusion/sqllogictest/README.md b/datafusion/sqllogictest/README.md
index cad15ef3a3..13ef797dfc 100644
--- a/datafusion/sqllogictest/README.md
+++ b/datafusion/sqllogictest/README.md
@@ -391,23 +391,24 @@ running tests.
## Running tests: Substrait round-trip mode
-This mode will run all the .slt test files in validation mode, adding a Substrait conversion round-trip for each
+This mode runs the selected `.slt` test files in validation mode, adding a Substrait conversion round-trip for each
generated DataFusion logical plan (SQL statement → DF logical → Substrait → DF logical → DF physical → execute).
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 the default suite in this mode:
```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