DuckDB Terminal - v0.6.0
    Preparing search index...

    Interface TerminalConfig

    Configuration options for creating a DuckDB terminal.

    const config: TerminalConfig = {
      container: '#terminal',
    };

    const config: TerminalConfig = {
      container: document.getElementById('terminal'),
      fontFamily: 'JetBrains Mono',
      fontSize: 16,
      theme: 'dark',
      storage: 'opfs',
      databasePath: '/mydata.duckdb',
      maximumThreads: 1,
      welcomeMessage: true,
      prompt: 'SQL> ',
      continuationPrompt: '... ',
      linkDetection: true,
      exactRowCount: false,
    };
    interface TerminalConfig {
        container: string | HTMLElement;
        continuationPrompt?: string;
        databasePath?: string;
        duckdbBundles?: DuckDBBundles;
        enableCharts?: boolean;
        exactRowCount?: boolean;
        fontFamily?: string;
        fontSize?: number;
        linkDetection?: boolean;
        maxDisplayRows?: number;
        maximumThreads?: number;
        prompt?: string;
        scrollback?: number;
        storage?: "memory" | "opfs";
        theme?: Theme | "dark" | "light";
        welcomeMessage?: boolean;
    }
    Index
    container continuationPrompt? databasePath? duckdbBundles? enableCharts? exactRowCount? fontFamily? fontSize? linkDetection? maxDisplayRows? maximumThreads? prompt? scrollback? storage? theme? welcomeMessage?
    container: string | HTMLElement

    The container element or CSS selector where the terminal will be mounted. Can be an HTMLElement or a CSS selector string (e.g., '#terminal', '.container').

    continuationPrompt?: string

    The continuation prompt displayed for multi-line SQL statements.

    '  > '
    databasePath?: string

    The database file path when using OPFS storage. Only used when storage is 'opfs'.

    duckdbBundles?: DuckDBBundles

    DuckDB-Wasm bundle manifest used during feature-based bundle selection. A manifest with a coi entry is required when maximumThreads is greater than 1.

    enableCharts?: boolean

    Enable the charts feature (.chart command). When enabled, uPlot is loaded from CDN on first use.

    false
    exactRowCount?: boolean

    Compute an exact result row count before fetching the first page. This can substantially increase work for expensive queries and is disabled by default.

    false
    fontFamily?: string

    Font family for the terminal text.

    '"Fira Code", "Cascadia Code", "JetBrains Mono", Consolas, monospace'
    fontSize?: number

    Font size in pixels.

    14
    linkDetection?: boolean

    Whether to automatically detect and make URLs clickable in output.

    true
    maxDisplayRows?: number

    Maximum number of rows displayed in a single terminal result page. The terminal starts with this page size, and .pagesize 0 resets to it.

    1000
    maximumThreads?: number

    Maximum number of DuckDB execution threads.

    Values greater than 1 require duckdbBundles with a compatible COI bundle and a cross-origin-isolated page. Multithreading remains opt-in to avoid downloading the larger experimental bundle by default.

    1
    prompt?: string

    The primary prompt string displayed before each command.

    '🦆 '
    scrollback?: number

    Scrollback buffer size in bytes. Larger values allow more history but use more memory.

    10485760 (10MB)
    storage?: "memory" | "opfs"

    The storage backend for the database.

    • 'memory': In-memory storage (data lost on page refresh)
    • 'opfs': Origin Private File System (persistent storage)
    'memory'
    theme?: Theme | "dark" | "light"

    The color theme for the terminal. Can be 'dark', 'light', or a custom Theme object.

    'dark'
    welcomeMessage?: boolean

    Whether to display the welcome message on startup.

    true

    Settings
    Member Visibility

    On This Page
    Properties