Blosc/python-blosc2

Document SUMMARY indexes for end users

Open

#645 geöffnet am 2. Juni 2026

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (47 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (207 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

Contributor Guide