@duckdbfan/drizzle-duckdb 0.0.1

package/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "printWidth": 80
+}

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,66 @@
+# drizzle-duckdb
+
+## Description
+A drizzle ORM client for use with DuckDB. Based on drizzle's Postgres client. As of writing this, certain things will work, and others won't. Notably, DuckDB-specific column types such as `struct`, `list`, `array` are not implemented, but this could be done using [drizzle custom types](https://orm.drizzle.team/docs/custom-types). (This is planned to be implemented in the package later on)
+
+## Disclaimers
+- **Experimental**: This project is in an experimental stage. Certain features may be broken or not function as expected.
+- **Use at Your Own Risk**: Users should proceed with caution and use this project at their own risk.
+- **Maintenance**: This project may not be actively maintained. Updates and bug fixes are not guaranteed.
+
+## Getting Started
+1. Install dependencies:
+    ```sh
+    bun add @duckdbfan/drizzle-duckdb
+    ```
+2. Figure it out! (sorry, might flesh this out later- see tests for some examples)
+    ```typescript
+    import { Database } from 'duckdb-async';
+    import { drizzle } from '@duckdbfan/drizzle-duckdb';
+    import { DefaultLogger, sql } from 'drizzle-orm';
+    import { char, integer, pgSchema, text } from 'drizzle-orm/pg-core';
+    
+    const client = await Database.create(':memory:');
+    const db = drizzle(client, { logger: new DefaultLogger() });
+
+    const customSchema = pgSchema('custom');
+
+    await db.execute(sql`CREATE SCHEMA IF NOT EXISTS ${customSchema}`);
+
+    const citiesTable = customSchema.table('cities', {
+      id: integer('id')
+        .primaryKey()
+        .default(sql`nextval('serial_cities')`),
+      name: text('name').notNull(),
+      state: char('state', { length: 2 }),
+    });
+
+    await db.execute(sql`CREATE SEQUENCE IF NOT EXISTS serial_cities;`);
+
+    await db.execute(
+      sql`
+        create table if not exists ${citiesTable} (
+          id integer primary key default nextval('serial_cities'),
+          name text not null,
+          state char(2)
+        )
+      `
+    );
+
+    const insertedIds = await db
+      .insert(citiesTable)
+      .values([
+        { name: 'Paris', state: 'FR' },
+        { name: 'London', state: 'UK' },
+      ])
+      .returning({ id: citiesTable.id });
+
+    console.log(insertedIds);
+
+    ```
+
+## Contributing
+Contributions are welcome, although I may not be very responsive.
+
+## License
+This project is licensed under the Apache License.

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@duckdbfan/drizzle-duckdb",
+  "version": "0.0.1",
+  "description": "A drizzle ORM client for use with DuckDB. Based on drizzle's Postgres client.",
+  "main": "./src/index.ts",
+  "scripts": {
+    "test": "vitest",
+    "t": "vitest --watch --ui"
+  },
+  "dependencies": {
+    "drizzle-orm": "0.40.0",
+    "duckdb-async": "^1.2.0"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.2.5",
+    "@types/uuid": "^10.0.0",
+    "@vitest/ui": "^1.6.0",
+    "uuid": "^10.0.0",
+    "vitest": "^1.6.0"
+  },
+  "directories": {
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/duckdbfan/drizzle-duckdb.git"
+  },
+  "keywords": [
+    "drizzle",
+    "duckdb"
+  ],
+  "author": "M L",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/duckdbfan/drizzle-duckdb/issues"
+  },
+  "homepage": "https://github.com/duckdbfan/drizzle-duckdb#readme"
+}

package/src/columns.ts

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

package/src/dialect.ts

@@ -0,0 +1,108 @@
+import { entityKind, is } from 'drizzle-orm/entity';
+import type { MigrationConfig, MigrationMeta } from 'drizzle-orm/migrator';
+import {
+  PgDate,
+  PgDateString,
+  PgDialect,
+  PgJson,
+  PgJsonb,
+  PgNumeric,
+  PgSession,
+  PgTime,
+  PgTimestamp,
+  PgTimestampString,
+  PgUUID,
+} from 'drizzle-orm/pg-core';
+import { DuckDBSession } from './session';
+import {
+  sql,
+  type DriverValueEncoder,
+  type QueryTypingsValue,
+} from 'drizzle-orm';
+
+export class DuckDBDialect extends PgDialect {
+  static readonly [entityKind]: string = 'DuckDBPgDialect';
+
+  override async migrate(
+    migrations: MigrationMeta[],
+    session: PgSession,
+    config: MigrationConfig
+  ): Promise<void> {
+    const migrationsSchema = config.migrationsSchema ?? 'drizzle';
+
+    const migrationsTable = config.migrationsTable ?? '__drizzle_migrations';
+
+    const migrationTableCreate = sql`
+			CREATE TABLE IF NOT EXISTS ${sql.identifier(migrationsSchema)}.${sql.identifier(
+      migrationsTable
+    )} (
+				id integer PRIMARY KEY default nextval('migrations_pk_seq'),
+				hash text NOT NULL,
+				created_at bigint
+			)
+		`;
+
+    await session.execute(
+      sql.raw('CREATE SEQUENCE IF NOT EXISTS migrations_pk_seq')
+    );
+    await session.execute(
+      sql`CREATE SCHEMA IF NOT EXISTS ${sql.identifier(migrationsSchema)}`
+    );
+    await session.execute(migrationTableCreate);
+
+    const dbMigrations = await session.all<{
+      id: number;
+      hash: string;
+      created_at: string;
+    }>(
+      sql`select id, hash, created_at from ${sql.identifier(
+        migrationsSchema
+      )}.${sql.identifier(migrationsTable)} order by created_at desc limit 1`
+    );
+
+    const lastDbMigration = dbMigrations[0];
+
+    await session.transaction(async (tx) => {
+      for await (const migration of migrations) {
+        if (
+          !lastDbMigration ||
+          Number(lastDbMigration.created_at) < migration.folderMillis
+        ) {
+          for (const stmt of migration.sql) {
+            await tx.execute(sql.raw(stmt));
+          }
+
+          await tx.execute(
+            sql`insert into ${sql.identifier(
+              migrationsSchema
+            )}.${sql.identifier(
+              migrationsTable
+            )} ("hash", "created_at") values(${migration.hash}, ${
+              migration.folderMillis
+            })`
+          );
+        }
+      }
+    });
+  }
+
+  override prepareTyping(
+    encoder: DriverValueEncoder<unknown, unknown>
+  ): QueryTypingsValue {
+    if (is(encoder, PgJsonb) || is(encoder, PgJson)) {
+      throw new Error('JSON and JSONB types are not supported in DuckDB');
+    } else if (is(encoder, PgNumeric)) {
+      return 'decimal';
+    } else if (is(encoder, PgTime)) {
+      return 'time';
+    } else if (is(encoder, PgTimestamp) || is(encoder, PgTimestampString)) {
+      return 'timestamp';
+    } else if (is(encoder, PgDate) || is(encoder, PgDateString)) {
+      return 'date';
+    } else if (is(encoder, PgUUID)) {
+      return 'uuid';
+    } else {
+      return 'none';
+    }
+  }
+}

package/src/driver.ts

