Skip to content

Add split_fields description to split spec #5830

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.

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 2 commits into from
Jul 15, 2025
Merged
Changes from all commits
Commits
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
5 changes: 4 additions & 1 deletion docs/internals/split-format.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ Quickwit's index are divided into small independent immutable piece of index cal
For convenience, a split consists in a single file, with the extension `.split`.

In reality, this file hides an internal mini static filesystem,
with the tantivy index files.
with:
- the Tantivy index files (`.idx`, `.pos`, `.term`...)
- a Quickwit specific file with the list of fields, including those indexed as part of a JSON type.
It contains the field name, type and capabilities.

The split file data layout looks like this:
- concatenation all of the files in the split
Expand Down