Catalogue / Data

Search index

datasearch-index

Derived index for text, prefix, vector or geospatial queries.

Category
Data
Properties
7
Components
32
Rules
1
Properties · 7 defined by this kind

A node of this kind resolves each property from its own props, then the component's defaults, then the default below.

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 for this kind · 1
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
Components · 32
Source
# yaml-language-server: $schema=../schema/kind.schema.json
# Derived index for text, prefix, vector or geospatial queries (Elasticsearch, Solr, in-house tries, S2/H3 cell indexes).
# Absorbs the geospatial-index candidate: structure geo-cell plus geoScheme.
schemaVersion: "1"
type: "kind"
id: "search-index"
category: "data"
properties:
  structure:
    type: "enum"
    values: ["inverted", "trie", "vector", "geo-cell"]
    default: "inverted"
  shardingStrategy:
    type: "enum"
    values: ["none", "hash", "geo", "time", "prefix-range"]
    default: "none"
    advanced: true
  indexing:
    type: "enum"
    values: ["sync", "async", "batch"]
    default: "async"
  rebuildCadenceHours:
    type: "integer"
    advanced: true
  replicas:
    type: "integer"
  geoScheme:
    type: "enum"
    values: ["none", "s2", "h3", "geohash", "quadtree"]
    default: "none"
    advanced: true
  managed:
    type: "boolean"
    default: false

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