---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: duckdbi
excerpt: |
  DuckDB Community Extensions
  Browser-based BI dashboard extension for DuckDB. Run SQL queries and build interactive dashboards with drag-and-drop charts, all from the DuckDB CLI.

extension:
  name: duckdbi
  description: Browser-based BI dashboard extension for DuckDB. Run SQL queries and build interactive dashboards with drag-and-drop charts, all from the DuckDB CLI.
  version: 0.1.0
  language: C++
  build: cmake
  license: MIT
  requires_toolchains: ""
  maintainers:
    - nkwork9999

repo:
  github: nkwork9999/DuckDBI
  ref: 87e34e337b32352f7b83a47345afde8a2f0d0682

docs:
  hello_world: |
    -- Load the extension
    LOAD duckdbi;

    -- Start the BI server on port 8080
    SELECT duckdbi_start('localhost', 8080);

    -- Open http://localhost:8080 in your browser
    -- Write SQL, create charts, build dashboards

    -- Stop the server when done
    SELECT duckdbi_stop();

  extended_description: |
    DuckDBI turns DuckDB into a local BI server. The extension embeds a full single-page application
    with a simple SQL query and results screen. Advanced dashboards and reports are available at `/advanced`.

    **Core Features**:
    - SQL query editor with JSON result rendering
    - Interactive charts powered by Plotly.js (Bar, Line, Scatter, Area, 3D Scatter)
    - Drag-and-drop dashboard layout via Gridstack.js
    - PDF export with jsPDF and html2canvas
    - Markdown query-column previews on both routes, with HTML/link sanitization
    - English, Simplified Chinese, and Japanese interface controls
    - Markdown reports via Marked.js

    **Functions**:
    - `duckdbi_start(host, port)` - Start the HTTP server and open the dashboard UI
    - `duckdbi_stop()` - Stop the running server

    **Architecture**:
    The extension bundles an HTTP server (cpp-httplib) and a complete SPA as a compiled-in
    string literal. The `/api/query` endpoint executes SQL against the attached DuckDB database
    and returns JSON results to the browser frontend. No external server or setup required.

extension_star_count: 5
extension_star_count_pretty: 5
extension_download_count: 706
extension_download_count_pretty: 706
image: '/images/community_extensions/social_preview/preview_community_extension_duckdbi.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ❌ | ✅ | ❌ | ❌ | ✅ |
| Linux ARM64 | ❌ | ✅ | ❌ | ❌ | ✅ |
| macOS AMD64 | ❌ | ✅ | ❌ | ❌ | ✅ |
| macOS ARM64 | ❌ | ✅ | ❌ | ❌ | ✅ |
| Windows AMD64 | ❌ | ✅ | ❌ | ❌ | ✅ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ✅ | ❌ | ❌ | ✅ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

| function_name | function_type | description | comment | examples |
|---------------|---------------|-------------|---------|----------|
| duckdbi_start | scalar        | NULL        | NULL    |          |
| duckdbi_stop  | scalar        | NULL        | NULL    |          |

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

|      name      |                       description                       | input_type | scope  | aliases | typed_value |
|----------------|---------------------------------------------------------|------------|--------|---------|-------------|
| temp_directory | Set the directory to which temporary files are written. | VARCHAR    | GLOBAL | []      | post.db.tmp |