jupysql-plugin

What it is and what it does

jupysql-plugin is a JupyterLab extension that brings SQL query capabilities into the notebook interface. It acts as a frontend for JupySQL, allowing you to write and execute SQL queries directly in JupyterLab 4 without leaving the notebook environment. The extension is built as a prebuilt JupyterLab extension and depends only on ploomber-core, making it lightweight to install.

The package is designed for data exploration and querying workflows within Jupyter. It supports Python 3.7 through 3.11 and integrates with the JupyterLab ecosystem. However, the project has been dormant, meaning it may not have been tested against the most recent JupyterLab releases and could require manual updates or workarounds if you are using a very recent version.

Use it for:

• Execute SQL queries against connected databases directly from a JupyterLab notebook without switching tools.
• Explore database schemas and run ad-hoc queries as part of a data analysis workflow.
• Integrate SQL-based data retrieval into reproducible notebook-based analyses.
• Prototype data pipelines that combine SQL queries with Python processing in a single environment.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A JupyterLab 4 extension that integrates JupySQL into the notebook environment, enabling SQL query execution and data exploration directly within JupyterLab.

Yes, if you use JupyterLab 4 and want SQL query capabilities in your notebook. The low install friction and minimal dependencies make it a straightforward addition. However, proceed with caution: dormancy means the extension may not be compatible with very recent JupyterLab updates. Test it in your environment first, or consider whether an alternative maintained extension better suits your needs.

Install

jupysql-plugin on PyPI

pip install jupysql-plugin

uv add jupysql-plugin

poetry add jupysql-plugin

Installing jupysql-plugin

Before you install

Low friction installation via pip. The package is dormant, but the repository remains active and unarchived. Depends only on ploomber-core, keeping the dependency footprint minimal.

License in practice

BSD 3-Clause License permits commercial and private use with minimal restrictions; you must retain copyright notice and license text in distributions.

Quickstart

pip install jupysql-plugin

# Then restart JupyterLab; the extension activates automatically
# Verify installation:
jupyter labextension list

Requires JupyterLab 4 (0.4.x or higher); the main branch is not compatible with JupyterLab 3. Requires Python 3.7 or later.

Verify before relying

• Whether dormancy since last release indicates active maintenance or signals compatibility issues with recent JupyterLab versions.
• Whether ploomber-core introduces transitive dependencies or system requirements not listed in the fact sheet.
• Specific SQL dialects and database backends supported by the extension.

Package facts

Evidence: jupysql_plugin-0.4.5-py3-none-any.whl

Tags

More Front-Ends packages