Add a reference page listing all data types and showing how to specify schemas
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 11
- Forks
- 11
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 14
Description
We want to document all data types we have that we support. Mostly this is Arrow types, but there are four important types we should make sure to include and might need special instructions:
- FixedSizeList of floats or uint8 are what we represent vectors (like embeddings as)
- UUIDs
- We have a JSON type that matches with the JSON columns
- We have a Blob column that that allows efficient access for large values.
The later two are treated as extension types.
There are some types we shouldn't emphasize because we don't support them well right now. This includes:
- Union
- Map
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named in the issue. Start by locating the documentation entry point and the schema/type definitions, then inventory the supported Arrow types and the four special types described here. Done means a reference page explains schema specification, highlights vector, UUID, JSON, and Blob handling, and notes that Union and Map are not emphasized.
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
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100