Adapters

adapters

DuckDB

Explore a local DuckDB database, run SQL, and manage extensions.

Setup

For a persistent database, use method: file with a path on the DSUI server filesystem. Mount the directory into the container first.

services:
  - id: warehouse
    adapter: duckdb
    name: Analytics warehouse
    connection:
      method: file
      path: /data/warehouse.duckdb

For a disposable database, use method: memory.

connection:
  method: memory
  readOnly: false

Available

  • Browse databases, schemas, tables, views, indexes, functions, and types
  • Preview data and inspect DDL
  • Run and cancel SQL queries
  • Create schemas, tables, views, and indexes
  • Attach databases and import data
  • Install, load, and manage extensions
  • Create secrets and work with notebooks

Signals

Running a query from DSUI emits duckdb.query-succeeded or duckdb.query-failed, with the operation, duration, and row count or error code. Query text is not included. DuckDB’s query history is maintained by DSUI, so queries launched outside DSUI do not emit these signals.

Not yet available

  • Multi-user database access control
  • A managed DuckDB server
  • Full coverage of every DuckDB extension and remote storage provider

The file path is evaluated by DSUI, not by your browser. Mount the directory into the DSUI container before using a file-backed database.