Bun support with --bun

[mikerockett]

I am trying to execute drizzle-kit commands using bun (instead of passing it off to node by way of the default shebang).

For example:

bun run --bun drizzle-kit generate:pg

or via package.json:

{
  "scripts": {
    "db:generate": "bun run --bun drizzle-kit generate:pg"
    // $ bun run db:generate
  }
}

When I do this, the command executes, but it cannot see my schema files. If I generated previously with node (ie, via the default shebang), and then with bun, it would generate a migration that drops all tables.

Output of the above command is always as if no schema files were present.

Drizzle Kit Config

import type { Config } from 'drizzle-kit'

export default {
  driver: 'pg',
  dbCredentials: { connectionString: process.env.DATABASE_URL! },
  schema: './lib/db/schema/*.ts',
  out: './lib/db/migrations',
  introspect: { casing: 'preserve' },
  schemaFilter: ['public'],
  strict: true,
  verbose: true,
} satisfies Config

Could it be because I am globbing the schema? Or, am I missing something?

Versions:

$ bun pm ls | grep drizzle
[0.03ms] ".env"
├── [email protected]
├── [email protected]

[hazelnutcloud]

can confirm facing this issue too, with plain './schema.ts' as input

EDIT: Found a workaround to this by using module.export instead of esm exports

[eknowles]

spent too many hours on this before i search for this issue.
I wasn't able to get the module exports workaround working, @hazelnutcloud are you able to clarify if this was via the drizzle config or cli?

[SnowMarble]

I found another way to fix it. It's kind of working, but we can use export in schema.ts

First, go to node_modules/drizzle-kit/bin.js and find src/serializer/<your-driver>Imports.ts(pg for pgImports.ts and mysql for mysqlImports.ts).

And, change forEach statement in prepareFromExports or prepareFromMySqlImports(function that contains forEach) to for ... in statement.
For example, we can fix pg like this:

// bin.js:12048
prepareFromExports = (exports) => {
  const tables = [];
  const enums = [];
  const schemas = [];
  for(let e in exports) {
    const t = exports[e];
    if ((0, import_pg_core.isPgEnum)(t)) {
      enums.push(t);
      continue;
    }
    if ((0, import_drizzle_orm4.is)(t, import_pg_core.PgTable)) {
      tables.push(t);
    }
    if ((0, import_drizzle_orm4.is)(t, import_pg_core.PgSchema)) {
      schemas.push(t);
    }
  }
  return { tables, enums, schemas };
};

Lastly, follow this comment to apply the change.

The problem is that Bun's Object.values or Object.keys for the Module object (a return value of require) give us nothing unlike Nodejs.

const schema = require('./db/schema.ts')
const exports = Object.values(schema) // []

and somehow for ... in can iterate the object even in Bun.

[malvinpratama]

I found another way to fix it. It's kind of working, but we can use export in schema.ts

First, go to node_modules/drizzle-kit/bin.js and find src/serializer/<your-driver>Imports.ts(pg for pgImports.ts and mysql for mysqlImports.ts).

And, change forEach statement in prepareFromExports or prepareFromMySqlImports(function that contains forEach) to for ... in statement. For example, we can fix pg like this:

// bin.js:12048
prepareFromExports = (exports) => {
  const tables = [];
  const enums = [];
  const schemas = [];
  for(let e in exports) {
    const t = exports[e];
    if ((0, import_pg_core.isPgEnum)(t)) {
      enums.push(t);
      continue;
    }
    if ((0, import_drizzle_orm4.is)(t, import_pg_core.PgTable)) {
      tables.push(t);
    }
    if ((0, import_drizzle_orm4.is)(t, import_pg_core.PgSchema)) {
      schemas.push(t);
    }
  }
  return { tables, enums, schemas };
};

Lastly, follow this comment to apply the change.

The problem is that Bun's Object.values or Object.keys for the Module object (a return value of require) give us nothing unlike Nodejs.

const schema = require('./db/schema.ts')
const exports = Object.values(schema) // []

and somehow for ... in can iterate the object even in Bun.

it's works.
can you create PR for this ?
I think this major issue for drizzle-kit if we want to support bun.

[SnowMarble]

@malvinpratama Unfortunately, drizzle kit is not an open source that we can't make a contrubution right away. But we can mention drizzle team to let them know about it.

[itsyoboieltr]

Looking forward to this fix! I only need to install node on my docker image so I can run drizzle-kit, everything else is already running with bun.

[itsyoboieltr]

@Angelelz Is there any way we could merge the fix proposed by @SnowMarble?
cc: @AndriiSherman

[gnosticdev]

For those having the same issue with sqlite, you can patch by changing require to await import in the prepareFromSqliteImports function.

// node_modules/drizzle-kit/bin.cjs: 12840
 prepareFromSqliteImports = async (imports) => {
      const tables = [];
      const enums = [];
      const { unregister } = await safeRegister();
      for (let i = 0; i < imports.length; i++) {
        const it = imports[i];
        // const i0 = require(`${it}`); <-- does not work with --bun flag
        const i0 = await import(`${it}`); // <-- this works with --bun
        const i0values = Object.values(i0);
        i0values.forEach((t) => {
          if ((0, import_drizzle_orm6.is)(t, import_sqlite_core.SQLiteTable)) {
            tables.push(t);
          }
        });
      }

Also, from instructions above:

1. add yarn.lock and patch-package:

 bun i --yarn && bunx patch-package drizzle-kit

2. make the change above
3. add postinstall: bunx patch-package to package.json scripts
4. delete yarn.lock

Thanks @SnowMarble for the fix!

[GoncaloJoseMoura]

this problem still persists.