Skip to content

docs: note README narrative is intentionally deferred #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JinBa1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: note README narrative is intentionally deferred #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,3 +214,4 @@ The README displays CI, Coverage (Codecov), and Dependencies badges at the top.
- EXPLAIN queries write the two-section plan text to the output file and do not execute the query. The plan root returned by `QueryPlanner.planQuery` for EXPLAIN is a no-op; `BlazeDB.run` short-circuits before operator iteration when `explainText` is non-null.
- Hash join is the default for equi-joins (`Constants.useHashJoin = true`). Set it to `false` in tests (via `@BeforeEach`/`@AfterEach`) to exercise the nested-loop path. `HashJoinOperator.hasEquiConjunct(Expression)` is the planner's check for at least one cross-side column=column equality in the condition.
- The JMH 1.37 benchmark suite lives in `src/test/java/com/github/jinba1/blazedb/bench/`. It is compiled as part of `test-compile` in CI but never executed there. `CachedOperator` (in `src/test/java/.../operator/`) is a test utility operator that replays a fixed in-memory tuple list — used by `JoinAlgorithmBenchmark` to isolate join algorithm cost from CSV I/O. The `bench/` package classes are JMH benchmarks and do not contain JUnit tests.
- The README's framing ("in-memory relational query engine") is intentionally unchanged for now: a repositioning around serving file-backed SQL to AI agents is planned once the network-facing interfaces exist. Keep README edits factual (counts, commands, feature rows); defer narrative restructuring until then.
Loading