graphile / graphile/graphile.github.io
Plugin example: setting the GraphQL type to use for a given PostgreSQL type
- Dominant language
- SCSS
- Stars
- 27
- Forks
- 126
- PR merge metrics
- No merged PRs in 30d
Description
Thanks to `@Gomes` on Discord. This only works for scalar-like types, for composite types you'll need to register separate input and output types (i.e. in addition to calling `pgRegisterGqlTypeByTypeId` you also need to call `pgRegisterGqlInputTypeByTypeId`)
```ts
import type { GraphQLType } from "graphql";
import type { Plugin } from "graphile-build";
import type { PgType } from "graphile-build-pg";
interface PgDomainToGqlTypePluginArgs {
/** PostgreSQL type identifier, e.g. "my_schema.my_type" */
typeIdentifier: string;
/** What GraphQL type should we use for this PG type */
gqlType: GraphQLType | ((build: Build) => GraphQLType);
}
/**
* Sets the GraphQL type `gqlType` to be used for the PostgreSQL type identified
* by `typeIdentifier`
*/
export function makePgDomainToGqlTypePlugin({
typeIdentifier,
gqlType,
}: PgDomainToGqlTypePluginArgs): Plugin {
return (builder) => {
builder.hook("build", (build) => {
const { namespaceName, entityName: typeName } = build.pgParseIdentifier(
typeIdentifier
);
const pgType = build.pgIntrospectionResultsByKind.type.find(
(type: PgType) =>
type.namespaceName === namespaceName && type.name === typeName
);
if (!pgType) {
throw new Error(`Failed to find the type '${typeIdentifier}'`);
}
build.pgRegisterGqlTypeByTypeId(pgType.id, () =>
typeof gqlType === "function" ? gqlType(build) : gqlType
);
return build;
});
};
}
```
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.