Need help with elastic-builder?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sudo-suhas
373 Stars 43 Forks MIT License 353 Commits 11 Opened issues

Description

A Node.js implementation of the elasticsearch Query DSL :construction_worker:

Services available

!
?

Need anything else?

Contributors list

# 13,562
Vue.js
vue-cli
code-sp...
progres...
282 commits
# 181
nextjs
postman...
graphql...
angular...
12 commits
# 459,715
JavaScr...
TypeScr...
elastic...
query-b...
6 commits
# 170,892
GraphQL
hashico...
graphql...
mysql-c...
2 commits
# 155,637
SQL
koa2
Koa
immer
2 commits
# 300,757
Shell
elastic...
GraphQL
graphql...
2 commits
# 2,198
autoit
socat
R
atom-pl...
2 commits
# 398,702
dynamod...
TypeScr...
JavaScr...
Shell
1 commit
# 681,130
JavaScr...
TypeScr...
Shell
elastic...
1 commit
# 366,715
sentry
crash-r...
React
HTML
1 commit
# 61,858
CSS
React
Angular
preact-...
1 commit
# 7,029
playfra...
Amazon ...
serverl...
aws-lam...
1 commit
# 91,608
HTML
Angular
cloud-f...
Firebas...
1 commit
# 82,591
HTML
Visual ...
vscode
semver
1 commit
# 271,110
Lua
vst
Dart
lv2
1 commit
# 207,876
TypeScr...
elastic...
query-b...
Objecti...
1 commit
# 220,083
React
d3js
dataviz
CSS
1 commit
# 259,908
aws-ses
mailgun
HTML
PHP
1 commit

elastic-builder

npm version Build Status Coverage Status semantic-release

A Node.js implementation of the Elasticsearch DSL for use with the official elasticsearch javascript client with builder syntax.

elastic-builder

Check out the API reference documentation.

Relevant blog post: https://blog.logrocket.com/elasticsearch-query-body-builder-node-js/

elastic-builder includes TypeScript definition for superior development experience.

Elasticsearch compatibility

elastic-builder
was built for 5.x query DSL. However, the library should be usable with 2.x as well. For older versions of the DSL, you can try
elastic.js
or
bodybuilder

