Allow customizing many to many join table name

[lmiller1990]

Related

I found this one: #9119

Alternative / What I tried

Maybe using

  marker: list({
    access: allowAll,
    fields: {
      name: text({ validation: { isRequired: true } }),
      marker_type: text({ validation: { isRequired: true } }),
      data_source: text({ db: { isNullable: true } }),
      reference_range_type: text({ db: { isNullable: true } }),
      standardization_value_type: text({ db: { isNullable: true } }),
      categories: relationship({
        ref: "category.markers",
        many: true,
        db: {
          relationName: "marker_category",
        },
      }),
    },
  }),

  marker_category: list({
    access: allowAll,
    db: {
      extendPrismaSchema: (schema: string) => {
        return `
        model marker_category {
          id          String    @id @default(cuid())
          created_at  DateTime  @default(now()) @mysql.Timestamp(0)
          updated_at  DateTime? @mysql.Timestamp(0)
          opt_lock    Int?
          marker_id   String    
          category_id String    
          notes       String?   @mysql.Text
          category    category  @relation(fields: [category_id], references: [id], onUpdate: Restrict, map: "FK_marker_category_category_id")
          marker      marker    @relation(fields: [marker_id], references: [id], onUpdate: Restrict, map: "FK_marker_category_marker_id")
        
          @@unique([marker_id, category_id], map: "UK_marker_category_marker_id_category_id")
          @@index([category_id], map: "FK_marker_category_category_id")
        }`;
      },
    },
    fields: {
      marker_id: text({}),
      category_id: text({}),
    },
  }),

  category: list({
    access: allowAll,
    fields: {
      name: text({ validation: { isRequired: true } }),
      markers: relationship({
        ref: "marker.categories",
        many: true,
        db: {},
      }),
    },
  }),

I can't seem to get it to work. This compiles what looks like the desired schema but I get an error

Issue

I am working with an existing schema that uses a join table like so:

marker -> marker_category <- category

Where it is a Many to Many via marker_category. marker_category has 3 columns: id (unique), category_id and marker_id, which are how the many to many is represented.

Prisma allows us to configure this, but keystone is hard-coded to use a specific convention:

keystone/packages/core/src/lib/core/resolve-relationships.ts

Line 182 in 218de8d

const relationName = `${leftRel.listKey}_${leftRel.fieldPath}`

I actually wrote my own schema.prisma that works as expected in isolation, but when I declare my relationships in the schema.ts, keystone's codegen overrides my schema.prisma.

I tried the --no-prisma flag, but I get an error

npx keystone dev --no-db-push --no-prisma
✨ Starting Keystone
⭐️ Server listening on :3000 (http://localhost:3000/)
⭐️ GraphQL API available at /api/graphql
TypeError: Error trying to prepare the Admin UI
    at initKeystone (/Users/lachlan/code/dump/recommendation-cms/node_modules/@keystone-6/core/scripts/cli/dist/keystone-6-core-scripts-cli.cjs.dev.js:1148:45)

Not sure if this is intended - even if this did work, the keystone convention for join tables isn't compatible with my schema.

Ideally, we'd be able to customize this:

  marker: list({
    access: allowAll,
    fields: {
      name: text({ validation: { isRequired: true } }),
      marker_type: text({ validation: { isRequired: true } }),
      data_source: text({ db: { isNullable: true } }),
      reference_range_type: text({ db: { isNullable: true } }),
      standardization_value_type: text({ db: { isNullable: true } }),
      categories: relationship({
        joinTable "marker_category",
        on: "marker_id"
      }),
    },
  }),

... or something to that meaning. I could make a PR if there is interest. I really want to use Keystone but this is a blocker.

[lmiller1990]

I am learning more. I now see that most of this is in Prisma-land.

One other question - does keystone even support explicit many to many? Seems no?