materializeinc/materialize · Archived

mz-adapter-guide

Correctness invariants + architecture: adapter, coordinator, pgwire, peek paths, timestamp oracle. Trigger: questions about these subsystems — "how does coordinator work", "what are read holds", "explain peek path", "how does timestamp selection work", "why does this query block". Also when editing OR reviewing code in src/adapter/, src/pgwire/, src/timestamp-oracle/ (reviewing a PR, diff, or commit that touches these paths counts).

First seen Apr 29, 2026

Installation

$ npx skills add materializeinc/materialize --skill mz-adapter-guide

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

Also in this package

Other skills from materializeinc/materialize · top by installs.

npx skills add materializeinc/materialize

Browse all from materializeinc/materialize

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 6.3K
License LICENSE
Default branch main
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,730 B
  • docs SUMMARY.md 462 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 4 installs

SKILL.md

Adapter Guide Skill

When working on or reviewing the adapter layer or related crates, always read and follow the guidance in doc/developer/guide-adapter.md. That document contains correctness invariants, architectural notes, a list of optimizations that have been tried and rejected for correctness reasons, and a checklist for reviewing adapter changes. Read it before making changes and before reviewing them.

Read doc/developer/guide-adapter.md now.

When working on the timestamp oracle (src/timestamp-oracle/), also read the module-level docs in src/timestamp-oracle/src/lib.rs and src/timestamp-oracle/src/batching_oracle.rs for the TimestampOracle trait contract and the batching/linearizability invariants.

When you or the user discover that an approach is incorrect or heading in a wrong direction, suggest distilling the learning into doc/developer/guide-adapter.md. Add it to whichever section fits best — a new correctness invariant, a new subsection under an existing invariant, a rejected optimization, or a new top-level section if needed. Describe what was tried, why it's wrong, and any relevant context. This keeps the guide up to date and prevents future re-discovery of the same pitfalls.