v1.0
75%
Benchmarks
Extension
Studio
Studio Package
Drizzle Run
Our goodies!
EdgeDB
Turso
🚀 Drizzle is giving you 10% off Turso Scaler and Pro for 1 Year 🚀
Payload
Xata
Neon
Nuxt
Hydra
Deco.cx
Tembo
SQLite Cloud
Become a Gold Sponsor
Become a Gold Sponsor

drizzle-graphql

通过一行代码从 Drizzle 模式创建 GraphQL 服务器，并轻松增强自定义查询和变更。

快速开始

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

npm
yarn
pnpm
bun 
npm i drizzle-orm@latest

Apollo 服务器

npm
yarn
pnpm
bun 
npm i 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(`🚀 服务器已准备好，地址为 ${url}`);

GraphQL Yoga

npm
yarn
pnpm
bun 
npm i 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');
});

自定义模式

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('服务器正在运行在 http://localhost:4000/graphql');
})