Skip to content

docs: add documentation for MAP dtype (#556)#557

Merged
fresh-borzoni merged 2 commits into
apache:mainfrom
qzyu999:feat/add-map-dtype-docs-556
May 23, 2026
Merged

docs: add documentation for MAP dtype (#556)#557
fresh-borzoni merged 2 commits into
apache:mainfrom
qzyu999:feat/add-map-dtype-docs-556

Conversation

@qzyu999
Copy link
Copy Markdown
Contributor

@qzyu999 qzyu999 commented May 19, 2026

Purpose

Linked issue: close #556

The purpose of this pull request is to implement and document support for the MAP data type in the Fluss Rust client. This allows users to correctly define, construct, and read map structures (key-value pairs) when interacting with Fluss tables.

Brief change log

Documentation:

  • Added the InternalRow::get_map signature and FlussMap reference to website/docs/user-guide/rust/api-reference.md.
  • Updated the Data Types table and added a dedicated ## Maps usage guide (with code examples) in website/docs/user-guide/rust/data-types.md.

Tests

  • Ran cargo fmt --all -- --check to ensure that no lint issues arose from the documentation.

API and Format

No.

Documentation

Documentation and code examples for constructing and reading maps have been added to the Rust User Guide (api-reference.md and data-types.md).

@fresh-borzoni fresh-borzoni force-pushed the feat/add-map-dtype-docs-556 branch from 1280c54 to b05b7bc Compare May 23, 2026 19:33
Copy link
Copy Markdown
Member

@fresh-borzoni fresh-borzoni left a comment

Choose a reason for hiding this comment

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

@qzyu999 Thank you for the PR, I added some improvements around ergonomics on top, merging

@fresh-borzoni fresh-borzoni merged commit 15bf742 into apache:main May 23, 2026
11 checks passed
@qzyu999 qzyu999 deleted the feat/add-map-dtype-docs-556 branch May 23, 2026 19:45
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.

[docs] Add documentation for Map data type

2 participants