chore: replace better-sqlite3 with libsql (#1830)

t3-oss · Apr 22, 2024 · 3257d0a · 3257d0a
1 parent ed5f545
commit 3257d0a
Show file tree

Hide file tree

Showing 9 changed files with 226 additions and 34 deletions.
diff --git a/.changeset/beige-buttons-chew.md b/.changeset/beige-buttons-chew.md
@@ -0,0 +1,5 @@
+---
+"create-t3-app": minor
+---
+
+feat: replace better-sqlite3 with libsql
diff --git a/cli/package.json b/cli/package.json
@@ -64,6 +64,7 @@
  "devDependencies": {
  "@auth/drizzle-adapter": "^0.7.0",
  "@auth/prisma-adapter": "^1.4.0",
+ "@libsql/client": "^0.6.0",
  "@planetscale/database": "^1.16.0",
  "@prisma/adapter-planetscale": "^5.10.2",
  "@prisma/client": "^5.10.2",
@@ -73,11 +74,9 @@
  "@trpc/next": "next",
  "@trpc/react-query": "next",
  "@trpc/server": "next",
- "@types/better-sqlite3": "^7.6.9",
  "@types/fs-extra": "^11.0.4",
  "@types/gradient-string": "^1.1.5",
  "@types/node": "^20.11.20",
- "better-sqlite3": "^9.4.3",
  "drizzle-kit": "^0.20.14",
  "drizzle-orm": "^0.29.4",
  "mysql2": "^3.9.1",

diff --git a/cli/src/cli/index.ts b/cli/src/cli/index.ts
@@ -284,7 +284,7 @@ export const runCli = async (): Promise<CliResults> => {
  return p.select({
  message: "What database provider would you like to use?",
  options: [
- { value: "sqlite", label: "SQLite" },
+ { value: "sqlite", label: "SQLite (LibSQL)" },
  { value: "mysql", label: "MySQL" },
  { value: "postgres", label: "PostgreSQL" },
  { value: "planetscale", label: "PlanetScale" },

diff --git a/cli/src/installers/dependencyVersionMap.ts b/cli/src/installers/dependencyVersionMap.ts
@@ -21,8 +21,7 @@ export const dependencyVersionMap = {
  "@planetscale/database": "^1.16.0",
  postgres: "^3.4.3",
  pg: "^8.11.3",
- "@types/better-sqlite3": "^7.6.9",
- "better-sqlite3": "^9.4.3",
+ "@libsql/client": "^0.6.0",
 
  // TailwindCSS
  tailwindcss: "^3.4.1",

diff --git a/cli/src/installers/drizzle.ts b/cli/src/installers/drizzle.ts
@@ -18,7 +18,6 @@ export const drizzleInstaller: Installer = ({
  "eslint-plugin-drizzle",
  ];
  if (databaseProvider === "planetscale") devPackages.push("mysql2");
- if (databaseProvider === "sqlite") devPackages.push("@types/better-sqlite3");
  if (databaseProvider === "postgres") devPackages.push("pg");
 
  addPackageDependency({
@@ -35,7 +34,7 @@ export const drizzleInstaller: Installer = ({
  planetscale: "@planetscale/database",
  mysql: "mysql2",
  postgres: "postgres",
- sqlite: "better-sqlite3",
+ sqlite: "@libsql/client",
  } as const
  )[databaseProvider],
  ],

diff --git a/cli/src/installers/envVars.ts b/cli/src/installers/envVars.ts
@@ -44,15 +44,8 @@ export const envVariablesInstaller: Installer = ({
  "template/extras/src/env",
  envFile
  );
- const envFileText = fs.readFileSync(envSchemaSrc, "utf-8");
  const envSchemaDest = path.join(projectDir, "src/env.js");
- fs.writeFileSync(
- envSchemaDest,
- databaseProvider === "sqlite"
- ? envFileText.replace("\n .url()", "")
- : envFileText,
- "utf-8"
- );
+ fs.copyFileSync(envSchemaSrc, envSchemaDest);
  }
 
  const envDest = path.join(projectDir, ".env");
@@ -99,9 +92,7 @@ DATABASE_URL='mysql:https://YOUR_MYSQL_URL_HERE?sslaccept=strict'`;
  } else if (databaseProvider === "postgres") {
  content += `DATABASE_URL="postgresql:https://postgres:password@localhost:5432/${projectName}"`;
  } else if (databaseProvider === "sqlite") {
- content += usingPrisma
- ? 'DATABASE_URL="file:./db.sqlite"'
- : 'DATABASE_URL="db.sqlite"';
+ content += 'DATABASE_URL="file:./db.sqlite"';
  }
  content += "\n";
  }

diff --git a/cli/template/extras/config/drizzle-config-sqlite.ts b/cli/template/extras/config/drizzle-config-sqlite.ts
@@ -4,7 +4,7 @@ import { env } from "~/env";
 
 export default {
  schema: "./src/server/db/schema.ts",
- driver: "better-sqlite",
+ driver: "libsql",
  dbCredentials: {
  url: env.DATABASE_URL,
  },

diff --git a/cli/template/extras/src/server/db/index-drizzle/with-sqlite.ts b/cli/template/extras/src/server/db/index-drizzle/with-sqlite.ts
@@ -1,5 +1,5 @@
-import Database from "better-sqlite3";
-import { drizzle } from "drizzle-orm/better-sqlite3";
+import { createClient, type Client } from "@libsql/client";
+import { drizzle } from "drizzle-orm/libsql";
 
 import { env } from "~/env";
 import * as schema from "./schema";
@@ -9,11 +9,11 @@ import * as schema from "./schema";
  * update.
  */
 const globalForDb = globalThis as unknown as {
- conn: Database.Database | undefined;
+ client: Client | undefined;
 };
 
-export const conn =
- globalForDb.conn ?? new Database(env.DATABASE_URL, { fileMustExist: false });
-if (env.NODE_ENV !== "production") globalForDb.conn = conn;
+export const client =
+ globalForDb.client ?? createClient({ url: env.DATABASE_URL });
+if (env.NODE_ENV !== "production") globalForDb.client = client;
 
-export const db = drizzle(conn, { schema });
+export const db = drizzle(client, { schema });