@@ -0,0 +1,273 @@
+import { entityKind, is } from 'drizzle-orm/entity';
+import type { Logger } from 'drizzle-orm/logger';
+import { DefaultLogger } from 'drizzle-orm/logger';
+import { PgDatabase } from 'drizzle-orm/pg-core/db';
+import { PgDialect } from 'drizzle-orm/pg-core/dialect';
+import {
+  createTableRelationsHelpers,
+  extractTablesRelationalConfig,
+  type ExtractTablesWithRelations,
+  type RelationalSchemaConfig,
+  type TablesRelationalConfig,
+} from 'drizzle-orm/relations';
+import {
+  getTableColumns,
+  type DrizzleConfig,
+  type DrizzleTypeError,
+} from 'drizzle-orm/utils';
+import type {
+  DuckDBClient,
+  DuckDBQueryResultHKT,
+  DuckDBTransaction,
+} from './session';
+import { DuckDBSession } from './session.ts';
+import { DuckDBDialect } from './dialect.ts';
+
+import {
+  PgSelectBase,
+  PgSelectBuilder,
+  type CreatePgSelectFromBuilderMode,
+  type SelectedFields,
+  type TableLikeHasEmptySelection,
+} from 'drizzle-orm/pg-core/query-builders';
+import {
+  PgColumn,
+  PgTable,
+  type PgSession,
+  type PgTransactionConfig,
+} from 'drizzle-orm/pg-core';
+import { sql, SQL, type ColumnsSelection } from 'drizzle-orm/sql/sql';
+import { Column } from 'drizzle-orm/column';
+import { Subquery, ViewBaseConfig, type SQLWrapper } from 'drizzle-orm';
+import { PgViewBase } from 'drizzle-orm/pg-core/view-base';
+import type {
+  GetSelectTableName,
+  GetSelectTableSelection,
+} from 'drizzle-orm/query-builders/select.types';
+import { aliasFields } from './utils.ts';
+
+export interface PgDriverOptions {
+  logger?: Logger;
+}
+
+const selectionRegex = /select\s+(.+)\s+from/i;
+const aliasRegex = /as\s+(.+)$/i;
+
+export class DuckDBDriver {
+  static readonly [entityKind]: string = 'DuckDBDriver';
+
+  constructor(
+    private client: DuckDBClient,
+    private dialect: DuckDBDialect,
+    private options: PgDriverOptions = {}
+  ) {
+    // const clientProxy = new Proxy(client, {
+    //   get(target, prop, receiver) {
+    //     if (prop === 'all') {
+    //       return (query: string, params: Parameters<typeof target.all>) => {
+    //         // DuckDB names returned variables differently than Postgres
+    //         // so we need to remap them to match the Postgres names
+    //         const selection = selectionRegex.exec(query);
+    //         if (selection?.length !== 2) {
+    //           return target.all(query, params);
+    //         }
+    //         const fields = selection[1].split(',').map((field) => {});
+    //         return target.all(query, params);
+    //       };
+    //     }
+    //     return Reflect.get(target, prop, receiver);
+    //   },
+    // });
+  }
+
+  createSession(
+    schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined
+  ): DuckDBSession<Record<string, unknown>, TablesRelationalConfig> {
+    return new DuckDBSession(this.client, this.dialect, schema, {
+      logger: this.options.logger,
+    });
+  }
+}
+
+// Need to work around omitted internal types from drizzle...
+// interface DuckDBDatabaseInternal<
+//   TSchema extends Record<string, unknown> = Record<string, never>
+// > extends PgDatabase<DuckDBQueryResultHKT, TSchema> {
+//   dialect: PgDialect;
+//   session: DuckDBSession<Record<string, unknown>, TablesRelationalConfig>;
+// }
+
+// export type DuckDBDatabase<
+//   TSchema extends Record<string, unknown> = Record<string, never>
+// > = DuckDBDatabaseInternal<TSchema>;
+
+export function drizzle<
+  TSchema extends Record<string, unknown> = Record<string, never>
+>(
+  client: DuckDBClient,
+  config: DrizzleConfig<TSchema> = {}
+): DuckDBDatabase<TSchema, ExtractTablesWithRelations<TSchema>> {
+  const dialect = new DuckDBDialect();
+
+  const logger =
+    config.logger === true ? new DefaultLogger() : config.logger || undefined;
+
+  let schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined;
+
+  if (config.schema) {
+    const tablesConfig = extractTablesRelationalConfig(
+      config.schema,
+      createTableRelationsHelpers
+    );
+    schema = {
+      fullSchema: config.schema,
+      schema: tablesConfig.tables,
+      tableNamesMap: tablesConfig.tableNamesMap,
+    };
+  }
+
+  const driver = new DuckDBDriver(client, dialect, { logger });
+  const session = driver.createSession(schema);
+
+  return new DuckDBDatabase(dialect, session, schema) as DuckDBDatabase<
+    TSchema,
+    ExtractTablesWithRelations<TSchema>
+  >;
+}
+
+export class DuckDBDatabase<
+  TFullSchema extends Record<string, unknown> = Record<string, never>,
+  TSchema extends TablesRelationalConfig = ExtractTablesWithRelations<TFullSchema>
+> extends PgDatabase<DuckDBQueryResultHKT, TFullSchema, TSchema> {
+  static readonly [entityKind]: string = 'DuckDBDatabase';
+
+  constructor(
+    readonly dialect: DuckDBDialect,
+    readonly session: DuckDBSession<TFullSchema, TSchema>,
+    schema: RelationalSchemaConfig<TSchema> | undefined
+  ) {
+    super(dialect, session, schema);
+  }
+
+  select(): PgSelectBuilder<undefined>;
+  select<TSelection extends SelectedFields>(
+    fields: TSelection
+  ): PgSelectBuilder<TSelection>;
+  select(fields?: SelectedFields): PgSelectBuilder<SelectedFields | undefined> {
+    if (!fields) {
+      // iterate over all fields and do the same as below (may have to extend/override `.from()`)
+
+      return new DuckDBSelectBuilder({
+        fields: fields ?? undefined,
+        session: this.session as unknown as PgSession<DuckDBQueryResultHKT>,
+        dialect: this.dialect,
+      });
+    }
+
+    const aliasedFields: SelectedFields = aliasFields(fields);
+
+    return new DuckDBSelectBuilder({
+      fields: aliasedFields,
+      session: this.session as unknown as PgSession<DuckDBQueryResultHKT>,
+      dialect: this.dialect,
+    });
+  }
+
+  override async transaction<T>(
+    transaction: (tx: DuckDBTransaction<TFullSchema, TSchema>) => Promise<T>
+  ): Promise<T> {
+    return await this.session.transaction<T>(transaction);
+  }
+}
+
+interface PgViewBaseInternal<
+  TName extends string = string,
+  TExisting extends boolean = boolean,
+  TSelectedFields extends ColumnsSelection = ColumnsSelection
+> extends PgViewBase<TName, TExisting, TSelectedFields> {
+  [ViewBaseConfig]?: {
+    selectedFields: SelectedFields;
+  };
+}
+
+export class DuckDBSelectBuilder<
+  TSelection extends SelectedFields | undefined,
+  TBuilderMode extends 'db' | 'qb' = 'db'
+> extends PgSelectBuilder<TSelection, TBuilderMode> {
+  private _fields: TSelection;
+  private _session: PgSession | undefined;
+  private _dialect: DuckDBDialect;
+  private _withList: Subquery[] = [];
+  private _distinct:
+    | boolean
+    | {
+        on: (PgColumn | SQLWrapper)[];
+      }
+    | undefined;
+
+  constructor(config: {
+    fields: TSelection;
+    session: PgSession | undefined;
+    dialect: PgDialect;
+    withList?: Subquery[];
+    distinct?:
+      | boolean
+      | {
+          on: (PgColumn | SQLWrapper)[];
+        };
+  }) {
+    super(config);
+    this._fields = config.fields;
+    this._session = config.session;
+    this._dialect = config.dialect;
+    if (config.withList) {
+      this._withList = config.withList;
+    }
+    this._distinct = config.distinct;
+  }
+
+  from<TFrom extends PgTable | Subquery | PgViewBaseInternal | SQL>(
+    source: TableLikeHasEmptySelection<TFrom> extends true
+      ? DrizzleTypeError<"Cannot reference a data-modifying statement subquery if it doesn't contain a `returning` clause">
+      : TFrom
+  ): CreatePgSelectFromBuilderMode<
+    TBuilderMode,
+    GetSelectTableName<TFrom>,
+    TSelection extends undefined ? GetSelectTableSelection<TFrom> : TSelection,
+    TSelection extends undefined ? 'single' : 'partial'
+  > {
+    const isPartialSelect = !!this._fields;
+    const src = source as TFrom;
+
+    let fields: SelectedFields;
+    if (this._fields) {
+      fields = this._fields;
+    } else if (is(src, Subquery)) {
+      // This is required to use the proxy handler to get the correct field values from the subquery
+      fields = Object.fromEntries(
+        Object.keys(src._.selectedFields).map((key) => [
+          key,
+          src[
+            key as unknown as keyof typeof src
+          ] as unknown as SelectedFields[string],
+        ])
+      );
+    } else if (is(src, PgViewBase)) {
+      fields = src[ViewBaseConfig]?.selectedFields as SelectedFields;
+    } else if (is(src, SQL)) {
+      fields = {};
+    } else {
+      fields = aliasFields(getTableColumns<PgTable>(src), !isPartialSelect);
+    }
+
+    return new PgSelectBase({
+      table: src,
+      fields,
+      isPartialSelect,
+      session: this._session,
+      dialect: this._dialect,
+      withList: this._withList,
+      distinct: this._distinct,
+    }) as any;
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './driver.ts';
+export * from './session.ts';
+export * from './columns.ts';

package/src/migrator.ts

@@ -0,0 +1,18 @@
+import type { MigrationConfig } from 'drizzle-orm/migrator';
+import { readMigrationFiles } from 'drizzle-orm/migrator';
+import type { DuckDBDatabase } from './driver';
+import type { PgSession } from 'drizzle-orm/pg-core/session';
+
+export async function migrate<TSchema extends Record<string, unknown>>(
+  db: DuckDBDatabase<TSchema>,
+  config: MigrationConfig
+) {
+  const migrations = readMigrationFiles(config);
+
+  await db.dialect.migrate(
+    migrations,
+    // Need to work around omitted internal types from drizzle...
+    db.session as unknown as PgSession,
+    config
+  );
+}

package/src/session.ts

@@ -0,0 +1,237 @@
+import type { Connection, Database, RowData } from 'duckdb-async';
+import { entityKind } from 'drizzle-orm/entity';
+import { type Logger, NoopLogger } from 'drizzle-orm/logger';
+import type { PgDialect } from 'drizzle-orm/pg-core/dialect';
+import { PgTransaction } from 'drizzle-orm/pg-core';
+import type { SelectedFieldsOrdered } from 'drizzle-orm/pg-core/query-builders/select.types';
+import type {
+  PgTransactionConfig,
+  PreparedQueryConfig,
+  PgQueryResultHKT,
+} from 'drizzle-orm/pg-core/session';
+import { PgPreparedQuery, PgSession } from 'drizzle-orm/pg-core/session';
+import type {
+  RelationalSchemaConfig,
+  TablesRelationalConfig,
+} from 'drizzle-orm/relations';
+import { fillPlaceholders, type Query, SQL, sql } from 'drizzle-orm/sql/sql';
+import type { Assume } from 'drizzle-orm/utils';
+import { mapResultRow } from './utils';
+import type { DuckDBDialect } from './dialect';
+import { TransactionRollbackError } from 'drizzle-orm/errors';
+
+export type DuckDBClient = Database;
+
+export class DuckDBPreparedQuery<
+  T extends PreparedQueryConfig
+> extends PgPreparedQuery<T> {
+  static readonly [entityKind]: string = 'DuckDBPreparedQuery';
+
+  // private rawQueryConfig: QueryOptions;
+  // private queryConfig: QueryOptions;
+
+  constructor(
+    private client: DuckDBClient | Connection,
+    private queryString: string,
+    private params: unknown[],
+    private logger: Logger,
+    private fields: SelectedFieldsOrdered | undefined,
+    private _isResponseInArrayMode: boolean,
+    private customResultMapper?: (rows: unknown[][]) => T['execute']
+  ) {
+    super({ sql: queryString, params });
+  }
+
+  async execute(
+    placeholderValues: Record<string, unknown> | undefined = {}
+  ): Promise<T['execute']> {
+    const params = fillPlaceholders(this.params, placeholderValues);
+
+    this.logger.logQuery(this.queryString, params);
+
+    const {
+      fields,
+      client,
+      joinsNotNullableMap,
+      customResultMapper,
+      queryString,
+    } = this as typeof this & { joinsNotNullableMap?: Record<string, boolean> };
+
+    const rows = (await client.all(queryString, ...params)) ?? [];
+
+    if (rows.length === 0 || !fields) {
+      return rows;
+    }
+
+    const rowValues = rows.map((row) => Object.values(row));
+
+    return customResultMapper
+      ? customResultMapper(rowValues)
+      : rowValues.map((row) =>
+          mapResultRow<T['execute']>(fields!, row, joinsNotNullableMap)
+        );
+  }
+
+  all(
+    placeholderValues: Record<string, unknown> | undefined = {}
+  ): Promise<T['all']> {
+    return this.execute(placeholderValues);
+  }
+
+  isResponseInArrayMode(): boolean {
+    return false;
+  }
+}
+
+export interface DuckDBSessionOptions {
+  logger?: Logger;
+}
+
+export class DuckDBSession<
+  TFullSchema extends Record<string, unknown> = Record<string, never>,
+  TSchema extends TablesRelationalConfig = Record<string, never>
+> extends PgSession<DuckDBQueryResultHKT, TFullSchema, TSchema> {
+  static readonly [entityKind]: string = 'DuckDBSession';
+
+  private logger: Logger;
+
+  constructor(
+    private client: DuckDBClient | Connection,
+    dialect: DuckDBDialect,
+    private schema: RelationalSchemaConfig<TSchema> | undefined,
+    private options: DuckDBSessionOptions = {}
+  ) {
+    super(dialect);
+    this.logger = options.logger ?? new NoopLogger();
+  }
+
+  prepareQuery<T extends PreparedQueryConfig = PreparedQueryConfig>(
+    query: Query,
+    fields: SelectedFieldsOrdered | undefined,
+    name: string | undefined,
+    isResponseInArrayMode: boolean,
+    customResultMapper?: (rows: unknown[][]) => T['execute']
+  ): PgPreparedQuery<T> {
+    return new DuckDBPreparedQuery(
+      this.client,
+      query.sql,
+      query.params,
+      this.logger,
+      fields,
+      isResponseInArrayMode,
+      customResultMapper
+    );
+  }
+
+  override async transaction<T>(
+    transaction: (tx: DuckDBTransaction<TFullSchema, TSchema>) => Promise<T>
+  ): Promise<T> {
+    const connection =
+      'connect' in this.client ? await this.client.connect() : this.client;
+
+    const session = new DuckDBSession(
+      connection,
+      this.dialect,
+      this.schema,
+      this.options
+    );
+
+    const tx = new DuckDBTransaction<TFullSchema, TSchema>(
+      this.dialect,
+      session,
+      this.schema
+    );
+
+    await tx.execute(sql`BEGIN TRANSACTION;`);
+
+    try {
+      const result = await transaction(tx);
+      await tx.execute(sql`commit`);
+      return result;
+    } catch (error) {
+      await tx.execute(sql`rollback`);
+      throw error;
+    } finally {
+      await connection.close();
+    }
+  }
+}
+
+type PgTransactionInternals<
+  TFullSchema extends Record<string, unknown> = Record<string, never>,
+  TSchema extends TablesRelationalConfig = Record<string, never>
+> = {
+  dialect: DuckDBDialect;
+  session: DuckDBSession<TFullSchema, TSchema>;
+};
+
+type DuckDBTransactionWithInternals<
+  TFullSchema extends Record<string, unknown> = Record<string, never>,
+  TSchema extends TablesRelationalConfig = Record<string, never>
+> = PgTransactionInternals<TFullSchema, TSchema> &
+  DuckDBTransaction<TFullSchema, TSchema>;
+
+export class DuckDBTransaction<
+  TFullSchema extends Record<string, unknown>,
+  TSchema extends TablesRelationalConfig
+> extends PgTransaction<DuckDBQueryResultHKT, TFullSchema, TSchema> {
+  static readonly [entityKind]: string = 'DuckDBTransaction';
+
+  rollback(): never {
+    throw new TransactionRollbackError();
+  }
+
+  getTransactionConfigSQL(config: PgTransactionConfig): SQL {
+    const chunks: string[] = [];
+    if (config.isolationLevel) {
+      chunks.push(`isolation level ${config.isolationLevel}`);
+    }
+    if (config.accessMode) {
+      chunks.push(config.accessMode);
+    }
+    if (typeof config.deferrable === 'boolean') {
+      chunks.push(config.deferrable ? 'deferrable' : 'not deferrable');
+    }
+    return sql.raw(chunks.join(' '));
+  }
+
+  setTransaction(config: PgTransactionConfig): Promise<void> {
+    // Need to work around omitted internal types from drizzle...
+    type Tx = DuckDBTransactionWithInternals<TFullSchema, TSchema>;
+    return (this as unknown as Tx).session.execute(
+      sql`set transaction ${this.getTransactionConfigSQL(config)}`
+    );
+  }
+
+  override async transaction<T>(
+    transaction: (tx: DuckDBTransaction<TFullSchema, TSchema>) => Promise<T>
+  ): Promise<T> {
+    // Need to work around omitted internal types from drizzle...
+    type Tx = DuckDBTransactionWithInternals<TFullSchema, TSchema>;
+
+    const savepointName = `sp${this.nestedIndex + 1}`;
+    const tx = new DuckDBTransaction<TFullSchema, TSchema>(
+      (this as unknown as Tx).dialect,
+      (this as unknown as Tx).session,
+      this.schema,
+      this.nestedIndex + 1
+    );
+    await tx.execute(sql.raw(`savepoint ${savepointName}`));
+    try {
+      const result = await transaction(tx);
+      await tx.execute(sql.raw(`release savepoint ${savepointName}`));
+      return result;
+    } catch (err) {
+      await tx.execute(sql.raw(`rollback to savepoint ${savepointName}`));
+      throw err;
+    }
+  }
+}
+
+export type GenericRowData<T extends RowData = RowData> = T;
+
+export type GenericTableData<T = RowData> = T[];
+
+export interface DuckDBQueryResultHKT extends PgQueryResultHKT {
+  type: GenericTableData<Assume<this['row'], RowData>>;
+}

package/src/utils.ts

@@ -0,0 +1,216 @@
+/* Marked as internal in the original source, so we need to copy it here */
+import {
+  type SelectedFieldsOrdered,
+  type AnyColumn,
+  type DriverValueDecoder,
+  is,
+  Column,
+  SQL,
+  getTableName,
+  sql,
+} from 'drizzle-orm';
+import { PgColumn, type SelectedFields } from 'drizzle-orm/pg-core';
+
+// Need to get around "decoder" property being marked as internal
+type SQLInternal<T = unknown> = SQL<T> & {
+  decoder: DriverValueDecoder<T, any>;
+};
+
+export function mapResultRow<TResult>(
+  columns: SelectedFieldsOrdered<AnyColumn>,
+  row: unknown[],
+  joinsNotNullableMap: Record<string, boolean> | undefined
+): TResult {
+  // Key -> nested object key, value -> table name if all fields in the nested object are from the same table, false otherwise
+  const nullifyMap: Record<string, string | false> = {};
+
+  const result = columns.reduce<Record<string, any>>(
+    (result, { path, field }, columnIndex) => {
+      let decoder: DriverValueDecoder<unknown, unknown>;
+      if (is(field, Column)) {
+        decoder = field;
+      } else if (is(field, SQL)) {
+        decoder = (field as SQLInternal).decoder;
+      } else {
+        decoder = (field.sql as SQLInternal).decoder;
+      }
+      let node = result;
+      for (const [pathChunkIndex, pathChunk] of path.entries()) {
+        if (pathChunkIndex < path.length - 1) {
+          if (!(pathChunk in node)) {
+            node[pathChunk] = {};
+          }
+          node = node[pathChunk];
+          continue;
+        }
+
+        const rawValue = row[columnIndex]!;
+
+        const value = (node[pathChunk] =
+          rawValue === null ? null : decoder.mapFromDriverValue(rawValue));
+
+        if (joinsNotNullableMap && is(field, Column) && path.length === 2) {
+          const objectName = path[0]!;
+          if (!(objectName in nullifyMap)) {
+            nullifyMap[objectName] =
+              value === null ? getTableName(field.table) : false;
+          } else if (
+            typeof nullifyMap[objectName] === 'string' &&
+            nullifyMap[objectName] !== getTableName(field.table)
+          ) {
+            nullifyMap[objectName] = false;
+          }
+          continue;
+        }
+
+        // may need to add a condition for non-Aliased SQL
+        if (
+          joinsNotNullableMap &&
+          is(field, SQL.Aliased) &&
+          path.length === 2
+        ) {
+          const col = field.sql.queryChunks.find((chunk) => is(chunk, Column));
+          const tableName = col?.table && getTableName(col?.table);
+
+          if (!tableName) {
+            continue;
+          }
+
+          const objectName = path[0]!;
+
+          if (!(objectName in nullifyMap)) {
+            nullifyMap[objectName] = value === null ? tableName : false;
+            continue;
+          }
+
+          if (nullifyMap[objectName] && nullifyMap[objectName] !== tableName) {
+            nullifyMap[objectName] = false;
+          }
+          continue;
+        }
+      }
+      return result;
+    },
+    {}
+  );
+
+  // Nullify all nested objects from nullifyMap that are nullable
+  if (joinsNotNullableMap && Object.keys(nullifyMap).length > 0) {
+    for (const [objectName, tableName] of Object.entries(nullifyMap)) {
+      if (typeof tableName === 'string' && !joinsNotNullableMap[tableName]) {
+        result[objectName] = null;
+      }
+    }
+  }
+
+  return result as TResult;
+}
+
+export function aliasFields(
+  fields: SelectedFields,
+  fullJoin = false
+): SelectedFields {
+  return Object.fromEntries(
+    Object.entries(fields)
+      .filter(([key]) => key !== 'enableRLS')
+      .map(([key, value]) => {
+        if (fullJoin && is(value, Column)) {
+          return [
+            key,
+            sql`${value}`.as(`${getTableName(value.table)}.${value.name}`),
+          ];
+        }
+
+        if (fullJoin && is(value, SQL)) {
+          const col = value
+            .getSQL()
+            .queryChunks.find((chunk) => is(chunk, Column));
+
+          const tableName = col?.table && getTableName(col?.table);
+
+          return [key, value.as(tableName ? `${tableName}.${key}` : key)];
+        }
+
+        if (is(value, SQL) || is(value, Column)) {
+          return [key, (is(value, SQL) ? value : sql`${value}`).as(key)];
+        }
+
+        if (is(value, SQL.Aliased)) {
+          return [key, value];
+        }
+
+        // todo: should probably make this recursive?
+        if (typeof value === 'object') {
+          const parentKey = key;
+
+          return [
+            key,
+            Object.fromEntries(
+              Object.entries(value)
+                .filter(([childKey]) => childKey !== 'enableRLS')
+                .map(([childKey, childValue]) => [
+                  childKey,
+                  (is(childValue, SQL) ? childValue : sql`${childValue}`).as(
+                    `${parentKey}.${childKey}`
+                  ),
+                ])
+            ),
+          ];
+        }
+
+        return [key, value];
+      })
+  );
+}
+
+// DuckDB names returned variables differently than Postgres
+// so we need to remap them to match the Postgres names
+
+const selectionRegex = /select\s+(.+)\s+from/i;
+// const tableIdPropSelectionRegex = /("(.+)"\."(.+)")(\s+as\s+'?(.+?)'?\.'?(.+?)'?)?/i;
+const tableIdPropSelectionRegex = new RegExp(
+  [
+    `("(.+)"\\."(.+)")`, // table identifier + property
+    `(\\s+as\\s+'?(.+?)'?\\.'?(.+?)'?)?`, // optional AS clause
+  ].join(''),
+  'i'
+);
+const noTableIdPropSelectionRegex = /"(.+)"(\s+as\s+'?\1'?)?/i;
+
+const tablePropRegex = /"(.+)"\."(.+)"/i;
+const asClauseRegex = /as\s+(.+)$/i;
+const aliasRegex = /as\s+'?(.+)'?\.'?(.+)'?$/i;
+
+/* Takes an SQL query as a string, and adds or updates "AS" clauses
+ * to the form: `AS 'table_name.column_name'`
+ * instead of : `AS "table_name"."column_name"`
+ */
+export function queryAdapter(query: string): string {
+  // Things to consider:
+  // - need to handle nested selects
+  // - what about full joins?
+  const selection = selectionRegex.exec(query);
+
+  if (selection?.length !== 2) {
+    return query;
+  }
+
+  const fields = selection[1].split(',').map((field) => {
+    const trimmedField = field.trim();
+
+    // - different scenarios:
+    //    - no table identifier + no AS clause -> ignore
+    //    - no table identifier + AS clause -> ensure AS clause format
+    //    - table identifier + no AS clause -> add AS clause
+    //    - table identifier + AS clause -> ensure AS clause format
+    const propSelection = tableIdPropSelectionRegex
+      .exec(trimmedField)
+      ?.filter(Boolean);
+
+    if (!propSelection) {
+      return trimmedField;
+    }
+  });
+
+  return query.replace(selection[1], fields.join(', '));
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleDetection": "force",
+    "isolatedModules": true, // need?
+    "composite": false, // need?
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+		"sourceMap": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true
+  }
+}