Add drizzle-orm/node-sqlite for node:sqlite support

[mizchi]

I added drizzle-orm/node-sqlite driver for node:sqlite

import { drizzle } from "drizzle-orm/node-sqlite";
import { sqliteTable, text, integer } from "drizzle-orm/sqlite-core";
import { eq } from "drizzle-orm";

const users = sqliteTable("users", {
  id: integer("id").primaryKey(),
  name: text("name").notNull(),
});
const db = drizzle(":memory:");

https://nodejs.org/api/sqlite.html

node:sqlite requires node >v22.5

It's mostly a port of better-sqlite3 version.

Test

My local tests.

https://gist.github.com/mizchi/4859a5134e92bea1ab41259fed328f9e

with deno+sqlite+drizzle

https://gist.github.com/mizchi/9c69c920ac12e6cb7e77b1fd6be8adbe

integration-tests is mostly a stub yet, as it didn't port well as is.

Motivation

for deno + drizzle + sqlite
#2648 (comment)

related #3868

[mizchi]

This test needs node v22.5 but now v18 in this repo (.nvmrc).
What is the appropriate thing to do?

[mizchi]

This is required to reference node:sqlite but may cause backwards compatibility issues for the node APIs in this repository.

[vladfaust]

How can I test it locally? "drizzle-orm": "git+https://github.com/mizchi/drizzle-orm.git#node-sqlite" results in npm error Unsupported URL Type "workspace:": workspace:./drizzle-orm/dist.

UPD: I tried using https://gitpkg.vercel.app, but building Drizzle locally is another level of complexity. Would have to stick to a drizzle-orm/sqlite-proxy wrapper until this is merged!

Proxy implementation reference

import { drizzle } from "drizzle-orm/sqlite-proxy";
import { DatabaseSync } from "node:sqlite";

// NOTE: You'll have to make sure that table keys are sorted!
// Otherwise it won't work.
//

/**
 * Returns a new object with entries sorted by key.
 */
export function sortByKey<T extends { [key: string]: any }>(
  obj: T,
  compareFn?: (a: string, b: string) => number,
): T {
  return Object.keys(obj)
    .sort(compareFn)
    .reduce((acc, key) => {
      (acc as any)[key] = obj[key];
      return acc;
    }, {} as T);
}

const providers = sqliteTable(
  "providers",

  // NOTE: Sort the keys automatically.
  sortByKey({
    peerId: text("peer_id").primaryKey(),
    latestHeartbeatAt: int("latest_heartbeat_at", {
      mode: "timestamp",
    }).notNull(),
  }),
);

const sqlite = new DatabaseSync(":memory:");

const db = drizzle<typeof schema>(
  async (sql, params, method) => {
    // console.debug({ sql, params, method });
    let stmt = sqlite.prepare(sql);

    switch (method) {
      case "all": {
        const rows = stmt.all(...params);
        // console.debug({ rows });
        return {
          rows: rows.map((row) => Object.values(row as any)),
        };
      }

      case "get": {
        const row = stmt.get(...params);
        // console.debug({ row });
        return { rows: [Object.values(row as any)] };
      }

      case "run":
      case "values":
        stmt.run(...params);
        return { rows: [] };
    }
  },

  // Pass the schema to the drizzle instance
  { schema },
);

[mizchi]

I would also like to know how it is designed in this project.

I mainly wanted to use it with deno, so I released my own scoped package (@mizchi/drizzle-orm) for debugging and checked the operation.

import { drizzle } from "npm:@mizchi/drizzle-orm/dist/node-sqlite/index.js";
import {
  integer,
  sqliteTable,
  text,
} from "npm:@mizchi/drizzle-orm/dist/sqlite-core/index.js";
import { eq } from "npm:@mizchi/drizzle-orm/dist/index.js";

Note: This package is for checking the operation and will not be maintained. Do not use it.