
Security News
pnpm 10.12 Introduces Global Virtual Store and Expanded Version Catalogs
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.
elasticsearch-query
Advanced tools
elasticsearch-query generate queries for elasticsearch by simplify params
elasticsearch-query easily generate complex elasticsearch queries (last version for ELS 5.X)
npm install elasticsearch-query
var elsQuery = require('elasticsearch-query');
var elsGeneratorQueries = new elsQuery();
var type = null;
var mustQuery = {
'createdBy': 'kimchy'
};
/*
** method@generate(type, query, queryAggregations, match_type, callback);
**
** type (string) type on your elasticsearch index (not necessary could be null)
** query (object) that you want to transform
** queryAggregations (object) elasticsearch query if you want an aggregation more specific
** match_type (object) you can use {term: true}, or {match: true}, {match_phrase_prefix: true}, ...
** callback (function) return err & queryELS
*/
elsGeneratorQueries.generate(type, mustQuery, null, {term: true}, function(err, queryELS) {
console.log('mustQuery ->', JSON.stringify(queryELS));
});
==> queryELS
{
"query": {
"bool":{
"must":[
{
"term":{
"createdBy":"kimchy"
}
}
],
"must_not":[],
"should":[],
"filter":[]
}
}
}
<==
// I want documents createdBy kimchy or postedBy boubaks
var orQuery = {
'|createdBy': 'kimchy',
'|postedBy': 'boubaks'
};
elsGeneratorQueries.generate(type, orQuery, null, {term: true}, function(err, queryELS) {
console.log('orQuery ->', JSON.stringify(queryELS));
});
// I want documents not createdBy kimchy & not postedBy boubaks
var mustNotQuery = {
'!createdBy': 'kimchy',
'!postedBy': 'boubaks'
}
elsGeneratorQueries.generate(type, mustNotQuery, null, {term: true}, function(err, queryELS) {
console.log('mustNotQuery ->', JSON.stringify(queryELS));
});
// I want documents where "age" is between 18 and 60 both included
var rangeQuery = {
'$lte': { 'age': 60 },
'$gte': { 'age': 18 }
};
elsGeneratorQueries.generate(type, rangeQuery, null, {term: true}, function(err, queryELS) {
console.log('rangeQuery ->', JSON.stringify(queryELS));
});
==> queryELS
{
"query":{
"bool":{
"must":[
{
"range":{
"age":{
"lte":60,
"gte":18
}
}
}
],
"must_not":[],
"should":[],
"filter": []
}
}
<==
// I want the username aggregation and count between VERIFIED people where the field AGE exist and between 18-60 years old, not include boubaks
var complexQuery = {
'verified': true,
'$exist': 'age',
'$lte': { 'age': 60 },
'$gte': { 'age': 18 },
'!username': 'boubaks',
'$facet': 'username',
'$count': true
};
elsGeneratorQueries.generate(type, complexQuery, null, {term: true}, function(err, queryELS) {
console.log('complexQuery ->', JSON.stringify(queryELS));
});
==> queryELS
{
"query":{
"bool":{
"must":[
{
"term":{
"verified":true
}
},
{
"range":{
"age":{
"lte":60,
"gte":18
}
}
},
{
"exists":{
"field":"age"
}
}
],
"must_not":[
{
"term":{
"username":"boubaks"
}
}
],
"should":[],
"filter": []
}
},
"aggregations":{
"aggs":{
"terms":{
"field":"username",
"size":10
}
}
}
}
<==
You can add an handle function to a specific field setted
// addHandle(param, defaultValue, fcn);
// deleteHandle(index[, all (boolean)]);
// getHandles(); // console.log by default (will be removed)
/*
** @query: {$test: "elasticsearch"}
** @queryELS: the query generate for elasticsearch
** callback: function(err, queryELS)
*/
var handleTest = function (query, queryELS, callback) {
var error = null;
if (query.$test) {
// Do your stuff
}
callback(error, queryELS);
};
elsQueryGenerator.addHandle('$test', null, handleTest);
If you want to do specific action or normal query on $page, $limit, $sort, $skip, $handle you have to add handle function
FAQs
elasticsearch-query generate queries for elasticsearch by simplify params
The npm package elasticsearch-query receives a total of 5 weekly downloads. As such, elasticsearch-query popularity was classified as not popular.
We found that elasticsearch-query demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.
Security News
Amaro 1.0 lays the groundwork for stable TypeScript support in Node.js, bringing official .ts loading closer to reality.
Research
A deceptive PyPI package posing as an Instagram growth tool collects user credentials and sends them to third-party bot services.