OpenSearch

Search indexopensearch

Open-source Elasticsearch fork with the same sharding and refresh model.

Provider
default
Category
Data
Properties · 4 set by this component
propertytypevaluesrequiredkind defaultthis component
geoScheme · advancedenumnone | s2 | h3 | geohash | quadtreenononeinherited
indexingenumsync | async | batchnoasync▸ async
managedboolean—nofalseinherited
rebuildCadenceHours · advancedinteger—no—inherited
refreshIntervalSeconds · component propertyinteger—no1inherited
replicasinteger—no—▸ 1
shardingStrategy · advancedenumnone | hash | geo | time | prefix-rangenonone▸ hash
shards · component propertyinteger—no1inherited
structureenuminverted | trie | vector | geo-cellnoinverted▸ inverted
vectorSearch · component propertyboolean—nofalseinherited
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: "opensearch", component: "opensearch" }
Other Search index products · 31
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# OpenSearch: Elasticsearch fork with the same shard, replica and refresh defaults.
# vectorSearch: the k-NN plugin's knn_vector field type with approximate and exact search (OpenSearch "k-NN vector").
schemaVersion: "1"
type: "component"
id: "opensearch"
kind: "search-index"
provider: "default"
docs: "https://docs.opensearch.org/"
defaults:
  structure: "inverted"
  shardingStrategy: "hash"
  indexing: "async"
  replicas: 1
properties:
  shards:
    type: "integer"
    default: 1
  refreshIntervalSeconds:
    type: "integer"
    default: 1
  vectorSearch:
    type: "boolean"
    default: false

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