Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

elasticsearch-graphql

Package Overview
Dependencies
Maintainers
1
Versions
17
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

elasticsearch-graphql

Schema generator and query builder for elasticsearch

  • 1.1.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2
decreased by-71.43%
Maintainers
1
Weekly downloads
 
Created
Source

Elastic Search GraphQL

Schema and query builder for Elastic Search

  • Creates a static typed graphql schema from an elastic search mapping
  • Transforms your graphql query and creates an elastic search body
  • Runs the search on your elastic index
  • Returns the results and calls your hits schema

For working example, checkout elasticsearch-graphql-server-example

js-standard-style

Usage

var graphql = require('graphql');
var esGraphQL = require('elasticsearch-graphql')
var hitsSchema = require('./schemas/myGraphQLSchema')

esGraphQL({
  graphql: graphql,
  name: 'ordersSearch',
  elastic: {
    host: 'localhost:9200',
    index: 'orders',
    type: 'order'
  },
  hitsSchema: hitsSchema
},function(err, schema) {

  var rootSchema = new graphql.GraphQLSchema({
    query: new graphql.GraphQLObjectType({
      name: 'RootQueryType',
      fields: {
        mySearchData: {
          type: schema.type,
          args: schema.args,
          resolve: schema.resolve
        }
      }
    })
  })
})

Query Builder

It will fetch the current mapping from elasticsearch and create a static typed schema for you. Add the schema to you graphql server and the type helper will lead you. The hits field will resolve to whatever schema you send in. So you can use elasticsearch for searching data and then easily get your real data from anywhere. See full example in in /examples

Example query
{
  ordersSearch(query: "New Order",
    filters: {
      images: {
        createdBy: {
          values: ["Simon Nord", "James Kyburz"],
          operator: OR
        }
      }
    }
  ) {
    aggregations {
      status {
        timestamp {
          unhandledDocs
          buckets(limit: 5) {
            key,
            count
          }
        }
      }
    }
    hits {
      id
    }
  }
}

TODO

  • Support multiple indexes
  • Do smarter elasticsearch queries
  • Add more options, like query type etc.
  • Add tests
  • Allow more aggregation types
  • Allow more complex filters

FAQs

Package last updated on 07 Feb 2016

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc