Generic search index

Search indexsearch-index

Vendor-neutral search index. Use when the real product is not in the catalogue; every rule for this kind still applies.

Provider
default
Category
Data
Official docs
not recorded
Generic?
Vendor-neutral: the kind itself
Properties · 0 set by this component
propertytypevaluesrequireddefault
geoScheme · advancedenumnone | s2 | h3 | geohash | quadtreenonone
indexingenumsync | async | batchnoasync
managedboolean—nofalse
rebuildCadenceHours · advancedinteger—no—
replicasinteger—no—
shardingStrategy · advancedenumnone | hash | geo | time | prefix-rangenonone
structureenuminverted | trie | vector | geo-cellnoinverted
Rules that apply · 1

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

derived-store-without-cdc-or-rebuild

A search index is derived data and needs an asynchronous feed from a stream, change data capture or an indexing worker. Without one it is written inline on the request path, and it can never be rebuilt after it drifts.

  • — this does not hold:
  • — the node has at least one asynchronous incoming edge from a stream, change-data-capture or worker
Use it in a design
nodes:
  - { id: "search-index", component: "search-index" }
Other Search index products · 31
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# The vendor-neutral search index: the kind itself, with no product behind it. It sets no
# defaults and adds no properties, so every required kind property stays required on the node.
schemaVersion: "1"
type: "component"
id: "search-index"
kind: "search-index"
provider: "default"

The same page as markdown, for an agent: /catalogue/components/search-index.md