feat: implement InQL RFC 001 — dataset hierarchy and DataSet API#11
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR implements InQL RFC 001 in the InQL package: the dataset type hierarchy and programmatic relational API that downstream RFCs (
query {}, Substrait, execution) build on.The library now exposes the full trait ladder—
DataSet[T]→BoundedDataSet[T]/UnboundedDataSet[T]→DataFrame[T],LazyFrame[T],DataStream[T]—with the eightDataSetinstance methods spelled in the RFC using Incan’sSelf-based shipped signatures, pluspub::inql.functionsaggregate helpers for the.agg(...)import model. Method bodies are stubs that fail at runtime until execution lands (InQL RFC 004); the contract is types, exports, and compile-time structure.Docs catch up with Implemented / Shipped in: 0.1.0, the contract-complete checklist, reference and explanation pages under
docs/language/, examples underexamples/, and RFC index notes. Static capability gating (compile-time rejection of invalid ops on unbounded carriers) remains Incan typechecker work—tracked as incan #187, with InQL #10 to revisit package/docs when that exists.Closes #2
Type of change
docs/rfcs/*)Area(s)
Key details
inql0.1.0 andfrom pub::inql import DataSet, BoundedDataSet, UnboundedDataSet, DataFrame, LazyFrame, DataStream, compose signatures against the hierarchy, call the relational method surface on carriers, and importtotal/count_rowsfrompub::inql.functionsfor the aggregate story RFC 001 describes. No real query execution or I/O yet—that is RFC 004 and friends.src/dataset.incn,src/functions.incn;src/lib.incnre-exports;tests/test_dataset.incnexercises exports and trait assignability;examples/*plusexamples/README.md;docs/language/reference/dataset_types.mdanddocs/language/explanation/dataset_types.md; RFC 001 marked implemented with Design Decisions, Related links to incan#187 / InQL chore: Revisit InQL package/docs after Incan static capability gating (RFC 001) #10, and clarified split between library contract vs compiler enforcement.NotImplementedError-style failures until execution is wired—acceptable for a contract-first 0.1.0 if docs and RFC say so.Testing / verification
make ci(ormake fmt-check,make build,make test)Manual verification notes:
incan run/incan teston examples as you prefer; CI should already covermake ci.Docs impact
If docs updated:
docs/rfcs/001_inql_dataset.md,docs/rfcs/README.md,docs/language/reference/dataset_types.md,docs/language/explanation/dataset_types.md,examples/README.md.Checklist