Repository files navigation

SQL editor support for formatting, syntax highlighting and code completion of SQL in cell magic, line magic, python string and file editor.

• JupyterLab >= 4.0.0

To install the extension, execute:

pip install jupyterlab_sql_editor[all]

To remove the extension, execute:

pip uninstall jupyterlab_sql_editor

Note: You will need NodeJS to build the extension package.

Thejlpm command is JupyterLab's pinned version ofyarn that is installed with JupyterLab. You may useyarn ornpm in lieu ofjlpm below.

# Clone the repo to your local environment# Change directory to the jupyterlab_sql_editor directory# Install package in development modepip install -e .[all]# Link your development version of the extension with JupyterLabjupyter labextension develop. --overwrite# Rebuild extension Typescript source after making changesjlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when neededjlpm watch# Run JupyterLab in another terminaljupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, thejlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

pip uninstall jupyterlab_sql_editor

In development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension list to figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyterlab-sql-editor within that folder.

SeeRELEASE