1.0 beta: How to type drizzle?

[MickL]

Enhancement hasn't been filed before.

• I have verified this enhancement I'm about to request hasn't been suggested before.

Describe the enhancement you want to request

Since Drizzle now wants relations rather than schema, how do we type the Drizzle object? I tried using typeof relations with no success, before it was working with typeof schema:

import { drizzle, type NeonDatabase } from 'drizzle-orm/neon-serverless';
import { relations } from '@myworkspace/db';

let db: NeonDatabase<typeof relations>; // <- Doesnt work with relations

export const useDb = (): NeonDatabase<typeof relations> => {
  if (!db) {
    db = drizzle('DATABASE_URL', {
      relations,
      casing: 'snake_case',
    });
  }

  return db;
};

[Ceppnik]

Hi! I managed to get it working by passing both types as generic arguments:
let db: NeonDatabase<typeof schema, typeof relations>;

[AlexBlokh]

yeah, we need to put that it docs

[MickL]

Thanks @Ceppnik this seems to work!

@AlexBlokh I find it confusing (as a developer) that we have a separation between schema and relations now. Arent relations part of a schema? Personally I would rename defineRelations() to defineSchema() and make use of this function required:

import * as tables from '@myworkspace/db';

const db = drizzle(databaseUrl, {
      schema: defineSchema(tables, r => {
            // ... relations
      }),
});

[nikelborm]

Arent relations part of a schema

Relations do not affect how SQL is generated. Foreign keys are part of a schema, relations are not, and they can be present independently of each other.