Skip to content

Add FileType to the FileMetaData diagram, regenerate - #218

Merged
wgtmac merged 3 commits into
apache:productionfrom
Baunsgaard:fix-metadata-filetype-diagram
Nov 17, 2026
Merged

wgtmac merged 3 commits into
apache:productionfrom
Baunsgaard:fix-metadata-filetype-diagram

Conversation

@Baunsgaard

Copy link
Copy Markdown
Contributor

The Metadata page shows a class diagram of FileMetaData. Its LogicalTypes box was missing FileType, which was added to parquet-format in apache/parquet-format#585 (FILE logical type).

Change

  • static/images/FileMetaData.mermaid: add FileType to the LogicalTypes class
  • static/images/FileMetaData.svg: regenerate with npx mmdc -i FileMetaData.mermaid -o FileMetaData.svg
  • static/images/PageHeader.svg: regenerate with npx mmdc -i PageHeader.mermaid -o PageHeader.svg (source unchanged)

Both SVGs were regenerated because the mermaid diagrams are now rendered with a newer mermaid version (mermaid-cli 12.x, from #209). The SVGs were previously rendered with 11.x, so their colours and default styling changed. The diagram content is the same, apart from the new FileType entry.

Checked against the current submodule thrift (LogicalType union): every other logical type was already present. Only FileType was missing. Physical Type values are unchanged.

Verification

  • FileType appears once in the regenerated SVG
  • Diff is the new Mermaid line plus the regenerated SVG layout for that class box

Reviewer checklist

  • Metadata diagram shows FileType under LogicalTypes after deploy
  • No other logical types were removed

The metadata diagram's LogicalTypes class was missing FileType after
parquet-format added the FILE logical type. Update the Mermaid source
and regenerate the SVG so the docs page matches the thrift definition.
The FileMetaData diagram was regenerated with mermaid-cli 12 in the
previous commit, which changed the default palette. Regenerate the
PageHeader diagram the same way so both figures on the Metadata page
use the same renderer and look. The diagram source is unchanged.
@Baunsgaard

Copy link
Copy Markdown
Contributor Author

@alamb Since you updated the dependency, maybe you want to stamp this one as well?

@alamb

alamb commented Nov 9, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the ping @Baunsgaard

COuld you do me a favor and post the changes in this PR: a screen shot of the old diagrams and a screen shot of the new ones?

Add FiniteVectorType (FINITE_VECTOR logical type, added in
apache/parquet-format PR #624) to the LogicalTypes box in
FileMetaData.mermaid and regenerate FileMetaData.svg.
@Baunsgaard

Copy link
Copy Markdown
Contributor Author

Thanks for the ping @Baunsgaard

COuld you do me a favor and post the changes in this PR: a screen shot of the old diagrams and a screen shot of the new ones?

Sure @alamb here you go, sorry for the delay, I took the liberty to include the new Vector type as well!

Some Sceenshots after:

image image image

Some Before:

image image image

@alamb alamb changed the title Add FileType to the FileMetaData diagram Add FileType to the FileMetaData diagram, regenerate Nov 12, 2026

@alamb alamb left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you @Baunsgaard -- this looks good to me. The newer rendering is nice with new colors too

@wgtmac

wgtmac commented Nov 17, 2026

Copy link
Copy Markdown
Member

Thanks @Baunsgaard and @alamb!

@wgtmac
wgtmac merged commit a95c06e into apache:production Nov 17, 2026
1 check passed
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.

3 participants