Drizzle Relational API v2

[motopods]

drizzle-team/drizzle-orm#2316 (comment)

Drizzle-orm has released a beta version with relations-v2, hoping that GQLoom can follow up on this.

[xcfox]

Thank you for using GQLoom. The information you provided is really important to me.

GQLoom considers drizzle as its primary ORM.
I expect to complete the adaptation work for Relational API v2 within a week.

[xcfox]

The beta version of @gqloom/drizzle has completed support for Drizzle Relational Queries version 2.

Install the Beta Version

# use pnpm
pnpm add @drizzle-orm@beta @gqloom/drizzle@beta
pnpm add -D @drizzle-kit@beta

# use yarn
yarn add @drizzle-orm@beta @gqloom/drizzle@beta
yarn add -D @drizzle-kit@beta

# use npm
npm install @drizzle-orm@beta @gqloom/drizzle@beta
npm install -D @drizzle-kit@beta

Migration

Refer to the Drizzle documentation.
It's worth noting that gqloom still requires a db instance that includes all tables:

import * as tables from './schema'
import { relations } from './relations'
import { drizzle } from 'drizzle-orm/...'

const db = drizzle('<url>', { schema: tables, relations })

[motopods]

I found that it seems to be missing a very important function, aggregate query, such as how many total data items are there?

If V2 supported defining aggregate fields then the problem would be simple, but it doesn't seem to be supported.

drizzle-team/drizzle-orm#2316 (comment)

[xcfox]

I found that it seems to be missing a very important function, aggregate query, such as how many total data items are there?

If you are looking for the count operation, the current version of GQLoom's DrizzleResolverFactory already includes this operation.

export const userResolver = resolver.of(users, {
  users: userResolverFactory.selectArrayQuery(),
  usersCount: userResolverFactory.countQuery(),
})

You can easily use a GraphQL query similar to the following to retrieve both the list of items and the total number of items at the same time:

query userList($where: UsersFilters) {
  users(where: $where, limit: 10) {
    id
    name
  }
  usersCount(where: $where)
}

This query is typically used for pagination.
For other aggregate queries, we can also achieve similar effects by adding additional queries. Even if Drizzle doesn't have a built-in API, we can implement it by writing SQL code manually.

I hope this is helpful to you.

[motopods]

Thanks for your reply. I suggest that the documentation mention countQuery more. I searched and found that it is only found in prisma.

[motopods]

Factory query does not support relations?

export const relations = defineRelations(schema, (r) => ({
  users: {
    sessions: r.many.userSessions(),
  },
  userSessions: {
    user: r.one.users({
      from: r.userSessions.userId,
      to: r.users.id,
    }),
  },
}))

I can't found sessions in UsersItem

[xcfox]

The relations field needs to be manually added. For example:

const userResolver = resolver.of(users, {
  me: query(users).resolve(() => db.select().from(users).then(res => res[0]))

  sessions: usersResolverFactory.relationField("sessions"),
})

This allows us to ignore complex relational queries when writing custom queries and mutations. GQLoom will use Dataloader to load data behind the scenes.

There is another important reason: drizzle does not store relationship metadata in the 'users' table internally. Without using a drizzleResolverFactory that accepts full db objects, it is difficult for GQLoom to know that the 'users' table has a relationship field called 'sessions'.

---

I'm currently considering how to automatically generate select parameters based on GraphQL queries so that we can precisely retrieve the right amount of data from the database. After this feature is completed, perhaps we can directly add relational fields to UsersItem. However, this means that we need to explicitly call a useSelectiveFields() for all mutation or query that return entities. The API might look like this:

const userResolver = resolver.of(users, {
  me: query(users)
    .resolve(async() => {
      const [me] = await db.select(useSelectiveFields(users)).from(users)
      return me
    })
})

[motopods]

"errors": [
    {
      "message": "Unexpected error.",
      "path": [
        "users",
        0,
        "sessions"
      ],
      "extensions": {
        "code": "INTERNAL_SERVER_ERROR",
        "originalError": {
          "message": "undefined is not an object (evaluating 'queryBuilder.findMany')",
        }
      }
    }
  ],
  "data": null
}

[motopods]

"errors": [
    {
      "message": "Unexpected error.",
      "path": [
        "users",
        0,
        "sessions"
      ],
      "extensions": {
        "code": "INTERNAL_SERVER_ERROR",
        "originalError": {
          "message": "undefined is not an object (evaluating 'queryBuilder.findMany')",
        }
      }
    }
  ],
  "data": null
}

Fixed in 0.9.0-beta.7

[motopods]

factory should use relation object field name, not table name.

export const relations = defineRelations(schema, (r) => ({
  users: {
    tags: r.many.userTags(),
  },
  userTags: {
    user: r.one.users({
      from: r.userTags.userId,
      to: r.users.id,
    }),
  },
}))

export const userTags = drizzleSilk(
  pgTable("user_tags", {
    id: uuid().primaryKey().defaultRandom(),
    userId: uuid()
      .notNull()
      .references(() => users.id, {
        onDelete: "cascade",
        onUpdate: "cascade",
      }),
    tag: text().unique().notNull(),
  }),
)

this.db.query[this.tableName] // this should be userTags not user_tags.

https://github.com/modevol-com/gqloom/blob/a0e4434dea68d535bb6f311823e40938e434cdbe/packages/drizzle/src/factory/resolver.ts#L104C1-L105C1

@xcfox

[xcfox]

Thank you for your feedback.
I will release a version to fix this problem in the next few days.