Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graphql-compose/graphql-compose-elasticsearch
Hide Elastic Search REST API behind GraphQL.
https://github.com/graphql-compose/graphql-compose-elasticsearch
elastic elasticsearch graphql graphql-compose
Last synced: 3 months ago
JSON representation
Hide Elastic Search REST API behind GraphQL.
- Host: GitHub
- URL: https://github.com/graphql-compose/graphql-compose-elasticsearch
- Owner: graphql-compose
- License: mit
- Created: 2017-03-05T15:26:11.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T17:46:58.000Z (12 months ago)
- Last Synced: 2024-10-30T00:00:30.982Z (3 months ago)
- Topics: elastic, elasticsearch, graphql, graphql-compose
- Language: TypeScript
- Homepage: https://graphql-compose.herokuapp.com/elasticsearch/
- Size: 2.31 MB
- Stars: 583
- Watchers: 17
- Forks: 77
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
- awesome-ccamel - graphql-compose/graphql-compose-elasticsearch - Hide Elastic Search REST API behind GraphQL. (TypeScript)
- awesome-list - graphql-compose-elasticsearch - compose | 519 | (TypeScript)
README
# graphql-compose-elasticsearch
[](https://www.npmjs.com/package/graphql-compose-elasticsearch)
[](http://www.npmtrends.com/graphql-compose-elasticsearch)
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/semantic-release/semantic-release)
This module expose Elastic Search REST API via GraphQL.
## Elastic Search REST API proxy
Supported all elastic versions that support official [elasticsearch-js](https://github.com/elastic/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.
```js
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](https://github.com/graphql-compose/graphql-compose-elasticsearch/tree/master/examples/differentVersions)
Live demo of [Introspection of Elasticsearch API via Graphiql](https://graphql-compose.herokuapp.com/elasticsearch/)
---
## ObjectTypeComposer from Elastic mapping
In other side this module is a plugin for [graphql-compose](https://github.com/graphql-compose/graphql-compose), which derives GraphQLType from your [elastic mapping](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html) 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 elastic `search` 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 to `opts` input field.
- `searchConnection` - elastic `search` method that implements Relay Cursor Connection [spec](https://facebook.github.io/relay/graphql/connections.htm) for infinite lists. Internally it uses cheap [search_after](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-search-after.html) API. One downside, Elastic does not support backward scrolling, so `before` argument will not work.
- `searchPagination` - elastic `search` method that has `page` and `perPage` arguments
- `findById` - get elastic record by id
- `updateById` - update elastic record by id
- feel free to add your resolver or ask for a new one
```js
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](https://github.com/graphql-compose/graphql-compose-elasticsearch/blob/master/examples/elastic50/index.js)
## Installation
```bash
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
### API proxy: Getting several raw elastic metric in one request
### Mapping: Relay Cursor Connection
### Mapping: Generated GraphQL Types and Documentation
## 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](https://github.com/graphql-compose/graphql-compose-elasticsearch/blob/master/src/__tests__/github_issues/37-test.js)):
```js
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 },
},
},
});
},
});
```
## License
[MIT](https://github.com/graphql-compose/graphql-compose-elasticsearch/blob/master/LICENSE.md)