drizzle-graphql

在一行中从 Drizzle 架构创建一个 GraphQL 服务器，并轻松地通过自定义查询和变更增强它。

快速入门

确保你的 drizzle-orm 版本至少为 0.30.9，如果需要，请进行更新：

npm

yarn

pnpm

bun

npm i drizzle-orm@latest

yarn add drizzle-orm@latest

pnpm add drizzle-orm@latest

bun add drizzle-orm@latest

Apollo Server

npm

yarn

pnpm

bun

npm i drizzle-graphql @apollo/server graphql

yarn add drizzle-graphql @apollo/server graphql

pnpm add drizzle-graphql @apollo/server graphql

bun add drizzle-graphql @apollo/server graphql

server.ts

schema.ts

import { buildSchema } from 'drizzle-graphql';
import { drizzle } from 'drizzle-orm/...';
import client from './db';
import { ApolloServer } from '@apollo/server';
import { startStandaloneServer } from '@apollo/server/standalone';

import * as dbSchema from './schema';

const db = drizzle(client, { schema: dbSchema });

const { schema } = buildSchema(db);

const server = new ApolloServer({ schema });
const { url } = await startStandaloneServer(server);

console.log(`🚀 Server ready at ${url}`);

import { integer, serial, text, pgTable } from 'drizzle-orm/pg-core';
import { relations } from 'drizzle-orm';

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
});

export const usersRelations = relations(users, ({ many }) => ({
  posts: many(posts),
}));

export const posts = pgTable('posts', {
  id: serial('id').primaryKey(),
  content: text('content').notNull(),
  authorId: integer('author_id').notNull(),
});

export const postsRelations = relations(posts, ({ one }) => ({
  author: one(users, { fields: [posts.authorId], references: [users.id] }),
}));

GraphQL Yoga

npm

yarn

pnpm

bun

npm i drizzle-graphql graphql-yoga graphql

yarn add drizzle-graphql graphql-yoga graphql

pnpm add drizzle-graphql graphql-yoga graphql

bun add drizzle-graphql graphql-yoga graphql

server.ts

schema.ts

import { buildSchema } from 'drizzle-graphql';
import { drizzle } from 'drizzle-orm/...';
import { createYoga } from 'graphql-yoga';
import { createServer } from 'node:http';

import * as dbSchema from './schema';

const db = drizzle({ schema: dbSchema });

const { schema } = buildSchema(db);

const yoga = createYoga({ schema });
const server = createServer(yoga);

server.listen(4000, () => {
  console.info('服务器已启动，地址为 http://localhost:4000/graphql');
});

import { integer, serial, text, pgTable } from 'drizzle-orm/pg-core';
import { relations } from 'drizzle-orm';

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
});

export const usersRelations = relations(users, ({ many }) => ({
  posts: many(posts),
}));

export const posts = pgTable('posts', {
  id: serial('id').primaryKey(),
  content: text('content').notNull(),
  authorId: integer('author_id').notNull(),
});

export const postsRelations = relations(posts, ({ one }) => ({
  author: one(users, { fields: [posts.authorId], references: [users.id] }),
}));

自定义架构

ℹ️

buildSchema() 使用标准的 graphql SDK 生成架构和类型，因此其输出与支持该标准的任何库兼容。

如果您想自定义您的架构，可以使用 entities 对象来构建自己的新架构：

server.ts

schema.ts

import { buildSchema } from 'drizzle-graphql';
import { drizzle } from 'drizzle-orm/...';
import { GraphQLList, GraphQLNonNull, GraphQLObjectType, GraphQLSchema } from 'graphql';
import { createYoga } from 'graphql-yoga';
import { createServer } from 'node:http';

import * as dbSchema from './schema';

const db = drizzle({ schema: dbSchema });

const { entities } = buildSchema(db);

// 您可以自定义希望的查询或变更的部分
const schema = new GraphQLSchema({
  query: new GraphQLObjectType({
    name: 'Query',
    fields: {
      // 仅选择所有生成的查询中希望的查询
      users: entities.queries.users,
      customer: entities.queries.customersSingle,

      // 创建自定义查询
      customUsers: {
        // 您可以重用和自定义原始架构中的类型
        type: new GraphQLList(new GraphQLNonNull(entities.types.UsersItem)),
        args: {
          // 您也可以重用输入
          where: {
            type: entities.inputs.UsersFilters
          },
        },
        resolve: async (source, args, context, info) => {
          // 在这里添加自定义逻辑...
          const result = await db.select(schema.users).where()...

          return result;
        },
      },
    },
  }),
  // 变更也适用相同的规则
  mutation: new GraphQLObjectType({
    name: 'Mutation',
    fields: entities.mutations,
  }),
  // 如果需要架构内的类型
  types: [...Object.values(entities.types), ...Object.values(entities.inputs)],
});

const yoga = createYoga({
  schema,
});

const server = createServer(yoga);

server.listen(4000, () => {
  console.info('Server is running on http://localhost:4000/graphql');
})

import { integer, serial, text, pgTable } from 'drizzle-orm/pg-core';
import { relations } from 'drizzle-orm';

export const users = pgTable('users', {
  id: serial('id').primaryKey(),
  name: text('name').notNull(),
});

export const usersRelations = relations(users, ({ many }) => ({
  posts: many(posts),
}));

export const posts = pgTable('posts', {
  id: serial('id').primaryKey(),
  content: text('content').notNull(),
  authorId: integer('author_id').notNull(),
});

export const postsRelations = relations(posts, ({ one }) => ({
  author: one(users, { fields: [posts.authorId], references: [users.id] }),
}));

Become a Gold Sponsor