Package: jupyterlab-sql-explorer
jupyterlab-sql-explorerjupyterlab-sql-explorer is an extensible JupyterLab plugin that enables users to run SQL statements and navigate database objects within JupyterLab. Here are its main features:Browse and navigate data objects such as tables and views using a tree structure. This capability is particularly useful for data analysts who need to understand the underlying data organization.Run SQL statements directly in JupyterLab and view the returned results.Support for multiple databases, including MySQL, PostgreSQL, Hive, SQLite, ORACLE, and more.Edit annotations for data objects and support for both local and shared modes. With jupyterlab-sql-explorer, users can add annotations to data objects such as tables and views. This feature is especially valuable for data analysts working in teams, as it facilitates collaboration and knowledge sharing around specific data assets.UsageAdd Database ConnctionWhen using for the first time, open the dialog box to add a data connection by selecting "Database->New Connection" from the menu.Edit Comments:To edit the comments of data objects, you can right-click on the corresponding connection, table, or column in the database navigation tree and select the "Edit Comment" option. This will open an editing box that allows you to add or modify the comment content.Share Comments:By default, comments are saved locally. If you need to share comments within a team, you must follow these steps:In $HOME/.jupyter/jupyter_notebook_config.py (on Windows %USERPROFILE%/.jupyter/jupyter_notebook_config.py), add or modify the following line:c.JupyterLabSqlExplorer.comments_store='database::your_database_connection_string'Replace 'your_database_connection_string' with the database connection string you have configured. For example, if you are using a MySQL database, the connection string may look like this:c.JupyterLabSqlExplorer.comments_store='database::mysql+pymysql://root:12345@192.168.1.100:3306/data'This will store the comments in a MySQL database. You can choose to use other types of databases as needed.Ensure that each team member follows the steps mentioned above to modify the configuration and restart. This will enable the sharing of comments among team members.RequirementsJupyterLab >= 3.2sqlalchemy >1.4 <2.0InstallTo install the extension, execute:pipinstalljupyterlab-sql-exploreror install with special database driver,pipinstalljupyterlab-sql-explorer[hive]UninstallTo remove the extension, execute:pipuninstalljupyterlab-sql-explorerTroubleshootIf you are seeing the frontend extension, but it is not working, check
that the server extension is enabled:jupyterserverextensionlistIf the server extension is installed and enabled, but you are not seeing
the frontend extension, check the frontend extension is installed:jupyterlabextensionlistContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab-sql-explorer directory# Install package in development modepipinstall-e".[test]"# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Server extension must be manually installed in develop modejupyterserverextensionenablejupyterlab-sql-explorer# Rebuild extension Typescript source after making changesjlpmbuildYou 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 neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith 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 buildcommand 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:jupyterlabbuild--minimize=FalseDevelopment uninstall# Server extension must be manually disabled in develop modejupyterserverextensiondisablejupyterlab-sql-explorer
pipuninstalljupyterlab-sql-explorerIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyterlab-sql-explorerwithin that folder.Testing the extensionServer testsThis extension is usingPytestfor Python code testing.Install test dependencies (needed only once):pipinstall-e".[test]"# Each time you install the Python package, you need to restore the front-end extension linkjupyterlabextensiondevelop.--overwriteTo execute them, run:pytest-vv-rap--covjupyterlab-sql-explorerFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension uses Playwright for the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE