Skip to content

Reorganize sections for "Data Types" doc. #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Reorganize sections for "Data Types" doc. #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions docs/docs/core/data_types.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ In CocoIndex, all data processed by the flow have a type determined when the flo

This makes schema of data processed by CocoIndex clear, and easily determine the schema of your index.

## Basic Types
## Data Types

### Basic Types

This is the list of all basic types supported by CocoIndex:

Expand All @@ -30,11 +32,6 @@ For some types, CocoIndex Python SDK provides annotated types with finer granula
When defining [custom functions](/docs/core/custom_function), use the specific types as type annotations for arguments and return values.
So CocoIndex will have information about the specific type.

## Composite Types

Note: CocoIndex will support functions taking composite types as arguments or returning composite types soon.
We'll update this section with corresponding Python types by then.

### Struct

A struct has a bunch of fields, each with a name and a type.
Expand All @@ -45,7 +42,14 @@ A table has a collection of rows, each of which is a struct with specified schem

The first field of a table is always the primary key.

## Indexable Types
:::note

CocoIndex will support functions taking struct and table types as arguments or returning composite types soon.
We'll update this section with corresponding Python types by then.

:::

## Types to Create Indexes

### Key Types

Expand Down