Blosc/python-blosc2

Document SUMMARY indexes for end users

Open

#645 aberto em 2 de jun. de 2026

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (47 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (207 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

SUMMARY indexes are now built automatically when a CTable is first closed, and they accelerate where() queries by skipping blocks that cannot match the predicate. This is a significant feature but it is only described in the API reference, not in any user-facing guide. The tutorial 15.indexing-ctables.ipynb covers FULL/PARTIAL indexes but does not mention SUMMARY at all.

Suggested work:

  • Add a section to 15.indexing-ctables.ipynb explaining: what SUMMARY indexes store (per-block min/max), when they are built automatically, the create_summary_index=False opt-out, and how to verify they are being used.
  • Add a short example that measures query time with and without a SUMMARY index on a realistic dataset
  • Update doc/reference/ctable.rst to cross-reference the new create_summary_index parameter

Guia do colaborador