Configuration Options

Learn how to customize SQL Workbench Embedded for your needs

Global Configuration

Configure SQL Workbench globally using SQLWorkbench.config(). This affects all instances on your page.

Basic Global Configuration

basic-config.js

Initialization Queries

Use initQueries to run setup queries once before user queries. Perfect for loading extensions, setting configurations, or creating UDFs.

init-queries.js

Per-Instance Configuration

Override global settings for individual embedded instances.

HTML Attributes

per-instance.html

Programmatic Instantiation

programmatic.js

Advanced Configuration

Custom CDN and Base URL

Specify custom CDN sources and base URLs for your deployment.

advanced-config.js

Complete Configuration Example

complete-config.js

Configuration Reference

OptionTypeDefaultDescription
selectorstring'pre.sql-workbench-embedded'CSS selector for auto-discovery
baseUrlstringwindow.location.originBase URL for relative file paths
themestring'auto''light', 'dark', 'auto', or custom theme name
autoInitbooleantrueAuto-initialize on DOMContentLoaded
duckdbVersionstring'1.31.1-dev1.0'DuckDB WASM version to use
duckdbCDNstringjsdelivrCDN source for DuckDB WASM
editablebooleantrueAllow SQL code editing
showOpenButtonbooleantrueDisplay "Open in SQL Workbench" button
initQueriesstring[][]Setup queries executed once before user queries