Document SUMMARY indexes for end users
- Lingua principale
- Python
- Stelle
- 211
- Fork
- 58
- Merge medio
- 1g 17h
- PR unite (30g)
- 6
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Direzione di ricerca
Start with tutorial 15.indexing-ctables.ipynb and the SUMMARY index behavior described in the issue, then inspect doc/reference/ctable.rst for the create_summary_index parameter. Add the user-facing explanation, opt-out and verification details, plus a realistic timing example comparing queries with and without SUMMARY indexes. Done means both documentation locations cover the feature and cross-reference the parameter.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- jupyter-notebook, python
- Ambito
- databases, documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Specificata chiaramente
- Idoneità per principianti
- 74/100