drizzle-graphql-extended
v0.8.8
Published
Automatically generate GraphQL schema or customizable schema config fields from Drizzle ORM schema
Downloads
81
Maintainers
Readme
Drizzle-GraphQL
Automatically create GraphQL schema or customizable schema config fields from Drizzle ORM schema
Usage
Pass your drizzle database instance and schema into builder to generate
{ schema, entities }
objectUse
schema
if pre-built schema already satisfies all your neeeds. It's compatible witn any server that consumesGraphQLSchema
class instanceExample: hosting schema using GraphQL Yoga
import { createServer } from 'node:http' import { createYoga } from 'graphql-yoga' import { buildSchema } from 'drizzle-graphql' // db - your drizzle instance import { db } from './database' const { schema } = buildSchema(db) const yoga = createYoga({ schema }) server.listen(4000, () => { console.info('Server is running on http://localhost:4000/graphql') })
If you want to customize your schema, you can use
entities
object to build your own new schemaimport { createServer } from 'node:http' import { GraphQLList, GraphQLNonNull, GraphQLObjectType, GraphQLSchema } from 'graphql' import { createYoga } from 'graphql-yoga' import { buildSchema } from 'drizzle-graphql' // Schema contains 'Users' and 'Customers' tables import { db } from './database' const { entities } = buildSchema(db) // You can customize which parts of queries or mutations you want const schema = new GraphQLSchema({ query: new GraphQLObjectType({ name: 'Query', fields: { // Select only wanted queries out of all generated users: entities.queries.users, customer: entities.queries.customersSingle, // Create a custom one customUsers: { // You can reuse and customize types from original schema type: new GraphQLList(new GraphQLNonNull(entities.types.UsersItem)), args: { // You can reuse inputs as well where: { type: entities.inputs.UsersFilters } }, resolve: async (source, args, context, info) => { // Your custom logic goes here... const result = await db.select(schema.Users).where()... return result } } } }), // Same rules apply to mutations mutation: new GraphQLObjectType({ name: 'Mutation', fields: entities.mutations }), // In case you need types inside your schema types: [...Object.values(entities.types), ...Object.values(entities.inputs)] }) const yoga = createYoga({ schema }) server.listen(4000, () => { console.info('Server is running on http://localhost:4000/graphql') })