Added basic demo and update README to use libsql client

Author: max-programming

README.md

@@ -46,11 +46,11 @@ bun add drizzle-query-logger
 ### Basic Usage
 
 ```typescript
-import Database from 'better-sqlite3';
-import { drizzle } from 'drizzle-orm/better-sqlite3';
+import { createClient } from '@libsql/client/sqlite3';
+import { drizzle } from 'drizzle-orm/libsql';
 import { EnhancedQueryLogger } from 'drizzle-query-logger';
 
-const client = new Database(':memory:');
+const client = createClient({ url: ':memory:' });
 export const db = drizzle(client, {
   logger: new EnhancedQueryLogger(),
 });

demo/.gitignore

@@ -0,0 +1,34 @@
+# dependencies (bun install)
+node_modules
+
+# output
+out
+dist
+*.tgz
+
+# code coverage
+coverage
+*.lcov
+
+# logs
+logs
+_.log
+report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# caches
+.eslintcache
+.cache
+*.tsbuildinfo
+
+# IntelliJ based IDEs
+.idea
+
+# Finder (MacOS) folder config
+.DS_Store

demo/README.md

@@ -0,0 +1,13 @@
+# `drizzle-query-logger` demo
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```

demo/bun.lock

@@ -0,0 +1,24 @@
+import { createClient } from "@libsql/client/sqlite3";
+import { drizzle } from "drizzle-orm/libsql";
+import { EnhancedQueryLogger } from "drizzle-query-logger";
+
+import * as schema from "./tables";
+import {
+  CREATE_TODOS_TABLE,
+  CREATE_USERS_TABLE,
+  SEED_USERS_AND_TODOS,
+} from "./queries";
+
+const client = createClient({ url: ":memory:" });
+
+client.execute(CREATE_USERS_TABLE);
+client.execute(CREATE_TODOS_TABLE);
+for (const query of SEED_USERS_AND_TODOS) {
+  client.execute(query);
+}
+
+export const db = drizzle(client, {
+  // logger: true,
+  logger: new EnhancedQueryLogger(),
+  schema,
+});

demo/db/index.ts

@@ -0,0 +1,23 @@
+export const CREATE_USERS_TABLE = `
+  CREATE TABLE users (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    name TEXT,
+    email TEXT
+  )
+`;
+
+export const CREATE_TODOS_TABLE = `
+  CREATE TABLE todos (
+    id INTEGER PRIMARY KEY AUTOINCREMENT,
+    title TEXT,
+    completed INTEGER DEFAULT 0,
+    userId INTEGER REFERENCES users(id)
+  )
+`;
+
+export const SEED_USERS_AND_TODOS = [
+  `INSERT INTO users (name, email) VALUES ('John Doe', 'john.doe@example.com')`,
+  `INSERT INTO users (name, email) VALUES ('Jane Smith', 'jane.smith@example.com')`,
+  `INSERT INTO todos (title, completed, userId) VALUES ('Buy groceries', 0, 1)`,
+  `INSERT INTO todos (title, completed, userId) VALUES ('Finish project', 1, 2)`,
+];

demo/db/queries.ts

@@ -0,0 +1,26 @@
+import { relations } from "drizzle-orm";
+import { integer, sqliteTable, text } from "drizzle-orm/sqlite-core";
+
+export const users = sqliteTable("users", {
+  id: integer("id").primaryKey(),
+  name: text("name"),
+  email: text("email"),
+});
+
+export const todos = sqliteTable("todos", {
+  id: integer("id").primaryKey(),
+  title: text("title"),
+  completed: integer("completed").default(0),
+  userId: integer("userId").references(() => users.id),
+});
+
+export const userRelations = relations(users, ({ many }) => ({
+  todos: many(todos),
+}));
+
+export const todoRelations = relations(todos, ({ one }) => ({
+  user: one(users, {
+    fields: [todos.userId],
+    references: [users.id],
+  }),
+}));

demo/db/tables.ts

@@ -0,0 +1,26 @@
+import { eq } from "drizzle-orm";
+
+import { db } from "./db";
+import { todos, users } from "./db/tables";
+
+const allUsers = await db.select().from(users);
+
+const allTodos = await db.select().from(todos);
+
+const userOneWithTodos = await db
+  .select()
+  .from(users)
+  .where(eq(users.id, 1))
+  .innerJoin(todos, eq(users.id, todos.userId));
+
+const userTwoWithTodos = await db.query.users.findFirst({
+  where: eq(users.id, 2),
+  with: {
+    todos: true,
+  },
+});
+
+console.log(allUsers);
+console.log(allTodos);
+console.log(userOneWithTodos);
+console.log(userTwoWithTodos);

demo/index.ts

@@ -0,0 +1,17 @@
+{
+  "name": "demo",
+  "module": "index.ts",
+  "type": "module",
+  "private": true,
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "@libsql/client": "^0.15.14",
+    "drizzle-orm": "^0.44.5",
+    "drizzle-query-logger": "^1.0.7"
+  }
+}

demo/package.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}