PartiQL Rust

This is a collection of crates to provide Rust support for the PartiQL query language.

The crates in this repository are considered experimental, under active/early development, and APIs are subject to change.

This project uses workspaces to manage the crates in this repository. The partiql crate is intended to be the crate that exports all the relevant partiql-* sub-crate functionality. It is factored in this way to make applications needing only some sub-component of the PartiQL implementation possible (e.g. an application that only requires the PartiQL parser can depend on partiql-parser directly).

Development

Public enums are marked #[non_exhaustive] so that new variants can be added without requiring every consumer to update its matches. Matches in other crates, including other crates in this workspace, must handle unrecognized variants with a catch-all arm. Choose fallback behavior appropriate to the operation, such as returning an unsupported-operation error.

This project uses a git submodule to pull in partiql-tests. The easiest way to pull everything in is to clone the repository recursively:

$ git clone --recursive https://github.com/partiql/partiql-lang-rust.git

You can also initialize the submodules as follows:

$ git submodule update --init --recursive

Local CI Checks

To run the same checks that GitHub Actions CI runs locally, you can use the provided Makefile:

# Run all core CI checks (build, test, format, clippy, security)
make ci-check

# Or run individual checks
make build        # Build the workspace
make test         # Run tests
make fmt          # Check code formatting
make clippy       # Run clippy lints
make deny         # Run cargo-deny security/license checks
make conformance  # Run conformance tests (slower)
make coverage     # Generate code coverage report
make help         # Show all available targets

The ci-check target runs the essential checks that must pass for CI, equivalent to:

cargo build --workspace && cargo test --workspace && cargo fmt --all -- --check && cargo clippy --all-features --workspace -- -D warnings && cargo deny check advisories && cargo deny check bans licenses sources

Note: The deny target requires cargo-deny to be installed:

cargo install cargo-deny

Running the conformance tests

Running cargo test from the partiql-lang-rust root will not run the conformance tests by default.

To run all the tests (including conformance tests), you will need to run cargo test with the "conformance_test" --features flag:

cargo test --features "conformance_test"

Or to run just the conformance tests:

cargo test --package partiql-conformance-tests --features "conformance_test"

More details on running individual tests can be found in the partiql-conformance-tests crate README.

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.