hyper-adapter-elasticsearch

A Search port adapter that uses Elasticsearch to index documents for full text search in the hyper service framework

---

• Table of Contents
• Getting Started
• Installation
• Features
• Methods
• Testing
• Contributing
• License

Getting Started

import { default as elasticsearch } from 'https://x.nest.land/[email protected]/mod.js'

export default {
  app,
  adapter: [
    {
      port: 'search',
      plugins: [elasticsearch({ url: 'http://localhost:9200' })],
    },
  ],
}

Installation

This is a Deno module available to import from nest.land

deps.js

export { default as elasticsearch } from 'https://x.nest.land/[email protected]/mod.js'

Features

• create an index in Elasticsearch
• delete an index in Elasticsearch
• index a document using Elasticsearch
• retrieving an indexed document from Elasticsearch index
• update an indexed document in Elasticsearch index
• remove an indexed document from Elasticsearch index
• bulk operation to index multiple docs using Elasticsearch (uses Elasticsearches bulk api)
• query an Elasticsearch index

Methods

This adapter fully implements the Search port and can be used as the hyper Search service adapter

See the full port here

Testing

• Spin up docker image locally

docker run \
-p 9200:9200 -p 9600:9600 \
-e "discovery.type=single-node" \
-v /workspace/hyper-adapter-elasticsearch/scripts/opensearch.yml:/usr/share/opensearch/config/opensearch.yml \
opensearchproject/opensearch:1.2.3

• Run hyper

./scripts/hyper.sh

• Run hyper-test

Contributing

Contributions are welcome! See the hyper contribution guide

License

Apache-2.0