Skip to main content

Examples and Evidence Index

This index explains what each TeaQL example can actually prove. A code block, model description, generated workspace, executed test, and retained CI artifact are different evidence classes and must not be presented as interchangeable.

Inventory last reviewed: 2026-07-14.

Evidence Classes​

ClassMeaning
Reproducible fixtureInputs and repeatable commands are committed; execution still needs a recorded run.
ExecutedA named version combination was run successfully on a recorded date.
Retained CI evidenceLogs, manifests, outputs, and a run/artifact identifier are preserved.
Contract-checked illustrationStatic code shape passes documentation rules but was not compiled against a generated model.
Historical evaluationEvidence for an older version; useful for history, not current compatibility.

“Runnable” should identify the exact command, working directory, dependency versions, provider, expected result, and retained evidence. Without those fields, use a narrower status.

Dated Example Inventory​

ExampleLocationCurrent statusWhat it provesWhat it does not prove
Minimal Golden Path modelmodel.xml and fixture POMReproducible committed inputOne SQLite model and Maven plugin fixture are available to evaluation/generation jobs.A committed generated workspace or successful runtime by themselves.
Golden Path workflowgolden-path.ymlWorkflow defined; no retained remote run recordedExact Java/Rust client, target, generation, test, classification, and artifact-retention procedure.Retained CI proof until a run/artifact ID is added to the evidence ledger.
Rust Quick StartQuick Start — RustExecuted locally on 2026-07-13cargo-teaql 2.0.8, both dynamic targets, TeaQL/SQLite 4.1.1, tests, startup, query, audited mutation, and regeneration.MSRV, non-SQLite providers, load/concurrency limits, or release support lifetime.
Java Golden PathVerification Evidence ArchiveJuly 2026 evaluation/generation/regeneration executed; build blocked in that campaignMaven plugin 1.1.1 target discovery and Java generation behavior, including defects observed in that run.Current Java status or a runnable Java application, query, or mutation.
Model Explorer source catalogsrc/data/models.js and ModelExplorerContract-checked illustration; src/pages/models/** is currently excluded from the site buildFive domain guides, each with six Java/Rust scenario pairs, follow documented intent/audit terminal shapes.A currently published route, source KSML, successful generation, compilation, provider execution, or exact emitted methods for those models.
CookbookCookbook evidence matrixMixed per recipeEach recipe declares its source/runtime review or executed boundary and missing tests.Uniform execution status across every recipe or stack.
Evaluation Report #001PDF reportHistorical evaluation dated 2026-06-09A school-management Rust exercise reported for TeaQL 3.2.2, SQLite/SQLx 0.8, and cargo-teaql 0.2.0.Current TeaQL 4.1.1, current provider architecture, or current client 2.0.8 compatibility.

The PDF is retained as historical engineering evidence. Its commands, crate names, generated shapes, and conclusions must not be copied into current setup guidance without regeneration and verification.

Model Explorer Source Boundary​

The Model Explorer source currently contains five catalog entries:

  • Ecommerce Order Service;
  • Clinic Appointment Service;
  • Hotel Management Service;
  • Helpdesk Ticketing Service;
  • Supply Chain Service.

Each entry contains six scenarios—simple query, graph loading, advanced filter, aggregation, DDD extension, and runtime customization—with both Java and Rust variants. That is 30 scenario pairs and 60 language-specific snippets.

The documentation contract checker validates query intent ordering and mutation audit terminals in those strings. The model data file does not contain the KSML sources named by its sourceDir labels, and those scenarios have not been generated or compiled as current workspaces. Treat every generated facade, entity, relation, filter, and update method as illustrative until the matching model source and generated evidence are committed.

The Docusaurus pages configuration currently excludes models/**, so these components do not constitute a published model catalog. Removing that exclusion is a separate publication decision and should happen only after the evidence and navigation requirements below are satisfied.

Reproduce the Maintained Path​

The Rust Quick Start and Java failure records in this inventory describe the July 2026 campaign. For a new run, start from the current language journey, inspect the live target catalog, and use the commands in the Golden Path workflow. Do not repair generated output by hand. Use Cross-language Conformance Status for current committed capability evidence and the archived Java Compatibility Evidence only when investigating those historical failure signatures.

Evidence Still Missing​

The example collection is not ready for a first-class top-level Examples section until it includes:

  1. a retained current Java generated build, query, audited mutation, and logs linked from this site;
  2. a retained run/artifact identifier for the committed Golden Path workflow;
  3. at least one maintained generated-output sample with its source model and generator command;
  4. compiled/generated evidence for Model Explorer entries or an explicit decision to keep them as design-only guides;
  5. current non-SQLite provider examples with provider/database/toolchain versions and expected output;
  6. small AI task examples with allowed edit surfaces and generated-output review checklists.

Adding or Promoting an Example​

An example entry must record:

  • source model or fixture path;
  • client and generator versions;
  • dynamic target and exact command;
  • generated dependency versions;
  • build/test/run command and working directory;
  • provider/database/toolchain versions;
  • expected output;
  • generated versus handwritten file boundaries;
  • evidence status, date, owner, update trigger, and retained artifact link.

Promote an illustration to executed only after its exact model and methods are generated and run. Promote an executed example to retained CI evidence only after logs/artifacts have a durable run identifier.