├── .github └── workflows │ ├── publish.yml │ └── test.yml ├── .gitignore ├── LICENSE ├── README.md ├── datasette_query_assistant ├── __init__.py └── templates │ └── query_assistant.html ├── pyproject.toml └── tests ├── cassettes └── test_query_assistant │ ├── test_database_assistant_page.yaml │ └── test_table_assistant_page.yaml ├── conftest.py └── test_query_assistant.py /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish Python Package 2 | 3 | on: 4 | release: 5 | types: [created] 6 | 7 | permissions: 8 | contents: read 9 | 10 | jobs: 11 | test: 12 | runs-on: ubuntu-latest 13 | strategy: 14 | matrix: 15 | python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] 16 | steps: 17 | - uses: actions/checkout@v4 18 | - name: Set up Python ${{ matrix.python-version }} 19 | uses: actions/setup-python@v5 20 | with: 21 | python-version: ${{ matrix.python-version }} 22 | cache: pip 23 | cache-dependency-path: pyproject.toml 24 | - name: Install dependencies 25 | run: | 26 | pip install '.[test]' 27 | - name: Run tests 28 | run: | 29 | python -m pytest 30 | deploy: 31 | runs-on: ubuntu-latest 32 | needs: [test] 33 | environment: release 34 | permissions: 35 | id-token: write 36 | steps: 37 | - uses: actions/checkout@v4 38 | - name: Set up Python 39 | uses: actions/setup-python@v5 40 | with: 41 | python-version: "3.12" 42 | cache: pip 43 | cache-dependency-path: pyproject.toml 44 | - name: Install dependencies 45 | run: | 46 | pip install setuptools wheel build 47 | - name: Build 48 | run: | 49 | python -m build 50 | - name: Publish 51 | uses: pypa/gh-action-pypi-publish@release/v1 52 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [push, pull_request] 4 | 5 | permissions: 6 | contents: read 7 | 8 | jobs: 9 | test: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"] 14 | steps: 15 | - uses: actions/checkout@v4 16 | - name: Set up Python ${{ matrix.python-version }} 17 | uses: actions/setup-python@v5 18 | with: 19 | python-version: ${{ matrix.python-version }} 20 | cache: pip 21 | cache-dependency-path: pyproject.toml 22 | - name: Install dependencies 23 | run: | 24 | pip install '.[test]' 25 | - name: Run tests 26 | run: | 27 | python -m pytest 28 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .venv 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | venv 6 | .eggs 7 | .pytest_cache 8 | *.egg-info 9 | .DS_Store 10 | .vscode 11 | dist 12 | build 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # datasette-query-assistant 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/datasette-query-assistant.svg)](https://pypi.org/project/datasette-query-assistant/) 4 | [![Changelog](https://img.shields.io/github/v/release/datasette/datasette-query-assistant?include_prereleases&label=changelog)](https://github.com/datasette/datasette-query-assistant/releases) 5 | [![Tests](https://github.com/datasette/datasette-query-assistant/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-query-assistant/actions/workflows/test.yml) 6 | [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-query-assistant/blob/main/LICENSE) 7 | 8 | Query databases and tables with AI assistance 9 | 10 | **Early alpha**. 11 | 12 | ## Installation 13 | 14 | Install this plugin in the same environment as Datasette. 15 | ```bash 16 | datasette install datasette-query-assistant 17 | ``` 18 | 19 | ## Configuration 20 | 21 | Set the model ID to be used by this plugin by adding this to your Datasette configuration: 22 | 23 | ```yaml 24 | plugins: 25 | datasette-query-assistant: 26 | model: openai/gpt-4.1-mini 27 | key_env_var: OPENAI_API_KEY 28 | ``` 29 | To use the `openai/gpt-4.1-mini` model you'll need to install `llm-openai-plugin` in addition to `datasette-query-assistant`. 30 | 31 | If the model needs an API key, set the `key_env_var` to the name of an environment variable and ensure that environment variable is correctly set. 32 | 33 | You can use any model that is available via an [LLM plugin](https://llm.datasette.io/en/stable/plugins/directory.html) 34 | 35 | ## Usage 36 | 37 | Users with `execute-sql` permission will gain a database action menu item for "Query this database with AI assistance" which will let them ask a question and be redirected to a commented SQL query that will hopefully answer it. 38 | 39 | ## Development 40 | 41 | To set up this plugin locally, first checkout the code. Then create a new virtual environment: 42 | ```bash 43 | cd datasette-query-assistant 44 | python3 -m venv venv 45 | source venv/bin/activate 46 | ``` 47 | Now install the dependencies and test dependencies: 48 | ```bash 49 | pip install -e '.[test]' 50 | ``` 51 | To run the tests: 52 | ```bash 53 | pytest 54 | ``` 55 | To re-generate the tests with refreshed examples from the API: 56 | ```bash 57 | pytest -x --record-mode=rewrite --inline-snapshot=fix 58 | ``` 59 | -------------------------------------------------------------------------------- /datasette_query_assistant/__init__.py: -------------------------------------------------------------------------------- 1 | from datasette import hookimpl, Response, Forbidden 2 | import dataclasses 3 | from llm import get_async_model 4 | import re 5 | import urllib 6 | from markupsafe import escape 7 | import markdown2 8 | from datasette.utils import sqlite3 9 | import itsdangerous 10 | from typing import Tuple, Optional, Set 11 | 12 | SYSTEM_PROMPT = """ 13 | You answer questions by generating SQL queries using SQLite schema syntax. 14 | Always start with -- SQL comments explaining what you are about to do. 15 | No yapping. Output SQL with extensive SQL comments in a sql tagged 16 | fenced markdown code block. 17 | 18 | Return only one SQL SELECT query. Follow the query with an explanation 19 | of what the query does and how it works, which should include bold for 20 | emphasis where appropriate. 21 | 22 | Example question: 23 | 24 | How many rows in the sqlite_master table? 25 | 26 | Example output (shown between ----): 27 | ---- 28 | ```sql 29 | select count(*) from sqlite_master 30 | ``` 31 | Count the **number of rows** in the `sqlite_master` table. 32 | ---- 33 | The table schema is: 34 | """.lstrip() 35 | 36 | SCHEMA_SQL = """ 37 | select group_concat(sql, '; 38 | ') from sqlite_master where type != 'trigger' 39 | """ 40 | SCHEMA_SQL_SPECIFIC = """ 41 | select group_concat(sql, '; 42 | ') from sqlite_master where tbl_name in (PARAMS) and type != 'trigger' 43 | """ 44 | 45 | 46 | @dataclasses.dataclass 47 | class Config: 48 | model_id: str 49 | 50 | 51 | def config(datasette): 52 | return 53 | 54 | 55 | async def get_schema(db, table=None): 56 | if table: 57 | 58 | def _related(conn): 59 | return get_related_tables(conn, table) 60 | 61 | tables = await db.execute_fn(_related) 62 | tables.add(table) 63 | sql = SCHEMA_SQL_SPECIFIC.replace("PARAMS", ",".join("?" for _ in tables)) 64 | return (await db.execute(sql, tuple(tables))).first()[0] 65 | else: 66 | return (await db.execute(SCHEMA_SQL)).first()[0] 67 | 68 | 69 | async def has_permission(datasette, actor, database): 70 | return await datasette.permission_allowed( 71 | actor, "execute-sql", database, default=True 72 | ) 73 | 74 | 75 | _sql_re = re.compile(r"```sql\n(?P.*?)\n```(?P.*)", re.DOTALL) 76 | 77 | 78 | def extract_sql_and_explanation(sql) -> Tuple[str, Optional[str]]: 79 | match = _sql_re.search(sql) 80 | if match: 81 | return match.group("sql"), match.group("explanation") 82 | return sql, None 83 | 84 | 85 | async def generate_sql_with_retries( 86 | model, db, question, schema, sql=None, max_retries=3 87 | ) -> Tuple[str, Optional[str]]: 88 | # if sql: 89 | # question = "Previous query:\n" + sql + "\n\n" + question 90 | attempt = 0 91 | conversation = model.conversation() 92 | while attempt < max_retries: 93 | attempt += 1 94 | response = await conversation.prompt( 95 | question, system=SYSTEM_PROMPT + schema, stream=False 96 | ) 97 | sql, explanation = extract_sql_and_explanation(await response.text()) 98 | # Try to run it as an explain 99 | # First remove any of those leading comment lines 100 | lines = sql.split("\n") 101 | not_comments = [line for line in lines if not line.startswith("-- ")] 102 | explain = "explain " + "\n".join(not_comments) 103 | try: 104 | if explain.lower().split()[1] != "select": 105 | raise ValueError("only select queries are supported") 106 | await db.execute(explain) 107 | return sql, explanation 108 | except (sqlite3.Error, sqlite3.Warning, ValueError) as ex: 109 | question = "Error: {}".format(str(ex)) 110 | # If we get here we are going to give up, but we'll send the query anyway 111 | sql += f"\n-- Gave up after {max_retries} attempts" 112 | return sql, explanation 113 | 114 | 115 | async def assistant(request, datasette): 116 | database = request.url_vars["database"] 117 | db = datasette.get_database(database) 118 | if not await has_permission(datasette, request.actor, database): 119 | raise Forbidden("You do not have execute-sql permission") 120 | 121 | if request.method == "POST": 122 | post_vars = await request.post_vars() 123 | question = (post_vars.get("question") or "").strip() 124 | sql = post_vars.get("sql") or None 125 | table = post_vars.get("table") or None 126 | if not question: 127 | datasette.add_message(request, "Question is required", datasette.ERROR) 128 | return Response.redirect(request.full_path) 129 | 130 | # Here we go 131 | schema = await get_schema(db, table) 132 | 133 | model = get_async_model("openai/gpt-4.1-mini") 134 | 135 | sql, explanation = await generate_sql_with_retries( 136 | model, db, question, schema, sql=sql 137 | ) 138 | args = {"sql": sql} 139 | if explanation: 140 | args["explanation"] = datasette.sign(explanation, namespace="explanation") 141 | return Response.redirect( 142 | datasette.urls.database(database) + "?" + urllib.parse.urlencode(args) 143 | ) 144 | 145 | table = request.args.get("table") 146 | schema = await get_schema(db, table) 147 | return Response.html( 148 | await datasette.render_template( 149 | "query_assistant.html", 150 | {"schema": schema, "database": database, "table": table}, 151 | request=request, 152 | ) 153 | ) 154 | 155 | 156 | @hookimpl 157 | def table_actions(datasette, actor, table, database): 158 | async def inner(): 159 | if await has_permission(datasette, actor, database): 160 | return [ 161 | { 162 | "href": datasette.urls.database(database) 163 | + "/-/assistant?{}".format( 164 | urllib.parse.urlencode({"table": table}) 165 | ), 166 | "label": "Query this table with AI assistance", 167 | "description": "Ask a question to build a SQL query", 168 | } 169 | ] 170 | 171 | return inner 172 | 173 | 174 | @hookimpl 175 | def database_actions(datasette, actor, database): 176 | async def inner(): 177 | if await has_permission(datasette, actor, database): 178 | return [ 179 | { 180 | "href": datasette.urls.database(database) + "/-/assistant", 181 | "label": "Query this database with AI assistance", 182 | "description": "Ask a question to build a SQL query", 183 | } 184 | ] 185 | 186 | return inner 187 | 188 | 189 | @hookimpl 190 | def top_query(request, datasette, database, sql): 191 | signed_explanation = request.args.get("explanation") or "" 192 | explanation = "" 193 | try: 194 | explanation_decoded = datasette.unsign( 195 | signed_explanation, namespace="explanation" 196 | ) 197 | if explanation_decoded: 198 | explanation = '
{}
'.format( 199 | markdown2.markdown(explanation_decoded) 200 | ) 201 | except itsdangerous.exc.BadSignature: 202 | explanation = "" 203 | return """ 204 |
AI query assistant 205 |
206 |

207 |

209 |

210 | 211 | 212 | 213 |

214 |
215 | {} 216 | """.format( 217 | datasette.urls.database(database), 218 | escape(sql), 219 | request.scope["csrftoken"](), 220 | explanation, 221 | ) 222 | 223 | 224 | @hookimpl 225 | def register_routes(): 226 | return [ 227 | ( 228 | r"^/(?P[^/]+)/-/assistant$", 229 | assistant, 230 | ), 231 | ] 232 | 233 | 234 | def get_related_tables( 235 | sqlite_connection: sqlite3.Connection, table_name: str 236 | ) -> Set[str]: 237 | def get_directly_related_tables(table: str, explored_tables: Set[str]) -> Set[str]: 238 | related_tables = set() 239 | cursor = sqlite_connection.cursor() 240 | # Get tables that table has a foreign key to 241 | cursor.execute(f'PRAGMA foreign_key_list("{table}")') 242 | for row in cursor.fetchall(): 243 | related_table = row[2] 244 | if related_table not in explored_tables: 245 | related_tables.add(related_table) 246 | explored_tables.add(related_table) 247 | 248 | # Get tables that have a foreign key to table 249 | cursor.execute("SELECT name FROM sqlite_master WHERE type='table'") 250 | for row in cursor.fetchall(): 251 | other_table = row[0] 252 | if other_table not in explored_tables: 253 | cursor.execute(f'PRAGMA foreign_key_list("{other_table}")') 254 | for fk_row in cursor.fetchall(): 255 | if fk_row[2] == table: 256 | related_tables.add(other_table) 257 | explored_tables.add(other_table) 258 | break 259 | 260 | return related_tables 261 | 262 | all_related_tables = set() 263 | directly_related_tables = get_directly_related_tables(table_name, {table_name}) 264 | while directly_related_tables: 265 | all_related_tables.update(directly_related_tables) 266 | new_directly_related_tables = set() 267 | for tbl in directly_related_tables: 268 | new_directly_related_tables.update( 269 | get_directly_related_tables(tbl, all_related_tables) 270 | ) 271 | directly_related_tables = new_directly_related_tables 272 | 273 | return set(all_related_tables) 274 | -------------------------------------------------------------------------------- /datasette_query_assistant/templates/query_assistant.html: -------------------------------------------------------------------------------- 1 | {% extends "base.html" %} 2 | 3 | {% block title %}Query assistant for {% if table %}{{ table }}{% else %}{{ database }}{% endif %}{% endblock %} 4 | 5 | {% block crumbs %} 6 | {{ crumbs.nav(request=request, database=database, table=table) }} 7 | {% endblock %} 8 | 9 | {% block content %} 10 | 11 |

Query assistant for {% if table %}{{ table }}{% else %}{{ database }}{% endif %}

12 | 13 |
14 |

15 | 16 |

17 |

18 |

19 | 20 | {% if table %} 21 | 22 | {% endif %} 23 | 24 | 25 | 26 |

27 |
28 | 29 |
Schema that will be passed to the model 30 | 
{{ schema }}
31 |
32 | 33 | 36 | 37 | 85 | {% endblock %} 86 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "datasette-query-assistant" 3 | version = "0.1a3" 4 | description = "Query databases and tables with AI assistance" 5 | readme = "README.md" 6 | authors = [{name = "Simon Willison"}] 7 | license = "Apache-2.0" 8 | classifiers=[ 9 | "Framework :: Datasette" 10 | ] 11 | requires-python = ">=3.9" 12 | dependencies = [ 13 | "datasette>=1.0a0", 14 | "llm>=0.22", 15 | "markdown2", 16 | ] 17 | 18 | [project.urls] 19 | Homepage = "https://github.com/datasette/datasette-query-assistant" 20 | Changelog = "https://github.com/datasette/datasette-query-assistant/releases" 21 | Issues = "https://github.com/datasette/datasette-query-assistant/issues" 22 | CI = "https://github.com/datasette/datasette-query-assistant/actions" 23 | 24 | [project.entry-points.datasette] 25 | query_assistant = "datasette_query_assistant" 26 | 27 | [project.optional-dependencies] 28 | test = ["llm-openai-plugin", "inline-snapshot", "pytest", "pytest-asyncio", "pytest-recording", "sqlite-utils"] 29 | 30 | [tool.pytest.ini_options] 31 | asyncio_mode = "strict" 32 | 33 | [tool.setuptools.package-data] 34 | datasette_query_assistant = ["templates/*"] 35 | -------------------------------------------------------------------------------- /tests/cassettes/test_query_assistant/test_database_assistant_page.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: '{"input": [{"role": "system", "content": "You answer questions by generating 4 | SQL queries using SQLite schema syntax.\nAlways start with -- SQL comments explaining 5 | what you are about to do.\nNo yapping. Output SQL with extensive SQL comments 6 | in a sql tagged\nfenced markdown code block.\n\nReturn only one SQL SELECT query. 7 | Follow the query with an explanation\nof what the query does and how it works, 8 | which should include bold for\nemphasis where appropriate.\n\nExample question:\n\nHow 9 | many rows in the sqlite_master table?\n\nExample output (shown between ----):\n----\n```sql\nselect 10 | count(*) from sqlite_master\n```\nCount the **number of rows** in the `sqlite_master` 11 | table.\n----\nThe table schema is:\nCREATE TABLE foo (id integer primary key, 12 | name text)"}, {"role": "user", "content": "Show me all the data in the foo table"}], 13 | "model": "gpt-4.1-mini", "stream": false}' 14 | headers: 15 | accept: 16 | - application/json 17 | accept-encoding: 18 | - gzip, deflate 19 | connection: 20 | - keep-alive 21 | content-length: 22 | - '879' 23 | content-type: 24 | - application/json 25 | host: 26 | - api.openai.com 27 | user-agent: 28 | - AsyncOpenAI/Python 1.76.2 29 | x-stainless-arch: 30 | - arm64 31 | x-stainless-async: 32 | - async:asyncio 33 | x-stainless-lang: 34 | - python 35 | x-stainless-os: 36 | - MacOS 37 | x-stainless-package-version: 38 | - 1.76.2 39 | x-stainless-read-timeout: 40 | - '600' 41 | x-stainless-retry-count: 42 | - '0' 43 | x-stainless-runtime: 44 | - CPython 45 | x-stainless-runtime-version: 46 | - 3.12.0 47 | method: POST 48 | uri: https://api.openai.com/v1/responses 49 | response: 50 | body: 51 | string: !!binary | 52 | H4sIAAAAAAAAA3RUTW/bMAy951cIunQLliJ27XztOHSnDsPW3prBlmU60SaLrkSlDYr898Gy4yRF 53 | ezEsPvKJfCT1OmKMq5KvGLfgmmy2iG5kms6jRTpdRMu4iIWsimU5lUV5E5dyKorlNJkv42ohkqS6 54 | 4V9aAiz+gqQjCRoHnV1aEARlJlosmiezKJ5Fs3nAHAnyro2RWDcaCMouCKxFy1fMeK2DQZmjR1YC 55 | CaXdJerIekkKzYW9Fi8Zemo8ZYT/4A2IJej27k1Dk+Q6mtTKqEk8jdPJNJlESV9WCOcr9jhijLHX 56 | 8B30qt1mkEsmxaKVa5nMFiKN5+ksSpfLJH5XrsBB+wYCCzgnNnACPtIlgBINgTmldJ7WBe2xcnih 57 | ITo4CGOQxFGtxz8XYHBfMZ7nuXvSazOZsPtfd+zJg90zQuZAgyQmtGYSta+NY8KU4Wzx2bHKYs1o 58 | C4xEoYFdVYhXa3N/e3f77YGN2fffP3+wCvHr2uR5vjYPW+V6cgtkFezAsfG4pWtJSkFiPGaO0ELJ 59 | lAnGvELMe/5i32ekzIbBruXp0mKfvGtt+Tj/zCq0PWjx+UgTCK75UPyh/xv04BZ1UFI4pxwJQ51z 60 | 6xiceCOs0Bp0Rog6k0KHuSTroYMt7BR6lx1XIgtjM4ygBeHQKLPhq76FHKoKLZ05tePg61rYfW8c 61 | MXbotgfsTknISEG7K7yESnjd9ZoHxc5zIagbsIJ8MEfX094aut1fXqGtxel8NkvBbyi+u7+reYtK 62 | diJ5Qj4Ap8nihE3WnN9pvZFh/ELWyrV96Bffh0UYElLmYnf7d+MNcPYiDHlLIbdQniKnXe599Ns3 63 | IV28B7zHO3TsI2pCEvoExnE66OUdXLxpNZBo57vlP4wO/wEAAP//AwDxf5SbhwUAAA== 64 | headers: 65 | CF-RAY: 66 | - 939189000ab27d23-LAX 67 | Connection: 68 | - keep-alive 69 | Content-Encoding: 70 | - gzip 71 | Content-Type: 72 | - application/json 73 | Date: 74 | - Thu, 01 May 2025 19:02:48 GMT 75 | Server: 76 | - cloudflare 77 | Set-Cookie: 78 | - __cf_bm=A36mulovkt818TSk94rwODLlLq0hFHW19akmZLwqUc0-1746126168-1.0.1.1-7rsETv8YOrhJVMZHG7IHyaC8jaEbY.6KFR8bhgkTDPOcZ7NqTkBBFZeinIWrN85B3kTI9HU6S4FdFOVay0_sKjXGP907SgZACZUxRlILDAo; 79 | path=/; expires=Thu, 01-May-25 19:32:48 GMT; domain=.api.openai.com; HttpOnly; 80 | Secure; SameSite=None 81 | - _cfuvid=sZmpoXnD5vU7mZaYpIcqJwzoWujUPogspVn8ZctaUVY-1746126168965-0.0.1.1-604800000; 82 | path=/; domain=.api.openai.com; HttpOnly; Secure; SameSite=None 83 | Transfer-Encoding: 84 | - chunked 85 | X-Content-Type-Options: 86 | - nosniff 87 | alt-svc: 88 | - h3=":443"; ma=86400 89 | cf-cache-status: 90 | - DYNAMIC 91 | openai-organization: 92 | - user-r3e61fpak04cbaokp5buoae4 93 | openai-processing-ms: 94 | - '1874' 95 | openai-version: 96 | - '2020-10-01' 97 | strict-transport-security: 98 | - max-age=31536000; includeSubDomains; preload 99 | x-request-id: 100 | - req_59dde03c1f28080593ba14b98013ccdd 101 | status: 102 | code: 200 103 | message: OK 104 | version: 1 105 | -------------------------------------------------------------------------------- /tests/cassettes/test_query_assistant/test_table_assistant_page.yaml: -------------------------------------------------------------------------------- 1 | interactions: 2 | - request: 3 | body: '{"input": [{"role": "system", "content": "You answer questions by generating 4 | SQL queries using SQLite schema syntax.\nAlways start with -- SQL comments explaining 5 | what you are about to do.\nNo yapping. Output SQL with extensive SQL comments 6 | in a sql tagged\nfenced markdown code block.\n\nReturn only one SQL SELECT query. 7 | Follow the query with an explanation\nof what the query does and how it works, 8 | which should include bold for\nemphasis where appropriate.\n\nExample question:\n\nHow 9 | many rows in the sqlite_master table?\n\nExample output (shown between ----):\n----\n```sql\nselect 10 | count(*) from sqlite_master\n```\nCount the **number of rows** in the `sqlite_master` 11 | table.\n----\nThe table schema is:\nCREATE TABLE foo (id integer primary key, 12 | name text)"}, {"role": "user", "content": "Count of rows in foo"}], "model": 13 | "gpt-4.1-mini", "stream": false}' 14 | headers: 15 | accept: 16 | - application/json 17 | accept-encoding: 18 | - gzip, deflate 19 | connection: 20 | - keep-alive 21 | content-length: 22 | - '862' 23 | content-type: 24 | - application/json 25 | host: 26 | - api.openai.com 27 | user-agent: 28 | - AsyncOpenAI/Python 1.76.2 29 | x-stainless-arch: 30 | - arm64 31 | x-stainless-async: 32 | - async:asyncio 33 | x-stainless-lang: 34 | - python 35 | x-stainless-os: 36 | - MacOS 37 | x-stainless-package-version: 38 | - 1.76.2 39 | x-stainless-read-timeout: 40 | - '600' 41 | x-stainless-retry-count: 42 | - '0' 43 | x-stainless-runtime: 44 | - CPython 45 | x-stainless-runtime-version: 46 | - 3.12.0 47 | method: POST 48 | uri: https://api.openai.com/v1/responses 49 | response: 50 | body: 51 | string: !!binary | 52 | H4sIAAAAAAAAA3RUTW/bMAy951cQurQNmiJ2Pp0di+60rcDWnZrBVmTa0SZLrkS1K4r898Gy4yRd 53 | egkcPvKRfHrS2wCAyZytgFl0dTpfRhMxmyXTZSKWURJv5rN4kWwmSSHGcVIU4zhaJMs5LnJRRFE8 54 | ZtcNgdn8RkF7EqMdtnFhkRPmKW+waDGdR/E8micBc8TJu6ZGmKpWSJi3RWitsWwF2isVAlLvM9Ic 55 | iUvlTlFH1guSRp/EK/43NZ5qTymZP/gONDmqpndZ02h6E40qqeUoHsez0Xg6iqbdWqGcreBxAADw 56 | Fn57vSpX9nLxGQ9y8TyZTvJ8VuQJ5oLHZ+UKHPRaY2BB53iJB+AjXQIojCbUh5GOxzqh3W+Of6mv 57 | Dglca0N8r9bjrxMwpK+AZVnmntRaj0Zwa7wmoC0CGeIKtK82aMEUYM2LA6lbjG8UwkVhzMVa/7j7 58 | cnf7ALf3P789XA6vYK0/f7//CoUxn9Y6y7K1fthKB08e7SuIht8FkuHwXIvhcN8kK4zJulabV/BO 59 | 6rIF9q0y4GVpseSEUHgdTAEvWym2YJG81W2j8ztYdF4ROCS4DCHpQHCHwJVqEwtrqnaKqxvW67br 60 | vnopmTUqHAJ3TjrimtrkJjEksZpbrhSqlIxRqeAqWJqsxxa2+CyNd+n+NqXBcb17LXJntNQlW3Wn 61 | z7AojKWjpMZJvqq4fe2CA4Bde/HQPkuBKUlsrhnLseBetTZhjozF41kIqxotJx/C0c24iwajdM0L 62 | Yyt++H9kw5DXL9/2b3feGilakTwZ1gMHUzIydVof97Rei+DcMLV0jRG6N8OHO9QPJPXJtY/mk+v/ 63 | gaPHpJ9bcLHF/FA5bmfvqt8/J4voHHCOtz+xj6iD8w9gPJn2enmHJ89hhcRzTrzh3w12/wAAAP// 64 | AwDTjNIhwgUAAA== 65 | headers: 66 | CF-RAY: 67 | - 9391890dab042aa1-LAX 68 | Connection: 69 | - keep-alive 70 | Content-Encoding: 71 | - gzip 72 | Content-Type: 73 | - application/json 74 | Date: 75 | - Thu, 01 May 2025 19:02:50 GMT 76 | Server: 77 | - cloudflare 78 | Set-Cookie: 79 | - __cf_bm=KI41m5goq0MdStN7jaOvz0xBcEmATwG5A6PKwoMaD9A-1746126170-1.0.1.1-UhUtcNacquruYpq_QWWNF2qCcFuLWFWZXkoqtOsVx1wJ5zwiMjZVJc9H7t4NM1vIOwfZ8hTOqDd8E9qxuoGBx1uFrHo8paFEMH9NHMHbWuU; 80 | path=/; expires=Thu, 01-May-25 19:32:50 GMT; domain=.api.openai.com; HttpOnly; 81 | Secure; SameSite=None 82 | - _cfuvid=5.jV5jhOJnJ12IaU9aYvciYDPL_v0ZzAMlUR1kAaRNw-1746126170883-0.0.1.1-604800000; 83 | path=/; domain=.api.openai.com; HttpOnly; Secure; SameSite=None 84 | Transfer-Encoding: 85 | - chunked 86 | X-Content-Type-Options: 87 | - nosniff 88 | alt-svc: 89 | - h3=":443"; ma=86400 90 | cf-cache-status: 91 | - DYNAMIC 92 | openai-organization: 93 | - user-r3e61fpak04cbaokp5buoae4 94 | openai-processing-ms: 95 | - '1595' 96 | openai-version: 97 | - '2020-10-01' 98 | strict-transport-security: 99 | - max-age=31536000; includeSubDomains; preload 100 | x-request-id: 101 | - req_303e97d0c7b10f4659ad92ddb0579f82 102 | status: 103 | code: 200 104 | message: OK 105 | version: 1 106 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | import os 2 | import pytest 3 | 4 | 5 | @pytest.fixture(autouse=True) 6 | def patch_env(monkeypatch): 7 | if not os.environ.get("OPENAI_API_KEY"): 8 | monkeypatch.setenv("OPENAI_API_KEY", "mock-key") 9 | 10 | 11 | @pytest.fixture(scope="module") 12 | def vcr_config(): 13 | return {"filter_headers": ["authorization"]} 14 | -------------------------------------------------------------------------------- /tests/test_query_assistant.py: -------------------------------------------------------------------------------- 1 | from datasette.app import Datasette 2 | from datasette_query_assistant import get_related_tables 3 | from inline_snapshot import snapshot 4 | import pytest_asyncio 5 | import pytest 6 | import sqlite_utils 7 | import urllib 8 | 9 | pytestmark = [pytest.mark.vcr(ignore_localhost=True)] 10 | 11 | 12 | @pytest.fixture(scope="module") 13 | def vcr_config(): 14 | return {"filter_headers": ["x-api-key"]} 15 | 16 | 17 | @pytest_asyncio.fixture 18 | async def datasette(): 19 | ds = Datasette() 20 | db = ds.add_memory_database("test") 21 | await db.execute_write( 22 | "create table if not exists foo (id integer primary key, name text)" 23 | ) 24 | return ds 25 | 26 | 27 | def test_get_related_tables(): 28 | db = sqlite_utils.Database(memory=True) 29 | db["foo.bar.baz"].insert({"id": 1}, pk="id") 30 | db["species"].insert({"id": 1, "name": "Dog"}, pk="id") 31 | db["animals"].insert( 32 | {"id": 1, "name": "Cleo", "species": 1}, 33 | pk="id", 34 | foreign_keys=(("species", "species", "id"),), 35 | ) 36 | assert get_related_tables(db.conn, "foo.bar.baz") == set() 37 | assert get_related_tables(db.conn, "species") == {"species", "animals"} 38 | assert get_related_tables(db.conn, "animals") == {"species", "animals"} 39 | 40 | 41 | @pytest.mark.asyncio 42 | @pytest.mark.vcr() 43 | async def test_database_assistant_page(datasette): 44 | response = await datasette.client.get("/test/-/assistant") 45 | assert response.status_code == 200 46 | assert "Query assistant for test" in response.text 47 | assert ( 48 | "
CREATE TABLE foo (id integer primary key, name text)
" 49 | in response.text 50 | ) 51 | # Submit the form 52 | csrftoken = response.cookies["ds_csrftoken"] 53 | post_response = await datasette.client.post( 54 | "/test/-/assistant", 55 | cookies={ 56 | "ds_csrftoken": csrftoken, 57 | }, 58 | data={ 59 | "question": "Show me all the data in the foo table", 60 | "csrftoken": csrftoken, 61 | }, 62 | ) 63 | assert post_response.status_code == 302 64 | qs = dict(urllib.parse.parse_qsl(post_response.headers["location"].split("?")[1])) 65 | assert qs["sql"] == snapshot( 66 | """\ 67 | -- SQL query to select all columns and all rows from the table 'foo' 68 | SELECT * FROM foo;\ 69 | """ 70 | ) 71 | 72 | 73 | @pytest.mark.asyncio 74 | async def test_table_assistant_page(datasette): 75 | response = await datasette.client.get("/test/-/assistant?table=foo") 76 | assert response.status_code == 200 77 | assert "Query assistant for foo" in response.text 78 | assert ( 79 | "
CREATE TABLE foo (id integer primary key, name text)
" 80 | in response.text 81 | ) 82 | # Submit the form 83 | csrftoken = response.cookies["ds_csrftoken"] 84 | post_response = await datasette.client.post( 85 | "/test/-/assistant", 86 | cookies={ 87 | "ds_csrftoken": csrftoken, 88 | }, 89 | data={ 90 | "question": "Count of rows in foo", 91 | "csrftoken": csrftoken, 92 | }, 93 | ) 94 | assert post_response.status_code == 302 95 | qs = dict(urllib.parse.parse_qsl(post_response.headers["location"].split("?")[1])) 96 | assert qs["sql"] == snapshot( 97 | """\ 98 | -- Count the total number of rows in the table 'foo' 99 | SELECT COUNT(*) 100 | FROM foo;\ 101 | """ 102 | ) 103 | --------------------------------------------------------------------------------