Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hemerajs/hemera-elasticsearch
Use Elasticsearch with Hemera
https://github.com/hemerajs/hemera-elasticsearch
elasticsearch hemerajs search
Last synced: about 2 months ago
JSON representation
Use Elasticsearch with Hemera
- Host: GitHub
- URL: https://github.com/hemerajs/hemera-elasticsearch
- Owner: hemerajs
- License: mit
- Created: 2017-12-25T20:53:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-17T18:34:30.000Z (over 6 years ago)
- Last Synced: 2024-04-14T05:40:32.691Z (9 months ago)
- Topics: elasticsearch, hemerajs, search
- Language: JavaScript
- Homepage:
- Size: 22.5 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hemera-elasticsearch package
[](https://travis-ci.org/hemerajs/hemera-elasticsearch)
[](https://www.npmjs.com/package/hemera-elasticsearch)
[](#badge)
This is a plugin to use Elasticsearch with Hemera.
This plugin based on the official driver [elasticsearch](https://github.com/elastic/elasticsearch-js).
## Start elasticsearch via docker
```
docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elastic.co/elasticsearch/elasticsearch:6.2.3
```
## Install
```
npm i hemera-elasticsearch --save
```
## Usage
```js
const hemera = new Hemera(nats)
hemera.use(equire('hemera-joi'))
hemera.use(require('hemera-elasticsearch'), {
elasticsearch: {
log: 'trace'
}
})
```
## Plugin decorators
* .elasticsearch
## Interface
* [Elasticsearch API](#elasticsearch-api)
* [search](#search)
* [exists](#exists)
* [create](#create)
* [delete](#delete)
* [update](#update)
* [count](#count)
* [bulk](#bulk)
* [refresh](#refresh)
---
### search
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `search`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-search)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'search',
data: {}
},
function(err, resp) {}
)
```
---
### exists
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `exists`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-exists)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'exists',
data: {
index: 'my-index',
type: 'my-type',
id: 'jieu99'
}
},
function(err, resp) {}
)
```
---
### create
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `create`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-create)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'create',
data: {}
},
function(err, resp) {}
)
```
---
### delete
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `delete`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-delete)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'delete',
data: {}
},
function(err, resp) {}
)
```
---
### update
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `update`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-update)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'update',
data: {}
},
function(err, resp) {}
)
```
---
### count
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `count`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-count)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'count',
data: {}
},
function(err, resp) {}
)
```
---
### bulk
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `bulk`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-bulk)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'bulk',
data: {}
},
function(err, resp) {}
)
```
---
### refresh
The pattern is:
* `topic`: is the service name to publish to `elasticsearch`
* `cmd`: is the command to execute `refresh`
* `data`: options see [elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-indices-refresh)
Example:
```js
hemera.act(
{
topic: 'elasticsearch',
cmd: 'refresh',
data: {}
},
function(err, resp) {}
)
```