Skip to content
This repository has been archived by the owner on Aug 2, 2024. It is now read-only.

Files

Latest commit

6cb05f7 · May 30, 2023

History

History
45 lines (33 loc) · 1.56 KB

README.md

File metadata and controls

45 lines (33 loc) · 1.56 KB

node-red-contrib-opensearch

A set of Node-RED contributed nodes for OpenSearch including search, get, exists, create, update, delete, tail.

Using @opensearch-project/opensearch features, such as authentication.

ℹ️ For Elasticsearch, see this parent project.

Install

Run the following command in the root directory of your Node-RED install

npm install node-red-contrib-opensearch

Features

  • Shareable connection config node
  • All authentication schemes and other features (e.g. proxy) supported by @opensearch-project/opensearch (none, basic, api-key, bearer)
  • Easily interpret input messages via mustache templates, including the use of context data
  • Nodes
    • Connection - Config node for the connection to Opensearch
    • Doc level =>
      • Create - Create a doc
      • Delete - Delete a doc
      • Exists - Test if a doc exists
      • Get - Emit a single doc by its ID
      • Index - Index a doc (or update it)
      • Search - Stream found docs as new messages
      • Tail - Stream new docs as new messages
      • Update - By script or static doc
    • Index level =>
      • Exists - Test if index exists
      • Create - Create an index (apply settings and mappings)

Usage

See the documentation in the (right hand side) help pane of Node-Red; or the help block at the top of each node's .html file.

Contributions

A fork of forks... See contributors in packages.js for projects this was based on.