apache / apache/arrow

[Documentation] No description of Map in-memory layout

Open
#29,720 0 comments 0 reactions 0 assignees View on GitHub
Component: Documentation Component: Format
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 13h
Merged PRs (30d)
88

Description

The page https://arrow.apache.org/docs/format/Columnar.html#physical-memory-layout has no description of the Map type, even though it is part of the schema.fbs. This makes it difficult to implement and understand when it should be used.

**Reporter**: [Jorge Leitão](https://issues.apache.org/jira/browse/ARROW-14131) / @jorgecarleitao

**Note**: *This issue was originally created as [ARROW-14131](https://issues.apache.org/jira/browse/ARROW-14131). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Contributor guide

Open the contributing guide

Research direction

Start with the physical memory layout page at https://arrow.apache.org/docs/format/Columnar.html#physical-memory-layout and inspect the Map definition in schema.fbs. Document Map's in-memory layout and when it should be used, so the page covers this schema type and is sufficient to implement and understand it.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.