chryso 0.0.2

Chryso is a Calcite-style SQL parser + optimizer engine in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# Testing Strategy

## Goals
- Unit tests should validate the full pipeline: parse -> logical -> optimize -> physical -> execute.
- Tests should be able to assert on explain output and execution results.
- Tests must run without external engines by default.

## Test Helpers
`chryso::test_support` provides:
- `execute(sql, dialect)` returns logical/physical explains plus execution results.
- `execute_with_adapter(sql, dialect, adapter)` allows integration with real engines.
- `explain(sql, dialect)` returns logical/physical explain strings only.

These helpers are compiled for unit tests and can be enabled for integration tests with the
`test-utils` feature.

## Running Tests
- Unit tests:
  - `cargo test`
- Parser-focused unit tests:
  - `cargo test -p chryso-parser`
- Integration tests using test helpers:
  - `cargo test --features test-utils`
- Plan snapshot tests:
  - `cargo test --test plan_snapshot`

## Snapshot Recording
To update `tests/testdata/plan/case1/out.json`, run:
```
CHRYSO_RECORD=1 cargo test --test plan_snapshot
```

## Example (Integration Test)
```rust
use chryso::parser::Dialect;
use chryso::test_support::execute;

#[test]
fn pipeline_is_explainable() {
    let sql = "select id from users where id = 1";
    let run = execute(sql, Dialect::Postgres).expect("execute");
    assert!(run.logical_explain.contains("LogicalProject"));
    assert!(run.physical_explain.contains("Project"));
}
```