npmpackage.info

Gathering detailed insights and metrics for @brooklyn-labs/postgraphile-plugin-nested-mutations

@brooklyn-labs/postgraphile-plugin-nested-mutations - 1.2.2 | npmpackage.info

@brooklyn-labs/postgraphile-plugin-nested-mutations

Nested mutations for Postgraphile

1.2.2

MIT

JavaScript

75.12 kB

2.8

Installations

npm install @brooklyn-labs/postgraphile-plugin-nested-mutations

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

16.19.0

NPM Version

8.19.3 Pull Requests

Open

10

Total

13

Closed

1

Merged

2

Issues

Open

0

Total

2

Closed

2

Releases

Version 1.2.2

v1.2.2

Updated on Feb 10, 2023

Version 1.2.1

v1.2.1

Updated on Jun 06, 2022

Version 1.2.0

v1.2.0

Updated on Aug 10, 2021

View All 3 releases

Languages

JavaScript

Shell

JavaScript (99.76%)

Shell (0.24%)

Developer

brooklyn-labs

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1 Stars

107 Commits

18 Branches

Updated on Apr 19, 2024

Maintainers

View All 3 Contributors

Package Meta Information

Latest Version

1.2.2

Package Id

@brooklyn-labs/postgraphile-plugin-nested-mutations@1.2.2

Unpacked Size

75.12 kB

Size

12.90 kB

File Count

NPM Version

8.19.3

Node Version

16.19.0

Published on

Feb 10, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

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.

Getting Started

CLI

1postgraphile --append-plugins postgraphile-plugin-nested-mutations

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

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

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

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

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

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.8

/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

@brooklyn-labs/postgraphile-plugin-nested-mutations

Installations

Developer Guide

No

CommonJS

16.19.0

8.19.3

Pull Requests

10

13

1

2

Issues

0

2

2

Releases

Languages

Developer

brooklyn-labs

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

postgraphile-plugin-nested-mutations

Getting Started

CLI

Library

Plugin Options

Usage

Connect to Existing Record

connectByNodeId

connectBy<K>

Creating New Records

create

Delete existing Record

deleteByNodeId

deleteBy<K>

Updating Records

updateByNodeId

updatedBy<K>

Example

Smart Comments

10

10

10

0

0

0

0

0

0

0

0

0

2.8

/10

`connectByNodeId`

`connectBy<K>`

`create`

`deleteByNodeId`

`deleteBy<K>`

`updateByNodeId`

`updatedBy<K>`