About

The page of a hub's search: /explore, /api/v1/search with its declared schema and the header search box, over the public sources the features register in the framework's search registry (a hub's datasets and files, their facets and orders), which the search feature browses with Elasticsearch or in memory. It names no kind of material, so another hub explores its own.

Provides

Services
ExploreServiceUvlhubSearchService
Routes
/api/v1/search/explore/explore/admin/reindex/search
Hooks filled
admin.dashboard.cardsdataset.home.actionslayout.head.csslayout.header.menulayout.scripts
Translations
es

Commands

  • $ splent feature:explore reindex

    Builds again what the search holds of every public source.

  • $ splent feature:explore reset

    The same as reindex: every source's index is dropped and built again.

Run them in your workspace once the feature is installed in the selected product.

Configuration

Setting Default What it does
EXPLORE_HEADER_SEARCH true The header's search box, which asks /search as the reader types. A product whose header has the catalog's search (splent_feature_search), which finds the datasets through the source explore registers, turns it off.

These are the defaults. A product changes them in its own pyproject.toml, under [tool.splent.config], or in .env.deploy in production.

Dependencies

Requires
Works better with

In product lines

Extension points

Hook slots
explore.aside
Templates
explore/index.htmlhooks/admin_index_card.htmlhooks/header_search.htmlhooks/home_explore_more.html
Services
ExploreServiceUvlhubSearchService
Routes
A refinement can add routes to its blueprint

Other features fill its hook slots. A refinement can override its templates and services or extend its models without forking it.

Compatibility

Python
>=3.13
SPLENT framework
>=1.30.0