# SQLab
An SQLab adventure is a text-based game where the player evolves through a series of isolated or interconnected puzzles by crafting SQL queries.
It consists in a standalone database encompassing the core dataset, a handful of stored procedures, and a table of encrypted messages (such as narrative elements, puzzle statements, answers, explanations, etc.).
There is no requirement to wrap a dedicated application around this database to “run” the game. It can be played on any generic GUI such as [DBeaver](https://dbeaver.io), [phpMyAdmin](https://www.phpmyadmin.net), [pgAdmin](https://www.pgadmin.org), or directly in a command-line interface.
Each question comes with a unique formula, for example, `salt_042(sum(hash) OVER ())`. Appended to the `SELECT` clause, this formula calculates a decryption token, which may unlock the next episode or, if the query is incorrect, a tailored hint (assuming the game's creator has provided one).
In an educational context, this setup enables the students to learn and practice SQL without constant oversight. The instructor might stave off boredom by logging their queries and injecting new hints as needed, improving the game for all involved.
## Examples on GitHub
| Game | Pitch | Versions | DBMS | Included |
| --- | --- | --- | --- | --- |
| [SQLab Island](https://github.com/laowantong/sqlab_island) | An adaptation of [SQL Island](https://sql-island.informatik.uni-kl.de) by Johannes Schildgen | English | MySQL, PostgreSQL, SQLite | Sources + SQLab database |
| [SQLab Sessform](https://github.com/laowantong/sqlab_sessform) | A set of independent exercises + _Mortelles Sessions_, a police investigation on a training company | French | MySQL, PostgresQL | SQLab database |
| SQLab Club | An adaptation of [PostgreSQL Exercises](https://pgexercises.com) by Alisdair Owens | English | PostgreSQL | Sources + SQLab database (coming later) |
| SQLab Corbeau | An original adaptation of the movie [_Le Corbeau_](https://fr.wikipedia.org/wiki/Le_Corbeau_(film,_1943)) by Henri-Georges Clouzot (1943) | French | MySQL | SQLab database (coming later) |
## How can I create my own SQLab adventure?
The `sqlab` command-line tool is not required to play, but is necessary to create a new adventure.
```
pip install sqlab
```
The documentation is not yet available. In the meantime, you may explore the repository of [SQLab Island](https://github.com/laowantong/sqlab_island). The provided dataset and Jupyter notebooks serve as source material for the generation of the SQLab database.
Raw data
{
"_id": null,
"home_page": "https://github.com/laowantong/sqlab/",
"name": "sqlab",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.0",
"maintainer_email": null,
"keywords": "education, relational, database, sql, games",
"author": "Aristide Grange",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e9/bd/f3d9606c17293b72a10be763f34d41f535bfe02a86982b0486365bc569df/sqlab-0.5.5.tar.gz",
"platform": null,
"description": "# SQLab\n\n\n\nAn SQLab adventure is a text-based game where the player evolves through a series of isolated or interconnected puzzles by crafting SQL queries.\n\nIt consists in a standalone database encompassing the core dataset, a handful of stored procedures, and a table of encrypted messages (such as narrative elements, puzzle statements, answers, explanations, etc.).\n\nThere is no requirement to wrap a dedicated application around this database to \u201crun\u201d the game. It can be played on any generic GUI such as [DBeaver](https://dbeaver.io), [phpMyAdmin](https://www.phpmyadmin.net), [pgAdmin](https://www.pgadmin.org), or directly in a command-line interface.\n\nEach question comes with a unique formula, for example, `salt_042(sum(hash) OVER ())`. Appended to the `SELECT` clause, this formula calculates a decryption token, which may unlock the next episode or, if the query is incorrect, a tailored hint (assuming the game's creator has provided one).\n\nIn an educational context, this setup enables the students to learn and practice SQL without constant oversight. The instructor might stave off boredom by logging their queries and injecting new hints as needed, improving the game for all involved.\n\n## Examples on GitHub\n\n| Game | Pitch | Versions | DBMS | Included |\n| --- | --- | --- | --- | --- |\n| [SQLab Island](https://github.com/laowantong/sqlab_island) | An adaptation of [SQL Island](https://sql-island.informatik.uni-kl.de) by Johannes Schildgen | English | MySQL, PostgreSQL, SQLite | Sources + SQLab database |\n| [SQLab Sessform](https://github.com/laowantong/sqlab_sessform) | A set of independent exercises + _Mortelles Sessions_, a police investigation on a training company | French | MySQL, PostgresQL | SQLab database |\n| SQLab Club | An adaptation of [PostgreSQL Exercises](https://pgexercises.com) by Alisdair Owens | English | PostgreSQL | Sources + SQLab database (coming later) |\n| SQLab Corbeau | An original adaptation of the movie [_Le Corbeau_](https://fr.wikipedia.org/wiki/Le_Corbeau_(film,_1943)) by Henri-Georges Clouzot (1943) | French | MySQL | SQLab database (coming later) |\n\n## How can I create my own SQLab adventure?\n\nThe `sqlab` command-line tool is not required to play, but is necessary to create a new adventure.\n\n```\npip install sqlab\n```\n\nThe documentation is not yet available. In the meantime, you may explore the repository of [SQLab Island](https://github.com/laowantong/sqlab_island). The provided dataset and Jupyter notebooks serve as source material for the generation of the SQLab database.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "SQL Adventure Builder: a command line tool for creating standalone SQL activities.",
"version": "0.5.5",
"project_urls": {
"Homepage": "https://github.com/laowantong/sqlab/",
"Repository": "https://github.com/laowantong/sqlab/",
"issues": "https://github.com/laowantong/sqlab/issues"
},
"split_keywords": [
"education",
" relational",
" database",
" sql",
" games"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6064220e372a81ebde46969398f4ce524ccd705c4bca1038a4d32eab7a021d54",
"md5": "79cfd5231d6f0ff6e2bcbce0050cc5c9",
"sha256": "49e7ee3ef2aa5a083bf437c5e70a814db59a34b46acaf7d2a71a982a60a0faa1"
},
"downloads": -1,
"filename": "sqlab-0.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "79cfd5231d6f0ff6e2bcbce0050cc5c9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.0",
"size": 46693,
"upload_time": "2024-06-10T17:35:19",
"upload_time_iso_8601": "2024-06-10T17:35:19.520073Z",
"url": "https://files.pythonhosted.org/packages/60/64/220e372a81ebde46969398f4ce524ccd705c4bca1038a4d32eab7a021d54/sqlab-0.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9bdf3d9606c17293b72a10be763f34d41f535bfe02a86982b0486365bc569df",
"md5": "5e587aaf0eccca3c12b0df43a45d243c",
"sha256": "c3c40bc8309546cbd564efd0a906c65741732c18d8d733bb56d53684f977c4a1"
},
"downloads": -1,
"filename": "sqlab-0.5.5.tar.gz",
"has_sig": false,
"md5_digest": "5e587aaf0eccca3c12b0df43a45d243c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.0",
"size": 36114,
"upload_time": "2024-06-10T17:35:20",
"upload_time_iso_8601": "2024-06-10T17:35:20.770920Z",
"url": "https://files.pythonhosted.org/packages/e9/bd/f3d9606c17293b72a10be763f34d41f535bfe02a86982b0486365bc569df/sqlab-0.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-10 17:35:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "laowantong",
"github_project": "sqlab",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sqlab"
}
JSON
