jupysql-plugin

library0.4.5pypypi✓ verified 85d ago

JupyterLab extension for JupySQL, providing a graphical interface for SQL queries in notebooks. Current version 0.4.5, released sporadically with minor updates.

database data

pip install jupysql-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · JUPYSQL-PLUGIN

jupysql-plugin

databasepythonv0.4.5

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

jupysql_plugin

✓ import jupysql_plugin

✗ from jupysql import plugin

Module is installed as a separate package, not part of jupysql

After installation, reload the page, specify connection string, and run a query.

import jupysql_plugin %load_ext sql import os db_url = os.environ.get('DATABASE_URL', 'sqlite://') %sql $db_url %sql SELECT 1 as test;

Debug

Known issues

gotchaPlugin must be installed in the same environment as JupyterLab. Installing via pip outside the active Jupyter environment will not work.

fix

Install jupysql-plugin in the JupyterLab kernel's Python environment.

affects: all

gotchaJupyterLab 4 is not supported; only JupyterLab 3.x works.

fix

Use JupyterLab 3 or downgrade: conda install jupyterlab=3

affects: all

deprecatedThe plugin's SQL editor UI may break with newer versions of JupySQL (>=0.10). Compatibility is not guaranteed.

fix

Keep jupysql at version <0.10 or check for plugin updates.

affects: 0.4.x

breakingPlugin version 0.3.0 changed the extension name from 'jupysql-plugin' to 'jupysql_plugin' in some contexts. Old configurations may not work.

fix

Re-enable the extension: jupyter labextension enable jupysql_plugin

affects: >=0.3.0

Errors

Common errors & fixes

JupyterLab extension 'jupysql_plugin' is not installed

Extension not enabled after installation or not built.

fix

Run: jupyter labextension enable jupysql_plugin

ModuleNotFoundError: No module named 'jupysql_plugin'

Package not installed in the Jupyter kernel's Python environment.

fix

Install in the correct environment: pip install jupysql-plugin

Error: This extension does not support JupyterLab 4

JupyterLab 4 is not compatible.

fix

Downgrade to JupyterLab 3: conda install jupyterlab=3

Upgrade

Version history

0.4.5latest on PyPI · released Sep 5, 2024

Audit

Dependencies

jupysqlrequiredCore query engine, required for plugin functionality

jupyterlabrequiredPlugin is a JupyterLab extension, version 3.x required

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/ploomber/jupysql-plugin.git ↗

packagehttps://pypi.org/project/jupysql-plugin/ ↗