Skip to content

Add posting index and covering index documentation#404

Open
nwoolmer wants to merge 1 commit intomainfrom
nw_index
Open

Add posting index and covering index documentation#404
nwoolmer wants to merge 1 commit intomainfrom
nw_index

Conversation

@nwoolmer
Copy link
Copy Markdown
Contributor

Summary

  • Add new documentation page for posting index and covering index (posting-index.md)
  • Update existing index, CREATE TABLE, ALTER TABLE ADD INDEX, schema design, and SQL optimizer hints docs with posting index syntax and examples
  • Add posting index entry to sidebar navigation

Test plan

  • Verify yarn build succeeds with no broken links
  • Review posting index page renders correctly
  • Check cross-links between index pages work

🤖 Generated with Claude Code

New page: concepts/deep-dive/posting-index.md
- When to use, creating with INDEX TYPE POSTING and INCLUDE
- Covering index: how it works, supported types, choosing columns
- Verifying with EXPLAIN, comparison with bitmap index
- All accelerated query patterns with examples
- SQL optimizer hints (no_covering, no_index)
- Trade-offs: storage, write performance, memory
- Architecture: file types, generations, sealing, FSST compression
- Limitations

Updated pages:
- indexes.md: added index type comparison table
- create-table.md: added posting index and INCLUDE syntax
- alter-table-alter-column-add-index.md: added posting + INCLUDE examples
- sql-optimizer-hints.md: added no_covering and no_index hints
- schema-design-essentials.md: added indexing decision guide
- sidebars.js: added posting-index to Deep Dive navigation
@github-actions
Copy link
Copy Markdown

🚀 Build success!

Latest successful preview: https://preview-404--questdb-documentation.netlify.app/docs/

Commit SHA: cecfffb

📦 Build generates a preview & updates link on each commit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant