@drizzle-adapter/d1 1.0.0

package/README.md

@@ -0,0 +1,260 @@
+# @drizzle-adapter/d1
+
+Cloudflare D1 adapter implementation for the Drizzle Adapter ecosystem.
+
+## Overview
+
+The `@drizzle-adapter/d1` package provides the Cloudflare D1 implementation for the Drizzle Adapter interface. While you don't interact with this package directly (you use `@drizzle-adapter/core` instead), it enables D1 support in the Drizzle Adapter ecosystem.
+
+## Why D1?
+
+D1 offers unique advantages for Cloudflare Workers:
+
+- **Edge SQLite**: Distributed SQLite database built for the edge
+- **Zero Configuration**: Automatic replication and distribution
+- **Global Performance**: Data served from the closest edge location
+- **Cloudflare Workers Integration**: Native integration with Workers
+- **Automatic Scaling**: Built-in scalability and reliability
+- **Cost Effective**: Included in Workers pricing with generous free tier
+- **SQLite Compatibility**: Familiar SQLite interface and features
+- **Automatic Backups**: Built-in backup and restore capabilities
+
+### Perfect For:
+
+1. **Edge Applications**: Data served from the closest location
+2. **Cloudflare Workers**: Native database for Workers applications
+3. **Global Applications**: Automatic global distribution
+4. **Cost-Sensitive Projects**: Included in Workers pricing
+5. **Simple Deployments**: Zero configuration required
+
+## Installation
+
+```bash
+# Install both the core package and the D1 adapter
+pnpm install @drizzle-adapter/core @drizzle-adapter/d1
+```
+
+## Usage
+
+### Cloudflare Workers Setup
+
+First, set up your D1 database:
+
+```bash
+# Create a new D1 database
+wrangler d1 create my-database
+
+# Add to wrangler.toml
+[[d1_databases]]
+binding = "DB"
+database_name = "my-database"
+database_id = "your-database-id"
+```
+
+### Configuration
+
+```typescript
+import { DrizzleAdapterFactory, TypeDrizzleDatabaseConfig } from '@drizzle-adapter/core';
+import { D1Database } from '@cloudflare/workers-types';
+
+interface Env {
+  DB: D1Database;
+}
+
+const config: TypeDrizzleDatabaseConfig = {
+  DATABASE_DRIVER: 'd1',
+  DATABASE: env.DB
+};
+
+const factory = new DrizzleAdapterFactory();
+const adapter = await factory.create(config);
+```
+
+### Important Note About Connections
+
+While D1 operates within the Workers environment and doesn't require traditional database connections, this adapter implements the standard connection interface for compatibility. This means your code remains portable across different database adapters:
+
+```typescript
+// These connection operations are no-ops for D1 but ensure
+// your code remains portable if you switch to another database
+const connection = adapter.getConnection();
+await connection.connect(); // No-op for D1
+const client = await connection.getClient();
+
+// Your database operations
+
+await connection.disconnect(); // No-op for D1
+```
+
+### Schema Definition
+
+```typescript
+const dataTypes = adapter.getDataTypes();
+
+const users = dataTypes.dbTable('users', {
+  id: dataTypes.dbInteger('id').primaryKey().autoincrement(),
+  name: dataTypes.dbText('name').notNull(),
+  email: dataTypes.dbText('email').notNull().unique(),
+  metadata: dataTypes.dbText('metadata'), // JSON stored as text
+  createdAt: dataTypes.dbInteger('created_at')
+    .default(sql`(unixepoch())`)
+});
+
+const posts = dataTypes.dbTable('posts', {
+  id: dataTypes.dbInteger('id').primaryKey().autoincrement(),
+  userId: dataTypes.dbInteger('user_id')
+    .references(() => users.id),
+  title: dataTypes.dbText('title').notNull(),
+  content: dataTypes.dbText('content').notNull(),
+  published: dataTypes.dbInteger('published').default(0),
+  createdAt: dataTypes.dbInteger('created_at')
+    .default(sql`(unixepoch())`)
+});
+```
+
+### Basic CRUD Operations
+
+```typescript
+import { eq, and, or, desc, sql } from 'drizzle-orm';
+
+const client = await adapter.getConnection().getClient();
+
+// INSERT
+// Single insert with returning
+const [newUser] = await client
+  .insert(users)
+  .values({
+    name: 'John Doe',
+    email: 'john@example.com',
+    metadata: JSON.stringify({ role: 'user' })
+  })
+  .returning();
+
+// Bulk insert
+await client
+  .insert(posts)
+  .values([
+    {
+      userId: newUser.id,
+      title: 'First Post',
+      content: 'Hello, world!'
+    },
+    {
+      userId: newUser.id,
+      title: 'Second Post',
+      content: 'Another post'
+    }
+  ]);
+
+// SELECT
+// Select all
+const allUsers = await client
+  .select()
+  .from(users);
+
+// Select with conditions
+const user = await client
+  .select()
+  .from(users)
+  .where(eq(users.email, 'john@example.com'));
+
+// Select with join
+const userPosts = await client
+  .select({
+    userName: users.name,
+    postTitle: posts.title,
+    content: posts.content,
+    metadata: users.metadata
+  })
+  .from(posts)
+  .leftJoin(users, eq(posts.userId, users.id))
+  .where(eq(posts.published, 1))
+  .orderBy(desc(posts.createdAt));
+
+// UPDATE
+await client
+  .update(users)
+  .set({
+    name: 'John Smith',
+    metadata: JSON.stringify({ role: 'admin' })
+  })
+  .where(eq(users.id, newUser.id));
+
+// DELETE
+await client
+  .delete(posts)
+  .where(
+    and(
+      eq(posts.userId, newUser.id),
+      eq(posts.published, 0)
+    )
+  );
+```
+
+### Worker Implementation
+
+```typescript
+interface Env {
+  DB: D1Database;
+}
+
+export default {
+  async fetch(request: Request, env: Env): Promise<Response> {
+    const factory = new DrizzleAdapterFactory();
+    const adapter = await factory.create({
+      DATABASE_DRIVER: 'd1',
+      DATABASE: env.DB
+    });
+
+    const client = await adapter.getConnection().getClient();
+    const url = new URL(request.url);
+
+    try {
+      switch (url.pathname) {
+        case '/users': {
+          const users = await client
+            .select()
+            .from(users);
+          return Response.json(users);
+        }
+
+        case '/posts': {
+          const posts = await client
+            .select({
+              title: posts.title,
+              content: posts.content,
+              author: users.name
+            })
+            .from(posts)
+            .leftJoin(users, eq(posts.userId, users.id))
+            .where(eq(posts.published, 1))
+            .orderBy(desc(posts.createdAt));
+          return Response.json(posts);
+        }
+
+        default:
+          return new Response('Not Found', { status: 404 });
+      }
+    } catch (error) {
+      return new Response('Error', { status: 500 });
+    }
+  }
+}
+```
+
+## Best Practices
+
+1. **Edge Optimization**: Queries are automatically optimized for edge execution
+2. **JSON Handling**: Store JSON data as TEXT and parse/stringify as needed
+3. **Error Handling**: Implement proper error handling for edge environments
+4. **Query Optimization**: Minimize the number of queries per request
+5. **Portability**: Use the connection interface for database portability
+
+## Contributing
+
+We welcome contributions! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+## Related Packages
+
+- [@drizzle-adapter/core](../core) - Core interfaces and types
+- [@drizzle-adapter/sqlite-core](../sqlite-core) - Shared SQLite functionality

package/dist/Adapter/D1DrizzleAdapter.d.ts

@@ -0,0 +1,32 @@
+import type { D1Database } from '@cloudflare/workers-types';
+import { D1DrizzleConnection } from './D1DrizzleConnection.js';
+import { D1DrizzleDataTypes } from './D1DrizzleDataTypes.js';
+import type { DrizzleAdapterInterface } from '@drizzle-adapter/core';
+export declare class D1DrizzleAdapter implements DrizzleAdapterInterface {
+    private readonly connection;
+    private connectionInstance;
+    /**
+     * Constructor.
+     *
+     * @param {D1Database} connectionDriver
+     */
+    constructor(connection: D1Database);
+    /**
+     * Returns the dialect.
+     *
+     * @returns {string}
+     */
+    getDialect(): string;
+    /**
+     * Returns the data types.
+     *
+     * @returns {D1DrizzleDataTypes}
+     */
+    getDataTypes(): D1DrizzleDataTypes;
+    /**
+     * Returns the connection.
+     *
+     * @returns {D1DrizzleConnection}
+     */
+    getConnection(): D1DrizzleConnection;
+}

package/dist/Adapter/D1DrizzleAdapter.js

@@ -0,0 +1,41 @@
+import { D1DrizzleConnection } from './D1DrizzleConnection.js';
+import { D1DrizzleDataTypes } from './D1DrizzleDataTypes.js';
+export class D1DrizzleAdapter {
+    connection;
+    connectionInstance = null;
+    /**
+     * Constructor.
+     *
+     * @param {D1Database} connectionDriver
+     */
+    constructor(connection) {
+        this.connection = connection;
+    }
+    /**
+     * Returns the dialect.
+     *
+     * @returns {string}
+     */
+    getDialect() {
+        return 'sqlite';
+    }
+    /**
+     * Returns the data types.
+     *
+     * @returns {D1DrizzleDataTypes}
+     */
+    getDataTypes() {
+        return new D1DrizzleDataTypes();
+    }
+    /**
+     * Returns the connection.
+     *
+     * @returns {D1DrizzleConnection}
+     */
+    getConnection() {
+        if (!this.connectionInstance) {
+            this.connectionInstance = new D1DrizzleConnection(this.connection);
+        }
+        return this.connectionInstance;
+    }
+}

package/dist/Adapter/D1DrizzleConnection.d.ts

@@ -0,0 +1,29 @@
+import type { D1Database } from '@cloudflare/workers-types';
+import type { DrizzleClientInterface, DrizzleConnectionInterface } from '@drizzle-adapter/core';
+export declare class D1DrizzleConnection implements DrizzleConnectionInterface {
+    private client;
+    /**
+     * Constructor.
+     *
+     * @param {D1Database} driver
+     */
+    constructor(driver: D1Database);
+    /**
+     * Establishes a connection.
+     *
+     * @returns {Promise<void>}
+     */
+    connect(): Promise<void>;
+    /**
+     * Disconnects from the database.
+     *
+     * @returns {Promise<void>}
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Returns the client.
+     *
+     * @returns {Promise<DrizzleClientInterface>}
+     */
+    getClient(): Promise<DrizzleClientInterface>;
+}

package/dist/Adapter/D1DrizzleConnection.js

@@ -0,0 +1,39 @@
+import { drizzle } from 'drizzle-orm/d1';
+export class D1DrizzleConnection {
+    client;
+    /**
+     * Constructor.
+     *
+     * @param {D1Database} driver
+     */
+    constructor(driver) {
+        // We want to add the execute method as an alias for run
+        const database = drizzle(driver);
+        database.execute = database.run;
+        this.client = database;
+    }
+    /**
+     * Establishes a connection.
+     *
+     * @returns {Promise<void>}
+     */
+    async connect() {
+        // D1 is serverless, no need to explicitly connect
+    }
+    /**
+     * Disconnects from the database.
+     *
+     * @returns {Promise<void>}
+     */
+    async disconnect() {
+        // D1 is serverless, no need to explicitly disconnect
+    }
+    /**
+     * Returns the client.
+     *
+     * @returns {Promise<DrizzleClientInterface>}
+     */
+    async getClient() {
+        return this.client;
+    }
+}

package/dist/Adapter/D1DrizzleDataTypes.d.ts

@@ -0,0 +1,3 @@
+import { SqliteCoreDrizzleDataTypes } from '@drizzle-adapter/sqlite-core';
+export declare class D1DrizzleDataTypes extends SqliteCoreDrizzleDataTypes {
+}

package/dist/Adapter/D1DrizzleDataTypes.js

@@ -0,0 +1,3 @@
+import { SqliteCoreDrizzleDataTypes } from '@drizzle-adapter/sqlite-core';
+export class D1DrizzleDataTypes extends SqliteCoreDrizzleDataTypes {
+}

package/dist/Adapter/index.d.ts

@@ -0,0 +1,2 @@
+export * from './D1DrizzleAdapter.js';
+export * from './D1DrizzleConnection.js';

package/dist/Adapter/index.js

@@ -0,0 +1,2 @@
+export * from './D1DrizzleAdapter.js';
+export * from './D1DrizzleConnection.js';

package/dist/Factory/D1DrizzleAdapterFactory.d.ts

@@ -0,0 +1,12 @@
+import type { TypeD1DatabaseConfig } from '../Type/Types.js';
+import { D1DrizzleAdapter } from '../Adapter/D1DrizzleAdapter.js';
+import type { DrizzleAdapterFactoryInterface } from '@drizzle-adapter/core';
+export declare class D1DrizzleAdapterFactory implements DrizzleAdapterFactoryInterface {
+    /**
+     * Returns a adapter.
+     *
+     * @param {TypeD1DatabaseConfig} databaseConfig
+     * @returns {Promise<D1DrizzleAdapter>}
+     */
+    create(databaseConfig: TypeD1DatabaseConfig): Promise<D1DrizzleAdapter>;
+}

package/dist/Factory/D1DrizzleAdapterFactory.js

@@ -0,0 +1,12 @@
+import { D1DrizzleAdapter } from '../Adapter/D1DrizzleAdapter.js';
+export class D1DrizzleAdapterFactory {
+    /**
+     * Returns a adapter.
+     *
+     * @param {TypeD1DatabaseConfig} databaseConfig
+     * @returns {Promise<D1DrizzleAdapter>}
+     */
+    async create(databaseConfig) {
+        return new D1DrizzleAdapter(databaseConfig.DATABASE);
+    }
+}

package/dist/Factory/index.d.ts

@@ -0,0 +1 @@
+export * from './D1DrizzleAdapterFactory.js';

package/dist/Factory/index.js

@@ -0,0 +1 @@
+export * from './D1DrizzleAdapterFactory.js';

package/dist/Interface/D1DrizzleClientInterface.d.ts

@@ -0,0 +1,13 @@
+import type { AnyD1Database } from 'drizzle-orm/d1';
+import type { DrizzleClientInterface } from '@drizzle-adapter/core';
+export interface D1DrizzleClientInterface extends DrizzleClientInterface {
+    execute(...args: any[]): ReturnType<AnyD1Database['run']>;
+    $with(...args: any[]): ReturnType<AnyD1Database['$with']>;
+    $count(...args: any[]): ReturnType<AnyD1Database['$count']>;
+    with(...args: any[]): ReturnType<AnyD1Database['with']>;
+    select(...args: any[]): ReturnType<AnyD1Database['select']>;
+    selectDistinct(...args: any[]): ReturnType<AnyD1Database['selectDistinct']>;
+    update(...args: any[]): ReturnType<AnyD1Database['update']>;
+    insert(...args: any[]): ReturnType<AnyD1Database['insert']>;
+    transaction(...args: any[]): ReturnType<AnyD1Database['transaction']>;
+}

package/dist/Interface/D1DrizzleClientInterface.js

@@ -0,0 +1 @@
+export {};

package/dist/Interface/index.d.ts

@@ -0,0 +1 @@
+export * from './D1DrizzleClientInterface.js';

package/dist/Interface/index.js

@@ -0,0 +1 @@
+export * from './D1DrizzleClientInterface.js';

package/dist/Type/Types.d.ts

@@ -0,0 +1,5 @@
+import type { D1Database } from '@cloudflare/workers-types';
+import type { TypeDrizzleDatabaseConfig } from '@drizzle-adapter/core';
+export interface TypeD1DatabaseConfig extends TypeDrizzleDatabaseConfig {
+    readonly DATABASE: D1Database;
+}

package/dist/Type/Types.js

@@ -0,0 +1 @@
+export {};

package/dist/Type/index.d.ts

@@ -0,0 +1 @@
+export * from './Types.js';

package/dist/Type/index.js

@@ -0,0 +1 @@
+export * from './Types.js';

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './Adapter/index.js';
+export * from './Factory/index.js';
+export * from './Interface/index.js';
+export * from './Type/index.js';
+import { D1DrizzleAdapterFactory } from './Factory/index.js';
+export default D1DrizzleAdapterFactory;

package/dist/index.js

@@ -0,0 +1,7 @@
+export * from './Adapter/index.js';
+export * from './Factory/index.js';
+export * from './Interface/index.js';
+export * from './Type/index.js';
+// default export so that core factory can use it directly
+import { D1DrizzleAdapterFactory } from './Factory/index.js';
+export default D1DrizzleAdapterFactory;

package/eslint.config.mjs

