{"id":13928818,"url":"https://github.com/jupyter-xeus/xeus-sql","last_synced_at":"2025-04-04T13:09:30.773Z","repository":{"id":43156241,"uuid":"317675653","full_name":"jupyter-xeus/xeus-sql","owner":"jupyter-xeus","description":"Jupyter kernel for SQL databases","archived":false,"fork":false,"pushed_at":"2024-12-16T08:46:03.000Z","size":4801,"stargazers_count":169,"open_issues_count":20,"forks_count":23,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-03-28T12:05:43.531Z","etag":null,"topics":["db2","firebird","mysql","odbc","postgresql","sql","sqlite"],"latest_commit_sha":null,"homepage":"https://xeus-sql.readthedocs.io/en/latest/","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jupyter-xeus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-12-01T21:44:25.000Z","updated_at":"2025-02-01T18:57:34.000Z","dependencies_parsed_at":"2025-01-19T00:31:56.104Z","dependency_job_id":null,"html_url":"https://github.com/jupyter-xeus/xeus-sql","commit_stats":{"total_commits":137,"total_committers":8,"mean_commits":17.125,"dds":0.416058394160584,"last_synced_commit":"4189a98992195f7021aab9bc07aeb9227d8b8a33"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-xeus%2Fxeus-sql","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-xeus%2Fxeus-sql/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-xeus%2Fxeus-sql/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jupyter-xeus%2Fxeus-sql/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jupyter-xeus","download_url":"https://codeload.github.com/jupyter-xeus/xeus-sql/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247182338,"owners_count":20897379,"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":["db2","firebird","mysql","odbc","postgresql","sql","sqlite"],"created_at":"2024-08-07T18:01:49.614Z","updated_at":"2025-04-04T13:09:30.718Z","avatar_url":"https://github.com/jupyter-xeus.png","language":"C++","funding_links":[],"categories":["mysql","C++"],"sub_categories":[],"readme":"# xeus-sql\n[![GithubActions](https://github.com/jupyter-xeus/xeus-sql/actions/workflows/main.yml/badge.svg)](https://github.com/jupyter-xeus/xeus-sql/actions/workflows/main.yml)\n[![Join the chat at https://gitter.im/QuantStack/Lobby](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/QuantStack/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![Documentation Status](https://readthedocs.org/projects/xeus-sql/badge/?version=latest)](https://xeus-sql.readthedocs.io/en/latest/?badge=latest)\n[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyter-xeus/xeus-sql/stable?urlpath=lab/tree/examples/SQLite.ipynb)\n\n`xeus-sql` is a Jupyter kernel for general SQL implementations based on the native implementation of the Jupyter protocol [xeus](https://github.com/jupyter-xeus/xeus) and [SOCI](https://github.com/SOCI/soci), a database access library for C++.\n\n![xeus-sql screencast](xeus-sql-screencast.gif)\n\n## Usage\n\nLaunch the Jupyter notebook with `jupyter notebook` or Jupyter lab with `jupyter lab` and launch a new SQL notebook by selecting the **xsql** kernel.\n\nNote that `xeus-sql` support the following SQL implementations:\n\n* DB2\n* Firebird\n* MySQL\n* ODBC (generic backend)\n* Oracle\n* PostgreSQL\n* SQLite3\n\n## Installation\n\n`xeus-sql` has been packaged for the mamba (or conda) package manager.\n\nTo ensure that the installation works, it is preferable to install `xeus-sql` in a fresh environment.\n\nTo ensure that the installation works, it is preferable to install `xeus` in a fresh environment. It is also needed to use\na [miniforge](https://github.com/conda-forge/miniforge#mambaforge) or [miniconda](https://conda.io/miniconda.html) installation because with the full [anaconda](https://www.anaconda.com/)\nyou may have a conflict.\n\nThe safest usage is to create an environment named `xeus-sql`\n\n```\nmamba create -n xeus-sql\nsource activate xeus-sql\n```\n\n### Installing from conda-forge\n\nTo install xeus-sql with the mamba (or conda) package manager:\n\n```\nmamba install xeus-sql jupyterlab -c conda-forge\n```\n\nWith mamba:\n\n```\nmamba install xeus-sql jupyterlab -c conda-forge\n```\n\nConda forge offers packaged versions for MySQL, PostgreSQL and SQLite and you can download them with: `soci-mysql`, `soci-postgresql` or `soci-sqlite`.\n\n`xeus-sql` includes `soci-core` only. Which consists on the SOCI package with no DB extension attached.\n\n## Documentation\n\nhttps://xeus-sql.readthedocs.io/en/latest/\n\n## Dependencies\n\n``xeus-sql`` depends on\n\n- [xeus](https://github.com/jupyter-xeus/xeus)\n- [Tabulate](https://github.com/p-ranav/tabulate)\n- [xvega](https://github.com/Quantstack/xvega)\n- [SQLite\\*](https://github.com/sqlite/sqlite)\n- [PostgreSQL\\*](https://github.com/postgres)\n- [MySQL\\*](https://github.com/mysql/mysql-server)\n\n##### xeus dependencies\n\n| `xeus-sql` | `xeus-zmq`      | `tabulate`     | `nlohmann_json`    | `xproperty` | `xvega-bindings` | `soci-core` |\n|------------|-----------------|----------------|--------------------|-------------|------------------|-------------|\n| main       | \u003e=3.1.0, \u003c4.0   | \u003e=1.4\\|\u003e=3.0.0 | \u003e= 0.0.10, \u003c3.10.0 | \u003e=0.11.0    | \u003e=0.0.10         | \u003e=4.0.1     |\n| 0.3.0      | \u003e=3.1.0, \u003c4.0   | \u003e=1.4\\|\u003e=3.0.0 | \u003e= 0.0.10, \u003c3.10.0 | \u003e=0.11.0    | \u003e=0.0.10         | \u003e=4.0.1     |\n| 0.2.1      | \u003e=1.0.1, \u003c2.0   | \u003e=1.4\\|\u003e=3.0.0 | \u003e= 0.0.10, \u003c3.10.0 | \u003e=0.11.0    | \u003e=0.0.10         | \u003e=4.0.1     |\n| 0.2.0      | \u003e=1.0.1, \u003c2.0   | \u003e=1.4\\|\u003e=3.0.0 | \u003e= 0.0.10, \u003c3.10.0 | \u003e=0.11.0    | \u003e=0.0.10         | \u003e=4.0.1     |\n\nPrior to version 0.2, xeus-sql was depending on\n\n| `xeus-sql` | `xeus`          | `tabulate`     | `nlohmann_json`    | `xproperty` | `xvega-bindings` | `soci-core` |\n|------------|-----------------|----------------|--------------------|-------------|------------------|-------------|\n| \u003c=0.1.5    | \u003e=2.0.0, \u003c3.0   | \u003e=1.4\\|\u003e=3.0.0 | \u003e= 0.0.10, \u003c3.10.0 | \u003e=0.10.4    | \u003e=0.0.10         | \u003e=4.0.1     |\n| \u003c=0.1.2    | \u003e=1.0.0, \u003c2.0   | \u003e=1.4\\|\u003e=3.0.0 | \u003e= 0.0.10 \\| 4.0.1 | \u003e=0.10.4    | \u003e=0.0.10         | \u003e=4.0.1     |\n| \u003c=0.0.6    | \u003e=0.24.0, \u003c0.25 | \u003e=1.4\\|\u003e=3.0.0 | \u003e= 0.0.5 \\| 4.0.1  | \u003e=0.10.4    | \u003e=0.0.3          | \u003e=4.0.1     |\n\n##### SQL dependencies\n\nThese are optional dependencies that come by default with `xeus-sql` but may or may not be added to your project in case you're building manually. For more information check the CONTRIBUTING file.\n\n| `xeus-sql` | `PostgreSQL` | `SQLite`    | `MySQL`      | `soci-sqlite`, `soci-postgres`, `soci-mysql` |\n|------------|--------------|-------------|--------------|----------------------------------------------|\n| main       | \u003e=3.30.1, \u003c4 | \u003e=3.0.0, \u003c4 | \u003e=1.3.0,\u003c2.0 | \u003e=4.0.1                                      |\n| \u003c=0.1.5    | \u003e=3.30.1, \u003c4 | \u003e=3.0.0, \u003c4 | \u003e=1.3.0,\u003c2.0 | \u003e=4.0.1                                      |\n\n## Contributing\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) to know how to contribute and set up a development environment.\n\n## License\n\nWe use a shared copyright model that enables all contributors to maintain the\ncopyright on their contributions.\n\nThis software is licensed under the BSD-3-Clause license. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyter-xeus%2Fxeus-sql","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjupyter-xeus%2Fxeus-sql","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjupyter-xeus%2Fxeus-sql/lists"}