brooklyn-labs / postgraphile-plugin-remove-foreign-key-fields Public

Notifications You must be signed in to change notification settings
Fork 0
Star 13

This PostGraphile plugin removes all foreign key fields from the GraphQL schema while still allowing foreign relationships to be created.

License

MIT license

13 stars 0 forks Branches Tags Activity

Star

Notifications

brooklyn-labs/postgraphile-plugin-remove-foreign-key-fields

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 27 Commits
.github		.github
.vscode		.vscode
src		src
. prettierignore		. prettierignore
.editorconfig		.editorconfig
.eslintrc.json		.eslintrc.json
.gitattributes		.gitattributes
.gitignore		.gitignore
.prettierrc		.prettierrc
CHANGELOG.MD		CHANGELOG.MD
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

Repository files navigation

postgraphile-plugin-remove-foreign-key-fields

GitHub Workflow Status (with branch) npm (scoped) License

Motivation

This PostGraphile plugin removes all foreign key fields from the GraphQL schema while still allowing foreign relationships to be created. Primary key fields (which may also be used as a foreign key) are not removed from the GraphQL schema.

Example

type Person {
 id
 firstName
 lastName
 addressId
 address {
 id
 street
 city
 state
 postalCode
 }
}

This extension will remove addressId from the Person type in an effort to simplify the schema.

type Person {
 id
 firstName
 lastName
 address {
 id
 street
 city
 state
 postalCode
 }
}

You can still get the address id through the Address type.

Person->address->id.

Getting Started

Install npm package.

npm install postgraphile-plugin-remove-foreign-key-fields

Add plugin to postgraphile.

import express from "express";
import { postgraphile } from "postgraphile";
import { RemoveForeignKeyFieldsPlugin } from "postgraphile-plugin-remove-foreign-key-fields";
const app = express();
// Add PostGraphile middleware.
app.use(
 postgraphile(`postgres://username:password@localhost:5432/postgres`, {
 appendPlugins: [RemoveForeignKeyFieldsPlugin],
 }),
);
// Start up server.
app.listen(3000, "localhost", 511, () => {
 logger.info(`🚀 Server listening at http://localhost:3000`);
});