postgraphile-plugin-foreign-field-direction
This plugin allows you to expose only a single direction of connections exposed by foreign key constraints.
Example
With the following schema
create table classroom (
id int primary key,
name text
);
create table teacher (
id int primary key,
classroom_id int not null references classroom(id)
);
in the GraphQL generated, the Teacher type will have a classroomByClassroomId field, and the Classroom type will have a teachersByClassroomId field.
By using the foreignFieldDirection smart tag, you can choose to expose only one of those two fields.
For example, via a smart comment
teacher_classroom_id_fkey on teacher is E'@foreignFieldDirection forward';
Usage
This is a simple plugin. You can just copy it into your project and modify as needed. You can install it using npm or yarn:
yarn add postgraphile-plugin-foreign-field-direction
const { ForeignFieldDirectionPlugin } = require('postgraphile-plugin-foreign-field-direction')
Smart Tag Arguments
forward and backward are the only valid arguments for the foreignFieldDirection smart tag. Any other value, including a blank value, will set throw an error and prevent the GQL schema from compiling.
The forward argument indicates that you want to expose a traversal only FROM the table on which the constraint is defined.
The backward argument indicates that you want to expose a traversal only TO the table on which the constraint is defined.
Compatibility
This plugin has no dependencies. It was tested with Postgraphile v4.12.9.
2k Jan 7, 2023
6 Dec 7, 2022
16 Nov 13, 2022
1.1k Dec 25, 2022
1 Jan 3, 2022
2 Jul 17, 2022
6 Aug 23, 2022
7 Sep 4, 2022
71 Dec 23, 2022