Sphinx

Full-text search daemon serving indexes built offline by its indexer.

Provider
default
Category
Data
Properties · 4 set by this component
propertytypevaluesrequiredkind defaultthis component
geoScheme · advancedenumnone | s2 | h3 | geohash | quadtreenononeinherited
indexType · component propertyenumplain | realtimenoplaininherited
indexingenumsync | async | batchnoasync▸ batch
managedboolean—nofalse▸ false
rebuildCadenceHours · advancedinteger—no—inherited
replicasinteger—no—inherited
searchdPort · component propertyinteger—no9312inherited
shardingStrategy · advancedenumnone | hash | geo | time | prefix-rangenonone▸ none
structureenuminverted | trie | vector | geo-cellnoinverted▸ inverted
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: "sphinx", component: "sphinx" }
Other Search index products · 31
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# Sphinx: full-text search server. Per the Sphinx reference manual a plain index is built offline
# by the `indexer` tool and served by the `searchd` daemon, which listens on port 9312 for the
# native protocol; real-time indexes are an alternative index type.
schemaVersion: "1"
type: "component"
id: "sphinx"
kind: "search-index"
provider: "default"
docs: "http://sphinxsearch.com/docs/current.html"
defaults:
  managed: false
  structure: "inverted"
  shardingStrategy: "none"
  indexing: "batch"
properties:
  indexType:
    type: "enum"
    values: ["plain", "realtime"]
    default: "plain"
  searchdPort:
    type: "integer"
    default: 9312

The same page as markdown, for an agent: /catalogue/components/sphinx.md