@@ -0,0 +1,6 @@
+import eslintConfig from '@dmitryrechkin/eslint-standard/eslint.config.mjs';
+
+export default eslintConfig({
+	tsconfigPath: './tsconfig.eslint.json',
+	ignores: ['packages/**', 'tests/**'],
+});

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@drizzle-adapter/d1",
+  "type": "module",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "devDependencies": {
+    "@cloudflare/workers-types": "^4.20240208.0",
+    "@dmitryrechkin/eslint-standard": "^1.0.7",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.0.0",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "fix-esm-import-path": "^1.0.1",
+    "shx": "^0.3.4",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.5.3",
+    "vitest": "^0.24.5",
+    "wrangler": "^3.91.0"
+  },
+  "dependencies": {
+    "@libsql/client": "^0.5.6",
+    "drizzle-orm": "^0.36.4",
+    "@drizzle-adapter/sqlite-core": "1.0.0"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "format": "eslint --fix .",
+    "test": "vitest run",
+    "check": "tsc --noEmit",
+    "build": "shx rm -rf dist && tsc && fix-esm-import-path dist",
+    "package:tgz": "pnpm pack",
+    "package:publish": "pnpm publish --access public"
+  }
+}

package/src/Adapter/D1DrizzleAdapter.ts

@@ -0,0 +1,50 @@
+import type { D1Database } from '@cloudflare/workers-types';
+import { D1DrizzleConnection } from './D1DrizzleConnection';
+import { D1DrizzleDataTypes } from './D1DrizzleDataTypes';
+import type { DrizzleAdapterInterface } from '@drizzle-adapter/core';
+
+export class D1DrizzleAdapter implements DrizzleAdapterInterface
+{
+	private connectionInstance: D1DrizzleConnection | null = null;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param {D1Database} connectionDriver
+	 */
+	public constructor(private readonly connection: D1Database) {}
+
+	/**
+	 * Returns the dialect.
+	 *
+	 * @returns {string}
+	 */
+	public getDialect(): string
+	{
+		return 'sqlite';
+	}
+
+	/**
+	 * Returns the data types.
+	 *
+	 * @returns {D1DrizzleDataTypes}
+	 */
+	public getDataTypes(): D1DrizzleDataTypes
+	{
+		return new D1DrizzleDataTypes();
+	}
+
+	/**
+	 * Returns the connection.
+	 *
+	 * @returns {D1DrizzleConnection}
+	 */
+	public getConnection(): D1DrizzleConnection
+	{
+		if (!this.connectionInstance)
+		{
+			this.connectionInstance = new D1DrizzleConnection(this.connection);
+		}
+		return this.connectionInstance;
+	}
+}

package/src/Adapter/D1DrizzleConnection.ts

@@ -0,0 +1,53 @@
+import type { D1Database } from '@cloudflare/workers-types';
+import { drizzle } from 'drizzle-orm/d1';
+import type { DrizzleClientInterface, DrizzleConnectionInterface } from '@drizzle-adapter/core';
+import type { D1DrizzleClientInterface } from 'src/Interface';
+
+export class D1DrizzleConnection implements DrizzleConnectionInterface
+{
+	private client: DrizzleClientInterface;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param {D1Database} driver
+	 */
+	public constructor(driver: D1Database)
+	{
+		// We want to add the execute method as an alias for run
+		const database: ReturnType<typeof drizzle> | D1DrizzleClientInterface = drizzle(driver);
+		(database as unknown  as D1DrizzleClientInterface).execute = database.run;
+
+		this.client = database as unknown as D1DrizzleClientInterface;
+	}
+
+	/**
+	 * Establishes a connection.
+	 *
+	 * @returns {Promise<void>}
+	 */
+	public async connect(): Promise<void>
+	{
+		// D1 is serverless, no need to explicitly connect
+	}
+
+	/**
+	 * Disconnects from the database.
+	 *
+	 * @returns {Promise<void>}
+	 */
+	public async disconnect(): Promise<void>
+	{
+		// D1 is serverless, no need to explicitly disconnect
+	}
+
+	/**
+	 * Returns the client.
+	 *
+	 * @returns {Promise<DrizzleClientInterface>}
+	 */
+	public async getClient(): Promise<DrizzleClientInterface>
+	{
+		return this.client;
+	}
+}

package/src/Adapter/D1DrizzleDataTypes.ts

@@ -0,0 +1,3 @@
+import { SqliteCoreDrizzleDataTypes } from '@drizzle-adapter/sqlite-core';
+
+export class D1DrizzleDataTypes extends SqliteCoreDrizzleDataTypes {}

package/src/Adapter/index.ts

@@ -0,0 +1,2 @@
+export * from './D1DrizzleAdapter';
+export * from './D1DrizzleConnection';