Workspace Map
Every crate in the Krishiv workspace, its responsibility, maturity, and public API surface.
The Krishiv workspace contains 24 crates. This page is generated from Cargo.toml and PRODUCT_FACTS.md. Each crate is listed with its responsibility, maturity status, key public APIs, and link to relevant documentation.
Complete Crate Map
| Crate | Responsibility | Maturity | Key APIs | Docs |
|---|---|---|---|---|
krishiv |
User-facing facade and CLI binary. | Available | sql, explain, jobs, local start |
Docs |
krishiv-api |
Session, DataFrame, Stream, IncrementalFlow, and all public Rust API types. | Available | Session, DataFrame, Stream, IncrementalFlow, PipelineBuilder |
Docs |
krishiv-sql |
DataFusion integration, SQL execution, catalog and table-provider abstractions. | Available | — | Docs |
krishiv-plan |
Logical/physical plans, expression AST, UDF contracts, governance/policy, CEP. | Available | — | — |
krishiv-runtime |
Embedded, single-node, and remote runtime routing. | Available | — | Docs |
krishiv-dataflow |
Arrow operator runtime, queues, barriers, windows, joins, stateful ops. | Available | — | Docs |
krishiv-delta |
DeltaBatch, operators, IncrementalView, IntegrateOp. | Experimental | — | Docs |
krishiv-ivm |
Incremental view maintenance engine. | Experimental | — | Docs |
krishiv-scheduler |
Coordinator, job/task lifecycle, metadata stores, leadership, gRPC server. | Available | — | Docs |
krishiv-executor |
Executor process, task runner, task assignment receiver, shuffle/checkpoint hooks. | Available | — | Docs |
krishiv-state |
In-memory and RocksDB-backed keyed state, TTL, migration, checkpoint/savepoint. | Preview | — | Docs |
krishiv-shuffle |
In-memory, local disk, object-store, and Flight-oriented shuffle support. | Preview | — | Docs |
krishiv-connectors |
Source/sink contracts, Parquet/Kafka/S3 paths, Iceberg-first lakehouse helpers. | Preview | — | Docs |
krishiv-proto |
Typed IDs and coordinator/executor wire contracts. | Available | — | — |
krishiv-common |
Shared utilities used across runtime and engine crates. | Available | — | — |
krishiv-python |
PyO3 Python bindings. | Available | — | Docs |
krishiv-flight-sql |
Arrow Flight SQL server. | Preview | — | Docs |
krishiv-sql-gateway |
Separately versioned JDBC/ODBC SQL gateway facade. | Preview | — | — |
krishiv-operator |
Kubernetes CRD and operator integration. | Preview | — | Docs |
krishiv-ui |
Status API and web UI assets. | Preview | — | — |
krishiv-metrics |
Metrics, tracing, and debug report structures. | Available | — | Docs |
krishiv-engine-core |
Core engine abstractions shared across runtime modes. | Available | — | — |
krishiv-bench |
Benchmarks (on-demand; excluded from default workspace builds). | Available | — | — |
krishiv-chaos |
Cross-crate chaos and fault-injection integration tests. | Available | — | — |
Maturity Key
| Status | Meaning |
|---|---|
| Available | Implemented, tested, and used in core workflows. APIs are stable within minor versions. |
| Preview | Scaffolding and initial implementation exist. End-to-end certification work is ongoing. Use with caution. |
| Experimental | Implemented and functional. APIs and semantics may change. Not certified for production use. |
| In Progress | Active development. Do not advertise as complete. |
| Planned | On the roadmap but not yet implemented. Do not rely on these without maintainer confirmation. |
Architecture Invariants
- Do not build separate engines for batch and streaming.
- One active job coordinator per job; executors are replaceable data-plane workers.
- Shuffle, state, checkpoint, metadata, and connector behavior live behind crate APIs.
- Prefer typed IDs, typed fragments, typed errors, and capability flags over stringly-routed public contracts.
Build Commands
cargo check --workspace
cargo test --workspace --exclude krishiv-python
cargo clippy --workspace --exclude krishiv-python --exclude krishiv-chaos -- -D warnings
cargo fmt --checkFeature Matrix
| Feature | Purpose |
|---|---|
minimal | Smallest facade surface; no optional deployment capabilities. |
local | Default developer build; embedded plus single-node capabilities. |
embedded | In-process API use; no optional dependencies. |
single-node | Local daemon/in-process cluster with Flight SQL, shuffle, and RocksDB metadata. |
distributed | Bare remote cluster support with Flight SQL, shuffle, and etcd metadata. |
k8s | Distributed support plus Kubernetes operator/CRD capability. |
full | Standard compute-engine build: distributed/Kubernetes, Kafka, and primary Iceberg support. |