Installations

npm install @megacookie/postgraphile-plugin-nested-mutations

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

17.3.0

NPM Version

8.3.0 Score

71

Supply Chain

99

Quality

75.5

Maintenance

100

Vulnerability

98.2

License

Pull Requests

Open

0

Total

4

Closed

2

Merged

2

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

2

JavaScript

Shell

JavaScript (99.73%)

Shell (0.27%)

Developer

MegaCookie

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

1 Stars

106 Commits

6 Branches

1 Contributors

Updated on Feb 07, 2022

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

1.1.2

Package Id

@megacookie/postgraphile-plugin-nested-mutations@1.1.2

Unpacked Size

82.19 kB

Size

14.18 kB

File Count

9

NPM Version

8.3.0

Node Version

17.3.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

graphile-build-pg

Peer Dependencies

1

postgraphile-core

Dev Dependencies

13

@graphile-contrib/pg-simplify-inflector debug eslint eslint-config-airbnb-base eslint-config-prettier eslint-plugin-import eslint-plugin-prettier graphql jest jest-junit pg postgraphile-core prettier

@megacookie/postgraphile-plugin-nested-mutations

This plugin implements nested mutations based on both forward and reverse foreign key relationships in PostGraphile v4. Nested mutations can be of infinite depth.

My version adds (batch) creating and upserting features using upsert, batchCreate, batchUpsert and allows you to deleteOthers, to delete existing rows (resulting replacing the rows the existing rows with the new rows that you want to insert)

Getting Started

CLI

1postgraphile --append-plugins @megacookie/postgraphile-plugin-nested-mutations

or just add this to schemaPlugins in your config file if you're using Postgraphile in library mode.

See here for more information about loading plugins with PostGraphile.

Library

1const express = require('express');
2const { postgraphile } = require('postgraphile');
3const PostGraphileNestedMutations = require('postgraphile-plugin-nested-mutations');
4
5const app = express();
6
7app.use(
8  postgraphile(pgConfig, schema, {
9    appendPlugins: [
10      PostGraphileNestedMutations,
11    ],
12  })
13);
14
15app.listen(5000);

Plugin Options

When using PostGraphile as a library, the following plugin options can be passed via graphileBuildOptions:

nestedMutationsSimpleFieldNames

Use simple field names for nested mutations. Instead of names suffixed with tableBy<Key> and tableUsing<Key>, tables with a single foreign key relationship between them will have their nested relation fields named table. Defaults to false.

1postgraphile(pgConfig, schema, {
2  graphileBuildOptions: {
3    nestedMutationsSimpleFieldNames: true,
4  }
5});

nestedMutationsDeleteOthers

Controls whether the deleteOthers field is available on nested mutations. Defaults to true.

1postgraphile(pgConfig, schema, {
2  graphileBuildOptions: {
3    nestedMutationsDeleteOthers: false,
4  }
5});

nestedMutationsOldUniqueFields

If enabled, plural names for one-to-one relations will be used. For backwards compatibility. Defaults to false.

1postgraphile(pgConfig, schema, {
2  graphileBuildOptions: {
3    nestedMutationsOldUniqueFields: false,
4  }
5});

Usage

This plugin creates an additional field on each GraphQL Input type for every forward and reverse foreign key relationship on a table, with the same name as the foreign table.

Each nested mutation field will have the following fields. They will accept an array if the relationship is a one-to-many relationship, or a single input if they are one-to-one.

Connect to Existing Record

`connectByNodeId`

Connect using a nodeId from the nested table.

`connectBy<K>`

Connect using any readable primary key or unique constraint on the nested table.

Creating New Records

`create`

Create a new record in the nested table.

Delete existing Record

`deleteByNodeId`

Delete using a nodeId from the nested table.

`deleteBy<K>`

Delete using any readable primary key or unique constraint on the nested table.

Updating Records

`updateByNodeId`

Update a record using a nodeId from the nested table.

`updatedBy<K>`

Update a record using any readable primary key or unique constraint on the nested table.

Example

1create table parent (
2  id serial primary key,
3  name text not null
4);
5
6create table child (
7  id serial primary key,
8  parent_id integer,
9  name text not null,
10  constraint child_parent_fkey foreign key (parent_id)
11    references p.parent (id)
12);

A nested mutation against this schema, using Parent as the base mutation would look like this:

1mutation {
2  createParent(input: {
3    parent: {
4      name: "Parent 1"
5      childrenUsingId: {
6        connectById: [{
7          id: 1
8        }]
9        create: [{
10          name: "Child 1"
11        }, {
12          name: "Child 2"
13        }]
14      }
15    }
16  }) {
17    parent {
18      id
19      name
20      childrenByParentId {
21        nodes {
22          id
23          name
24        }
25      }
26    }
27  }
28}

Or using Child as the base mutation:

1mutation {
2  createChild(input: {
3    child: {
4      name: "Child 1"
5      parentToParentId: {
6        create: {
7          name: "Parent of Child 1"
8        }
9      }
10    },
11  }) {
12    child {
13      id
14      name
15      parentByParentId {
16        id
17        name
18      }
19    }
20  }
21}

Smart Comments

Smart comments are supported for renaming the nested mutation fields.

1comment on constraint child_parent_fkey on child is
2  E'@fieldName parent\n@foreignFieldName children';

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More