Skip to content

docs: Add supported index key types to Index docs page#4606

Merged
clockwork-labs-bot merged 1 commit intomasterfrom
bot/docs-index-supported-types
Mar 30, 2026
Merged

docs: Add supported index key types to Index docs page#4606
clockwork-labs-bot merged 1 commit intomasterfrom
bot/docs-index-supported-types

Conversation

@clockwork-labs-bot
Copy link
Copy Markdown
Collaborator

Fixes #4592

Adds a "Supported Column Types" section to the Index documentation page listing:

  • Supported types: integers (all widths), bool, String, Identity, ConnectionId, Uuid, Hash, and no-payload enums with #[derive(SpacetimeType)]
  • Unsupported types: floats (no total ordering), ScheduleAt/TimeDuration/Timestamp (not yet supported, links Make Timestamp implement FilterableValue #2650), Vec/arrays, enums with payloads, nested structs
  • Workaround tip: scaled integers for floating-point coordinates
  • Direct index restrictions: only u8/u16/u32/u64 and no-payload enums

The list is derived from the FilterableValue trait implementations in crates/lib/src/filterable_value.rs and the direct index validation in crates/schema/src/def/validate/v9.rs.

Lists which types can and cannot be used as index keys for both
B-tree and direct indexes. Includes a workaround tip for
floating-point data (scaled integers) and links to the open
issue for Timestamp/TimeDuration support (#2650).
@cloutiertyler cloutiertyler added this pull request to the merge queue Mar 30, 2026
@github-merge-queue github-merge-queue Bot removed this pull request from the merge queue due to failed status checks Mar 30, 2026
@clockwork-labs-bot clockwork-labs-bot added this pull request to the merge queue Mar 30, 2026
Merged via the queue into master with commit fca10ae Mar 30, 2026
35 of 36 checks passed
@bfops bfops deleted the bot/docs-index-supported-types branch April 14, 2026 23:13
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 the allowed FilterableValues list to the Index docs page

2 participants