Awesome
graphql-compose-elasticsearch
This module expose Elastic Search REST API via GraphQL.
Elastic Search REST API proxy
Supported all elastic versions that support official elasticsearch-js client. Internally it parses its source code annotations and generates all available methods with params and descriptions to GraphQL Field Config Map. You may put this config map to any GraphQL Schema.
import { GraphQLSchema, GraphQLObjectType } from 'graphql';
import elasticsearch from 'elasticsearch';
import { elasticApiFieldConfig } from 'graphql-compose-elasticsearch';
const schema = new GraphQLSchema({
query: new GraphQLObjectType({
name: 'Query',
fields: {
elastic50: elasticApiFieldConfig(
// you may provide existed Elastic Client instance
new elasticsearch.Client({
host: 'http://localhost:9200',
apiVersion: '5.0',
})
),
// or may provide just config
elastic24: elasticApiFieldConfig({
host: 'http://user:pass@localhost:9200',
apiVersion: '2.4',
}),
elastic17: elasticApiFieldConfig({
host: 'http://user:pass@localhost:9200',
apiVersion: '1.7',
}),
},
}),
});
Full code example
Live demo of Introspection of Elasticsearch API via Graphiql
ObjectTypeComposer from Elastic mapping
In other side this module is a plugin for graphql-compose, which derives GraphQLType from your elastic mapping generates tons of types, provides all available methods in QueryDSL, Aggregations, Sorting with field autocompletion according to types in your mapping (like Dev Tools Console in Kibana).
Generated ObjectTypeComposer model has several awesome resolvers:
search
- greatly simplified elasticsearch
method. According to GraphQL adaptation and its projection bunch of params setup automatically due your graphql query (eg_source
,explain
,version
,trackScores
), other rare fine tuning params moved toopts
input field.searchConnection
- elasticsearch
method that implements Relay Cursor Connection spec for infinite lists. Internally it uses cheap search_after API. One downside, Elastic does not support backward scrolling, sobefore
argument will not work.searchPagination
- elasticsearch
method that haspage
andperPage
argumentsfindById
- get elastic record by idupdateById
- update elastic record by id- feel free to add your resolver or ask for a new one
import { GraphQLSchema, GraphQLObjectType } from 'graphql';
import elasticsearch from 'elasticsearch';
import { composeWithElastic } from 'graphql-compose-elasticsearch';
const mapping = {
properties: {
name: {
type: 'text',
fields: {
keyword: {
type: 'keyword',
},
},
},
gender: {
type: 'keyword',
},
skills: {
type: 'text',
},
languages: {
type: 'keyword',
},
location: {
properties: {
name: {
type: 'text',
},
point: {
type: 'geo_point',
},
},
},
createdAt: {
type: 'date',
},
},
};
const UserTC = composeWithElastic({
graphqlTypeName: 'UserES',
elasticIndex: 'user',
elasticType: 'user',
elasticMapping: mapping,
elasticClient: new elasticsearch.Client({
host: 'http://localhost:9200',
apiVersion: '5.0',
log: 'trace',
}),
// elastic mapping does not contain information about is fields are arrays or not
// so provide this information explicitly for obtaining correct types in GraphQL
pluralFields: ['skills', 'languages'],
});
const Schema = new GraphQLSchema({
query: new GraphQLObjectType({
name: 'Query',
fields: {
user: UserTC.getResolver('search').getFieldConfig(),
userPagination: UserTC.getResolver('searchPagination').getFieldConfig(),
userConnection: UserTC.getResolver('searchConnection').getFieldConfig(),
},
}),
});
Full code example
Installation
yarn add graphql graphql-compose elasticsearch graphql-compose-elasticsearch
// or
npm install graphql graphql-compose elasticsearch graphql-compose-elasticsearch --save
Modules graphql
, graphql-compose
, elasticsearch
are in peerDependencies
, so should be installed explicitly in your app.
Screenshots
API proxy: Raw search method
<img width="1316" alt="screen shot 2017-03-07 at 22 26 17" src="https://cloud.githubusercontent.com/assets/1946920/23859886/61066f40-082f-11e7-89d0-8443aa2ae930.png">API proxy: Getting several raw elastic metric in one request
<img width="1314" alt="screen shot 2017-03-07 at 22 34 01" src="https://cloud.githubusercontent.com/assets/1946920/23859892/65e71744-082f-11e7-8c1a-cafeb87e08e6.png">Mapping: Relay Cursor Connection
<img width="1411" alt="screen shot 2017-03-22 at 19 34 09" src="https://cloud.githubusercontent.com/assets/1946920/24200219/a058c220-0f36-11e7-9cf1-38394052f922.png">Mapping: Generated GraphQL Types and Documentation
<img width="1703" alt="screen shot 2017-03-22 at 19 33 24" src="https://cloud.githubusercontent.com/assets/1946920/24200220/a05944b6-0f36-11e7-9919-39b7001af203.png">FAQ
Creating custom Resolvers
If you need create something special, you may create a custom Resolver. For example, if you need to add a new tag for existing record, do it in the following manner (see full test-case):
ActivitiesEsTC.addResolver({
name: 'addTag',
kind: 'mutation',
type: 'JSON',
args: {
id: 'String!',
tag: 'String!',
},
resolve: ({ args }) => {
return elasticClient.update({
index: elasticIndex,
type: elasticType,
id: args.id,
body: {
script: {
inline: 'ctx._source.tags.add(params.tag)',
params: { tag: args.tag },
},
},
});
},
});