Skip to content

docs:add array type support#5884

Open
XuQianJin-Stars wants to merge 1 commit intolance-format:mainfrom
XuQianJin-Stars:docs/add-array-type-support
Open

docs:add array type support#5884
XuQianJin-Stars wants to merge 1 commit intolance-format:mainfrom
XuQianJin-Stars:docs/add-array-type-support

Conversation

@XuQianJin-Stars
Copy link
Contributor

Summary

Add comprehensive documentation for Arrow data types support in Lance, with a focus on array types for vector embeddings - the most important use case for Lance integration.

This PR addresses the feedback from the community that the Lance documentation was missing array/vector type support documentation. See: https://fluss.apache.org/docs/next/streaming-lakehouse/integrate-data-lakes/lance/

Changes

  • Add new docs/src/guide/data_types.md covering:

    • Complete Arrow type system overview (primitive, string, binary types)
    • Array types for vector embeddings (FixedSizeList, List, LargeList)
    • Python and Rust code examples for creating and using vector embeddings
    • Vector search examples with index creation
    • Nested and complex types (Struct, Map)
    • Data type mapping table for integrations with Flink, Spark, Presto, etc.
    • Best practices for vector data storage and retrieval
  • Update docs/src/guide/.pages to include the new Data Types page in navigation

Why This Matters

Vector embeddings are the primary use case for Lance integration with streaming systems like Apache Fluss. The existing documentation lacked:

  1. Clear explanation of how to use ARRAY<FLOAT>(n) / FixedSizeList for vectors
  2. Type mapping table showing array type support
  3. Practical examples for ML/AI workflows

This documentation fills that gap and helps users understand how to properly store and query vector embeddings in Lance.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 4, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

ACTION NEEDED
Lance follows the Conventional Commits specification for release automation.

The PR title and description are used as the merge commit message. Please update your PR title and description to match the specification.

For details on the error please inspect the "PR Title Check" action.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant