Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ltv/moleculer-postgraphile
moleculer-postgraphile
https://github.com/ltv/moleculer-postgraphile
Last synced: 2 months ago
JSON representation
moleculer-postgraphile
- Host: GitHub
- URL: https://github.com/ltv/moleculer-postgraphile
- Owner: ltv
- License: mit
- Created: 2019-03-29T08:00:48.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T19:02:04.000Z (about 2 years ago)
- Last Synced: 2024-09-19T04:09:20.978Z (4 months ago)
- Language: TypeScript
- Size: 2.4 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-moleculer - moleculer-postgraphile - [Postgraphile](https://www.graphile.org/) Create postgraphile service for automatically detects tables, columns, indexes, relationships, views, types, functions, comments, and more. (Mixins / GraphQL)
README
# Moleculer Postgraphile
This package use for creating mixin for each service which can support
[](https://circleci.com/gh/ltv/moleculer-postgraphile)
[](https://coveralls.io/github/ltv/moleculer-postgraphile?branch=master)
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/js/moleculer-postgraphile)
## Usage
```bash
yarn add moleculer-postgraphile
```
```js
broker.createService({
name: 'public',
mixins: [
PostgraphileMixin({
schema: 'public',
pgPool: new Pool({
connectionString: process.env.DATABASE_URL
})
})
]
});
```
- The mixin will create the `graphql` action for service.
- To change the action name, just metion the `action` in option
```js
{
schema: 'public',
action: 'graphile',
pgPool: ...
}
```
- To call graphql from other service:
```js
const query = `
query {
allPubPosts {
nodes {
id
title
content
}
}
}
`;
const variables = {};
const response = await broker.call('public.graphql', { query, variables });
```
- This mixin only create one graphql schema & service for one database schema.
- For stitching multiple schema from multiple services, use can use `introspectionQuery`
```js
import { introspectionQuery } from 'graphql';
const schema = broker.call('serviceName.graphql', {
query: introspectionQuery
});
```
- After then, you should create custom ApolloLink which context call to:
```js
broker.call('serviceName.graphql', { query, variables });
```
- There is another way to discover the introspection without calling `introspectionQuery`
- After creating graphql schema, the mixin will store the `introspected query` in cacher and set `service.settings.hasGraphQLSchema = true`
- And will emit the event `graphile.updated` with params { schema } // schema stands for Schema Name
- To get the `introspectionQuery`:
```js
if (this.broker.cacher) {
this.broker.cacher.get(`graphile.schema.${schemaName}`);
}
```
- Custom cache key
```js
PostgraphileMixin({
schema: 'public',
pgPool: new Pool({
connectionString: process.env.DATABASE_URL
}),
cache: {
prefix: 'my_key_prefix',
name: 'my_key_name'
}
});
```
- Available options:
```js
export interface MixinOptions {
schema: string; // Schema name -> required
pgPool: pg.Pool; // pgPool -> required
options?: PostGraphileCoreOptions; // Postgraphile option -> default = {}
action?: string; // action name -> default = 'graphql'
cache?: { prefix: string, name: string }; // for setting cache -> default = true
}
```
## Test
Before testing, please provision env with docker
```bash
yarn provision:dev
```
And then
```bash
yarn test:unit
```