README.md

@fastify/opensearch

Fastify plugin for Opensearch for sharing the same ES client in every part of your server. Under the hood, the official opensearch module is used.

Install

npm i @fastify/opensearch

Usage

Add it to your project with register and you are done! The plugin accepts the same options as the client.

const fastify = require('fastify')()

fastify.register(require('@fastify/opensearch'), {
  node: 'https://localhost:9200',
  auth: {
    username: 'admin',
    password: 'admin'
  }
})

fastify.get('/user', async function (req, reply) {
  const { body } = await this.opensearch.search({
    index: 'tweets',
    body: {
      query: { match: { text: req.query.q }}
    }
  })

  return body.hits.hits
})

fastify.listen({ port: 3000 }, err => {
  if (err) throw err
})

By default, @fastify/opensearch will try to ping the cluster as soon as you start Fastify, but in some cases pinging may not be supported due to the user permissions. If you want, you can disable the initial ping with the healthcheck option:

fastify.register(require('@fastify/opensearch'), {
  node: 'https://localhost:9200',
  healthcheck: false,
  auth: {
    username: 'admin',
    password: 'admin'
  }
})

If you need to connect to different clusters, you can also pass a namespace option:

const fastify = require('fastify')()

fastify.register(require('@fastify/opensearch'), {
  node: 'https://localhost:9200',
  namespace: 'cluster1',
  auth: {
    username: 'admin',
    password: 'admin'
  }
})

fastify.register(require('@fastify/opensearch'), {
  node: 'http://localhost:9201',
  namespace: 'cluster2',
  auth: {
    username: 'admin',
    password: 'admin'
  }
})

fastify.get('/user', async function (req, reply) {
  const { body } = await this.opensearch.cluster1.search({
    index: 'tweets',
    body: {
      query: { match: { text: req.query.q }}
    }
  })

  return body.hits.hits
})

fastify.listen({ port: 3000 }, err => {
  if (err) throw err
})

Versioning

By default the latest and greatest version of the Opensearch client is used, see the compatibility table to understand if the embedded client is correct for you. If it is not, you can pass a custom client via the client option.

const fastify = require('fastify')()
const { Client } = require('@opensearch-project/opensearch')

fastify.register(require('@fastify/opensearch'), {
  client: new Client({ node: 'https://localhost:9200' })
})

fastify.get('/user', async function (req, reply) {
  const { body } = await this.opensearch.search({
    index: 'tweets',
    body: {
      query: { match: { text: req.query.q }}
    }
  })

  return body.hits.hits
})

fastify.listen({ port: 3000 }, err => {
  if (err) throw err
})

License

Licensed under MIT.