---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: sqlnb
excerpt: |
  DuckDB Community Extensions
  Local SQL notebooks in your browser, backed by your DuckDB session

extension:
  name: sqlnb
  description: Local SQL notebooks in your browser, backed by your DuckDB session
  version: 0.1.0
  language: C++ and Rust
  build: cmake
  license: MIT
  requires_toolchains: rust
  excluded_platforms: "wasm_mvp;wasm_eh;wasm_threads;windows_amd64_mingw;windows_amd64_rtools"
  opt_in_platforms: osx_amd64
  maintainers:
    - nicosuave

repo:
  github: sidequery/sqlnb-extension
  ref: f9adda39f49b01af8d2454f426ddf6396cb029c2

docs:
  hello_world: |
    install sqlnb from community;
    load sqlnb;
    select sqlnb_start();

  extended_description: |
    Write SQL, explore query results, and build charts in a notebook connected to
    your local DuckDB database. Open and save notebook files, browse your tables,
    and revisit earlier versions with built-in notebook history.

    SQLNB can also open, edit, and save existing notebooks from the official
    DuckDB UI extension.

    Run `select sqlnb_start();` to open SQLNB in your browser. Keep your DuckDB
    session open while you work.

    See the [project documentation](https://github.com/sidequery/sqlnb-extension)
    for configuration and connecting AI tools through MCP.

extension_star_count: 0
extension_star_count_pretty: 0
extension_download_count: null
extension_download_count_pretty: n/a
image: '/images/community_extensions/social_preview/preview_community_extension_sqlnb.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 |
|---------------------------|---------------|-------------|---------|----------|
| sidequery_ui_start        | scalar        | NULL        | NULL    |          |
| sidequery_ui_status       | scalar        | NULL        | NULL    |          |
| sidequery_ui_stop         | scalar        | NULL        | NULL    |          |
| sqlnb_duckdb_ui_create    | scalar        | NULL        | NULL    |          |
| sqlnb_duckdb_ui_delete    | scalar        | NULL        | NULL    |          |
| sqlnb_duckdb_ui_duplicate | scalar        | NULL        | NULL    |          |
| sqlnb_duckdb_ui_notebook  | scalar        | NULL        | NULL    |          |
| sqlnb_duckdb_ui_notebooks | scalar        | NULL        | NULL    |          |
| sqlnb_duckdb_ui_save      | scalar        | NULL        | NULL    |          |
| sqlnb_is_read_only        | scalar        | NULL        | NULL    |          |
| sqlnb_read_query          | table         | NULL        | NULL    |          |
| sqlnb_start               | scalar        | NULL        | NULL    |          |
| sqlnb_status              | scalar        | NULL        | NULL    |          |
| sqlnb_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 |