elastic-builder
is also compatible with elasticsearch 6.0(alpha) for the most part. However, there are some breaking changes which have been called out in the docs(ex:
Script.file
.

What's Included:

Install

npm install elastic-builder --save

Usage

const esb = require('elastic-builder'); // the builder

const requestBody = esb.requestBodySearch() .query(esb.matchQuery('message', 'this is a test'));

// OR

const requestBody = new esb.RequestBodySearch().query( new esb.MatchQuery('message', 'this is a test') );

requestBody.toJSON(); // or print to console - esb.prettyPrint(requestBody) { "query": { "match": { "message": "this is a test" } } }

For each class,

MyClass
, a utility function
myClass
has been provided which constructs the object for us without the need for
new
keyword.

REPL

Try it out on the command line using the node REPL:

# Start the repl
node ./node_modules/elastic-builder/repl.js
# The builder is available in the context variable esb
elastic-builder > esb.prettyPrint(
...   esb.requestBodySearch()
...     .query(esb.matchQuery('message', 'this is a test'))
... );
{
  "query": {
    "match": {
      "message": "this is a test"
    }
  }
}

Motivation

Elasticsearch only provides a low level client for making requests.

elastic.js
was a relatively popular library for building the request search body. However, this project is not being maintained nor is the fork. There were several changes in the 5.0 release which make the older libraries unusable.

This library is a port of

elastic.js
to es6 with elasticsearch 5.x compatibility.

API Reference

API reference can be accessed here - https://elastic-builder.js.org/docs. The docs include examples ported from the official elasticsearch reference.

API documentation was generated using documentation.js. It is being hosted with help from this awesome project - https://github.com/js-org/dns.js.org

Recipes

The library has a few helper recipes:

const qry = esb.cookMissingQuery('user');

qry.toJSON(); { "bool": { "must_not": { "exists": { "field": "user" } } } }

Check out the reference docs for more examples.

If you have any recipes, please do share or better yet, create a pull request :smile:.

Changelog

releases

Examples

Usage with official elasticsearch client:

'use strict';

const elasticsearch = require('elasticsearch'); const esb = require('elastic-builder');

const client = new elasticsearch.Client({ host: 'localhost:9200', log: 'trace' });

const requestBody = esb .requestBodySearch() .query(esb.matchQuery('body', 'elasticsearch'));

client .search({ index: 'twitter', type: 'tweets', body: requestBody.toJSON() }) .then(resp => { const hits = resp.hits.hits; }) .catch(err => { console.trace(err.message); });

// Bool query
const requestBody = esb.requestBodySearch().query(
  esb.boolQuery()
    .must(esb.matchQuery('last_name', 'smith'))
    .filter(esb.rangeQuery('age').gt(30))
);
requestBody.toJSON();
{
  "query": {
    "bool": {
      "must": {
        "match": { "last_name": "smith" }
      },
      "filter": {
        "range": { "age": { "gt": 30 } }
      }
    }
  }
}

// Multi Match Query const requestBody = esb.requestBodySearch().query( esb.multiMatchQuery(['title', 'body'], 'Quick brown fox') .type('best_fields') .tieBreaker(0.3) .minimumShouldMatch('30%') ); requestBody.toJSON(); { "multi_match": { "query": "Quick brown fox", "type": "best_fields", "fields": ["title", "body"], "tie_breaker": 0.3, "minimum_should_match": "30%" } }

// Aggregation const requestBody = esb.requestBodySearch() .size(0) .agg(esb.termsAggregation('popular_colors', 'color')); requestBody.toJSON(); { "size": 0, "aggs": { "popular_colors": { "terms": { "field": "color" } } } }

// Nested Aggregation const requestBody = esb.requestBodySearch() .size(0) .agg( esb.termsAggregation('colors', 'color') .agg(esb.avgAggregation('avg_price', 'price')) .agg(esb.termsAggregation('make', 'make')) ); requestBody.toJSON(); { "size": 0, "aggs": { "colors": { "terms": { "field": "color" }, "aggs": { "avg_price": { "avg": { "field": "price" } }, "make": { "terms": { "field": "make" } } } } } }

// If you prefer using the new keyword const agg = new esb.TermsAggregation('countries', 'artist.country') .order('rock>playback_stats.avg', 'desc') .agg( new esb.FilterAggregation('rock', new esb.TermQuery('genre', 'rock')).agg( new esb.StatsAggregation('playback_stats', 'play_count') ) ); agg.toJSON(); { "countries": { "terms": { "field": "artist.country", "order": { "rock>playback_stats.avg": "desc" } }, "aggs": { "rock": { "filter": { "term": { "genre": "rock" } }, "aggs": { "playback_stats": { "stats": { "field": "play_count" } } } } } } }

// Sort const requestBody = esb.requestBodySearch() .query(esb.boolQuery().filter(esb.termQuery('message', 'test'))) .sort(esb.sort('timestamp', 'desc')) .sorts([ esb.sort('channel', 'desc'), esb.sort('categories', 'desc'), // The order defaults to desc when sorting on the _score, // and defaults to asc when sorting on anything else. esb.sort('content'), esb.sort('price').order('desc').mode('avg') ]); requestBody.toJSON(); { "query": { "bool": { "filter": { "term": { "message": "test" } } } }, "sort": [ { "timestamp": { "order": "desc" } }, { "channel": { "order": "desc" } }, { "categories": { "order": "desc" } }, "content", { "price": { "order": "desc", "mode": "avg" } } ] }

// From / size const requestBody = esb.requestBodySearch() .query(esb.matchAllQuery()) .size(5) .from(10); requestBody.toJSON(); { "query": { "match_all": {} }, "size": 5, "from": 10 }

For more examples, check out the reference docs.

Validation

elastic-builder
provides lightweight validation where ever possible:
$ node ./node_modules/elastic-builder/repl.js
elastic-builder > esb.multiMatchQuery().field('title').field('body').query('Quick brown fox').type('bwst_fields')
See https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html
Got 'type' - bwst_fields
Error: The 'type' parameter should belong to Set {
  'best_fields',
  'most_fields',
  'cross_fields',
  'phrase',
  'phrase_prefix' }
    at MultiMatchQuery.type (E:\Projects\repos\elastic-builder\lib\queries\full-text-queries\multi-match-query.js:134:23)
    at repl:1:77
    at ContextifyScript.Script.runInContext (vm.js:35:29)
    at REPLServer.defaultEval (repl.js:342:29)
    at bound (domain.js:280:14)
    at REPLServer.runBound [as eval] (domain.js:293:12)
    at REPLServer. (repl.js:538:10)
    at emitOne (events.js:96:13)
    at REPLServer.emit (events.js:188:7)
    at REPLServer.Interface._onLine (readline.js:239:10)

Tests

Run unit tests:

npm test

Credits

elastic-builder
is heavily inspired by
elastic.js
and the fork by Erwan Pigneul.

bodybuilder
for documentation style, build setup, demo page.

License

MIT © Suhas Karanth

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.