# query_index URL: /api/cache/query_index/ Section: cache -------------------------------------------------------------------------------- query_index - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy API Reference Cache ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module cache.query_index Query Index - Base class for queryable indexes. Provides O(1) lookups for common page queries by pre-computing indexes at build time. Similar to TaxonomyIndex but generalized for any page attribute. Architecture: Build indexes once during build phase (O(n) cost) Persist to disk for incremental builds Template access is O(1) hash lookup Incrementally update only changed pages Example: # Built-in indexes site.indexes.section.get('blog') # O(1) - all blog posts site.indexes.author.get('Jane Smith') # O(1) - posts by Jane # Custom indexes site.indexes.status.get('published') # O(1) - published posts View source 2 Classes Classes IndexEntry dataclass A single entry in a query index. Represents one index key (e.g., 'blog' section, 'Jane Smith' auth… 6 Caret Right A single entry in a query index. Represents one index key (e.g., 'blog' section, 'Jane Smith' author) and all pages that match that key. Implements the Cacheable protocol for type-safe serialization. Inherits from Cacheable Attributes Name Type Description key str Index key (e.g., 'blog', 'Jane Smith', '2024') page_paths list[str] List of page source paths (strings, not Page objects) metadata dict[str, Any] Extra data for display (e.g., section title, author email) updated_at str ISO timestamp of last update content_hash str Hash of page_paths for change detection Methods 4 to_cache_dict Serialize to cache-friendly dictionary (Cacheable protocol). 0 dict[str, Any] Caret Right def to_cache_dict(self) -> dict[str, Any] Serialize to cache-friendly dictionary (Cacheable protocol). Returns dict[str, Any] from_cache_dict classmethod Deserialize from cache dictionary (Cacheable protocol). 1 IndexEntry Caret Right def from_cache_dict(cls, data: dict[str, Any]) -> IndexEntry Deserialize from cache dictionary (Cacheable protocol). Parameters 1 data dict[str, Any] Returns IndexEntry to_dict Alias for to_cache_dict (backward compatibility). 0 dict[str, Any] Caret Right def to_dict(self) -> dict[str, Any] Alias for to_cache_dict (backward compatibility). Returns dict[str, Any] from_dict staticmethod Alias for from_cache_dict (backward compatibility). 1 IndexEntry Caret Right def from_dict(data: dict[str, Any]) -> IndexEntry Alias for from_cache_dict (backward compatibility). Parameters 1 data dict[str, Any] Returns IndexEntry Internal Methods 2 Caret Right __post_init__ Compute content hash if not provided. 0 None Caret Right def __post_init__(self) -> None Compute content hash if not provided. _compute_hash Compute hash of page_paths for change detection. 0 str Caret Right def _compute_hash(self) -> str Compute hash of page_paths for change detection. Returns str QueryIndex abstract Base class for queryable indexes. Subclasses define: - What to index (e.g., by_section, by_author,… 15 Caret Right Base class for queryable indexes. Subclasses define: What to index (e.g., by_section, by_author, by_tag) How to extract keys from pages Optionally: custom serialization logic The base class handles: Index storage and persistence Incremental updates Change detection O(1) lookups Inherits from ABC Methods 10 extract_keys Extract index keys from a page. Returns list of (key, metadata) tuples. Can re… 1 list[tuple[str, dic… Caret Right def extract_keys(self, page: Page) -> list[tuple[str, dict[str, Any]]] Extract index keys from a page. Returns list of (key, metadata) tuples. Can return multiple keys for multi-valued indexes (e.g., multi-author papers, multiple tags). Parameters 1 page Page Page to extract keys from Returns list[tuple[str, dict[str, Any]]] — List of (key, metadata) tuples update_page Update index for a single page. Handles: - Removing page from old keys - Addin… 2 set[str] Caret Right def update_page(self, page: Page, build_cache: BuildCache) -> set[str] Update index for a single page. Handles: Removing page from old keys Adding page to new keys Tracking affected keys for incremental regeneration Parameters 2 page Page Page to update build_cache BuildCache Build cache for dependency tracking Returns set[str] — Set of affected index keys (need regeneration) remove_page Remove page from all index entries. 1 set[str] Caret Right def remove_page(self, page_path: str) -> set[str] Remove page from all index entries. Parameters 1 page_path str Path to page source file Returns set[str] — Set of affected keys get Get page paths for index key (O(1) lookup). 1 list[str] Caret Right def get(self, key: str) -> list[str] Get page paths for index key (O(1) lookup). Parameters 1 key str Index key Returns list[str] — List of page paths (copy, safe to modify) keys Get all index keys. 0 list[str] Caret Right def keys(self) -> list[str] Get all index keys. Returns list[str] has_changed Check if index entry changed (for skip optimization). Compares page_paths as s… 2 bool Caret Right def has_changed(self, key: str, page_paths: list[str]) -> bool Check if index entry changed (for skip optimization). Compares page_paths as sets (order doesn't matter for most use cases). Parameters 2 key str Index key page_paths list[str] New list of page paths Returns bool — True if entry changed and needs regeneration get_metadata Get metadata for index key. 1 dict[str, Any] Caret Right def get_metadata(self, key: str) -> dict[str, Any] Get metadata for index key. Parameters 1 key str Index key Returns dict[str, Any] — Metadata dict (empty if key not found) save_to_disk Persist index to disk. 0 None Caret Right def save_to_disk(self) -> None Persist index to disk. clear Clear all index data. 0 None Caret Right def clear(self) -> None Clear all index data. stats Get index statistics. 0 dict[str, Any] Caret Right def stats(self) -> dict[str, Any] Get index statistics. Returns dict[str, Any] — Dictionary with index stats Internal Methods 5 Caret Right __init__ Initialize query index. 2 None Caret Right def __init__(self, name: str, cache_path: Path) Initialize query index. Parameters 2 name str Index name (e.g., 'section', 'author') cache_path Path Path to cache file (e.g., .bengal/indexes/section_index.json) _load_from_disk Load index from disk. 0 None Caret Right def _load_from_disk(self) -> None Load index from disk. _add_page_to_key Add page to index key. 3 None Caret Right def _add_page_to_key(self, key: str, page_path: str, metadata: dict[str, Any]) -> None Add page to index key. Parameters 3 key str Index key page_path str Path to page source file metadata dict[str, Any] Metadata to store with this entry _remove_page_from_key Remove page from index key. 2 None Caret Right def _remove_page_from_key(self, key: str, page_path: str) -> None Remove page from index key. Parameters 2 key str Index key page_path str Path to page source file __repr__ String representation. 0 str Caret Right def __repr__(self) -> str String representation. Returns str ← Previous page_discovery_cache Next → query_index_registry List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 1911 - Reading Time: 10 minutes