Skip to content

Commit

Permalink
Fix sqllogictests links in contributor-guide/index.md and README.md (#…
Browse files Browse the repository at this point in the history
…8314)

The crate was moved so the links need to be updated
  • Loading branch information
qrilka authored Nov 23, 2023
1 parent 9619f02 commit b648d4e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion datafusion/sqllogictest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ query <type_string> <sort_mode>
- NULL values are rendered as `NULL`,
- empty strings are rendered as `(empty)`,
- boolean values are rendered as `true`/`false`,
- this list can be not exhaustive, check the `datafusion/core/tests/sqllogictests/src/engines/conversion.rs` for
- this list can be not exhaustive, check the `datafusion/sqllogictest/src/engines/conversion.rs` for
details.
- `sort_mode`: If included, it must be one of `nosort` (**default**), `rowsort`, or `valuesort`. In `nosort` mode, the
results appear in exactly the order in which they were received from the database engine. The `nosort` mode should
Expand Down
6 changes: 3 additions & 3 deletions docs/source/contributor-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ Tests for code in an individual module are defined in the same source file with

### sqllogictests Tests

DataFusion's SQL implementation is tested using [sqllogictest](https://github.com/apache/arrow-datafusion/tree/main/datafusion/core/tests/sqllogictests) which are run like any other Rust test using `cargo test --test sqllogictests`.
DataFusion's SQL implementation is tested using [sqllogictest](https://github.com/apache/arrow-datafusion/tree/main/datafusion/sqllogictest) which are run like any other Rust test using `cargo test --test sqllogictests`.

`sqllogictests` tests may be less convenient for new contributors who are familiar with writing `.rs` tests as they require learning another tool. However, `sqllogictest` based tests are much easier to develop and maintain as they 1) do not require a slow recompile/link cycle and 2) can be automatically updated via `cargo test --test sqllogictests -- --complete`.

Expand Down Expand Up @@ -243,8 +243,8 @@ Below is a checklist of what you need to do to add a new aggregate function to D
- a new line in `signature` with the signature of the function (number and types of its arguments)
- a new line in `create_aggregate_expr` mapping the built-in to the implementation
- tests to the function.
- In [core/tests/sqllogictests/test_files](../../../datafusion/core/tests/sqllogictests/test_files), add new `sqllogictest` integration tests where the function is called through SQL against well known data and returns the expected result.
- Documentation for `sqllogictest` [here](../../../datafusion/core/tests/sqllogictests/README.md)
- In [sqllogictest/test_files](../../../datafusion/sqllogictest/test_files), add new `sqllogictest` integration tests where the function is called through SQL against well known data and returns the expected result.
- Documentation for `sqllogictest` [here](../../../datafusion/sqllogictest/README.md)
- Add SQL reference documentation [here](../../../docs/source/user-guide/sql/aggregate_functions.md)

### How to display plans graphically
Expand Down

0 comments on commit b648d4e

Please sign in to comment.