API Reference

Complete API documentation for Drizzle DuckDB.

Main Exports

• drizzle(): create a database instance
• DuckDBDatabase: database class methods
• Column Types: all column type helpers
• Array Helpers: array query functions
• OLAP Helpers: aggregate helpers and MotherDuck table functions
• migrate(): run migrations
• introspect(): generate schema from an existing database

Other Exports

• createDuckDBConnectionPool(): build a pool by hand. See Connection Pooling
• createPgDuckConnectionPool(): wrap a pg.Pool for pg_duckdb. drizzle() does this for you when you pass a pg.Pool
• configureDuckLake(): attach a DuckLake catalog on a single connection. See DuckLake
• DuckDBDialect: the dialect class. new DuckDBDialect().sqlToQuery(query) renders SQL the way the driver sends it, without a connection
• DuckDBSelectBuilder: the type that db.select() returns
• DuckDbMigrationConfig: the type of the migrate() config argument

---

Table of contents

• drizzle()
• DuckDBDatabase
• Column Types
• Array Helpers
• migrate()
• introspect()
• OLAP Helpers