elastic.js's Introduction

elastic.js can be used with elasticsearch 2.x and lower. There were several breaking changes in the 5.x release for the Query DSL.

You can try elastic-builder for elasticsearch version >= 5.x.

doc is here : https://cdn.rawgit.com/ErwanPigneul/elastic.js/master/dist/docs/ejs.html

elastic.js

A JavaScript implementation of the ElasticSearch DSL for use with the official elasticsearch javascript client.

Documentation

You can find the official documentation at the following locations:

You will also be able to find unofficial documentation and examples on on our blog and GitHub Gist pages here and here.

Examples

Search

See http://www.elasticsearch.org/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-search.

client.search({
  index: 'myindex',
  body: ejs.Request()
          .query(ejs.MatchQuery('title', 'test'))
          .facet(ejs.TermsFacet('tags').field('tags'))
}, function (error, response) {
  // handle response
});

Suggest

See http://www.elasticsearch.org/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-suggest

client.suggest({
  index: 'myindex',
  body: ejs.TermSuggester('mysuggester')
          .text('tset')
          .field('title')
}, function (error, response) {
  // handle suggestion response
});

Multi-Search

See http://www.elasticsearch.org/guide/en/elasticsearch/client/javascript-api/current/api-reference.html#api-msearch

client.msearch({
  body: [
    {}
    ejs.Request().query(ejs.MatchAllQuery()),
    { index: 'myindex', type: 'mytype' },
    ejs.Request().query(ejs.QueryStringQuery('"Test 1"'))
  ]
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Also, please don't edit elastic.js and elastic.min.js files as they are generated via grunt. You'll find source code in the "src" subdirectory!

Some tips (memo)

cd docs/ ./build.sh

License

elastic.js's People

Contributors

Stargazers

Watchers

elastic.js's Issues

Be sure all aggregations are available

to do

Replace deprecated Request.filter() with Request.post_filter()

For lack of time I can just point to the hackish PR I posted on YousefED/ElasticUI: YousefED/ElasticUI#109. Hopefully somebody will find it useful and create a proper PR for the elastic.js changes.

The documentation for `MultiMatchQuery#minimumShouldMatch` says it outputs percentages, but does integers:

First, thanks for the fork!

I wanted to report the following issue:

The documentation is not according with the code

It claims that MultiMatchQuery#minimumShouldMatch:

Sets a percent value controlling how many "should" clauses in the resulting Query should match.

and that the:

Parameters
minMatch An integer between 0 and 100.

but is not the case.
Once the function is called with an integer parameter, the output JSON for that field is an integer, and not the expected percentage.

{ multi_match:
   { query: 'test_query',
     fields: [ 'test_field' ],
     minimum_should_match: 4 } }

The api for [minimum-should-match in the es documentation](https://www.elastic.co/guide/en/elasticsearch/reference/1.4/query-dsl-minimum- +should-match.html) distinguishes the case for:

Type	Example	Description
Integer	3	Indicates a fixed value regardless of the number of optional clauses.
Percentage	75%	Indicates that this percent of the total number of optional clauses are necessary. The number computed +from the percentage is rounded down and used as the minimum.

If my analysis is correct, the documentation could be updated, describing that it is accepted a String representing any of the minimum_should_match options

Recommend Projects

erwanpigneul / elastic.js Goto Github PK