Skip to content

docs: update chunk examples to ColumnName keys#202

Merged
dfa1 merged 1 commit into
mainfrom
docs-writechunk-columnname
Jul 6, 2026
Merged

docs: update chunk examples to ColumnName keys#202
dfa1 merged 1 commit into
mainfrom
docs-writechunk-columnname

Conversation

@dfa1

@dfa1 dfa1 commented Jul 6, 2026

Copy link
Copy Markdown
Owner

Post-merge review follow-up to #201 (writeChunk(Map<ColumnName, Object>)) and #200 (Chunk.put(ColumnName, …)).

Several doc snippets still showed String keys and would not compile against the current API. DocsConsistencyTest is blind to them — the .put("x", …) and writeChunk(Map<…>) forms have no dotted receiver its method-name regex can match — so this surfaced in review rather than CI.

  • reference.md: writeChunk(Map<String, Object>)Map<ColumnName, Object> (the update refactor: type writeChunk map keys as ColumnName #201 was obligated to make)
  • README / tutorial / compatibility: .put("x", …).put(ColumnName.of("x"), …), plus the ColumnName import in the tutorial
  • JdbcImporter.toChunkMap: drop a pointless ColumnName → String → ColumnName round-trip an automated transform left behind — List<ColumnName> names = schema.fieldNames() now matches the clean CsvImporter form

DocsConsistencyTest + jdbc module build green.

🤖 Generated with Claude Code

Follow-up to the writeChunk(Map<ColumnName, Object>) retype (#201) and
the Chunk.put(ColumnName, ...) builder (#200): doc snippets still showed
String keys and would not compile. DocsConsistencyTest is blind to them
(the .put("x", ...) / writeChunk(Map<...>) forms have no dotted receiver
its regex can match), so this was caught in review, not CI.

- reference.md: writeChunk(Map<String, Object>) -> Map<ColumnName, Object>
- README / tutorial / compatibility: .put("x", ...) -> .put(ColumnName.of("x"), ...)
- tutorial: add the ColumnName import
- JdbcImporter.toChunkMap: drop a pointless ColumnName -> String -> ColumnName
  round-trip (List<ColumnName> names = schema.fieldNames())

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@dfa1 dfa1 merged commit 78a7e89 into main Jul 6, 2026
6 checks passed
@dfa1 dfa1 deleted the docs-writechunk-columnname branch July 6, 2026 06:03
dfa1 added a commit that referenced this pull request Jul 6, 2026
The Chunk builder row still read put(String column, Object data) but
the method has taken ColumnName since #200. A survey of backticked
method-signature claims (prompted by the #202 review) surfaced it;
#202 fixed the fenced .put snippets but missed this reference table row.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.

1 participant