Skip to content

#71: Document v2 runner architecture - #20

Merged
tkilias merged 41 commits into
mainfrom
documentation/v2_runner_design
Sep 26, 2026
Merged

tkilias merged 41 commits into
mainfrom
documentation/v2_runner_design

Conversation

@tkilias

@tkilias tkilias commented Aug 19, 2026 •

Copy link
Copy Markdown
Collaborator

Fixes #71

Summary

  • document the v2 runner composition, lifecycle, ownership, shutdown, and namespace boundaries;
  • define the worker-facing Context, Call, control-stream, message builder, and message view contracts;
  • document Arrow C Data Interface ownership and composite call messages;
  • define the two-queue background I/O implementation, eventfd/socket event loop, vectorized I/O, flow control, and row-boundary batch splitting;
  • add architecture diagrams and protocol design references.

Protocol details

  • the first record batch in each direction may be sent before Next; later batches use Next flow-control credit;
  • background splitting targets approximately 4 MiB at row boundaries and permits oversized rows;
  • orderly CloseConnection waits for the peer reply before transport close;
  • terminal worker operations return the documented Result statuses.

Validation

  • runner Markdown links and anchors validated;
  • JSON schemas parsed successfully;
  • conflict resolution completed against origin/main;
  • GitHub Bazel, SLC-CI, fuzzing, and mutation-testing checks are running on this revision.

The PR is documentation/design-only; no production runner implementation is included.

tkilias added 23 commits August 14, 2026 10:06
Make the high-level column definition the single source for Exasol type parameters and link to its Call Metadata contract from the Arrow mapping document.

Remove repeated property ownership text and legacy exasol field metadata from the mapping examples. Keep only conversion-specific GeoArrow and interval extension metadata, and update validation assertions and rendered mapping documentation accordingly.
@tkilias
tkilias force-pushed the documentation/v2_runner_design branch from c70ff7d to c6290ed Compare September 1, 2026 16:22
@tkilias
tkilias changed the base branch from main to documentation/design_v2_protocol September 1, 2026 16:23
Comment thread doc/design/v2/runner/README.md Outdated
Comment thread doc/design/v2/runner/context_implementation.md Outdated
Comment thread doc/design/v2/runner/context_interface.md Outdated
Comment thread doc/design/v2/runner/context_interface.md Outdated
Comment thread doc/design/v2/runner/context_implementation.md Outdated
Comment thread doc/design/v2/runner/context_implementation.md Outdated
Comment thread doc/design/v2/runner/context_interface.md Outdated
Comment thread doc/design/v2/runner/context_implementation.md Outdated
Comment thread doc/design/v2/runner/context_interface.md Outdated
Comment thread doc/design/v2/runner/context_implementation.md Outdated
Base automatically changed from documentation/design_v2_protocol to main September 26, 2026 18:58
@tkilias
tkilias requested a deployment to v2-fuzzing-pr-approval September 26, 2026 19:24 — with GitHub Actions Waiting
@tkilias
tkilias requested a deployment to v2-fuzzing-pr-approval September 26, 2026 19:26 — with GitHub Actions Waiting
@tkilias
tkilias marked this pull request as ready for review September 26, 2026 19:33
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-26T19:37:55.977175Z d8a0d2d Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d8a0d2d745

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread doc/design/v2/runner/context_implementation.md Outdated
Comment thread doc/design/v2/runner/context_implementation.md Outdated
Comment thread udf-runner-cpp/v2/json_schema/validate_schemas.py Outdated
Comment thread doc/design/v2/runner/context_implementation.md Outdated
Comment thread doc/design/v2/runner/README.md
@tkilias
tkilias requested a deployment to v2-fuzzing-pr-approval September 26, 2026 19:54 — with GitHub Actions Waiting
@tkilias tkilias changed the title Document v2 runner architecture #71: Document v2 runner architecture Sep 26, 2026
@tkilias
tkilias requested a deployment to v2-fuzzing-pr-approval September 26, 2026 20:04 — with GitHub Actions Waiting
@sonarqubecloud

Copy link
Copy Markdown

@tkilias
tkilias merged commit f6e598a into main Sep 26, 2026
29 of 30 checks passed
@tkilias
tkilias deleted the documentation/v2_runner_design branch September 26, 2026 21:37

This branch is waiting to be deployed

1 waiting deployment
v2-fuzzing-pr-approval — dd18febc Waiting Sep 26, 2026 by tkilias via pr_approval #117
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document v2 runner architecture

2 participants