{"id":13608702,"url":"https://github.com/pbugnion/jupyterlab-sql","last_synced_at":"2025-04-06T01:09:01.580Z","repository":{"id":41333537,"uuid":"168674852","full_name":"pbugnion/jupyterlab-sql","owner":"pbugnion","description":"SQL GUI for JupyterLab","archived":false,"fork":false,"pushed_at":"2023-01-05T04:02:41.000Z","size":3485,"stargazers_count":420,"open_issues_count":57,"forks_count":52,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-30T00:07:21.042Z","etag":null,"topics":["database","jupyterlab","jupyterlab-extension","sql"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pbugnion.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-02-01T09:37:05.000Z","updated_at":"2025-03-17T23:36:30.000Z","dependencies_parsed_at":"2023-02-03T10:01:37.476Z","dependency_job_id":null,"html_url":"https://github.com/pbugnion/jupyterlab-sql","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbugnion%2Fjupyterlab-sql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbugnion%2Fjupyterlab-sql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbugnion%2Fjupyterlab-sql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pbugnion%2Fjupyterlab-sql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pbugnion","download_url":"https://codeload.github.com/pbugnion/jupyterlab-sql/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247419860,"owners_count":20936012,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","jupyterlab","jupyterlab-extension","sql"],"created_at":"2024-08-01T19:01:29.310Z","updated_at":"2025-04-06T01:09:01.563Z","avatar_url":"https://github.com/pbugnion.png","language":"TypeScript","readme":"[![Build](https://img.shields.io/github/workflow/status/pbugnion/jupyterlab-sql/Tests/master)](https://github.com/pbugnion/jupyterlab-sql/actions)\n[![Latest version released on PyPi](https://img.shields.io/pypi/v/jupyterlab-sql.svg?style=flat-square\u0026label=version)](https://pypi.python.org/pypi/jupyterlab-sql)\n\n# jupyterlab-sql\n\n*jupyterlab-sql* adds a SQL user interface to JupyterLab:\n\n- explore your tables with a point-and-click interface\n- read and modify your database with custom queries\n\n![](./readme-images/intro.gif)\n\n\n## Installation\n\n### Installing on JupyterLab 1.x\n\nTo install *jupyterlab-sql*, run the following commands:\n\n```\npip install jupyterlab_sql\njupyter serverextension enable jupyterlab_sql --py --sys-prefix\njupyter lab build\n```\n\nYou will then need to restart any running Jupyter servers.\n\n*jupyterlab-sql* only works with Python 3.5 and above.\n\n### JupyterLab legacy\n\nTo install jupyterlab-sql on versions of JupyterLab pre 1.0, run:\n\n```\npip install jupyterlab_sql==0.2.1\njupyter serverextension enable jupyterlab_sql --py --sys-prefix\njupyter lab build\n```\n\n## Usage\n\n### Starting a new SQL session\n\nThere is a SQL icon in the launcher (*File* \u003e *New Launcher*):\n\n![](./readme-images/launcher.png)\n\nYou can also launch a session from the command palette: search for *SQL*.\n\n### Formulating the connection URL\n\nThe connection URL needs to be a valid database URL. Follow the\n[SQLAlchemy guide](https://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls)\non database URLs.\n\n### Executing statements\n\nPress `shift` + `enter` or `ctrl` + `enter` while in the main query\narea to dispatch the statement.\n\n### Database support\n\n*jupyterlab-sql* is tested against SQLite,\nPostgreSQL, and MySQL databases.\n\nOther databases supported by sqlalchemy may also work.\n\nIf you need support for other types of databases, see [issue\n#113](https://github.com/pbugnion/jupyterlab-sql/issues/113).\n\n### In-memory SQLite and persistence\n\nThe lifetime of a SQLite in-memory database is tied to the lifetime\nof the Jupyter server. Restarting the Jupyter server will clear any\ndata in your in-memory database.\n\n## Issue reporting and contributing\n\nReport issues using the [issue\ntracker](https://github.com/pbugnion/jupyterlab-sql/issues).\n\nContributions are welcome. If you have not developed JupyterLab\nextensions before, I recommend following [this\ntutorial](https://jupyterlab.readthedocs.io/en/stable/developer/xkcd_extension_tutorial.html).\n\n## Contributors\n\n*jupyterlab-sql* is maintained by Pascal Bugnion ([@pbugnion](https://github.com/pbugnion)) with\n contributions from:\n\n- Ashwin Chopra ([@shwinnn](https://github.com/shwinnn))\n\n*jupyterlab-sql* is built and maintained by people who give their time (in many cases, their free time) to the project.\n\n### I would like to join this list. How can I help?\n\nWe are currently looking for contributions of:\n\n- code: if you are unsure how to start, open an issue or email [Pascal Bugnion](https://pascalbugnion.net/contact.html).\n- additional database support: see [issue #113](https://github.com/pbugnion/jupyterlab-sql/issues/113).\n","funding_links":[],"categories":["JupyterLab Extensions","JupyterLab扩展","sql"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpbugnion%2Fjupyterlab-sql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpbugnion%2Fjupyterlab-sql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpbugnion%2Fjupyterlab-sql/lists"}