Socket
Socket
Sign inDemoInstall

es-query-builder

Package Overview
Dependencies
39
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    es-query-builder

build elasticsearch queries with self esteem


Version published
Weekly downloads
1
Maintainers
1
Install size
2.83 MB
Created
Weekly downloads
 

Readme

Source

es-query-builder

build elasticsearch queries the sane way

Motivation

the elasticsearch json query syntax is painful

Setup

es-query-builder expects both ES_URL and ES_INDEX environment variables to be definied

so you may have a config file that looks something like:

export ES_INDEX=events
export ES_URL=https://mysearch:9200

Usage

var Query = require('es-query-builder')

// create a fresh query:
var q = new Query

// chain modifications:
q.size(10) 
q.queryString('event.type:foo')
q.range('timestamp', 1467817775660, 1467817785860)
q.agg('min', 'min_timestamp', 'timestamp')
q.agg('max', 'max_timestamp', 'timestamp')

// call it!
q.fetch() // no args returns a promise

q.fetch(function(err, res) {
  // or with callback 
})

Keywords

FAQs

Last updated on 06 Jul 2016

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc